如何仅使用注释设置JAX-RS应用程序(没有web.xml)？

Question

是否可以仅使用注释设置JAX-RS应用程序？(使用Servlet 3.0和JAX-RS Jersey 1.1.0)

我试过,没有运气.web.xml似乎需要使用一些.

---

配置A(工作,但具有web.xml配置)

web.xml中

   ...
   <servlet>
      <servlet-name>org.foo.rest.MyApplication</servlet-name>
   </servlet>
   <servlet-mapping>
       <servlet-name>org.foo.rest.MyApplication</servlet-name>
       <url-pattern>/*</url-pattern>
   </servlet-mapping>
   ...

Java的

@ApplicationPath("/")
public class MyApplication extends Application {
    ...
}

---

配置B(不工作,抛出异常)

@ApplicationPath("/")
@WebServlet("/*") // <-- 
public class MyApplication extends Application {
    ...
}

后者似乎坚持认为Application将是Servlet的子类(例外不会留下任何猜测)

java.lang.ClassCastException: org.foo.rest.MyApplication cannot be cast to javax.servlet.Servlet

---

问题

1. 为什么web.xml定义有效,但注释没有？有什么不同？

2. 有没有办法使它工作,例如有一个没有web.xml的JAX-RS应用程序？

Answer 1

**如果您使用TOMCAT或JETTY,请阅读!**

接受的答案确实有效,但前提是将webapp部署到像Glassfish或Wildfly这样的应用服务器,以及可能的部署了像TomEE这样的EE扩展的servlet容器.它不适用于像Tomcat这样的标准servlet容器,我敢肯定大多数人都在寻找这里想要使用的解决方案.

如果您使用的是标准Tomcat安装(或其他一些servlet容器),则需要包含REST实现,因为Tomcat没有安装.如果您使用的是Maven,请将其添加到以下dependencies部分:

<dependencies>
  <dependency>
    <groupId>org.glassfish.jersey.bundles</groupId>
    <artifactId>jaxrs-ri</artifactId>
    <version>2.13</version>
  </dependency>
  ...
</dependencies>

然后只需将应用程序配置类添加到项目中.如果除了为其余服务设置上下文路径之外没有任何特殊配置需求,则该类可以为空.添加此类后,您无需配置任何内容web.xml(或根本不需要):

package com.domain.mypackage;
import javax.ws.rs.ApplicationPath;
import javax.ws.rs.core.Application;

@ApplicationPath("rest") // set the path to REST web services
public class ApplicationConfig extends Application {}

在此之后,使用Java类中的标准JAX-RS注释直接声明Web服务:

package com.domain.mypackage;
import javax.ws.rs.Consumes;
import javax.ws.rs.Produces;
import javax.ws.rs.GET;
import javax.ws.rs.MatrixParam;
import javax.ws.rs.Path;

// It's good practice to include a version number in the path so you can have
// multiple versions deployed at once. That way consumers don't need to upgrade
// right away if things are working for them.
@Path("calc/1.0")
public class CalculatorV1_0 {
  @GET
  @Consumes("text/plain")
  @Produces("text/plain")
  @Path("addTwoNumbers")
  public String add(@MatrixParam("firstNumber") int n1, @MatrixParam("secondNumber") int n2) {
    return String.valueOf(n1 + n2);
  }
}

这应该是你所需要的.如果您的Tomcat安装在端口8080上本地运行,并且您将WAR文件部署到上下文myContext,则转到...

http://localhost:8080/myContext/rest/calc/1.0/addTwoNumbers;firstNumber=2;secondNumber=3

......应该产生预期的结果(5).

Answer 2

似乎所有我需要做的就是这个(Servlet 3.0及以上版本)

@ApplicationPath("/*")
public class MyApplication extends Application {
    ...
}

并且显然不需要web.xml配置(在Tomcat 7上试过)

Answer 3

JAX-RS的第2章:用于RESTful Web服务的Java™API规范描述了Servlet环境中JAX-RS应用程序的发布过程(规范中的2.3.2节Servlet).

请注意,仅建议使用Servlet 3环境(第2.3.2节Servlet,第6页):

建议实现支持Servlet 3框架可插拔机制,以实现容器之间的可移植性,并利用容器提供的类扫描工具.

简而言之,如果您想使用no-web.xml方法,则可以使用javax.ws.rs.core.Application的自定义实现,该实现使用javax.ws.rs.ApplicationPath批注注册RESTful服务资源.

@ApplicationPath("/rest")

虽然您特别询问了Jersey,但您也可以阅读文章使用JAX-RS和WebSphere 8.5 Liberty Profile实现RESTful服务,其中我描述了WebSphere Liberty Profile的no-web.xml发布过程(使用Apache Wink作为实现JAX-RS).

Answer 4

您需要在pom.xml中设置正确的依赖项

<dependency>
        <groupId>javax.servlet</groupId>
        <artifactId>javax.servlet-api</artifactId>
        <version>3.0.1</version>
        <scope>provided</scope>
    </dependency>
    <dependency>
        <groupId>org.glassfish.jersey.containers</groupId>
        <artifactId>jersey-container-servlet</artifactId>
    </dependency>

这里有更多细节: jax-rs的入门示例