使用Jersey开发RESTful服务
2016-05-06 09:43
656 查看
REST
2000 年由 Roy Fielding 在博士论文中提出,他是 HTTP 规范 1.0 和 1.1 版的首席作者之一。
REST 中最重要的概念是资源(resources) ,使用全球 ID(通常使用 URI)标识。客户端应用程序使用 HTTP 方法(
Web 服务的基/根 URI,比如 http://host/<appcontext>/resources。 支持 MIME 类型的响应数据,包括 JSON/XML/ATOM 等等。
服务支持的操作集合(例如
如下表所示:
JSR-311 Java API for RESTful Web Services (JAX-RS) 1.0 and 1.1
JAX-RS是将在JavaEE 6引起的一种新技术。 JAX-RS即Java API for RESTful Web Services,是一个Java 编程语言的应用程序接口 ,支持按照表述性状态转移(REST)架构风格创建Web服务。JAX-RS使用了Java SE5引入的Java标注来简化Web服务的客户端和服务端
的开发和部署。包括:
@Path,标注资源类或者方法的相对路径
@GET,@PUT,@POST,@DELETE,标注方法是HTTP请求的类型。
@Produces,标注返回的MIME媒体类型
@Consumes,标注可接受请求的MIME媒体类型
@PathParam,@QueryParam,@HeaderParam,@CookieParam,@MatrixParam,@FormParam,分别标注方法的参数来自于HTTP请求的不同位置,例如@PathParam来自于URL的路径,@QueryParam来自于URL的查询参数,@HeaderParam来自于HTTP请求的头信息,@CookieParam来自于HTTP请求的Cookie。
Jersey 实现
Jersey 是 JAX-RS 的参考实现,它包含三个主要部分。
核心服务器(Core Server):通过提供 JSR 311 中标准化的注释和 API 标准化,您可以用直观的方式开发 RESTful Web 服务。
核心客户端(Core Client):Jersey 客户端 API 帮助您与 REST 服务轻松通信。
集成(Integration):Jersey 还提供可以轻松集成 Spring、Guice、Apache Abdera 的库
实例应用:
一、环境
1、Eclipse Juno R2
2. Tomcat 7
3. Jersey 2.7 下载地址( https://jersey.java.net/download.html)
二、流程
1.Eclipse 中创建一个 Dynamic Web Project ,本例为“RestDemo”
2.按个各人习惯建好包,本例为“com.waylau.rest.resources”
![](https://oscdn.geek-share.com/Uploads/Images/Content/201910/27/2c4559d3832d0f76e695b1e8eb18df27.jpg)
3.解压jaxrs-ri-2.7,
将api、ext、lib文件夹下的jar包都放到项目的lib下;
![](https://oscdn.geek-share.com/Uploads/Images/Content/201910/27/77c4bc8a12a1d48b52dd2695e86db962.jpg)
项目引入jar包
![](https://oscdn.geek-share.com/Uploads/Images/Content/202003/29/95ede02385121e27be1181aa518cc40c.jpg)
也可以使用maven直接使用jersey的骨架进行:首先jersey提供的骨架加入到eclipse中
Chances are you are using Apache Maven as a build & dependency management tool for your project. If you do, there is a very easy and convenient way to start playing with Jersey 2.22.2 by generating the skeleton application from one of the Jersey 2 maven
archetypes that we provide. For instance, to create a Jersey 2.22.2 application using the Grizzly 2 HTTP server container, use
If you want to create a Servlet container deployable Jersey 2.22.2 web application instead, use
4.在resources包下建一个class“HelloResource”
[java]
view plain
copy
print?
![](https://oscdn.geek-share.com/Uploads/Images/Content/201611/a7c8e286f463007e2a900848b93dd72c.png)
![](https://oscdn.geek-share.com/Uploads/Images/Content/201611/9e12f1d3e499fc949c886e7c9e0484f9)
package com.waylau.rest.resources;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.PathParam;
import javax.ws.rs.core.MediaType;
@Path("/hello")
public class HelloResource {
@GET
@Produces(MediaType.TEXT_PLAIN)
public String sayHello() {
return "Hello World!" ;
}
@GET
@Path("/{param}")
@Produces("text/plain;charset=UTF-8")
public String sayHelloToUTF8(@PathParam("param") String username) {
return "Hello " + username;
}
}
5.修改web.xml,添加基于Servlet-的部署
[html]
view plain
copy
print?
![](https://oscdn.geek-share.com/Uploads/Images/Content/201611/a7c8e286f463007e2a900848b93dd72c.png)
![](https://oscdn.geek-share.com/Uploads/Images/Content/201611/9e12f1d3e499fc949c886e7c9e0484f9)
<servlet>
<servlet-name>Way REST Service</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.waylau.rest.resources</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>Way REST Service</servlet-name>
<url-pattern>/rest/*</url-pattern>
</servlet-mapping>
6.项目部署到tomcat,运行
7.浏览器输入要访问的uri地址
http://localhost:8089/RestDemo/rest/hello
输出Hello World!
![](https://oscdn.geek-share.com/Uploads/Images/Content/201910/27/8ff7ffd23ecf7235f40ffa5c152f36bf.jpg)
http://localhost:8089/RestDemo/rest/hello/Way你好吗
输出Hello Way你好吗
![](https://oscdn.geek-share.com/Uploads/Images/Content/201910/27/cf500363dffb60bdc18fa3b9b9a5e73d.jpg)
2000 年由 Roy Fielding 在博士论文中提出,他是 HTTP 规范 1.0 和 1.1 版的首席作者之一。
REST 中最重要的概念是资源(resources) ,使用全球 ID(通常使用 URI)标识。客户端应用程序使用 HTTP 方法(
GET/ POST/ PUT/ DELETE)操作资源或资源集。RESTful Web 服务是使用 HTTP 和 REST 原理实现的 Web 服务。通常,RESTful Web 服务应该定义以下方面:
Web 服务的基/根 URI,比如 http://host/<appcontext>/resources。 支持 MIME 类型的响应数据,包括 JSON/XML/ATOM 等等。
服务支持的操作集合(例如
POST、GET、PUT或
DELETE)
如下表所示:
方法/资源 | 资源集合, URI 如: http://host/<appctx>/resources | 成员资源,URI 如: http://host/<appctx>/resources/1234 |
GET | 列出资源集合的所有成员 | 检索标识为 1234 的资源的表示形式。 |
PUT | 使用一个集合更新(替换)另一个集合。 | 更新标记为 1234 的数字资源。 |
POST | 在集合中创建数字资源 | 在下面创建一个子资源。 |
DELETE | 删除整个资源集合。 | 删除标记为 1234 的数字资源。 |
JSR-311 Java API for RESTful Web Services (JAX-RS) 1.0 and 1.1
JAX-RS是将在JavaEE 6引起的一种新技术。 JAX-RS即Java API for RESTful Web Services,是一个Java 编程语言的应用程序接口 ,支持按照表述性状态转移(REST)架构风格创建Web服务。JAX-RS使用了Java SE5引入的Java标注来简化Web服务的客户端和服务端
的开发和部署。包括:
@Path,标注资源类或者方法的相对路径
@GET,@PUT,@POST,@DELETE,标注方法是HTTP请求的类型。
@Produces,标注返回的MIME媒体类型
@Consumes,标注可接受请求的MIME媒体类型
@PathParam,@QueryParam,@HeaderParam,@CookieParam,@MatrixParam,@FormParam,分别标注方法的参数来自于HTTP请求的不同位置,例如@PathParam来自于URL的路径,@QueryParam来自于URL的查询参数,@HeaderParam来自于HTTP请求的头信息,@CookieParam来自于HTTP请求的Cookie。
Jersey 实现
Jersey 是 JAX-RS 的参考实现,它包含三个主要部分。
核心服务器(Core Server):通过提供 JSR 311 中标准化的注释和 API 标准化,您可以用直观的方式开发 RESTful Web 服务。
核心客户端(Core Client):Jersey 客户端 API 帮助您与 REST 服务轻松通信。
集成(Integration):Jersey 还提供可以轻松集成 Spring、Guice、Apache Abdera 的库
实例应用:
一、环境
1、Eclipse Juno R2
2. Tomcat 7
3. Jersey 2.7 下载地址( https://jersey.java.net/download.html)
二、流程
1.Eclipse 中创建一个 Dynamic Web Project ,本例为“RestDemo”
2.按个各人习惯建好包,本例为“com.waylau.rest.resources”
![](https://oscdn.geek-share.com/Uploads/Images/Content/201910/27/2c4559d3832d0f76e695b1e8eb18df27.jpg)
3.解压jaxrs-ri-2.7,
将api、ext、lib文件夹下的jar包都放到项目的lib下;
![](https://oscdn.geek-share.com/Uploads/Images/Content/201910/27/77c4bc8a12a1d48b52dd2695e86db962.jpg)
项目引入jar包
![](https://oscdn.geek-share.com/Uploads/Images/Content/202003/29/95ede02385121e27be1181aa518cc40c.jpg)
也可以使用maven直接使用jersey的骨架进行:首先jersey提供的骨架加入到eclipse中
Chances are you are using Apache Maven as a build & dependency management tool for your project. If you do, there is a very easy and convenient way to start playing with Jersey 2.22.2 by generating the skeleton application from one of the Jersey 2 maven
archetypes that we provide. For instance, to create a Jersey 2.22.2 application using the Grizzly 2 HTTP server container, use
mvn archetype:generate -DarchetypeGroupId=org.glassfish.jersey.archetypes -DarchetypeArtifactId=jersey-quickstart-grizzly2 -DarchetypeVersion=2.22.2
If you want to create a Servlet container deployable Jersey 2.22.2 web application instead, use
mvn archetype:generate -DarchetypeGroupId=org.glassfish.jersey.archetypes -DarchetypeArtifactId=jersey-quickstart-webapp -DarchetypeVersion=2.22.2
4.在resources包下建一个class“HelloResource”
[java]
view plain
copy
print?
![](https://oscdn.geek-share.com/Uploads/Images/Content/201611/a7c8e286f463007e2a900848b93dd72c.png)
package com.waylau.rest.resources;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.PathParam;
import javax.ws.rs.core.MediaType;
@Path("/hello")
public class HelloResource {
@GET
@Produces(MediaType.TEXT_PLAIN)
public String sayHello() {
return "Hello World!" ;
}
@GET
@Path("/{param}")
@Produces("text/plain;charset=UTF-8")
public String sayHelloToUTF8(@PathParam("param") String username) {
return "Hello " + username;
}
}
package com.waylau.rest.resources; import javax.ws.rs.GET; import javax.ws.rs.Path; import javax.ws.rs.Produces; import javax.ws.rs.PathParam; import javax.ws.rs.core.MediaType; @Path("/hello") public class HelloResource { @GET @Produces(MediaType.TEXT_PLAIN) public String sayHello() { return "Hello World!" ; } @GET @Path("/{param}") @Produces("text/plain;charset=UTF-8") public String sayHelloToUTF8(@PathParam("param") String username) { return "Hello " + username; } }
5.修改web.xml,添加基于Servlet-的部署
[html]
view plain
copy
print?
![](https://oscdn.geek-share.com/Uploads/Images/Content/201611/a7c8e286f463007e2a900848b93dd72c.png)
<servlet>
<servlet-name>Way REST Service</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.waylau.rest.resources</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>Way REST Service</servlet-name>
<url-pattern>/rest/*</url-pattern>
</servlet-mapping>
<servlet> <servlet-name>Way REST Service</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.waylau.rest.resources</param-value> </init-param> <load-on-startup>1</load-on-startup> </servlet> <servlet-mapping> <servlet-name>Way REST Service</servlet-name> <url-pattern>/rest/*</url-pattern> </servlet-mapping>
6.项目部署到tomcat,运行
7.浏览器输入要访问的uri地址
http://localhost:8089/RestDemo/rest/hello
输出Hello World!
![](https://oscdn.geek-share.com/Uploads/Images/Content/201910/27/8ff7ffd23ecf7235f40ffa5c152f36bf.jpg)
http://localhost:8089/RestDemo/rest/hello/Way你好吗
输出Hello Way你好吗
![](https://oscdn.geek-share.com/Uploads/Images/Content/201910/27/cf500363dffb60bdc18fa3b9b9a5e73d.jpg)
相关文章推荐
- Android Studio找不到R文件解决方法
- 杂记_一些关于python代码风格汇总_不断更新
- Leetcode 344 Reverse String 字符串处理
- Codeforces Round #350 (Div. 2) C
- 15省赛题回顾
- 数据库设计(1/9):数据元(Data Elements)
- [Leetcode] 92. Reverse Linked List II
- socket 笔记(二)
- ClassLoader
- Android性能测试工具:Emmagee
- 410c手把手安卓系统控制I2C光流传感器
- ECMAScript 6笔记(let,const 和 变量的解构赋值)
- [Weblogic]startWebLogic.cmd配置JAVA_OPTIONS无效的解决思路与方案
- 0506 打印cgrrct
- XCode环境下的一些基本概念
- 排序问题
- JsonConvert.DeserializeObject 的用法
- Android Performance Case Study
- IOS项目代码行统计
- LeetCode OJ 199. Binary Tree Right Side View