• 主页
  • 文章
  • 一般的
  • 使用 JAX-RS 和 Jersey 在 Java 中构建 RESTful 服务（摄氏到华氏和华氏到摄氏）

使用 JAX-RS 和 Jersey 在 Java 中构建 RESTful 服务（摄氏到华氏和华氏到摄氏）

已发表: 2020-03-25
使用 JAX-RS 和 Jersey 构建 RESTFul 服务

您是否有以下查询/问题之一？

  • 编写一个 java REST 服务，将华氏温度转换为摄氏温度，将摄氏度转换为华氏温度
  • REST with Java (JAX-RS) 使用 Jersey
  • Java中从华氏温度到摄氏温度的转换
  • 带学位转换的家庭作业帮助（CtoF，FtoC）
  • 用于 RESTful Web 服务的 Java API
  • Web 服务——哪个是最好的 Java REST API？
  • Java的REST API？
  • ctof 和 ftoc 教程。 ctof 和 ftoc Java 教程
  • 使用 Java 技术创建 RESTful Web 服务
  • 用于 Java 的 RESTful Web API 框架

RESTful Service ：具象状态传输 (REST) 作为 SOAP 和基于 Web 服务描述语言 (WSDL) 的 Web 服务的更简单替代方案，已在 Web 上获得广泛认可。

REST 定义了一组体系结构原则，您可以根据这些原则设计专注于系统资源的 Web 服务，包括各种用不同语言编写的客户端如何通过 HTTP 处理和传输资源状态。 如果以使用它的 Web 服务的数量来衡量，REST 仅在最近几年就已经成为一种主要的 Web 服务设计模型。 事实上，REST 已经对 Web 产生了如此大的影响，它主要取代了基于 SOAP 和 WSDL 的界面设计，因为它使用起来相当简单。

RESTFul 对比SOAP 教程。

jax-rs-hello-world-example-crunchify

JAX-RS：

Java API for RESTful Web Services (JAX-RS) 是一组用于开发人员 REST 服务的 API。 JAX-RS 是 Java EE6 的一部分，使开发人员能够轻松开发 REST Web 应用程序。

球衣：

Jersey 是用于构建 RESTful Web 服务的开源、生产质量、JAX-RS (JSR 311) 参考实现。 但是，它也不仅仅是参考实现。 Jersey 提供了一个 API，以便开发人员可以扩展 Jersey 以满足他们的需求。

让我们通过以下步骤开始构建简单的RESTful API ：

第1步

在 Eclipse => 文件 => 新建 => 动态 Web 项目中。 将其命名为“ CrunchifyRESTJerseyExample ”。

创建 Crunchify Eclipse 动态 Web 项目

确保您设置：

  • 目标运行时：Apache Tomcat v9.0
  • 动态网页模块版本：4.0

第2步

如果您没有看到web.xml （部署描述符），请按照以下步骤操作。 要么

  • 右键单击项目
  • 选择Java EE Tools
  • 单击Generate Deployment Descriptor Stub

这将在/WebContent/WEB-INF/文件夹下创建web.xml文件。

第三步

现在将 Project 转换为Maven Project ，以便我们可以添加所需的 .jar 文件作为依赖项。

脚步：

  • 右键单击项目
  • 点击Configure
  • 选择选项Convert to Maven Project 。
右键单击项目
将任何项目转换为 Maven 项目

只需单击Finish button而不进行任何更改。

在 Eclipse 中为 Maven 项目创建 POM 文件

第四步

打开pom.xml文件并添加以下依赖项。

  • asm.jar
  • jersey-bundle.jar
  • json.jar
  • jersey-server.jar
Maven 依赖项 - Crunchify Jersey 教程 - jersey-server.pom.xml

