RESTful JAX-RS注解示例

精华

小牛编辑

135浏览

2023-03-14

JAX-RS API提供以下注解可在java中开发RESTful应用程序。下面我们将使用 jersey 实现来开发JAX-RS示例。首先打开Eclipse，创建一个动态Web项目：JaxrsWeb。

Jersey Jar文件下载网址：https://jersey.github.io/download.html

1. JAX-RS注释

javax.ws.rs 包中包含JAX-RS注释。

注解	描述
`Path`	它标识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`的方法可以生成的媒体类型。

2. JAX-RS @Path, @GET 和 @PathParam 注解

文件：HelloService.java -

package com.yiibai;  

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.yiibai</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 -

<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>JAX-RS Server示例</title>
</head>
<body>
    <a href="rest/hello/yiibai">JAX-RS注解参数示例</a>
</body>
</html>

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

3. JAX-RS多个@PathParam

文件：HelloService.java -

package com.yiibai;  

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();  
    }

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

<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>JAX-RS Server示例</title>
</head>
<body>
    <a href="rest/hello/yiibai">JAX-RS注解参数示例</a><br/>
    <a href="rest/hello/2019/12/05">JAX-RS注解参数(日期)示例</a>
</body>
</html>

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

4. JAX-RS @FormParam和@POST注解

文件: ProductService.java -

package com.yiibai;

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>

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

填写产品信息并提交 -