Jersey 2.X + Maven构建Restful服务（一）

一、根据官网提供创建

mvn archetype:generate -DarchetypeArtifactId=jersey-quickstart-webapp \
                -DarchetypeGroupId=org.glassfish.jersey.archetypes -DinteractiveMode=false \
                -DgroupId=com.example -DartifactId=simple-service-webapp -Dpackage=com.example \
                -DarchetypeVersion=2.28

官网提供的，使用的是servlet2.5

 

二、使用sts4+maven创建

1、pom.xml

<project xmlns="http://maven.apache.org/POM/4.0.0"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<groupId>com.wzy</groupId>
	<artifactId>first</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<packaging>war</packaging>

	<properties>
		<jersey.version>2.28</jersey.version>
	</properties>

	<dependencies>
		<!-- 依赖注入框架 -->
		<dependency>
			<groupId>org.glassfish.jersey.inject</groupId>
			<artifactId>jersey-hk2</artifactId>
			<version>${jersey.version}</version>
		</dependency>
		<dependency>
			<groupId>org.glassfish.jersey.containers</groupId>
			<artifactId>jersey-container-servlet</artifactId>
			<version>${jersey.version}</version>
		</dependency>

	    <!-- servlet 2.X版本使用 -->
<!-- 		<dependency> -->
<!-- 			<groupId>org.glassfish.jersey.containers</groupId> -->
<!-- 			<artifactId>jersey-container-servlet-core</artifactId> -->
<!-- 			<version>${jersey.version}</version> -->
<!-- 		</dependency> -->


                <!-- 以下上面依赖已经包含 -->
		<!-- <dependency> -->
		<!-- <groupId>org.glassfish.jersey.core</groupId> -->
		<!-- <artifactId>jersey-client</artifactId> -->
		<!-- <version>${jersey.version}</version> -->
		<!-- </dependency> -->
		<!-- <dependency> -->
		<!-- <groupId>org.glassfish.jersey.core</groupId> -->
		<!-- <artifactId>jersey-server</artifactId> -->
		<!-- <version>${jersey.version}</version> -->
		<!-- </dependency> -->
		<!-- <dependency> -->
		<!-- <groupId>javax.ws.rs</groupId> -->
		<!-- <artifactId>javax.ws.rs-api</artifactId> -->
		<!-- <version>2.1.1</version> -->
		<!-- </dependency> -->
	</dependencies>
</project>

2、servlet 2.X 的支持

(1) servlet配置

	<servlet>
		<servlet-name>Jersey Web Application</servlet-name>
		<servlet-class>org.glassfish.jersey.servlet.ServletContainer</servlet-class>
		<init-param>
			<param-name>jersey.config.server.provider.packages</param-name>
			<param-value>com.example</param-value>
		</init-param>
		<load-on-startup>1</load-on-startup>
	</servlet>
	<servlet-mapping>
		<servlet-name>Jersey Web Application</servlet-name>
		<url-pattern>/webapi/*</url-pattern>
	</servlet-mapping>

比如其中一个接口叫：@Path("/user/get") ,

则可以通过http://localhost:8080/projectName/webapi/user/get访问

(2) filter配置

	<filter>
		<filter-name>MyApplication</filter-name>
		<filter-class>org.glassfish.jersey.servlet.ServletContainer</filter-class>
		<init-param>
			<param-name>jersey.config.server.provider.packages</param-name>
			<param-value>com.example</param-value>
		</init-param>
	</filter>
	<filter-mapping>
		<filter-name>MyApplication</filter-name>
		<url-pattern>/webapi/*</url-pattern>
	</filter-mapping>

需要修改@Path("/user/get") 路径为@Path("/webapi/user/get"),否则访问404.

(3) Application 和 ResourceConfig

JAX-RS提供了javax.ws.rs.core.Application，而Jersey提供了ResourceConfig；推荐使用ResourceConfig，ResourceConfig除了实现了Application，还实现了Configuration接口，提供了许多其他特性。

public class MyApplication extends ResourceConfig {

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

}

web.xml修改为：

		<init-param>
			<param-name>javax.ws.rs.Application</param-name>
			<param-value>com.example.MyApplication</param-value>
		</init-param>

 

3、servlet 3.0 的支持

servlet3.0使用唯一依赖的区别是jersey-container-servlet-core改为jersey-container-servlet，另外也新增了一些其他的用法。

（1）有web.xml

A、有Application的子类

	<servlet>
		<servlet-name>com.example.MyApplication</servlet-name>
	</servlet>
	<servlet-mapping>
		<servlet-name>com.exampleMyApplication</servlet-name>
		<url-pattern>/webapi/*</url-pattern>
	</servlet-mapping>

B、没有Application的子类

    <servlet>
        <servlet-name>javax.ws.rs.core.Application</servlet-name>
    </servlet>
    <servlet-mapping>
        <servlet-name>javax.ws.rs.core.Application</servlet-name>
        <url-pattern>/webapi/*</url-pattern>
    </servlet-mapping>

 

（2）无web.xml

 在ResourceConfig的继承类上添加@ApplicationPath("webapi")的注解：

@ApplicationPath("webapi")
public class MyApplication extends ResourceConfig{
	public MyApplication() {
		packages("com.wzy.rest,com.wzy.resources");
	}
}

修改pom.xml以忽略失踪的web.xml，设置 failOnMissingWebXml 为false：

	<build>
		<plugins>
			<plugin>
				<groupId>org.apache.maven.plugins</groupId>
				<artifactId>maven-compiler-plugin</artifactId>
				<version>2.5.1</version>
				<inherited>true</inherited>
				<configuration>
					<source>1.8</source>
					<target>1.8</target>
				</configuration>
			</plugin>
			<plugin>
				<groupId>org.apache.maven.plugins</groupId>
				<artifactId>maven-war-plugin</artifactId>
				<version>2.3</version>
				<configuration>
					<failOnMissingWebXml>false</failOnMissingWebXml>
				</configuration>
			</plugin>
		</plugins>
	</build>

 

三、依赖注入

以下使用的是 servlet3.0 + 无xml

1、pom.xml增加

<dependency>
	<groupId>javax.annotation</groupId>
	<artifactId>javax.annotation-api</artifactId>
	<version>1.3.2</version>
</dependency>

2、修改的类文件

@Path("/cdibean")
public class CDIBeanResources {
	@Inject
	MyOtherCdiBean bean; // CDI injected bean

	@GET
	@Produces("text/plain")
	public String getIt() {
		return bean.getIt();
	}
}


//需要注入的类
public class MyOtherCdiBean {

	public String getIt() {
		return "get it";
	}

	public static MyOtherCdiBean getInstance() {
		return new MyOtherCdiBean();
	}

}

//在resourceconfig中register需要注入的类
@ApplicationPath("webapi")
public class MyApplication extends ResourceConfig {
	public MyApplication() {
		register(new AbstractBinder() {
		    @Override
		    protected void configure() {
		        bind(MyOtherCdiBean.getInstance()).to(MyOtherCdiBean.class);
		    }
		});
		packages(true, "com.wzy.rest,com.wzy.config");
	}
}

 

下一篇将详细讲解参数注解等。