这是我的pom.xml文件。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
< project xmlns = "http://maven.apache.org/POM/4.0.0" xmlns : xsi = "http://www.w3.org/2001/XMLSchema-instance"
xsi : schemaLocation = "http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" >
< modelVersion > 4.0.0 < / modelVersion >
< groupId > CrunchifyRESTJerseyExample < / groupId >
< artifactId > CrunchifyRESTJerseyExample < / artifactId >
< version > 0.0.1 - SNAPSHOT < / version >
< packaging > war < / packaging >
< build >
< sourceDirectory > src < / sourceDirectory >
< plugins >
< plugin >
< artifactId > maven - compiler - plugin < / artifactId >
< version > 3.7.0 < / version >
< configuration >
< source > 1.7 < / source >
< target > 1.7 < / target >
< / configuration >
< / plugin >
< / plugins >
< / build >
< dependencies >
< dependency >
< groupId > asm < / groupId >
< artifactId > asm < / artifactId >
< version > 3.3.1 < / version >
< / dependency >
< dependency >
< groupId > com . sun . jersey < / groupId >
< artifactId > jersey - bundle < / artifactId >
< version > 1.19.4 < / version >
< / dependency >
< dependency >
< groupId > org . json < / groupId >
< artifactId > json < / artifactId >
< version > 20170516 < / version >
< / dependency >
< dependency >
< groupId > com . sun . jersey < / groupId >
< artifactId > jersey - server < / artifactId >
< version > 1.19.4 < / version >
< / dependency >
< dependency >
< groupId > com . sun . jersey < / groupId >
< artifactId > jersey - core < / artifactId >
< version > 1.19.4 < / version >
< / dependency >
< / dependencies >
< / project >

第 5 步

用这个更新你的 web.xml 文件。 这是我的web.xml文件副本：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
<? 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_3_0.xsd"
version = "3.0" >
< display - name > CrunchifyRESTJerseyExample < / 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 Web Application < / servlet - name >
< servlet - class > com . sun . jersey . spi . container . servlet . ServletContainer < / servlet - class >
< load - on - startup > 1 < / load - on - startup >
< / servlet >
< servlet - mapping >
< servlet - name > Jersey Web Application < / servlet - name >
< url - pattern > / crunchify /* < / url - pattern >
< / servlet - mapping >
< / web - app >

第 6 步

  • 转到Java Resources
  • 点击源
  • 右键->新建->类
  • 包：com.crunchify.restjersey
  • 名称：CtoFService

CtoFService.java

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
package com . crunchify . restjersey ;
 
/**
* @author Crunchify.com
* * Description: This program converts unit from Centigrade to Fahrenheit.
* Last updated: 12/28/2018
*/
 
import javax . ws . rs . GET ;
import javax . ws . rs . Path ;
import javax . ws . rs . PathParam ;
import javax . ws . rs . Produces ;
 
@ Path ( "/ctofservice" )
public class CtoFService {
@ GET
@ Produces ( "application/xml" )
public String convertCtoF ( ) {
 
Double fahrenheit ;
Double celsius = 36.8 ;
fahrenheit = ( ( celsius * 9 ) / 5 ) + 32 ;
 
String result = "@Produces(\"application/xml\") Output: \n\nC to F Converter Output: \n\n" + fahrenheit ;
return "<ctofservice>" + "<celsius>" + celsius + "</celsius>" + "<ctofoutput>" + result + "</ctofoutput>" + "</ctofservice>" ;
}
 
@ Path ( "{c}" )
@ GET
@ Produces ( "application/xml" )
public String convertCtoFfromInput ( @ PathParam ( "c" ) Double c ) {
Double fahrenheit ;
Double celsius = c ;
fahrenheit = ( ( celsius * 9 ) / 5 ) + 32 ;
 
String result = "@Produces(\"application/xml\") Output: \n\nC to F Converter Output: \n\n" + fahrenheit ;
return "<ctofservice>" + "<celsius>" + celsius + "</celsius>" + "<ctofoutput>" + result + "</ctofoutput>" + "</ctofservice>" ;
}
}

第 7 步

同样的方式创建 FtoCService.java

FtoCService.java

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
package com . crunchify . restjersey ;
 
/**
* @author Crunchify, LLC
* Description: This program converts unit from Fahrenheit to Centigrade.
*
*/
 
import javax . ws . rs . GET ;
import javax . ws . rs . Path ;
import javax . ws . rs . PathParam ;
import javax . ws . rs . Produces ;
import javax . ws . rs . core . Response ;
import org . json . JSONException ;
import org . json . JSONObject ;
 
