Jersey 入门（二）

最新推荐文章于 2022-12-22 15:25:54 发布
最新推荐文章于 2022-12-22 15:25:54 发布
阅读量392 收藏
点赞数
分类专栏： java 文章标签： jersey web service 服务器 开源

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的软件依赖性更小

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

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

 

JavaBean

JavaBeans是Java语言中可以重复使用的软件组件，它们是一种特殊的Java类[1]，将很多的对象封装到了一个对象(bean)中。特点是可序列化，提供无参构造器，提供getter方法和setter方法访问对象的属性。

优点

　　Bean可以控制它的属性，事件和方法是否暴露给其他程序

　　Bean可以接收来自其他对象的事件，也可以产生事件给其他对象

　　有软件可以配置Bean

　　Bean的属性可以被序列化，以供日后使用

JavaBean规范

要成为JavaBean类，必须遵循关于命名，构造器，方法的特定规范，有了这些规范，才能使用，复用，替代和连接javabean的工具。 
规范是：

　　有一个public 无参构造器

　　属性可以通过get, set, is方法或者遵循特定命名规范的其他方法访问。

　　可序列化

一个例子

复制代码 
public class PersonBean implements java.io.Serializable {

    /**
     * <code>name</code>属性(注意大小写)
     */
    private String name = null;

    private boolean deceased = false;

    /** 无参构造器(没有参数) */
    public PersonBean() {
    }

    /**
     * <code>name</code>属性的Getter方法
     */
    public String getName() {
        return name;
    }

    /**
     * <code>name</code>属性的Setter方法
     * @param value
     */
    public void setName(final String value) {
        name = value;
    }

    /**
     * "deceased"属性的Getter方法
     * 布尔型属性的Getter方法的不同形式(这里使用了is而非get)
     */
    public boolean isDeceased() {
        return deceased;
    }

    /**
     * <code>deceased</code>属性的Setter方法
     * @param value
     */
    public void setDeceased(final boolean value) {
        deceased = value;
    }
}
复制代码

 

总结

1. Javabean提供了一种保证，即对于所有的成员变量，一定有get,set方法。并且还可以序列化

2. REST服务基于底层的保证来实现，因此可以简化很多事情，比如Javabean和XML的转换就可以写得相当简单。

