spring boot 忽律返回字段

原创

mob64ca12cfa7d5 2024-09-19 03:39:02 ©著作权

文章标签 字段 User API 文章分类 spring boot 后端开发

©著作权归作者所有：来自51CTO博客作者mob64ca12cfa7d5的原创作品，请联系作者获取转载授权，否则将追究法律责任

Spring Boot 忽略返回字段实现指南

在开发 RESTful API 时，我们可能会遇到需要根据不同条件返回不同字段的情况。在 Spring Boot 中，我们可以通过分组序列化（即使用 @JsonView）或配合 DTO（数据传输对象）来实现忽略字段返回。本文将指导您实现这个功能，帮助您更好地理解和运用 Spring Boot 技术。

整体流程

我们可以将实现的流程分为以下几个步骤：

步骤	描述
1	创建实体类并定义需要的字段
2	创建 DTO 类以控制返回字段
3	在 Controller 中使用 `@JsonView` 注解
4	测试 API 返回可选字段

以下是上述步骤的流程图：

flowchart TD
    A[创建实体类] --> B[创建 DTO 类]
    B --> C[实现 Controller]
    C --> D[测试 API 返回字段]

步骤详细说明

1. 创建实体类

首先，我们需要一个实体类，假设我们有一个 User 类，包含一些用户的基本信息。

package com.example.demo.model;

public class User {
    private Long id; // 用户ID
    private String name; // 用户名
    private String email; // 用户邮箱
    private String password; // 用户密码

    // Getter 和 Setter 略
}

2. 创建 DTO 类

接下来，我们需要一个 DTO 类来定义不同视图下的需要返回的字段。我们可以使用 @JsonView 注解。

package com.example.demo.dto;

import com.fasterxml.jackson.annotation.JsonView;

public class UserDTO {
    public interface Summary {}
    public interface Detail extends Summary {}

    @JsonView(Summary.class)
    private Long id; // 用户ID

    @JsonView(Summary.class)
    private String name; // 用户名

    @JsonView(Detail.class)
    private String email; // 用户邮箱

    @JsonView(Detail.class)
    private String password; // 用户密码

    // Getter 和 Setter 略
}

在这个例子中，我们定义了两个视图：Summary 只包含 id 和 name 字段，而 Detail 包含所有字段。

3. 在 Controller 中使用 `@JsonView` 注解

下一步是实现我们的 Controller，并使用 @JsonView 注解来控制输出。

package com.example.demo.controller;

import com.example.demo.dto.UserDTO;
import com.example.demo.model.User;
import com.fasterxml.jackson.annotation.JsonView;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import java.util.Arrays;
import java.util.List;

@RestController
public class UserController {

    @GetMapping("/users")
    @JsonView(UserDTO.Summary.class) // 只返回 Summary 视图
    public List<UserDTO> getUsers(@RequestParam(value = "detail", required = false) boolean detail) {
        User user1 = new User(1L, "Alice", "alice@example.com", "password123");
        User user2 = new User(2L, "Bob", "bob@example.com", "password456");

        // 根据参数决定返回详情信息
        if (detail) {
            return Arrays.asList(new UserDTO(user1), new UserDTO(user2)); // 该行代码需要修改，允许 Detail 视图
        } else {
            return Arrays.asList(new UserDTO(user1), new UserDTO(user2)); // 允许 Summary 视图
        }
    }
}

在这个 Controller 中，我们设置了一个 /users GET 请求，根据查询参数 detail 来决定返回的字段。通过 @JsonView 注解，我们能够控制响应的字段。

4. 测试 API 返回字段

最后一步是测试 API 的返回。您可以使用 Postman、cURL 或直接在浏览器访问。以下是请求的例子：

获取基本用户信息（Summary 视图）:

GET /users

返回结果：

[
    {"id": 1, "name": "Alice"},
    {"id": 2, "name": "Bob"}
]

获取详细用户信息 (Detail 视图) :

GET /users?detail=true

返回结果：

[
    {"id": 1, "name": "Alice", "email": "alice@example.com", "password": "password123"},
    {"id": 2, "name": "Bob", "email": "bob@example.com", "password": "password456"}
]