使用Jersey 2.0进行依赖注入

时间:2013-04-25 13:58:50

标签: java dependency-injection jersey jersey-2.0 hk2

从头开始没有任何以前的Jersey 1.x知识,我很难理解如何在Jersey 2.0项目中设置依赖注入。

我也明白HK2可用于Jersey 2.0,但我似乎无法找到有助于Jersey 2.0集成的文档。

@ManagedBean
@Path("myresource")
public class MyResource {

    @Inject
    MyService myService;

    /**
     * Method handling HTTP GET requests. The returned object will be sent
     * to the client as "text/plain" media type.
     *
     * @return String that will be returned as a text/plain response.
     */
    @GET
    @Produces(MediaType.APPLICATION_JSON)
    @Path("/getit")
    public String getIt() {
        return "Got it {" + myService + "}";
    }
}

@Resource
@ManagedBean
public class MyService {
    void serviceCall() {
        System.out.print("Service calls");
    }
}

的pom.xml

<properties>
    <jersey.version>2.0-rc1</jersey.version>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.glassfish.jersey</groupId>
            <artifactId>jersey-bom</artifactId>
            <version>${jersey.version}</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

<dependencies>
    <dependency>
        <groupId>org.glassfish.jersey.core</groupId>
        <artifactId>jersey-common</artifactId>
    </dependency>
    <dependency>
        <groupId>org.glassfish.jersey.core</groupId>
        <artifactId>jersey-server</artifactId>
    </dependency>
    <dependency>
        <groupId>org.glassfish.jersey</groupId>
        <artifactId>jax-rs-ri</artifactId>
    </dependency>
</dependencies>

我可以让容器启动并提供我的资源,但是只要我将@Inject添加到MyService,框架就会抛出异常:

SEVERE: Servlet.service() for servlet [com.noip.MyApplication] in context with path [/jaxrs] threw exception [A MultiException has 3 exceptions.  They are:
1. org.glassfish.hk2.api.UnsatisfiedDependencyException: There was no object available for injection at Injectee(requiredType=MyService,parent=MyResource,qualifiers={}),position=-1,optional=false,self=false,unqualified=null,1039471128)
2. java.lang.IllegalArgumentException: While attempting to resolve the dependencies of com.noip.MyResource errors were found
3. java.lang.IllegalStateException: Unable to perform operation: resolve on com.noip.MyResource
] with root cause
org.glassfish.hk2.api.UnsatisfiedDependencyException: There was no object available for injection at Injectee(requiredType=MyService,parent=MyResource,qualifiers={}),position=-1,optional=false,self=false,unqualified=null,1039471128)
    at org.jvnet.hk2.internal.ThreeThirtyResolver.resolve(ThreeThirtyResolver.java:74)


我的初学者项目可以在GitHub上找到:https://github.com/donaldjarmstrong/jaxrs

8 个答案:

答案 0 :(得分:100)

您需要定义AbstractBinder并在JAX-RS应用程序中注册它。绑定器指定依赖注入应如何创建类。

public class MyApplicationBinder extends AbstractBinder {
    @Override
    protected void configure() {
        bind(MyService.class).to(MyService.class);
    }
}

如果在@Inject类型的参数或字段上检测到MyService.class,则会使用类MyService对其进行实例化。要使用此绑定程序,需要在JAX-RS应用程序中注册。在web.xml中,定义一个JAX-RS应用程序,如下所示:

<servlet>
  <servlet-name>MyApplication</servlet-name>
  <servlet-class>org.glassfish.jersey.servlet.ServletContainer</servlet-class>
  <init-param>
    <param-name>javax.ws.rs.Application</param-name>
    <param-value>com.mypackage.MyApplication</param-value>
  </init-param>
  <load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
  <servlet-name>MyApplication</servlet-name>
  <url-pattern>/*</url-pattern>
</servlet-mapping>

实施MyApplication类(在init-param中指定)。

public class MyApplication extends ResourceConfig {
    public MyApplication() {
        register(new MyApplicationBinder());
        packages(true, "com.mypackage.rest");
    }
}

指定依赖项注入的绑定程序在类的构造函数中注册,我们还使用MyResource方法调用告诉应用程序在何处查找REST资源(在您的情况下为packages())。

答案 1 :(得分:47)

首先只是回答接受回答中的评论。

  

&#34; bind有什么作用?如果我有接口和实现怎么办?&#34;

它只是阅读bind( implementation ).to( contract )。您可以选择替代链.in( scope )。默认范围为PerLookup。所以如果你想要一个单身人士,你可以

bind( implementation ).to( contract ).in( Singleton.class );

还有一个RequestScoped可用

此外,您还可以bind(Class).to(Class)代替bind(Instance).to(Class),它将自动成为单身人士。


添加到accepted answer

对于那些试图弄清楚如何在您的web.xml中注册AbstractBinder实施的人(即您没有使用ResourceConfig),似乎粘合剂赢了通过包裹扫描发现,即

<servlet-class>org.glassfish.jersey.servlet.ServletContainer</servlet-class>
<init-param>
    <param-name>jersey.config.server.provider.packages</param-name>
    <param-value>
        your.packages.to.scan
    </param-value>
</init-param>

或者这个

<init-param>
    <param-name>jersey.config.server.provider.classnames</param-name>
    <param-value>
        com.foo.YourBinderImpl
    </param-value>
</init-param>

为了让它发挥作用,我必须实现Feature

import javax.ws.rs.core.Feature;
import javax.ws.rs.core.FeatureContext;
import javax.ws.rs.ext.Provider;

@Provider
public class Hk2Feature implements Feature {

    @Override
    public boolean configure(FeatureContext context) {
        context.register(new AppBinder());
        return true;
    }
}

@Provider注释应该允许包裹扫描拾取Feature。或者,如果没有包扫描,您可以在Feature

中明确注册web.xml
<servlet>
    <servlet-name>Jersey Web Application</servlet-name>
    <servlet-class>org.glassfish.jersey.servlet.ServletContainer</servlet-class>
    <init-param>
        <param-name>jersey.config.server.provider.classnames</param-name>
        <param-value>
            com.foo.Hk2Feature
        </param-value>
    </init-param>
    ...
    <load-on-startup>1</load-on-startup>
</servlet>

另见:

以及来自Jersey文档的一般信息


更新

工厂

除了已接受答案中的基本绑定外,您还拥有工厂,您可以在其中拥有更复杂的创建逻辑,还可以访问请求上下文信息。例如

public class MyServiceFactory implements Factory<MyService> {
    @Context
    private HttpHeaders headers;

    @Override
    public MyService provide() {
        return new MyService(headers.getHeaderString("X-Header"));
    }

    @Override
    public void dispose(MyService service) { /* noop */ }
}

