如何将我的 Jersey REST API 变成可执行的 JAR？

Question

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

将我的 REST API 移植为 standalone/executable JAR 的最简单方法是什么？
我可以不用 Spring 启动吗？

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 资源 classes

定义您的 JAX-RS 资源 class(es)。以下仅为示例：

@Path("hello")
public class HelloWorldResource {

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

正在创建 Jersey 配置class

创建一个 class 来配置您的 Jersey 应用程序：

public class JerseyConfiguration extends ResourceConfig {

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

正在为 Tomcat

创建启动器 class

创建 class 以启动 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();
    }
}

添加用于创建可执行 JAR 的 Maven 插件

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

<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>

编译和运行应用程序

要编译和运行应用程序，请按照下列步骤操作：

打开命令行 window 或终端。
导航到 pom.xml 所在的项目的根目录。
编译项目：mvn clean compile.
打包应用程序：mvn package。
在目标目录中查找。您应该会看到一个具有以下名称或类似名称的文件：tomcat-embedded-example-1.0-SNAPSHOT.jar.
进入目标目录。
执行 JAR：java -jar tomcat-embedded-example-1.0-SNAPSHOT.jar.
该应用程序应在 http://localhost:8080/api/hello 可用。

查看更多

Answer 2

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

添加 Maven 依赖项

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

<properties>
    <jetty.version>9.4.7.v20170914</jetty.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.eclipse.jetty</groupId>
        <artifactId>jetty-server</artifactId>
        <version>${jetty.version}</version>
    </dependency>
    <dependency>
        <groupId>org.eclipse.jetty</groupId>
        <artifactId>jetty-servlet</artifactId>
        <version>${jetty.version}</version>
    </dependency>
    <dependency>
        <groupId>org.glassfish.jersey.containers</groupId>
        <artifactId>jersey-container-jetty-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 资源 classes

定义您的 JAX-RS 资源 class(es)。以下仅为示例：

@Path("hello")
public class HelloWorldResource {

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

正在创建 Jersey 配置class

创建一个 class 来配置您的 Jersey 应用程序：

public class JerseyConfiguration extends ResourceConfig {

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

为 Jetty 创建启动器 class

创建 class 以启动 Jetty 并部署您的应用程序：

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";
        }

        Server server = new Server(Integer.valueOf(port));
        ServletContextHandler context = new ServletContextHandler(server, "/");

        ServletHolder servlet = new ServletHolder(JERSEY_SERVLET_NAME,
                new ServletContainer(new JerseyConfiguration()));
        context.addServlet(servlet, "/api/*");

        try {
            server.start();
            server.join();
        } finally {
            server.destroy();
        }
    }
}

添加用于创建可执行 JAR 的 Maven 插件

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

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-shade-plugin</artifactId>
            <version>2.4.3</version>
            <configuration>
                <finalName>jetty-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>

编译和运行应用程序

要编译和运行应用程序，请按照下列步骤操作：

打开命令行 window 或终端。
导航到 pom.xml 所在的项目的根目录。
编译项目：mvn clean compile.
打包应用程序：mvn package。
在目标目录中查找。您应该会看到一个具有以下名称或类似名称的文件：jetty-embedded-example-1.0-SNAPSHOT.jar.
进入目标目录。
执行 JAR：java -jar jetty-embedded-example-1.0-SNAPSHOT.jar.
该应用程序应在 http://localhost:8080/api/hello 可用。

如何将我的 Jersey REST API 变成可执行的 JAR？

How to turn my Jersey REST API into an executable JAR?

rest

executable

jersey

添加 Maven 依赖项

正在创建 JAX-RS 资源 classes

正在创建 Jersey 配置class

正在为 Tomcat

添加用于创建可执行 JAR 的 Maven 插件

编译和运行应用程序

查看更多

添加 Maven 依赖项

正在创建 JAX-RS 资源 classes

正在创建 Jersey 配置class

为 Jetty 创建启动器 class

添加用于创建可执行 JAR 的 Maven 插件

编译和运行应用程序

查看更多