z1012890225
关注
专栏目录
jersey使用方法
乔的博客
01-03 1215
通过mvn创建jersey项目： https://jersey.java.net/download.html mvn archetype:generate -DarchetypeGroupId=org.glassfish.jersey.archetypes \ -DarchetypeArtifactId=jersey-quickstart-webapp -Darchet
jersey使用指南
小叶的编程实验室
09-22 1032
jersey 是基于Java的一个轻量级RESTful风格的Web Services框架。官网引入使用maven，在pom.xml中加入：<!-- Jersey --> <dependency> <groupId>org.glassfish.jersey.core</groupId> <artifactId>jersey-client</artifactId> <version>${
Jersey 入门与Javabean
weixin_34314962的博客
08-07 335
Jersey是JAX-RS（JSR311）开源参考实现用于构建RESTful Web service，它包含三个部分： 　　核心服务器（Core Server） 通过提供JSR 311中标准化的注释和API标准化，可以用直观的方式开发RESTful Web服务。 　　核心客户端（Core Client） Jersey客户端API能够帮助开发者与RESTful服务轻松通信； 　　集成（Inte...
jersey使用
mapengbo521521的专栏
10-23 1663
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 239
https://blog.csdn.net/zhengchao1991/article/details/53174763
介绍Jersey-Jersey入门基础
09-05
【 Jersey 框架简介】 Jersey 是一个开源的 Java 框架，用于实现 Representational State Transfer（REST）架构风格的服务。REST 是一种软件架构设计原则，它强调通过网络上的资源进行通信，通常使用 HTTP 协议。...
Jersey入门Demo
12-18
@GET @Produces(MediaType.TEXT_PLAIN) public String sayHello() { return "Hello World!" ; } @GET @Path("/{param}") @Produces("text/plain;charset=UTF-8") public String sayHelloToUTF8(@...
Jersey入门实例--很好
08-20
【标题】"Jersey入门实例--很好"指出的是一个关于Jersey框架的基础教程，适合初学者使用，通过导入到MyEclipse开发环境中，可以轻松学习并实践RESTful服务的创建。这个实例包括了服务端和客户端的实现，帮助开发者...
jetty-seed:使用 Maven、Jetty 和 Jersey 的入门代码
06-17
使用 Maven、Jetty 和 Jersey 的入门代码 使用 maven-shade-plugin 构建一个带有依赖项的胖 jar 使用单一资源在 8080 上运行码头服务器 建造 安装 跑步 java -jar target/jetty-app-{{version}}.jar 测试资源
Jersey2.13+spring3.2.3入门实例
10-05
** Jersey2.13 + Spring3.2.3入门实例详解** 本文将深入探讨如何结合Jersey 2.13和Spring 3.2.3框架构建一个入门级的Web服务应用。首先，我们来了解这两个关键组件的核心功能。 **Jersey** 是Java语言中最流行的...
RESTful Web 服务 Jersey使用
04-06
NULL 博文链接：https://danandyu8013.iteye.com/blog/1546286
Jersey 使用手册
07-24
Jersey，SUN的开源REST API工具，为程序员节省了将业务层代码封装为REST API的工作量。有效地提高了开发效率。
Jersey使用总结一（jersey初步使用和简单post请求几种参数传递，String方式，不含对象操作）
热门推荐
tianshi1017的专栏
07-16 2万+
首先说明一下，jersey是干什么的呢，我个人的理解就是类似于一种webservice技术或框架 jersey-rest为service端，其它的jersey请求为客户端，客户端发送一个请求（带参或不带参）调用service端的方法，方法返回结果给客户端。   如以下使用步奏： 一.建立服务器端:        1.下载jersey的相关jar        2.建立一个web pro
jersey 简单使用
iteye_12144的博客
11-25 237
[size=large] 之前对于Webservice已经看了很多，包括axis，axissession校验（保持会话），cxf，jsr311等等，今天看了jersey，简单的写了一个例子。分享给入门的朋友。 jersey是一种restful框架，使用它为我们提供接口。有三块重要的东西，jersey-server，jersey-core, 集成（与spring等等） codein...
Jersey教程
08-05 1062
Jersey介绍 Jersey RESTful 框架是开源的RESTful框架, 实现了JAX-RS (JSR 311 & JSR 339) 规范。它扩展了JAX-RS 参考实现， 提供了更多的特性和工具， 可以进一步地简化 RESTful service 和 client 开发。...
Spring Boot Jersey使用示例
weixin_33749242的博客
10-14 182
前言 本文将学习如何使用Spring Boot和Jersey框架，去配置和创建JAX-RS 2.0 REST API接口； 这个示例应用使用的是Jersey的Servlet容器去部署REST API接口； 工程目录 本文例子中的工程代码结果如下： 利用Spring Initializr工具创建Spring Boot应用Demo 1.访问Spring Initializr网站，添加Jersey (...
Jersey入门教程
大白菜代码哥
09-15 6288
 本文是Jersey入门介绍Jersey-Jersey入门  提示：本文章是翻译而来，感觉比较好，就发表在这里，跟大家分享。    By Julien Dubois  首先我们需要知道Representational State Transfer (REST)，因为REST与Jersey关系密切。REST是一种架构风格，是由Roy T. Fielding来定义的，这里需要
jersey
liuliangsailor的专栏
03-26 1019
Java Jersey使用總結 簡介 設置Jersey環境 Maven 引入Jar文件方式 Hello World 使用 资源 Root Resource And Sub-Resource HTTP Methods @Produces @Consumes 参数（Parameter Annotations） @PathParam @QueryParam @FormPar
Jersey 使用记录
最新发布
weixin_43366953的博客
12-22 495
Jersey的简单使用
Jersey RESTful框架详解与实战入门
Jersey简明手册是一份针对Jersey RESTful框架的详细介绍文档，Jersey是一个开源的框架，它遵循JAX-RS（Java API for RESTful Web Services）规范，为构建RESTful服务和客户端提供了扩展和便利性。REST...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值