rest - 如何将 Jersey REST API 转换为可执行 JAR？

Question

我正在使用 Jersey、Maven；并且可以使用 Jetty、Tomcat 或 J2EE Preview(可以嵌入吗？)。

1. 将 REST API 移植为独立/可执行 JAR 的最简单方法是什么？
2. 我可以在没有 Spring Boot 的情况下完成它吗？

Answer 1

按照以下步骤使用 Jersey 和 Tomcat 创建独立应用程序:

添加 Maven 依赖项

将以下依赖项和属性添加到您的 pom.xml 中:

<properties>
    <tomcat.version>8.5.23</tomcat.version>
    <jersey.version>2.26</jersey.version>
    <maven.compiler.source>1.8</maven.compiler.source>
    <maven.compiler.target>1.8</maven.compiler.target>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>

<dependencies>
    <dependency>
        <groupId>org.apache.tomcat.embed</groupId>
        <artifactId>tomcat-embed-core</artifactId>
        <version>${tomcat.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>
</dependencies>

创建 JAX-RS 资源类

定义您的 JAX-RS 资源类。以下只是一个示例:

@Path("hello")
public class HelloWorldResource {

    @GET
    @Produces(MediaType.TEXT_PLAIN)
    public Response helloWorld() {
        return Response.ok("Hello World").build();
    }
}

创建 Jersey 配置类

创建一个类来配置您的 Jersey 应用程序:

public class JerseyConfiguration extends ResourceConfig {

    public JerseyConfiguration() {
        packages("com.example");
    }
}

为 Tomcat 创建启动器类

创建一个类来启动 Tomcat 并部署您的应用程序:

public class Launcher {

    private static final String JERSEY_SERVLET_NAME = "jersey-container-servlet";

    public static void main(String[] args) throws Exception {
        new Launcher().start();
    }

    void start() throws Exception {

        String port = System.getenv("PORT");
        if (port == null || port.isEmpty()) {
            port = "8080";
        }

        String contextPath = "";
        String appBase = ".";

        Tomcat tomcat = new Tomcat();
        tomcat.setPort(Integer.valueOf(port));
        tomcat.getHost().setAppBase(appBase);

        Context context = tomcat.addContext(contextPath, appBase);
        Tomcat.addServlet(context, JERSEY_SERVLET_NAME,
                new ServletContainer(new JerseyConfiguration()));
        context.addServletMappingDecoded("/api/*", JERSEY_SERVLET_NAME);

        tomcat.start();
        tomcat.getServer().await();
    }
}

添加 Maven 插件以创建可执行 JAR

最后添加 Maven Shade 插件来创建可执行 JAR，其中 mainClass 属性引用启动类:

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-shade-plugin</artifactId>
            <version>2.4.3</version>
            <configuration>
                <finalName>tomcat-embedded-example-${project.version}</finalName>
            </configuration>
            <executions>
                <execution>
                    <phase>package</phase>
                    <goals>
                        <goal>shade</goal>
                    </goals>
                    <configuration>
                        <transformers>
                            <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
                                <mainClass>com.example.Launcher</mainClass>
                            </transformer>
                        </transformers>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

编译并运行应用程序

要编译并运行该应用程序，请按照下列步骤操作:

• 打开命令行窗口或终端。
• 导航到 pom.xml 所在的项目根目录。
• 编译项​​目:mvn cleancompile。
• 打包应用程序:mvn package。
• 查看目标目录。您应该会看到具有以下名称或类似名称的文件:tomcat-embedded-example-1.0-SNAPSHOT.jar。
• 切换到目标目录。
• 执行 JAR:java -jar tomcat-embedded-example-1.0-SNAPSHOT.jar。
• 该应用程序应可从 http://localhost:8080/api/hello 获取。

查看更多

• How to deploy a JAX-RS application on a Java SE environment?