jersey使用指南

最新推荐文章于 2022-12-22 15:25:54 发布
最新推荐文章于 2022-12-22 15:25:54 发布
阅读量1.4k 收藏 2
点赞数 1
分类专栏： REST

jersey 是基于Java的一个轻量级RESTful风格的Web Services框架。

官网

引入

使用maven，在pom.xml中加入：

<!-- Jersey -->
<dependency>
<groupId>org.glassfish.jersey.core</groupId>
    <artifactId>jersey-client</artifactId>
    <version>${jersey.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.media</groupId>
    <artifactId>jersey-media-moxy</artifactId>
    <version>${jersey.version}</version>
</dependency>
<dependency>
    <groupId>org.glassfish.jersey.media</groupId>
    <artifactId>jersey-media-multipart</artifactId>
    <version>${jersey.version}</version>
</dependency>

当然必不可少的，也需要使用Java EE的支持：

<!-- JAVA EE -->
<dependency>
    <groupId>javax</groupId>
    <artifactId>javaee-api</artifactId>
    <version>7.0</version>
    <scope>provided</scope>
</dependency>

Jar包详解：

jersey-client 是jersey提供的客户端包，封装了一些客户端操作的类
jersey-container-servlet 是jersey的核心，服务端必备包
jersey-media-moxy 是定义了jersry支持的常用的数据格式，json，xml都包括其中
jersey-media-multipart 是jersey的上传文件的支持

配置

jersey 的使用，必须要有一个全局的配置类，这个类需满足以下条件：

  • @ApplicationPath 注解该类，并且在参数中指定相对路径
  • 继承 org.glassfish.jersey.server.ResourceConfig 类
  • 该类构造方法中设置jersey的配置，比如指定接口的包路径

如下：

@ApplicationPath("/")
public class RESTServiceConfig extends ResourceConfig {

  public RESTServiceConfig() {
    packages("web.rest");
    register(MultiPartFeature.class);
  }
}

GET

GET例子：

@GET
@Path("/thing")
public String get() {
    return "thing";
}

POST

POST例子：

@POST
@Path("/add")
public Boolean add(@FormParam("name") String name) {
    // TODO save
    return true;
}

Param

jersey中有几种常用的接收参数的注解：

  • @PathParam 接收链接中参数，如"/xxx/{name}/",@PathParm("name")
  • @QueryParam 接收链接中的普通参数，如"/xxx?name=ttt",@QueryParam("name")
  • @FormParm 接收post提交中的表单参数
  • @FormDataParm 上传文件接收文件参数

json

开发中，json已经常用到无处不在了，jersey对json的支持很好。接收json，需要使用@Consumes，注解指定解压方式：

@Consumes(MediaType.APPLICATION_JSON)

返回json需要使用@Produces注解，指定压缩方式：

@Produces(MediaType.APPLICATION_JSON)

文件上传

示例:

  @POST
  @Path("import-excel")
  @Consumes(MediaType.MULTIPART_FORM_DATA)
  @Produces(MediaType.APPLICATION_JSON)
  public ImportResultBean importForExcel(@FormDataParam("file") String fileString,
                                         @FormDataParam("file") InputStream fis,
                                         @FormDataParam("file") FormDataContentDisposition fileDisposition) {
    // TODO
    return ;
  }

文件下载

文件下载需要将Response对象的压缩方式，指定为：

@Produces(MediaType.APPLICATION_OCTET_STREAM)

Jersey是JAX-RS（JSR311）开源参考实现用于构建RESTful Web service，它包含三个部分：

　　核心服务器（Core Server） 通过提供JSR 311中标准化的注释和API标准化，可以用直观的方式开发RESTful Web服务。

　　核心客户端（Core Client） Jersey客户端API能够帮助开发者与RESTful服务轻松通信；

　　集成（Integration） Jersey还提供可以轻松继承Spring、Guice、Apache Abdera的库

设置Jersey环境

Maven

复制代码 
<!--jersey-->
<dependency>
    <groupId>org.glassfish.jersey.containers</groupId>
    <artifactId>jersey-container-servlet-core</artifactId>
    <version>2.0</version>
</dependency>

<!--JAXB API-->
<dependency>
    <groupId>javax.xml.ws</groupId>
    <artifactId>jaxws-api</artifactId>
    <version>2.1</version>
</dependency>

<!-- Json支持 -->
<dependency>
    <groupId>org.codehaus.jackson</groupId>
    <artifactId>jackson-core-asl</artifactId>
    <version>1.9.12</version>
</dependency>
<dependency>
    <groupId>org.codehaus.jackson</groupId>
    <artifactId>jackson-mapper-asl</artifactId>
    <version>1.9.12</version>
</dependency>
<dependency>
    <groupId>org.codehaus.jackson</groupId>
    <artifactId>jackson-jaxrs</artifactId>
    <version>1.9.12</version>
</dependency>
复制代码

引入Jar文件方式 
从Jersey开发包中将以下库复制的WEB-INF下的库目录：

　　服务器 jersey-server.jar 、jersey-container-servlet-core.jar、jersey-container-servlet.jar、javax.ws.rs-api-2.0.jar

　　客户端： jersey-client.jar

　　common: jersey-common.jar

　　json支持：在Jersey2.0中需要使用Jackson1.9才能支持json。

Demo Hello Wolrd

第一步：编写一个名为HelloResource的资源，它接受Http Get请求并响应 ”Hello Jerset”

复制代码 
@Path("/hello")
public class HelloResource {
    @GET
    @Produces(MediaType.TEXT_PLAIN)
    public String sayHello() {
        return "Hello Jersey";
    }
}
复制代码

第二步：编写JAX-RS application

复制代码 
public class APIApplication extends ResourceConfig {
    public APIApplication() {
        //加载Resource
        register(HelloResource.class);

        //注册数据转换器
        register(JacksonJsonProvider.class);

        // Logging.
        register(LoggingFilter.class);
    }
}
复制代码

第三步：在web.xml文件中定义servelt调度程序，目的是将所有REST请求发送到Jersey容器。除了声明Jersey Servlet外，还需定义一个初始化参数，指定JAX-RS application。

复制代码 
<!--用于定义 RESTful Web Service 接口-->
<servlet>
    <servlet-name>JerseyServlet</servlet-name>
    <servlet-class>org.glassfish.jersey.servlet.ServletContainer</servlet-class>
    <init-param>
        <param-name>javax.ws.rs.Application</param-name>
        <param-value>cn.com.mink.resource.APIApplication</param-value>
    </init-param>

    <load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
    <servlet-name>JerseyServlet</servlet-name>
    <url-pattern>/services/*</url-pattern>
</servlet-mapping>
复制代码

第四步：测试程序 
在命令终端中输入以下命令，将会看到“Hello Jersey”。 
curl http://host:port/services/hello 
或者在浏览器中输入以下URL，将会看到“Hello Jersey” 
http://host:port/services/hello

 

使用

资源 

Root Resource And Sub-Resource 
资源是组成RESTful服务的关键部分，可以使用HTTP方法（如：GET、POST、PUT和DELETE）操作资源。在JAX-RX中，资源通过POJO实现，使用@Path 注释组成其标识符。资源可以有子资源，父资源是资源集合，子资源是成员资源。 
Resources是”/services” URI组成是集合资源，UserResource是“/services/user” URI组成的成员资源;

注意，POJO是指简单的Java对象

复制代码 
@Path("/services")
public class Resources {

    @Path("/user")
    public UserResource getUserResource() {
        ...
    }

    @Path("/book")
    public BookResource getBookResource() {
        ...
    }
}
复制代码

UserResource是“/user” URI组成的集合资源，getUser是“/user/{username}” URI组成的资源方法

大括号里的内容是参数，这样设置是合理的，因为username也会出现在url中，而path就是url的意思

复制代码 
@Path("/user")
public class UserResource {
    @GET
    @Path("{username"})
    @Produces("application/json")
    public User getUser(@PathParam("username") String userName) {
        ...
    }
}
复制代码

HTTP Methods 
HTTP方法映射到资源的CRUD（创建、读取、更新和删除）操作，基本模式如下：

　　HTTP GET: 读取/列出/检索单个资源

　　HTTP POST: 新建资源

　　HTTP PUT: 更新现有资源或资源集合

　　HTTP DELETE: 删除资源或资源集合

@Produces 
@Produces注释用来指定将要返回给client端的数据标识类型（MIME）。@Produces可以作为class注释，也可以作为方法注释，方法的@Produces注释将会覆盖class的注释。 覆盖的意思是假如方法声明了自己的Produce，那么以方法的为准，class的仅供参考
指定MIME类型 
@Produces(“application/json”) 
指定多个MIME类型 
@Produces({“application/json”,“application/xml”})

@Consumes 
@Consumes与@Produces相反，用来指定可以接受client发送过来的MIME类型，同样可以用于class或者method，也可以指定多个MIME类型，一般用于@PUT，@POST 。

参数（Parameter Annotations） 
Parameter Annotations用于获取client发送的数据。本文只介绍常用的注解，更多详见Jersey用户手册 
@PathParam 
使用@PathParam可以获取URI中指定规则的参数，比如：

@GET
@Path("{username"})
@Produces(MediaType.APPLICATION_JSON)
public User getUser(@PathParam("username") String userName) {
    ...
}

当浏览器请求http://localhost/user/jack时，userName值为jack。 

注意，这里的username并不是说Key是username, value是jack而是说/usr/后面跟着的东西就是username,这里username只是个变量

至于key,value的形式，下面也有

@QueryParam 
@QueryParam用于获取GET请求中的查询参数，如：

 

复制代码 
@GET
@Path("/user")
@Produces("text/plain")
public User getUser(@QueryParam("name") String name,
                    @QueryParam("age") int age) {
    ...
}
复制代码

当浏览器请求http://host:port/user?name=rose&age=25时，name值为rose，age值为25。如果需要为参数设置默认值，可以使用@DefaultValue，如：

复制代码 
@GET
@Path("/user")
@Produces("text/plain")
public User getUser(@QueryParam("name") String name,
                    @DefaultValue("26") @QueryParam("age") int age) {
    ...
}
复制代码

当浏览器请求http://host:port/user?name=rose时，name值为rose，age值为26。 

@FormParam 
@FormParam，顾名思义，从POST请求的表单参数中获取数据。如：

@POST
@Consumes("application/x-www-form-urlencoded")
public void post(@FormParam("name") String name) {
    // Store the message
}

表单我一直没弄清楚到底是什么东西，但就使用的情况来看，就是key,value之类的东西

BeanParam 
当请求参数很多时，比如客户端提交一个修改用户的PUT请求，请求中包含很多项用户信息。这时可以用@BeanParam。 
User Bean定义如下：

复制代码 
@XmlRootElement(name = "user")
public class User {
    @PathParam("userName) //我觉得这个应该是写错了，FormParam
    private String userName;

    @FormParam("name")
    private String name;

    @FormParam("telephone")
    private String telephone;

    @FormParam("email")
    private String email;

    public String getUserName() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }
    ...
}
复制代码

使用Map 
在一个大型的server中，因为参数的多变，参数结构的调整都会因为以上几种方式而遇到问题，这时可以考虑使用@Context 注释，并获取UriInfo实例，如下：

  
@GET
public String get(@Context UriInfo ui) {
    MultivaluedMap<String, String> queryParams = ui.getQueryParameters();
    MultivaluedMap<String, String> pathParams = ui.getPathParameters();
}

我觉得，可以认为map是上面几种情况的超集，因为它能够替代以上任意一种。map就是context

同样还可以通过@Context 注释获取ServletConfig、ServletContext、HttpServletRequest、HttpServletResponse和HttpHeaders等，如下：

复制代码 
@Path("/")
public class Resource {

    @Context
    HttpServletRequest req;

    @Context
    ServletConfig servletConfig;

    @Context
    ServletContext servletContext;

    @GET
    public String get(@Context HttpHeaders hh) {
        MultivaluedMap<String, String> headerParams = hh.getRequestHeaders();
        Map<String, Cookie> pathParams = hh.getCookies();
    }
}
复制代码

Jersey返回Json和Xml 
JAX-RS支持使用JAXB（Java API for XML Binding）将JavaBean绑定到XML或JSON，反之亦然。JavaBean必须使用@XmlRootElement标注，没有@XmlElement注释的字段将包含一个名称与之相同的XML元素，如下：

这里就说明了javabean和xml, json的关系

复制代码 
@XmlRootElement
public class OptionResult {
    @XmlElement(name = "code")
    private String result;

    private String errorMsg;

    public String getResult() {
        return result;
    }

    public void setResult(String result) {
        this.result = result;
    }

    public String getErrorMsg() {
        return errorMsg;
    }

    public void setErrorMsg(String errorMsg) {
        this.errorMsg = errorMsg;
    }
}
复制代码
然后在REST服务中使用：
复制代码 
@Path("/user")
public class UserResource {
    @POST
    @Produces("application/json")
    public OptionResult create(@BeanParam User user) {
        ...
    }
}
复制代码

最后，要注册数据转换器，该转换器会自动将JavaBean转换为json数据：

复制代码 
public class APIApplication extends ResourceConfig {
    public APIApplication() {
        //加载Model
        register(OptionResult.class);

        //加载与OptionResult同一个packge的Model
        //packages(OptionResult.class.getPackage().getName());

        //加载Resource
        register(UserResource.class);

        //注册数据转换器
        register(JacksonJsonProvider.class);

        // Logging.
        register(LoggingFilter.class);
    }
}
复制代码

说明：返回XML数据的原理相同，仅仅是数据转换器不同，只需要在APIApplication中同时XML数据转换器即可。 

Wiki上关于REST的总结

含状态传输（英文：Representational State Transfer，简称REST）是Roy Fielding博士在2000年他的博士论文中提出来的一种软件架构风格.

　　资源是由URI来指定。

　　对资源的操作包括获取、创建、修改和删除资源，这些操作正好对应HTTP协议提供的GET、POST、PUT和DELETE方法。

　　通过操作资源的表现形式来操作资源。

　　资源的表现形式则是XML或者HTML，取决于读者是机器还是人，是消费web服务的客户软件还是web浏览器。当然也可以是任何其他的格式。

应该注意区别应用的状态和连接协议的状态。HTTP连接是无状态的（也就是不记录每个连接的信息），而REST传输会包含应用的所有状态信息，因此可以大幅降低对HTTP连接的重复请求资源消耗。

实现举例：

每种操作都会对应一个函数

列举所有商品

GET http://www.store.com/products

呈现某一件商品

GET http://www.store.com/product/12345

下单购买

POST http://www.store.com/order
<purchase-order>
  <item> ... </item>
</purchase-order>

REST的优点

　　可更高效利用缓存来提高响应速度

　　通讯本身的无状态性可以让不同的服务器的处理一系列请求中的不同请求，提高服务器的扩展性

　　浏览器即可作为客户端，简化软件需求

　　相对于其他叠加在HTTP协议之上的机制，REST的软件依赖性更小

　　不需要额外的资源发现机制

　　在软件技术演进中的长期的兼容性更好

 


起一个好听的名字
关注
  • 1
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
专栏目录
Jersey 入门与Javabean
weixin_34314962的博客
08-07 327
Jersey是JAX-RS（JSR311）开源参考实现用于构建RESTful Web service，它包含三个部分： 　　核心服务器（Core Server） 通过提供JSR 311中标准化的注释和API标准化，可以用直观的方式开发RESTful Web服务。 　　核心客户端（Core Client） Jersey客户端API能够帮助开发者与RESTful服务轻松通信； 　　集成（Inte...
借力Jersey，铸就卓越RESTful API体验
最新发布
架构筑梦的Cherry Yang的博客
07-17 1036
Jersey是一个流行的RESTful Web服务框架，它基于Java平台，为开发者提供了丰富的功能和灵活的扩展性。Jersey支持多种HTTP方法（如GET、POST、PUT、DELETE等），并提供了丰富的注解和工具，帮助开发者快速构建RESTful API。此外，Jersey还提供了与多种Java Web服务器（如Tomcat、Jetty等）的集成，使开发者能够轻松部署和扩展RESTful服务。
jersey使用
mapengbo521521的专栏
10-23 1640
Jersey使用 一、            环境 1.         Tomcat6 2.         Jdk1.7 3.         Jersey  在https://jersey.java.net/download.html  下载jaxrs-ri-2.22.1.zip 二、            过程 1.         创建myeclipse创建web
jersey的使用
文盲青年的博客
06-04 232
https://blog.csdn.net/zhengchao1991/article/details/53174763
jersey 简单使用
iteye_12144的博客
11-25 220
[size=large] 之前对于Webservice已经看了很多，包括axis，axissession校验（保持会话），cxf，jsr311等等，今天看了jersey，简单的写了一个例子。分享给入门的朋友。 jersey是一种restful框架，使用它为我们提供接口。有三块重要的东西，jersey-server，jersey-core, 集成（与spring等等） codein...
Jersey开发指南
11-12
### Jersey开发指南知识点详解 #### 一、Jersey概述与RESTful Web Services - **Jersey简介**：Jersey是Sun Microsystems（后被Oracle收购）为实现RESTful Web Services而开发的一个框架。作为JAX-RS（JSR 311/339...
Jersey-2.x-User-Guide:Jersey 2.x User Guide《Jersey 2.x 用户指南》 ，中文翻译
05-15
《Jersey 2.x 用户指南》 ，中文翻译。 最近在做Java RESTful 相关的项目，借此机会学习了一把Jersey，发现网上中文的资料比较少，而且Jersey的更新比较快，很多博文都老了。之前写过几个关于Jersey的demo，也可以...
Jersey-2.x-User-Guide-Demos:《 Jersey 2.x用户指南》的演示《 Jersey 2.x用户指南》
03-24
该用户指南是为帮助开发者更好地理解和使用 Jersey 2.x 而编写的。它详细介绍了如何设置开发环境，创建 RESTful 资源，处理各种 HTTP 请求方法，使用注解进行资源映射，以及如何进行错误处理和日志记录。此外，还...
Jersey-Mongodb:Java Maven应用程序代表mongodb如何与jersey一起使用（RESTful）
05-23
"Jersey-Mongodb:Java Maven应用程序代表mongodb如何与jersey一起使用（RESTful）" 这个标题表明我们正在讨论一个使用Java编程语言开发的Maven项目，该项目专注于集成MongoDB数据库与Jersey框架来实现RESTful API...
Jersey教程
08-05 1037
Jersey介绍 Jersey RESTful 框架是开源的RESTful框架, 实现了JAX-RS (JSR 311 & JSR 339) 规范。它扩展了JAX-RS 参考实现， 提供了更多的特性和工具， 可以进一步地简化 RESTful service 和 client 开发。...
RESTful Web 服务 Jersey使用
04-06
NULL 博文链接：https://danandyu8013.iteye.com/blog/1546286
Jersey 使用手册
07-24
Jersey，SUN的开源REST API工具，为程序员节省了将业务层代码封装为REST API的工作量。有效地提高了开发效率。
Spring Boot Jersey使用示例
weixin_33749242的博客
10-14 169
前言 本文将学习如何使用Spring Boot和Jersey框架，去配置和创建JAX-RS 2.0 REST API接口； 这个示例应用使用的是Jersey的Servlet容器去部署REST API接口； 工程目录 本文例子中的工程代码结果如下： 利用Spring Initializr工具创建Spring Boot应用Demo 1.访问Spring Initializr网站，添加Jersey (...
jersey使用方法
乔的博客
01-03 1197
通过mvn创建jersey项目： https://jersey.java.net/download.html mvn archetype:generate -DarchetypeGroupId=org.glassfish.jersey.archetypes \ -DarchetypeArtifactId=jersey-quickstart-webapp -Darchet
Jersey使用总结一（jersey初步使用和简单post请求几种参数传递，String方式，不含对象操作）
热门推荐
tianshi1017的专栏
07-16 2万+
首先说明一下，jersey是干什么的呢，我个人的理解就是类似于一种webservice技术或框架 jersey-rest为service端，其它的jersey请求为客户端，客户端发送一个请求（带参或不带参）调用service端的方法，方法返回结果给客户端。   如以下使用步奏： 一.建立服务器端:        1.下载jersey的相关jar        2.建立一个web pro
Jersey入门教程
大白菜代码哥
09-15 6256
 本文是Jersey入门介绍Jersey-Jersey入门  提示：本文章是翻译而来，感觉比较好，就发表在这里，跟大家分享。    By Julien Dubois  首先我们需要知道Representational State Transfer (REST)，因为REST与Jersey关系密切。REST是一种架构风格，是由Roy T. Fielding来定义的，这里需要
Jersey 使用记录
weixin_43366953的博客
12-22 476
Jersey的简单使用
jersey的简单使用原理（jersey1.15版本）
GOODNESS_的博客
08-15 1083
来到新公司，看了一下框架，使用了一个jersey的RESTful的API，之前听都没听过，也不知道是个什么鸟东东，抽空看了一下他的简单使用方法和原理，记录一下。 一、web.xml配置 <servlet> <servlet-name>JerseyServlet</servlet-name> <servlet-class&gt...
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值