RESTful JAX-RS 注解示例

17 Mar 2025 | 阅读 2 分钟

JAX-RS API 提供了以下注解来开发 Java 中的 RESTful 应用程序。我们使用 jersey 实现来开发 JAX-RS 示例。

JAX-RS 注解

javax.ws.rs 包包含 JAX-RS 注解。

注解	描述
路径	它标识 URI 路径。可以在类或方法上指定它。
PathParam	表示 URI 路径的参数。
GET	指定方法响应 GET 请求。
POST	指定方法响应 POST 请求。
PUT	指定方法响应 PUT 请求。
HEAD	指定方法响应 HEAD 请求。
DELETE	指定方法响应 DELETE 请求。
OPTIONS	指定方法响应 OPTIONS 请求。
FormParam	表示表单的参数。
QueryParam	表示 URL 查询字符串的参数。
HeaderParam	表示标头的参数。
CookieParam	表示 cookie 的参数。
Produces	定义响应的媒体类型，例如 XML、PLAIN、JSON 等。它定义资源类或 MessageBodyWriter 的方法可以生成的媒体类型。
Consumes	它定义资源类或 MessageBodyReader 的方法可以生成的媒体类型。

JAX-RS @Path、@GET 和 @PathParam 注解

文件：HelloService.java

package com.javatpoint.rest;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.core.Response;
@Path("/hello")
public class HelloService{
 	@GET
	@Path("/{param}")
	public Response getMsg(@PathParam("param") String msg) {
 		String output = "Jersey say : " + msg;
 		return Response.status(200).entity(output).build();
 	}
}

文件：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" 
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee 
http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" 
id="WebApp_ID" version="3.0">
 <servlet>
    <servlet-name>Jersey REST Service</servlet-name>
    <servlet-class>org.glassfish.jersey.servlet.ServletContainer</servlet-class>
    <init-param>
        <param-name>jersey.config.server.provider.packages</param-name>
        <param-value>com.javatpoint.rest</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
  </servlet>
  <servlet-mapping>
    <servlet-name>Jersey REST Service</servlet-name>
    <url-pattern>/rest/*</url-pattern>
  </servlet-mapping>
</web-app> 

文件：index.html

现在在服务器上运行此应用程序，您将看到以下输出

输出

Jersey say : javatpoint

单击我下载此示例

JAX-RS 多 @PathParam 注解

文件：HelloService.java

package com.javatpoint.rest;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.core.Response;
@Path("/hello")
public class HelloService{
 	@GET
	@Path("{year}/{month}/{day}")
	public Response getDate(
			@PathParam("year") int year,
			@PathParam("month") int month, 
			@PathParam("day") int day) {
 
	   String date = year + "/" + month + "/" + day;
 
	   return Response.status(200)
		.entity("getDate is called, year/month/day : " + date)
		.build();
 	}
 }

文件：web.xml

它与上面的示例相同。

文件：index.html

现在在服务器上运行此应用程序，您将看到以下输出

输出

getDate is called, year/month/day : 2014/12/5

单击我下载此示例

JAX-RS @FormParam 和 @POST 注解

文件：HelloService.java

package com.javatpoint.rest;
import javax.ws.rs.FormParam;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.core.Response;
@Path("/product")
public class ProductService{
 	@POST
 	@Path("/add")
	public Response addUser(
		@FormParam("id") int id,
		@FormParam("name") String name,
		@FormParam("price") float price) {
 
		return Response.status(200)
			.entity(" Product added successfuly!<br> Id: "+id+"<br> Name: " + name+"<br> Price: "+price)
			.build();
 	}
}

文件：web.xml

它与上面的示例相同。

文件：index.html

<form action="rest/product/add" method="post">
Enter Id:<input type="text" name="id"/><br/><br/>
Enter Name:<input type="text" name="name"/><br/><br/>
Enter Price:<input type="text" name="price"/><br/><br/>
<input type="submit" value="Add Product"/>
</form>

现在在服务器上运行此应用程序，您将看到以下输出

输出