初试基于Jersey框架的RESTful服务开发

2024-01-12 00:58

本文主要是介绍初试基于Jersey框架的RESTful服务开发,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

      目前做着的项目中有一个向服务器获取树控件数据的模块,结合了之前受到RESTful架构思想的影响,我打算用RESTful的方式来发布资源服务。因为我对RESTful的理解就是一个面向资源的服务架构(我管它叫ROA),那用在这里是挺合适的,至少还能学一种新技术。

 

      我突击了解了几种主流的RESTful框架,比如Restlet, cetia4等等,最终感觉还是Jersey最容易上手,其号称是JAX-RS的参考实现,应该挺专业的。这篇博客将记录我使用Jersey完成的一个测试程序,实现Get方式的多级资源查询。

 

      环境准备:JDK1.6,Tomcat 6.16,Eclipse Galileo JEE版,和jersey-archive-1.1.5

 

      开发过程:首先是在Eclipse中新建一个Dynamic Web Project。因为它自动生成了WEB-INF和META-INF文件,并且提供打包成war文件的选项(其它项目类型可能也行,我就偷懒用它了)。

 

      接着先做点铺垫工作。因为我要求使用XML来响应客户端的请求,那可以用JAXB来把Java类映射成XML文件,Jersey是支持JAXB的,于是先建几个带有JAXB标签的JavaBean,这样后面操作的时候只要直接return我定义的类,框架会自动转成XML格式。例如:

 

@XmlRootElement(name = "category")
public class CategoryBean {private String id;private String name;public CategoryBean() {}public CategoryBean(String id, String name) {this.id = id;this.name = name;}@XmlAttributepublic String getId() {return id;}public void setId(String id) {this.id = id;}@XmlAttributepublic String getName() {return name;}public void setName(String name) {this.name = name;}
}

 

 相应的XML格式为:

 

<category name="" id=""/>
 

 

      还要建个类来模拟数据库,供资源类(这是实现RESTful服务的关键类,下面会说)来获取数据。这里建了一个DB类,具体代码就不贴了,看附件吧。实现的功能就是根据id号来获取相应的数据资源。

      接着便是写资源类了。资源类负责执行相应URI的响应行为,你不必关心URI地址的捕获问题,这些由框架提供的Servlet实现了。资源类不需要继承任何框架提供的类或接口,只要适当的加一些标签。贴段代码来说明吧:

 

@Path("/class")
public class ClassResource {@ContextUriInfo uriInfo;@ContextRequest request;@GET@Produces(MediaType.APPLICATION_XML)public List<ClassBean> getClassList() {List<ClassBean> classList = new ArrayList<ClassBean>();classList.addAll(DB.getClassMap().values());return classList;}@Path("{classId}")public CategoryResource getCategoryList(@PathParam("classId") String id) {return new CategoryResource(uriInfo, request, id);}
}

 

        类定义前的@Path("/class")说明这个资源类处理URI的“/class”后的内容。

@Context:使用注释来注入相关上下文对象。

     @GET:说明响应GET方式的请求

     @Produces:设定响应数据的格式,这里是XML格式。被注释的方法可以直接返回list或是带JAXB标签的自定义类,框架会自动转成XML数据。相对还有个@consumer标签用来定义请求数据的格式,当然这里的Get方法是用不到了。

     @Path("{classId}"):在方法定义前加path标签用来实现多级URI的解析。如果参数是在{}中的,说明将作为参数获取其值的,与方法的参数定义中的标签对应。

 

      如果方法的返回类型是一个资源类,则意味着对该URI段之后的内容(含该段)会由这个成员资源类来负责,当然当前资源类会将相应参数传递进成员资源类。以下是成员资源类的代码段:

 

// 这个类定义前就没有Path标签了。
public class CategoryResource {@ContextUriInfo uriInfo;@ContextRequest request;private String id;public CategoryResource(UriInfo uri, Request req, String id) {this.id = id;this.uriInfo = uri;this.request = req;}@GET@Produces(MediaType.APPLICATION_XML)public List<CategoryBean> getCategoryList() {List<CategoryBean> list = new ArrayList<CategoryBean>();list.addAll(DB.getCategoryMap(id).values());return list;}@Path("{categoryId}")public ServiceResource getServiceList(@PathParam("categoryId") String id) {return new ServiceResource(uriInfo, request, id);}
}
 

 

      如果需要,可以继续一级级添加下去。当然我这里没有符合RESTful的实践指导来设计URI,只是一个示例说明。

      然后要做的就是编辑web.xml了。我的文件内容如下:

 

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" id="WebApp_ID" version="2.5"><display-name>TestSample</display-name><welcome-file-list><welcome-file>index.html</welcome-file><welcome-file>index.htm</welcome-file><welcome-file>index.jsp</welcome-file><welcome-file>default.html</welcome-file><welcome-file>default.htm</welcome-file><welcome-file>default.jsp</welcome-file></welcome-file-list><servlet><servlet-name>Jersey REST Service</servlet-name><servlet-class>com.sun.jersey.spi.container.servlet.ServletContainer</servlet-class><init-param><param-name>com.sun.jersey.config.property.packages</param-name><param-value>cn.edu.njupt.restSample.resources</param-value></init-param><load-on-startup>1</load-on-startup></servlet><servlet-mapping><servlet-name>Jersey REST Service</servlet-name><url-pattern>/*</url-pattern></servlet-mapping>
</web-app>

 

 

     资源类类定义前Path标签里的“/”是和部署文件的映射路径有关的,在本例中如果部署文件映射的是"/*",则完整URI应该为http://<host>:<port>/<appctx>/class;如果映射"/test/*",则URI为http://<host>:<port>/<appctx>/test/class,熟悉servlet的应该一看就懂了。

 

     最后要做的就是打包放Tomcat里了。运行Tomcat,因为这个实验中响应的都是Get请求,直接用浏览器就可以测试,输入相应的地址试试吧。

