部分內(nèi)容參考自:https://github.com/waylau/Jersey-2.x-User-Guide/blob/master/Chapter%204.%20Application%20Deployment%20and%20Runtime%20Environments%20%E5%BA%94%E7%94%A8%E9%83%A8%E7%BD%B2%E5%92%8C%E8%BF%90%E8%A1%8C%E6%97%B6%E7%8E%AF%E5%A2%83/4.7.%20Servlet-based%20Deployment%20%E5%9F%BA%E4%BA%8E%20Servlet%20%E7%9A%84%E9%83%A8%E7%BD%B2.md
maven庫:http://mvnrepository.com/
環(huán)境:
IDEA Ultimate 2017.2.2 + JDK 1.8 + Jersey 2 + Maven + Tomcat 9.0.0.M22
首先創(chuàng)建項(xiàng)目:
選中Web Application(3.1)框架雳殊,勾選Create web.xml,IDE會(huì)在創(chuàng)建項(xiàng)目時(shí)創(chuàng)建web.xml配置文件驶沼。
創(chuàng)建項(xiàng)目后右鍵選中項(xiàng)目桩撮,添加框架支持敦第,選中Maven,隨即生成pom.xml文件店量。這里會(huì)彈出Event對(duì)話框芜果,會(huì)有提示你Enable Auto-Import,這里我們Enable一下融师。
然后開始通過maven添加依賴jar包右钾,引用Jersey,pom.xml配置如下:
<groupId>com.overc_i3.jerseydemo</groupId>
<artifactId>JerseyDemo</artifactId>
<version>1.0-SNAPSHOT</version>
<properties>
<!--maven默認(rèn)的java源值、目標(biāo)值版本是1.5舀射,修改成1.8-->
<maven.compiler.source>1.8</maven.compiler.source>
<maven.compiler.target>1.8</maven.compiler.target>
<jersey.version>2.25</jersey.version>
</properties>
<dependencies>
<dependency>
<!--jersey服務(wù)端包窘茁,將 Jersey 當(dāng)做 Servlet-->
<groupId>org.glassfish.jersey.containers</groupId>
<artifactId>jersey-container-servlet</artifactId>
<version>${jersey.version}</version>
</dependency>
<dependency>
<!--服務(wù)端核心包-->
<groupId>org.glassfish.jersey.core</groupId>
<artifactId>jersey-server</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.media</groupId>
<artifactId>jersey-media-json-jackson</artifactId>
<version>${jersey.version}</version>
</dependency>
</dependencies>
接下來是配置web.xml脆烟,項(xiàng)目里的路徑是web/WEB-INF/web.xml山林,這里我們將 Jersey 當(dāng)做 Servlet:
<servlet>
<!--Servlet配置-->
<servlet-name>jerseyServlet</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.overc_i3.jerseydemo</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>jerseyServlet</servlet-name>
<url-pattern>/*</url-pattern>
</servlet-mapping>
也可將 Jersey 當(dāng)做 Servlet Filter,如下配置:
<filter>
<filter-name>MyApplication</filter-name>
<filter-class>org.glassfish.jersey.servlet.ServletContainer</filter-class>
<init-param>
...
</init-param>
</filter>
...
<filter-mapping>
<filter-name>MyApplication</filter-name>
<url-pattern>/myApp/*</url-pattern>
</filter-mapping>
<init-param> 元素內(nèi)容將取決于你如何決定資源配置不同的 Jersey 資源邢羔。
最后一步配置驼抹,在輸出中把jar包全部加進(jìn)去
配置完成,開始寫上API代碼拜鹤,首先在src\main\java中根據(jù)之前配置的包建好對(duì)應(yīng)的包框冀,我這里配置的是com\overc_i3\jerseydemo,這里使用Json做交互署惯,先建model:
package com.overc_i3.model;
import java.util.List;
public class ReqJson {
private String id;
private List<ListBean> list;
public List<ListBean> getList() {
return list;
}
public void setList(List<ListBean> list) {
this.list = list;
}
public String getId() {
return id;
}
public void setId(String id) {
this.id = id;
}
public static class ListBean {
private String maxname;
public String getMaxname() {
return maxname;
}
public void setMaxname(String maxname) {
this.maxname = maxname;
}
}
}
創(chuàng)建TestApi類:
package com.overc_i3.jerseydemo;
import com.overc_i3.model.ReqJson;
import javax.ws.rs.*;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import java.util.ArrayList;
import java.util.List;
@Path("/")
public class TestApi {
//GET注解設(shè)置接受請(qǐng)求類型為GET
@GET
// 與Produces對(duì)應(yīng)的是@Consumes
@Produces(MediaType.TEXT_PLAIN)
//用作測(cè)試服務(wù)啟動(dòng)情況
public String getMessage() {
return "Hello world!";
}
@GET
@Consumes(MediaType.TEXT_PLAIN)//注解指定解壓方式接收數(shù)據(jù)類型
@Path("/hello")
public Response postJson(@QueryParam("name") String name) {
return Response.status(200).entity("hello "+name).build();
}
@POST
@Consumes(MediaType.APPLICATION_JSON)//注解指定解壓方式接收數(shù)據(jù)類型
@Produces(MediaType.APPLICATION_JSON)//注解指定壓縮方式返回?cái)?shù)據(jù)類型
@Path("/postJson2")
public Response postJson2(ReqJson msg) {
ReqJson reqJson = new ReqJson();
reqJson.setId(msg.getId());
List<ReqJson.ListBean> listBeanList = new ArrayList<>();
for (int i = 0; i < msg.getList().size(); i++) {
ReqJson.ListBean listBean = new ReqJson.ListBean();
listBean.setMaxname(msg.getList().get(i).getMaxname());
listBeanList.add(listBean);
}
reqJson.setList(listBeanList);
return Response.status(200).entity(reqJson).build();
}
}
現(xiàn)在配置Tomcat運(yùn)行一下:
點(diǎn)擊Run >Edit Configurations… > “+” > Tomcat Server > Local左驾,加入Tomcat,選擇Deployment tab, 點(diǎn)擊 “+”, 選擇唯一的Artifact极谊,點(diǎn)擊"OK"即可诡右。
配置好之后直接運(yùn)行,在瀏覽器訪問http://localhost:8080
到這里RESTful API已經(jīng)正常運(yùn)行轻猖,接下來再用Fiddler調(diào)用API(注意設(shè)置請(qǐng)求格式Content-Type: application/json):
到這里RESTful API已經(jīng)搭建完成帆吻,下面是部署的一些其它“姿勢(shì)”:
自定義 Application 子類
如果你的繼承 Application 類來提供有關(guān)根資源類的列表(getresources())和單身(getsingletons()),即你的 JAX-RS 應(yīng)用模型咙边,然后你需要注冊(cè)一個(gè) javax.ws.rs.Application [原名] 名稱的 Servlet 或 Servlet 過濾器作為 web 應(yīng)用程序的初始化參數(shù)猜煮,在 web.xml 中進(jìn)行部署描述:
配置 Jersey 容器 Servlet 或者 過濾器來自定義 Application 子類<init-param> <param-name>javax.ws.rs.Application</param-name> <param-value>org.foo.MyApplication</param-value> </init-param>
Jersey 將考慮所有 Application 實(shí)現(xiàn)的 getClasses() 和 getSingletons() 方法的返回。
注意:JAX-RS 規(guī)范定義的配置名稱確實(shí)是 javax.ws.rs.Application 而不是 javax.ws.rs.core.Application
Jersey 掃描包
如果配置屬性無需設(shè)置败许,要部署應(yīng)用程序只包括存儲(chǔ)在特定的包的資源和提供者王带,那么你可以指示 Jersey 自動(dòng)掃描這些包,這樣就能自動(dòng)注冊(cè)找到的任何資源和提供者:
配置 Jersey 的 Servlet 或者 Filter 來掃描包<init-param> <param-name>jersey.config.server.provider.packages</param-name> <param-value> org.foo.myresources,org.bar.otherresources </param-value> </init-param> <init-param> <param-name>jersey.config.server.provider.scanning.recursive</param-name> <param-value>false</param-value> </init-param>
Jersey 將會(huì)自動(dòng)發(fā)現(xiàn)被選中的資源和提供者市殷。你可以通過設(shè)置 >jersey.config.server.provider.scanning.recursive 屬性來決定 Jersey 是否掃描子包愕撰。默認(rèn)值是 true , 即啟用遞歸掃描子包。
源碼:https://github.com/overclockingi3/JerseyDemo