register(new AbstractBinder() {
    @Override
    public void configure() {
        bindFactory(MyServiceFactory.class).to(MyService.class)
                .in(RequestScoped.class);
    }
});

然后,您可以将MyService注入资源类。

答案 2 :(得分:11)

选定的答案可以追溯到前一段时间。在自定义HK2活页夹中声明每个绑定是不切实际的。 我正在使用Tomcat,我只需添加一个依赖项。尽管它是专为Glassfish设计的,但它完全适合其他容器。

   <dependency>
        <groupId>org.glassfish.jersey.containers.glassfish</groupId>
        <artifactId>jersey-gf-cdi</artifactId>
        <version>${jersey.version}</version>
    </dependency>

确保您的容器也已正确配置(see the documentation)。

答案 3 :(得分:5)

迟到但我希望这对某人有帮助。

我的JAX RS定义如下:

SomeManagedBean

然后,在我的代码中,我最终可以注入:

{{1}}

就我而言,{{1}}是ApplicationScoped bean。

希望这对任何人都有帮助。

答案 4 :(得分:2)

Oracle建议在将JAX-RS与CDI组合时将@Path注释添加到要注入的所有类型: http://docs.oracle.com/javaee/7/tutorial/jaxrs-advanced004.htm 虽然这远非完美(例如你在启动时会得到Jersey的警告),但我决定采用这条路线,这使我无法在活页夹中维护所有支持的类型。

示例:

@Singleton
@Path("singleton-configuration-service")
public class ConfigurationService {
  .. 
}

@Path("my-path")
class MyProvider {
  @Inject ConfigurationService _configuration;

  @GET
  public Object get() {..}
}

答案 5 :(得分:0)

如果您更喜欢使用Guice并且您不想声明所有绑定,您也可以尝试使用此适配器:

guice-bridge-jit-injector

答案 6 :(得分:0)

如果对我来说,如果我在Web应用程序中包含以下依赖项(在Tomcat 8.5,Jersey 2.27上运行),则无需AbstractBinder,它就可以工作:

<dependency>
    <groupId>javax.ws.rs</groupId>
    <artifactId>javax.ws.rs-api</artifactId>
    <version>2.1</version>
</dependency>
<dependency>
    <groupId>org.glassfish.jersey.containers</groupId>
    <artifactId>jersey-container-servlet</artifactId>
    <version>${jersey-version}</version>
</dependency>
<dependency>
    <groupId>org.glassfish.jersey.ext.cdi</groupId>
    <artifactId>jersey-cdi1x</artifactId>
    <version>${jersey-version}</version>
</dependency>
<dependency>
    <groupId>org.glassfish.jersey.inject</groupId>
    <artifactId>jersey-hk2</artifactId>
    <version>${jersey-version}</version>
</dependency>

对我来说,它可以与CDI 1.2 / CDI 2.0配合使用(分别使用Weld 2/3)。

答案 7 :(得分:0)

jersey静态服务所需的依赖关系,而Tomcat是服务器。 其中$ {jersey.version}为2.29.1

    <dependency>
        <groupId>javax.enterprise</groupId>
        <artifactId>cdi-api</artifactId>
        <version>2.0.SP1</version>
        <scope>provided</scope>
    </dependency>
    <dependency>
        <groupId>org.glassfish.jersey.core</groupId>
        <artifactId>jersey-server</artifactId>
        <version>${jersey.version}</version>
    </dependency>
    <dependency>
        <groupId>org.glassfish.jersey.containers</groupId>
        <artifactId>jersey-container-servlet</artifactId>
        <version>${jersey.version}</version>
    </dependency>
    <dependency>
        <groupId>org.glassfish.jersey.inject</groupId>
        <artifactId>jersey-hk2</artifactId>
        <version>${jersey.version}</version>
    </dependency>

基本代码如下:

@RequestScoped
@Path("test")
public class RESTEndpoint {

   @GET
   public String getMessage() {