这篇关于初试基于Jersey框架的RESTful服务开发的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/596288

相关文章

PyQt5 GUI 开发的基础知识

《PyQt5GUI开发的基础知识》Qt是一个跨平台的C++图形用户界面开发框架,支持GUI和非GUI程序开发,本文介绍了使用PyQt5进行界面开发的基础知识,包括创建简单窗口、常用控件、窗口属性设... 目录简介第一个PyQt程序最常用的三个功能模块控件QPushButton(按钮)控件QLable(纯文本

Python Web框架Flask、Streamlit、FastAPI示例详解

《PythonWeb框架Flask、Streamlit、FastAPI示例详解》本文对比分析了Flask、Streamlit和FastAPI三大PythonWeb框架:Flask轻量灵活适合传统应用... 目录概述Flask详解Flask简介安装和基础配置核心概念路由和视图模板系统数据库集成实际示例Stre

Olingo分析和实践之OData框架核心组件初始化(关键步骤)

《Olingo分析和实践之OData框架核心组件初始化(关键步骤)》ODataSpringBootService通过初始化OData实例和服务元数据,构建框架核心能力与数据模型结构,实现序列化、URI... 目录概述第一步:OData实例创建1.1 OData.newInstance() 详细分析1.1.1

Spring Boot 与微服务入门实战详细总结

《SpringBoot与微服务入门实战详细总结》本文讲解SpringBoot框架的核心特性如快速构建、自动配置、零XML与微服务架构的定义、演进及优缺点,涵盖开发环境准备和HelloWorld实战... 目录一、Spring Boot 核心概述二、微服务架构详解1. 微服务的定义与演进2. 微服务的优缺点三

基于Python开发一个图像水印批量添加工具

《基于Python开发一个图像水印批量添加工具》在当今数字化内容爆炸式增长的时代,图像版权保护已成为创作者和企业的核心需求,本方案将详细介绍一个基于PythonPIL库的工业级图像水印解决方案,有需要... 目录一、系统架构设计1.1 整体处理流程1.2 类结构设计(扩展版本)二、核心算法深入解析2.1 自

RabbitMQ消息总线方式刷新配置服务全过程

《RabbitMQ消息总线方式刷新配置服务全过程》SpringCloudBus通过消息总线与MQ实现微服务配置统一刷新,结合GitWebhooks自动触发更新,避免手动重启,提升效率与可靠性,适用于配... 目录前言介绍环境准备代码示例测试验证总结前言介绍在微服务架构中,为了更方便的向微服务实例广播消息,

关于DNS域名解析服务

《关于DNS域名解析服务》:本文主要介绍关于DNS域名解析服务,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录DNS系统的作用及类型DNS使用的协议及端口号DNS系统的分布式数据结构DNS的分布式互联网解析库域名体系结构两种查询方式DNS服务器类型统计构建DNS域

Linux中SSH服务配置的全面指南

《Linux中SSH服务配置的全面指南》作为网络安全工程师,SSH(SecureShell)服务的安全配置是我们日常工作中不可忽视的重要环节,本文将从基础配置到高级安全加固,全面解析SSH服务的各项参... 目录概述基础配置详解端口与监听设置主机密钥配置认证机制强化禁用密码认证禁止root直接登录实现双因素

Spring 框架之Springfox使用详解

《Spring框架之Springfox使用详解》Springfox是Spring框架的API文档工具,集成Swagger规范,自动生成文档并支持多语言/版本,模块化设计便于扩展,但存在版本兼容性、性... 目录核心功能工作原理模块化设计使用示例注意事项优缺点优点缺点总结适用场景建议总结Springfox 是

java向微信服务号发送消息的完整步骤实例

《java向微信服务号发送消息的完整步骤实例》:本文主要介绍java向微信服务号发送消息的相关资料,包括申请测试号获取appID/appsecret、关注公众号获取openID、配置消息模板及代码... 目录步骤1. 申请测试系统2. 公众号账号信息3. 关注测试号二维码4. 消息模板接口5. Java测试