@ Path ( "/ftocservice" )
public class FtoCService {
 
@ GET
@ Produces ( "application/json" )
public Response convertFtoC ( ) throws JSONException {
 
JSONObject jsonObject = new JSONObject ( ) ;
Double fahrenheit = 98.24 ;
Double celsius ;
celsius = ( fahrenheit - 32 ) * 5 / 9 ;
jsonObject . put ( "F Value" , fahrenheit ) ;
jsonObject . put ( "C Value" , celsius ) ;
 
String result = "@Produces(\"application/json\") Output: \n\nF to C Converter Output: \n\n" + jsonObject ;
return Response . status ( 200 ) . entity ( result ) . build ( ) ;
}
 
@ Path ( "{f}" )
@ GET
@ Produces ( "application/json" )
public Response convertFtoCfromInput ( @ PathParam ( "f" ) float f ) throws JSONException {
 
JSONObject jsonObject = new JSONObject ( ) ;
float celsius ;
celsius = ( f - 32 ) * 5 / 9 ;
jsonObject . put ( "F Value" , f ) ;
jsonObject . put ( "C Value" , celsius ) ;
 
String result = "@Produces(\"application/json\") Output: \n\nF to C Converter Output: \n\n" + jsonObject ;
return Response . status ( 200 ) . entity ( result ) . build ( ) ;
}
}

步骤 8

现在让我们清理 Eclipse 工作区并构建项目。

1
2
3
1. Project - > Clean
2. Project - > Right click - > Maven - > Update Project
3. Project - > Right click - > Run As . . - > Maven Build ( option 5 ) - > Add "clean install" - > Run
  • 对于上面的point 3 ，请使用these screenshots ：Maven 构建，全新安装。
  • 您应该会看到构建成功消息。

第 9 步

在 Tomcat 上部署项目CrunchifyRESTJerseyExample 。 如果您还没有这样做，这里是有关如何在 Eclipse 上设置 Tomcat 的详细步骤。

  • 转到服务器选项卡
  • 右键单击服务器
  • 单击Add and Remove Projects
  • 从左侧选择项目，然后单击Add
  • 点击完成
在 Tomcat 上部署 CrunchifyRESTJerseyExample

第十步

  • 启动 Tomcat 服务器 9.0
启动 Tomcat 服务器 9.0

完整的项目结构：

Crunchify REST Jersey 教程 - 完整的项目结构

以下是 Java 构建路径依赖项：

REST JAX-RS Jersey 构建路径依赖项

确保您为此项目使用 JDK 1.8。 启动 Java 9 – JAXB、JAX-WS、JAF、JTA、CORBA 模块被删除，您需要手动将这些模块添加到您的 Maven pom.xml 文件中。

搞定。

现在让我们测试一下 RESTful Web 服务。

测试 1： without参数的摄氏到华氏 Web 服务

链接： http://localhost:8080/CrunchifyRESTJerseyExample/crunchify/ctofservice/

c 到 f 网络服务

测试 2： with参数的摄氏到华氏 Web 服务

c to f webservice 带参数

测试 3： without参数的华氏到摄氏 Web 服务

f 到 c 网络服务

测试 4： with参数的华氏到摄氏 Web 服务

带参数的 f 到 c 网络服务

RESTFul 客户端示例：

  • 如何使用 Apache HttpClient 创建 RESTful Java 客户端 - 示例
  • 如何使用 Java.Net.URL 创建 RESTful Java 客户端 - 示例
  • 如何使用 Jersey 客户端创建 RESTful Java 客户端 - 示例

另一个必须阅读：

  • CrunchifyJSONtoHTML.js – JSON 到 HTML 表格转换器脚本
  • 如何以编程方式在 Java 中生成内存不足 (OOM)
  • 如何在一台服务器上运行多个 Tomcat 实例？
  • 如何在 Java 中从文件中读取 JSON 对象 – Crunchify 教程

运行代码时遇到问题？

一些分类步骤：

