java jersey restful 详解

2024-05-13 13:58
文章标签 java 详解 restful jersey

本文主要是介绍java jersey restful 详解，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

前言

在短信平台一期工作中，为便于移动平台的开发，使用了Java Jersey框架开发RESTFul风格的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的库。

在本次开发中使用Jersey2.0，并且仅使用了核心服务器。

设置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。

Hello World

以下将展示一个Hello World

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

@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() {//加载Resourceregister(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组成的成员资源;

@Path("/services")
public class Resources {@Path("/user")public UserResource getUserResource() {...}@Path("/book")public BookResource getBookResource() {...}
}

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

@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的注释。

  • 指定一个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。

@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
}

@BeanParam

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

@POST
@Consumes("application/x-www-form-urlencoded")
public void update(@BeanParam User user) {// Store the user data
}

User Bean定义如下：

@XmlRootElement(name = "user")
public class User {@PathParam("userName)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();
}

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

@Path("/")
public class Resource {@ContextHttpServletRequest req;@ContextServletConfig servletConfig;@ContextServletContext servletContext;@GETpublic 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元素，如下：

@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() {//加载Modelregister(OptionResult.class);//加载与OptionResult同一个packge的Model//packages(OptionResult.class.getPackage().getName());//加载Resourceregister(UserResource.class);//注册数据转换器register(JacksonJsonProvider.class);// Logging.register(LoggingFilter.class);}
}

说明：返回XML数据的原理相同，仅仅是数据转换器不同，只需要在APIApplication中同时注册XML数据转换器即可，详见 Jersey用户手册

问题总结

Ajax请求（POST、PUT和DELETE）无法将数据提交到Jersey容器
问题阐述

在短信平台的开发中，数据的CRUD全部使用Ajax技术完成，因此必须使用POST、PUT和DELETE请求。此三种请求的content-type均为“application/x-www-form-urlencoded”，使用UTF-8编码会变成“application/x-www-form-urlencoded; UTF-8”。在使用Firefox的tamperdata扩展调试程序的过程中发现，当content-type为“application/x-www-form-urlencoded”时，Jersey容器能够通过@FormParam注解获取到提交的数据，而content-type为“application/x-www-form-urlencoded; UTF-8”时便获取不到。

解决方案

最终我使用Java Filter和Jersey RequestFilter解决了问题。首先在Java Filter中使用UTF8将Request中的数据编码，然后在Jersey RequestFilter中将request对象中的content-type修改为“application/x-www-form-urlencoded”。如：

public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {HttpServletRequest req = (HttpServletRequest)request;req.setCharacterEncoding("UTF-8");
}public class RequestFilter implements ContainerRequestFilter {@Overridepublic void filter(ContainerRequestContext context) throws IOException {String headerString = context.getHeaderString("content-type");if (headerString != null) {//如果content-type以"application/x-www-form-urlencoded"开头，则处理if (headerString.startsWith(MediaType.APPLICATION_FORM_URLENCODED))context.getHeaders().putSingle("content-type", MediaType.APPLICATION_FORM_URLENCODED);}}
}

最后在web.xml中注册Java Filter（要注册在Jersey容器之前），在APIApplication中注册Jersey RequestFilter，如下：

public class APIApplication extends ResourceConfig {public APIApplication() {register(RequestFilter.class);}
}

这篇关于java jersey restful 详解的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/985902。

相关文章

Java NoClassDefFoundError运行时错误分析解决

Java NoClassDefFoundError运行时错误分析解决

《JavaNoClassDefFoundError运行时错误分析解决》在Java开发中,NoClassDefFoundError是一种常见的运行时错误,它通常表明Java虚拟机在尝试加载一个类时未能... 目录前言一、问题分析二、报错原因三、解决思路检查类路径配置检查依赖库检查类文件调试类加载器问题四、常见
阅读更多...
Java注解之超越Javadoc的元数据利器详解

Java注解之超越Javadoc的元数据利器详解

《Java注解之超越Javadoc的元数据利器详解》本文将深入探讨Java注解的定义、类型、内置注解、自定义注解、保留策略、实际应用场景及最佳实践,无论是初学者还是资深开发者,都能通过本文了解如何利用... 目录什么是注解？注解的类型内置注编程解自定义注解注解的保留策略实际用例最佳实践总结在 Java 编程
阅读更多...
MySQL数据库约束深入详解

MySQL数据库约束深入详解

《MySQL数据库约束深入详解》：本文主要介绍MySQL数据库约束,在MySQL数据库中,约束是用来限制进入表中的数据类型的一种技术,通过使用约束,可以确保数据的准确性、完整性和可靠性,需要的朋友... 目录一、数据库约束的概念二、约束类型三、NOT NULL 非空约束四、DEFAULT 默认值约束五、UN
阅读更多...
Python使用Matplotlib绘制3D曲面图详解

Python使用Matplotlib绘制3D曲面图详解

《Python使用Matplotlib绘制3D曲面图详解》：本文主要介绍Python使用Matplotlib绘制3D曲面图,在Python中,使用Matplotlib库绘制3D曲面图可以通过mpl... 目录准备工作绘制简单的 3D 曲面图绘制 3D 曲面图添加线框和透明度控制图形视角Matplotlib
阅读更多...
MySQL中的分组和多表连接详解

MySQL中的分组和多表连接详解

《MySQL中的分组和多表连接详解》：本文主要介绍MySQL中的分组和多表连接的相关操作,本文通过实例代码给大家介绍的非常详细,感兴趣的朋友一起看看吧... 目录mysql中的分组和多表连接一、MySQL的分组（group javascriptby ）二、多表连接（表连接会产生大量的数据垃圾）MySQL中的
阅读更多...
Java 实用工具类Spring 的 AnnotationUtils详解

Java 实用工具类Spring 的 AnnotationUtils详解

《Java实用工具类Spring的AnnotationUtils详解》Spring框架提供了一个强大的注解工具类org.springframework.core.annotation.Annot... 目录前言一、AnnotationUtils 的常用方法二、常见应用场景三、与 JDK 原生注解 API 的
阅读更多...
Java controller接口出入参时间序列化转换操作方法(两种)

Java controller接口出入参时间序列化转换操作方法(两种)

《Javacontroller接口出入参时间序列化转换操作方法(两种)》：本文主要介绍Javacontroller接口出入参时间序列化转换操作方法,本文给大家列举两种简单方法,感兴趣的朋友一起看... 目录方式一、使用注解方式二、统一配置场景：在controller编写的接口，在前后端交互过程中一般都会涉及
阅读更多...
Java中的StringBuilder之如何高效构建字符串

Java中的StringBuilder之如何高效构建字符串

《Java中的StringBuilder之如何高效构建字符串》本文将深入浅出地介绍StringBuilder的使用方法、性能优势以及相关字符串处理技术,结合代码示例帮助读者更好地理解和应用,希望对大家... 目录关键点什么是 StringBuilder？为什么需要 StringBuilder？如何使用 St
阅读更多...
使用Java将各种数据写入Excel表格的操作示例

使用Java将各种数据写入Excel表格的操作示例

《使用Java将各种数据写入Excel表格的操作示例》在数据处理与管理领域,Excel凭借其强大的功能和广泛的应用,成为了数据存储与展示的重要工具,在Java开发过程中,常常需要将不同类型的数据,本文... 目录前言安装免费Java库1. 写入文本、或数值到 Excel单元格2. 写入数组到 Excel表格
阅读更多...
redis中使用lua脚本的原理与基本使用详解

redis中使用lua脚本的原理与基本使用详解

《redis中使用lua脚本的原理与基本使用详解》在Redis中使用Lua脚本可以实现原子性操作、减少网络开销以及提高执行效率,下面小编就来和大家详细介绍一下在redis中使用lua脚本的原理... 目录Redis 执行 Lua 脚本的原理基本使用方法使用EVAL命令执行 Lua 脚本使用EVALSHA命令
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2