使用 javax.ws.rs.core.Application 实现通用 JAX-RS Web 服务

Question

启用 Servlet 3.0 的容器允许我们跳过 web.xml servlet 配置，并在您扩展 javax.ws.rs.core.Application、使用 @ApplicationPath 注释它并且不覆盖 getClasses() 方法后自动扫描您的代码以查找资源和提供程序。 （希望我没看错：\）

目前我正在使用 Jersey 实现并使用 @RolesAllowed 注释保护资源方法。为此，我需要注册 org.glassfish.jersey.server.filter.RolesAllowedDynamicFeature Provider 类，但是，我知道这样做的唯一方法是：

1. 在我的Application 类的getClasses() 方法中注册该类（我认为这会导致Servlet 3.0 容器不自动扫描）

2. 继续使用 web.xml Jersey servlet 设置和

   <init-param>
       <param-name>jersey.config.server.provider.classnames</param-name>
       <param-value>org.glassfish.jersey.server.filter.RolesAllowedDynamicFeature</param-value>
   </init-param>
   

现在这个问题背后的背景是我可能不得不切换到使用 RESTeasy，如果我使用选项 1，它会在代码中添加 Jersey 依赖项，并且代码不再是通用的。

如何编写代码以使用安全注释，同时维护可部署到另一个 Servlet 3.0 JAX-RS 实现的通用 JAX-RS 代码？

Answer 1

一种选择是使用javax.ws.rs.core.Feature（一种JAX-RS 标准类）。您可以在那里注册任何组件，然后使用@Provider 注释该类，它将像任何其他@Provider 或@Path 注释类一样被拾取

@Provider
public class MyFeature implements Feature {
    @Overrride
    public boolean configure(FeatureContext context) {
        context.register(RolesAllowedDynamicFeature.class);
    }
}

请注意，由于您使用的是 Jersey 功能，因此您的应用不再独立于实现，因此您不妨一直使用 Jersey。一方面，Jersey 不建议扫描类路径，这是做你正在做的事情的影响。相反，Jersey 有一种机制，允许您递归地扫描包（及其子包）。所以你可以这样做

@ApplicationPath("..")
public class AppConfig extends ResourceConfig {
    public AppConfig() {
        packages("the.packages.to.scan");
        register(RolesAllowedDynamicFeature.class);
    }
}

注意ResourceConfig 是Application 的子类

另请参阅：

• When to Use JAX-RS Class-path Scanning Mechanism
• Sevlet Based Deployment - Servlet 3.x Container

注意：

如果您想坚持类路径扫描机制，并希望保持项目独立于任何 Jersey 依赖项，您还可以在 Application 类中覆盖 Map<String, Object> getProperties()。在返回的Map 中，您可以添加您本来会在 web.xml 中添加的属性

@Override
public Map<String, Object> getProperties() {
    Map<String, Object> props = new HashMap<>();
    props.put("jersey.config.server.provider.classnames",
              "org.glassfish.jersey.server.filter.RolesAllowedDynamicFeature");
    return props;
}

但即使源代码独立于实现，应用程序仍然依赖于 Jersey 角色功能。如果您决定要移植，您仍然需要替换该功能。

如果您想保持完全独立，可以自己实现该功能。这并不是那么复杂。您可以查看the source code for RolesAllowedDynamicFeature。如果您决定尝试实现相同的功能，只需使用 @Provider 注释您的实现类，它就会被选中。