最初我使用jersey-core依赖。 但也添加了jersey-server依赖项以避免以下问题。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
SEVERE : Servlet [ Jersey Web Application ] in web application [ / CrunchifyRESTJerseyExample ] threw load ( ) exception
java . lang . ClassNotFoundException : com . sun . jersey . spi . container . servlet . ServletContainer
at org . apache . catalina . loader . WebappClassLoaderBase . loadClass ( WebappClassLoaderBase . java : 1328 )
at org . apache . catalina . loader . WebappClassLoaderBase . loadClass ( WebappClassLoaderBase . java : 1157 )
at org . apache . catalina . core . DefaultInstanceManager . loadClass ( DefaultInstanceManager . java : 542 )
at org . apache . catalina . core . DefaultInstanceManager . loadClassMaybePrivileged ( DefaultInstanceManager . java : 523 )
at org . apache . catalina . core . DefaultInstanceManager . newInstance ( DefaultInstanceManager . java : 150 )
at org . apache . catalina . core . StandardWrapper . loadServlet ( StandardWrapper . java : 1032 )
at org . apache . catalina . core . StandardWrapper . load ( StandardWrapper . java : 971 )
at org . apache . catalina . core . StandardContext . loadOnStartup ( StandardContext . java : 4829 )
at org . apache . catalina . core . StandardContext . startInternal ( StandardContext . java : 5143 )
at org . apache . catalina . util . LifecycleBase . start ( LifecycleBase . java : 183 )
at org . apache . catalina . core . ContainerBase $ StartChild . call ( ContainerBase . java : 1432 )
at org . apache . catalina . core . ContainerBase $ StartChild . call ( ContainerBase . java : 1422 )
at java . base / java . util . concurrent . FutureTask . run ( FutureTask . java : 264 )
at org . apache . tomcat . util . threads . InlineExecutorService . execute ( InlineExecutorService . java : 75 )
at java . base / java . util . concurrent . AbstractExecutorService . submit ( AbstractExecutorService . java : 140 )
at org . apache . catalina . core . ContainerBase . startInternal ( ContainerBase . java : 944 )
at org . apache . catalina . core . StandardHost . startInternal ( StandardHost . java : 831 )
at org . apache . catalina . util . LifecycleBase . start ( LifecycleBase . java : 183 )
at org . apache . catalina . core . ContainerBase $ StartChild . call ( ContainerBase . java : 1432 )
at org . apache . catalina . core . ContainerBase $ StartChild . call ( ContainerBase . java : 1422 )
at java . base / java . util . concurrent . FutureTask . run ( FutureTask . java : 264 )
at org . apache . tomcat . util . threads . InlineExecutorService . execute ( InlineExecutorService . java : 75 )
at java . base / java . util . concurrent . AbstractExecutorService . submit ( AbstractExecutorService . java : 140 )
at org . apache . catalina . core . ContainerBase . startInternal ( ContainerBase . java : 944 )
at org . apache . catalina . core . StandardEngine . startInternal ( StandardEngine . java : 261 )
at org . apache . catalina . util . LifecycleBase . start ( LifecycleBase . java : 183 )
at org . apache . catalina . core . StandardService . startInternal ( StandardService . java : 422 )
at org . apache . catalina . util . LifecycleBase . start ( LifecycleBase . java : 183 )
at org . apache . catalina . core . StandardServer . startInternal ( StandardServer . java : 801 )
at org . apache . catalina . util . LifecycleBase . start ( LifecycleBase . java : 183 )
at org . apache . catalina . startup . Catalina . start ( Catalina . java : 695 )
at java . base / jdk . internal . reflect . NativeMethodAccessorImpl . invoke0 ( Native Method )
at java . base / jdk . internal . reflect . NativeMethodAccessorImpl . invoke ( NativeMethodAccessorImpl . java : 62 )
at java . base / jdk . internal . reflect . DelegatingMethodAccessorImpl . invoke ( DelegatingMethodAccessorImpl . java : 43 )
at java . base / java . lang . reflect . Method . invoke ( Method . java : 566 )
at org . apache . catalina . startup . Bootstrap . start ( Bootstrap . java : 350 )
at org . apache . catalina . startup . Bootstrap . main ( Bootstrap . java : 492 )

如果您遇到上述错误，请尝试将以下 maven 依赖项添加到您的 pom.xml 文件中

1
2
3
4
5
< dependency >
     < groupId > org . glassfish . jersey . core < / groupId >
     < artifactId > jersey - server < / artifactId >
     < version > 2.27 < / version >
< / dependency >