接口中的参数

1.类型

在接口设计中，参数可以有多种类型，常见的包括路径参数（Path Parameter）、请求参数（Request Parameter）、请求体参数（Request Body Parameter）等。

2.区分

2.1 路径参数（Path Parameter）

@Path("/users/{userId}")
public class UserController {
    @GET
    @Path("/{userId}")
    public Response getUser(@PathParam("userId") String userId) {
        // 处理逻辑
    }
}

详解：

1.类级别的路径参数：
@Path("/users/{userId}")
这个注解定义了UserController类的基础路径，并包含一个路径参数{userId}。
{userId}是一个占位符，表示在实际请求中，这个位置会被具体的用户ID替换。
例如，/users/123中的123就是路径参数userId的值。

2.方法级别的路径参数：
@Path("/{userId}")
这个注解定义了getUser方法的路径，并再次包含一个路径参数{userId}。
由于类级别的路径已经包含了{userId}，方法级别的路径可以省略或重复定义。
例如，/users/123中的123会被映射到方法级别的路径参数{userId}。

3.假设有一个请求
GET http://localhost:8080/users/123
请求URL：http://localhost:8080/users/123
类级别路径：/users/{userId}
方法级别路径：/{userId}
路径参数值：123

路径参数是一种从URL路径中提取动态值的机制，常用于RESTful API中标识特定资源。在代码中，通过@Path注解定义路径参数，并使用@PathParam注解将路径参数绑定到方法参数上。这样可以方便地从URL中获取参数值并进行处理。

2.2 请求参数（Request Parameter）

@Path("/users")
public class UserController {
    @GET
    public Response getUsers(@QueryParam("age") int age) {
        // 处理逻辑
    }
}

详解

1.类级别的路径
@Path("/users")
这个注解定义了UserController类的基础路径。
所有在这个类中定义的方法都将以/users作为基础路径。

2.方法级别的HTTP动词
@GET
这个注解定义了getUsers方法响应HTTP GET请求。
GET请求通常用于获取资源，而不是修改资源。

3.请求参数的绑定
public Response getUsers(@QueryParam("age") int age) {
    // 处理逻辑
}
@QueryParam("age")注解用于将URL查询字符串中的age参数绑定到方法参数age上。
在实际请求中，查询字符串中的age参数的值会被传递给getUsers方法的age参数。

4.假设一个请求
GET http://localhost:8080/users?age=25
请求URL：http://localhost:8080/users?age=25
类级别路径：/users
查询参数：age=25
在这个请求中：
查询字符串中的age=25会被提取并绑定到getUsers方法的age参数上。
getUsers方法会接收到age的值为25，然后进行相应的处理。
请求参数的特点
位置：请求参数位于URL的问号 ? 后面，多个参数用 & 分隔。
用途：请求参数通常用于过滤、排序、分页等操作。
获取方式：在方法中使用@QueryParam注解来获取请求参数。

5.假设第二个请求
GET http://localhost:8080/users?age=25&name=John
查询字符串中的age=25和name=John会被提取并分别绑定到getUsers方法的age和name参数上。
getUsers方法会接收到age的值为25，name的值为John，然后进行相应的处理。

请求参数是一种从URL查询字符串中提取动态值的机制，常用于RESTful API中进行过滤、排序、分页等操作。在代码中，通过@QueryParam注解将查询字符串中的参数绑定到方法参数上。这样可以方便地从URL中获取参数值并进行处理。

2.3 请求体参数（Request Body Parameter）

请求体参数（Request Body Parameter）用于从HTTP请求体中提取数据

@Path("/users")
public class UserController {
    @POST
    @Consumes(MediaType.APPLICATION_JSON)
    public Response createUser(User user) {
        // 处理逻辑
    }
}

1.类级别的路径：
@Path("/users")
这个注解定义了UserController类的基础路径。
所有在这个类中定义的方法都将以/users作为基础路径。

2.方法级别的HTTP动词：
@POST
这个注解定义了createUser方法响应HTTP POST请求。
POST请求通常用于创建资源。

3.请求体的媒体类型：
@Consumes(MediaType.APPLICATION_JSON)
这个注解定义了createUser方法可以接受的请求体的媒体类型。
MediaType.APPLICATION_JSON表示请求体的内容类型是JSON格式。

4.请求体参数的绑定：
public Response createUser(User user) {
    // 处理逻辑
}
方法参数User user表示请求体中的数据将被映射到User对象。
框架会自动解析请求体中的JSON数据，并将其映射到User对象的属性上。

假设一个请求
POST http://localhost:8080/users
Content-Type: application/json
{
    "name": "John",
    "age": 30
}

请求URL：http://localhost:8080/users
HTTP方法：POST
请求头：Content-Type: application/json
请求体：
{
    "name": "John",
    "age": 30
}

在这个请求中：
请求体中的JSON数据会被解析并映射到User对象的属性上。
createUser方法会接收到一个User对象，其name属性为John，age属性为30，然后进行相应的处理。
请求体参数的特点
位置：请求体参数位于HTTP请求体中，通常用于传递复杂的对象数据。
用途：请求体参数通常用于创建或更新资源。
获取方式：在方法中直接定义参数对象，框架会自动解析请求体并映射到该对象。

假设有一个User类：
public class User {
    private String name;
    private int age;

    // Getters and Setters
}
在createUser方法中，框架会自动将请求体中的JSON数据映射到User对象的属性上：
@Path("/users")
public class UserController {
    @POST
    @Consumes(MediaType.APPLICATION_JSON)
    public Response createUser(User user) {
        // 处理逻辑
        // 例如，保存用户信息到数据库
        return Response.ok().build();
    }
}

请求体参数是一种从HTTP请求体中提取数据的机制，常用于RESTful API中创建或更新资源。在代码中，通过@Consumes注解指定请求体的媒体类型，并在方法参数中定义对象，框架会自动解析请求体并映射到该对象。这样可以方便地从请求体中获取复杂的对象数据并进行处理。