如何部署 JAX-RS 应用程序？

Question

JAX-RS 1.1 规范在第 6 页上写道：

如果不存在应用程序子类 添加的 servlet 必须命名为：

javax.ws.rs.core.Application

添加的 servlet 是什么？它可以是任意 servlet 吗？

如果存在应用程序子类 并且已经定义了一个servlet 具有 Servlet 初始化 参数名称为：

javax.ws.rs.Application

再说一遍，这里的“servlet”是什么？

如果存在应用程序子类 这不是由一个处理 现有 servlet 然后是 servlet 必须由 ContainerInitializer 添加 以完全限定名称命名 应用程序子类的。

“ContainerInitializer 添加的 servlet”是否意味着 servlet 是自动添加的？配置会是什么样子？

目前，我既不使用 Application 类，也不使用 web.xml，并且它可以工作（使用 GlassFish 3.1）。这种部署机制是否需要完整的类路径扫描，这对于大型库来说可能会很慢？

如何部署在Servlet容器上？

网络上有大量令人困惑的配置选项。请参阅此 web.xml 中包含上下文参数的示例（不适用于我！）。部署 JAX-RS 应用程序的首选方式是什么？

Answer 1

有许多选项可用于部署到 Java EE 6 容器（更具体地说是 Servlet 3.0 实现）：

最简单的是：

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://java.sun.com/xml/ns/j2ee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_3_0.xsd" version="3.0">
    <servlet>
        <servlet-name>javax.ws.rs.core.Application</servlet-name>
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>javax.ws.rs.core.Application</servlet-name>
        <url-pattern>/rest/*</url-pattern>
    </servlet-mapping>
</web-app>

然后是所有 @Path 和 @Provider 类在您的 Web 应用程序中找到的内容将在“默认”JAX-RS 应用程序中可用，servlet URL 模式为 “/rest/*”。

如果您有一个或多个扩展 javax.ws.rs.core.Application 的类，您可以这样指定：

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://java.sun.com/xml/ns/j2ee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_3_0.xsd" version="3.0">
    <servlet>
        <servlet-name>com.example.jaxrs.MyApplication</servlet-name>
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>com.example.jaxrs.MyApplication</servlet-name>
        <url-pattern>/rest/*</url-pattern>
    </servlet-mapping>
</web-app>

如果您希望只返回特定的 < 组，则可能需要执行上述操作URL 上的 code>@Path/@Provider 类（因此您可以拥有第二个具有上述不同 URL 模式的 MyApplication2）。

您还可以完全跳过整个 web.xml，只用 @ApplicationPath 注释您的 MyApplication 类，它将用作 URL 模式。我建议在任何情况下都保留 web.xml，因为无论如何您可能都必须在那里添加有关 Web 应用程序的其他信息。

如果您想知道 servlet-class 从何而来，它是由环境自动添加的。您可以通过查看 Servlet 3.0 ServletContext 获得一个想法。

Answer 2

使用 WAS 8.5，我更改 web.xml 添加：

<servlet>
    <servlet-class>com.ibm.websphere.jaxrs.server.IBMRestServlet</servlet-class>
    <init-param>
        <param-name>javax.ws.rs.Application</param-name>
        <param-value>com.tada.rest.RestApplication</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
    <servlet-name>javax.ws.rs.core.Application</servlet-name>
</servlet>
<servlet-mapping>
    <servlet-name>javax.ws.rs.core.Application</servlet-name>
    <url-pattern>/rest/*</url-pattern>
</servlet-mapping>

我的 RestApplication 看起来像：

import java.util.HashSet;
import java.util.Set;

import javax.ws.rs.core.Application;

public class RestApplication extends Application {

    @Override
    public Set<Class<?>> getClasses() {
        Set<Class<?>> sets = new HashSet<Class<?>>();
        sets.add(RestService.class);
        return sets;
    }
}

我的 RestService 看起来像

@Path("/tada")
public class RestService {
    @GET
    public String getSomething() {
        return "tada";
    }
}

我在 pom.xml 中添加依赖项：

<dependency>
    <groupId>javax.ws.rs</groupId>
    <artifactId>javax.ws.rs-api</artifactId>
    <version>2.0</version>
</dependency>

Answer 3

使用Servlet3.0，遵循这个。这对我有用。

<servlet>
    <description>JAX-RS Tools Generated - Do not modify</description>
    <servlet-name>JAX-RS Servlet</servlet-name>
    <servlet-class>com.ibm.websphere.jaxrs.server.IBMRestServlet</servlet-class>
    <init-param>
        <param-name>javax.ws.rs.Application</param-name>
        <param-value>your.restsrv.config.RESTConfig</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
    <enabled>true</enabled>
    <async-supported>false</async-supported>
</servlet>
<servlet>
    <servlet-name>javax.ws.rs.core.Application</servlet-name>
    <load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
    <servlet-name>javax.ws.rs.core.Application</servlet-name>
    <url-pattern>/rest/*</url-pattern>
</servlet-mapping>
<servlet-mapping>
    <servlet-name>JAX-RS Servlet</servlet-name>
    <url-pattern>/*</url-pattern>
</servlet-mapping>

Answer 4

正如我在上面的评论中所说，这完全取决于您要使用的框架。

http://syrupsucker.blogspot.com/2008/ 10/deploying-jersey-in-tomcat-60.html 用于泽西岛
http://syrupsucker.blogspot.com/2008/ 10/deploying-resteasy-in-tomcat-60.html for RESTeasy

据我所知，JAX-RS 不包含部署规范。