在 JAX-RS 中使用 @Context、@Provider 和 ContextResolver

Question

我刚刚熟悉使用 JAX-RS 在 Java 中实现 REST Web 服务，但遇到了以下问题。我的一个资源类需要访问存储后端，该后端被抽象在 StorageEngine 接口后面。我想将当前的 StorageEngine 实例注入到服务 REST 请求的资源类中，我认为一个很好的方法是使用 @Context 注释和适当的 ContextResolver 类。这是我到目前为止所拥有的：

在 MyResource.java 中：

class MyResource {
    @Context StorageEngine storage;
    [...]
}

在 StorageEngineProvider.java 中：

@Provider
class StorageEngineProvider implements ContextResolver<StorageEngine> {
    private StorageEngine storage = new InMemoryStorageEngine();

    public StorageEngine getContext(Class<?> type) {
        if (type.equals(StorageEngine.class))
            return storage;
        return null;
    }
}

我正在使用 com.sun.jersey.api.core.PackagesResourceConfig 自动发现提供程序和资源类，并根据日志，它很好地选择了 StorageEngineProvider 类（故意省略了时间戳和不必要的内容）：

INFO: Root resource classes found:
    class MyResource
INFO: Provider classes found:
    class StorageEngineProvider

但是， <我的资源类中的 code>storage 始终为 null - Jersey 都不会调用 StorageEngineProvider 的构造函数及其 getContext 方法，曾经。我在这里做错了什么？

Answer 1

我认为没有 JAX-RS 特定的方法可以完成您想要的操作。最接近的是：

@Path("/something/")
class MyResource {
    @Context
    javax.ws.rs.ext.Providers providers;

    @GET
    public Response get() {
        ContextResolver<StorageEngine> resolver = providers.getContextResolver(StorageEngine.class, MediaType.WILDCARD_TYPE);
        StorageEngine engine = resolver.get(StorageEngine.class);
        ...
    }
}

但是，我认为 @javax.ws.rs.core.Context 注释和 javax.ws.rs.ext.ContextResolver 实际上适用于与 JAX-RS 相关的类型和支持 JAX-RS 提供程序。

您可能需要寻找 Java 上下文和依赖注入 (JSR-299) 实现（应该在 Java EE 6 中可用）或其他依赖注入框架（例如 Google Guice）来为您提供帮助。

Answer 2

实现 InjectableProvider 。最有可能的是通过扩展 PerRequestTypeInjectableProvider 或 SingletonTypeInjectableProvider。

@Provider
public class StorageEngineResolver extends SingletonTypeInjectableProvider<Context, StorageEngine>{
    public MyContextResolver() {
        super(StorageEngine.class, new InMemoryStorageEngine());
    }
}

会让你拥有：

@Context StorageEngine storage;

Answer 3

我找到了另一种方法。就我而言，我想从我的持久层提供当前作为用户实体登录的用户。
这是这个类：

@RequestScoped
@Provider
public class CurrentUserProducer implements Serializable, ContextResolver<User> {

    /**
     * Default
     */
    private static final long serialVersionUID = 1L;


    @Context
    private SecurityContext secContext;

    @Inject
    private UserUtil userUtil;

    /**
     * Tries to find logged in user in user db (by name) and returns it. If not
     * found a new user with role {@link UserRole#USER} is created.
     * 
     * @return found user or a new user with role user
     */
    @Produces
    @CurrentUser
    public User getCurrentUser() {
        if (secContext == null) {
            throw new IllegalStateException("Can't inject security context - security context is null.");
        }
        return userUtil.getCreateUser(secContext.getUserPrincipal().getName(),
                                      secContext.isUserInRole(UserRole.ADMIN.name()));
    }

    @Override
    public User getContext(Class<?> type) {
        if (type.equals(User.class)) {
            return getCurrentUser();
        }
        return null;
    }

}

我只使用 implements ContextResolver 和 @Provider 来让 Jax-Rs 发现这个类并注入 SecurityContext 。
为了获取当前用户，我将 CDI 与我的限定符 @CurrentUser 结合使用。因此，在我需要当前用户的每个地方，我都会输入：

@Inject
@CurrentUser
private User user;

确实

@Context
private User user;

不起作用（用户为空）。

Answer 4

如果有人使用 Resteasy，这对我有用。

如果您将这样的内容添加到

ResteasyContext.pushContext(StorageEngine.class, new StorageEngine());

诸如 jaxrs 过滤器之类的内容中，它允许您执行以下操作：

@GET
@Path("/some/path")
public Response someMethod(@Context StorageEngine myStorageEngine) {
 ...
}

这是特定于 Resteasy 的，它没有像 SingletonTypeInjectableProvider 这样的内容。

Answer 5

对我有用的模式：在您的应用程序子类上添加一些字段，以提供您需要注入的对象。然后使用抽象基类进行“注入”：

public abstract class ServiceBase {

    protected Database database;

    @Context
    public void setApplication(Application app) {
        YourApplication application = (YourApplication) app;
        database = application.getDatabase();
    }
}

所有需要访问数据库的服务现在都可以扩展 ServiceBase 并通过受保护的字段（或 getter，如果您愿意的话）自动使用数据库。

这对我来说适用于 Undertow 和 Resteasy。理论上，这应该适用于所有 JAX-RS 实现，因为标准 AFAICS 支持应用程序的注入，但我尚未在其他设置中对其进行测试。

对我来说，相对于 Bryant 解决方案的优势在于，我不必编写一些解析器类，这样我就可以获取应用程序范围的单例（例如数据库）。