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

时间：2016-09-06 07:28:44

标签： rest jersey executable

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

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

2 个答案:

答案 0 :(得分：6)

按照以下步骤使用 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 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。
    • 上提供

查看更多

答案 1 :(得分：4)

按照以下步骤创建一个包含 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资源类

定义您的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");
    }
}

为Jetty创建启动器类

创建一个类来启动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();
        }
    }
}

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

编译并运行应用程序

要编译并运行该应用程序，请按以下步骤操作：

  • 打开命令行窗口或终端。
  • 导航到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。
    • 上提供

查看更多

相关问题
最新问题