初试基于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

相关文章

这15个Vue指令,让你的项目开发爽到爆

1. V-Hotkey 仓库地址: github.com/Dafrok/v-ho… Demo: 戳这里 https://dafrok.github.io/v-hotkey 安装: npm install --save v-hotkey 这个指令可以给组件绑定一个或多个快捷键。你想要通过按下 Escape 键后隐藏某个组件,按住 Control 和回车键再显示它吗?小菜一碟: <template

Hadoop企业开发案例调优场景

需求 (1)需求:从1G数据中,统计每个单词出现次数。服务器3台,每台配置4G内存,4核CPU,4线程。 (2)需求分析: 1G / 128m = 8个MapTask;1个ReduceTask;1个mrAppMaster 平均每个节点运行10个 / 3台 ≈ 3个任务(4    3    3) HDFS参数调优 (1)修改:hadoop-env.sh export HDFS_NAMENOD

嵌入式QT开发:构建高效智能的嵌入式系统

摘要: 本文深入探讨了嵌入式 QT 相关的各个方面。从 QT 框架的基础架构和核心概念出发,详细阐述了其在嵌入式环境中的优势与特点。文中分析了嵌入式 QT 的开发环境搭建过程,包括交叉编译工具链的配置等关键步骤。进一步探讨了嵌入式 QT 的界面设计与开发,涵盖了从基本控件的使用到复杂界面布局的构建。同时也深入研究了信号与槽机制在嵌入式系统中的应用,以及嵌入式 QT 与硬件设备的交互,包括输入输出设

OpenHarmony鸿蒙开发( Beta5.0)无感配网详解

1、简介 无感配网是指在设备联网过程中无需输入热点相关账号信息,即可快速实现设备配网,是一种兼顾高效性、可靠性和安全性的配网方式。 2、配网原理 2.1 通信原理 手机和智能设备之间的信息传递,利用特有的NAN协议实现。利用手机和智能设备之间的WiFi 感知订阅、发布能力,实现了数字管家应用和设备之间的发现。在完成设备间的认证和响应后,即可发送相关配网数据。同时还支持与常规Sof

活用c4d官方开发文档查询代码

当你问AI助手比如豆包,如何用python禁止掉xpresso标签时候,它会提示到 这时候要用到两个东西。https://developers.maxon.net/论坛搜索和开发文档 比如这里我就在官方找到正确的id描述 然后我就把参数标签换过来

【区块链 + 人才服务】可信教育区块链治理系统 | FISCO BCOS应用案例

伴随着区块链技术的不断完善,其在教育信息化中的应用也在持续发展。利用区块链数据共识、不可篡改的特性, 将与教育相关的数据要素在区块链上进行存证确权,在确保数据可信的前提下,促进教育的公平、透明、开放,为教育教学质量提升赋能,实现教育数据的安全共享、高等教育体系的智慧治理。 可信教育区块链治理系统的顶层治理架构由教育部、高校、企业、学生等多方角色共同参与建设、维护,支撑教育资源共享、教学质量评估、

Linux_kernel驱动开发11

一、改回nfs方式挂载根文件系统         在产品将要上线之前,需要制作不同类型格式的根文件系统         在产品研发阶段,我们还是需要使用nfs的方式挂载根文件系统         优点:可以直接在上位机中修改文件系统内容,延长EMMC的寿命         【1】重启上位机nfs服务         sudo service nfs-kernel-server resta

【区块链 + 人才服务】区块链集成开发平台 | FISCO BCOS应用案例

随着区块链技术的快速发展,越来越多的企业开始将其应用于实际业务中。然而,区块链技术的专业性使得其集成开发成为一项挑战。针对此,广东中创智慧科技有限公司基于国产开源联盟链 FISCO BCOS 推出了区块链集成开发平台。该平台基于区块链技术,提供一套全面的区块链开发工具和开发环境,支持开发者快速开发和部署区块链应用。此外,该平台还可以提供一套全面的区块链开发教程和文档,帮助开发者快速上手区块链开发。

cross-plateform 跨平台应用程序-03-如果只选择一个框架,应该选择哪一个?

跨平台系列 cross-plateform 跨平台应用程序-01-概览 cross-plateform 跨平台应用程序-02-有哪些主流技术栈? cross-plateform 跨平台应用程序-03-如果只选择一个框架,应该选择哪一个? cross-plateform 跨平台应用程序-04-React Native 介绍 cross-plateform 跨平台应用程序-05-Flutte

Vue3项目开发——新闻发布管理系统(六)

文章目录 八、首页设计开发1、页面设计2、登录访问拦截实现3、用户基本信息显示①封装用户基本信息获取接口②用户基本信息存储③用户基本信息调用④用户基本信息动态渲染 4、退出功能实现①注册点击事件②添加退出功能③数据清理 5、代码下载 八、首页设计开发 登录成功后,系统就进入了首页。接下来,也就进行首页的开发了。 1、页面设计 系统页面主要分为三部分,左侧为系统的菜单栏,右侧