SpringBoot定制JSON響應數(shù)據(jù)返回的示例代碼

更新時間：2024年05月19日 16:35:56 作者：奮斗的袍子007

@JsonView 是 Jackson 庫中的一個注解,它允許你定義哪些屬性應該被序列化到 JSON 中,基于不同的“視圖”或“配置”,在本文中,通過了解@JsonView,你將能夠更好地掌握如何在Spring Boot應用中定制JSON數(shù)據(jù)的輸出,需要的朋友可以參考下

一、前言

目前微服務項目中RESTful API已經(jīng)是前后端對接數(shù)據(jù)格式的標配模式了，RESTful API是一種基于REST（Representational State Transfer，表述性狀態(tài)轉移）原則的應用程序編程接口（Application Programming Interface），它主要用于Web服務之間的數(shù)據(jù)交互。RESTful API的設計遵循一些核心原則，這些原則使得API更加簡潔、靈活和可擴展。

在構建這些API時，我們往往需要根據(jù)不同的客戶端、用戶角色或業(yè)務需求，靈活地控制返回的數(shù)據(jù)結構和內(nèi)容。Jackson庫的@JsonView注解為我們提供了一種優(yōu)雅且高效的方式來實現(xiàn)這一目標。

二、問題場景

@JsonView 是 Jackson 庫中的一個注解，它允許你定義哪些屬性應該被序列化到 JSON 中，基于不同的“視圖”或“配置”。這在某些情況下非常有用，特別是當你想要為不同的用戶或API端點返回不同級別的詳細信息時。

例如，你可能有一個User對象，其中包含多個屬性，如id、name、email和password。當你為外部API或網(wǎng)站前端返回用戶數(shù)據(jù)時，你可能不希望包含password字段。但是，在內(nèi)部API或某些特定的情況下，你可能想要返回包含password的完整用戶對象。

這就是@JsonView可以幫助你的地方。你可以定義一個或多個“視圖”類，并為你的屬性指定應該出現(xiàn)在哪些視圖中。

在本文中，通過了解@JsonView，你將能夠更好地掌握如何在Spring Boot應用中定制JSON數(shù)據(jù)的輸出，從而提供更加靈活、安全且高效的RESTful API服務。

三、@JsonView主要應用場景

主要應用場景包括：

1.數(shù)據(jù)脫敏：在某些情況下，你可能不希望將數(shù)據(jù)庫中的某些敏感信息（如密碼、密鑰等）暴露給客戶端。通過使用 @JsonView，你可以定義哪些字段應該被包含在特定的視圖中，并在返回數(shù)據(jù)時僅包含這些字段。

2.自定義數(shù)據(jù)輸出：你可以根據(jù)客戶端的需求或權限級別，定義不同的視圖，并在返回數(shù)據(jù)時根據(jù)當前視圖的配置來輸出不同的字段組合。

四、代碼實戰(zhàn)

1. 定義實體類

package com.example.yddemo.JSONView;

import com.fasterxml.jackson.annotation.JsonView;

public class User {

    @JsonView(Views.Public.class)
    private Long id;

    @JsonView(Views.Public.class)
    private String name;

    @JsonView(Views.Internal.class)
    private String email;

    @JsonView(Views.Internal.class)
    private String password;

    public User(Long id, String name, String email, String password) {
        this.id = id;
        this.name = name;
        this.email = email;
        this.password = password;
    }

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }

    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", name='" + name + '\'' +
                ", email='" + email + '\'' +
                ", password='" + password + '\'' +
                '}';
    }
}

2. 定義視圖控制器

public class Views {
    public static class Public { }
    public static class Internal extends Public { }
}

3. 在代碼中使用，添加@JsonView注解

package com.example.yddemo.JSONView;

import com.fasterxml.jackson.annotation.JsonView;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class TestDemoController {

    @GetMapping("/user/Public")
    @JsonView(Views.Public.class)
    public User userPublic() {
        User user = new User(1L, "Tom", "123123@163.com", "123456") ;
        return user  ;
    }

    @GetMapping("/user/Internal")
    @JsonView(Views.Internal.class)
    public User userInternal() {
        User user = new User(1L, "Tom", "123123@163.com", "123456") ;
        return user;
    }
}

輸出結果

不想使用在Controller接口上使用@JsonView注解方式，你還可以通過編程的方式控制，通過ObjectMapper類也能方便的控制json輸出。

  @GetMapping("/user/all/public")
    public String userAllPublic() {
        ObjectMapper mapper = new ObjectMapper();
        User user = new User(1L, "Tom", "123123@163.com", "123456") ;
        String publicJson;
        try {
            publicJson = mapper.writerWithView(Views.Public.class).writeValueAsString(user);
        } catch (JsonProcessingException e) {
            throw new RuntimeException(e);
        }
        return publicJson;
    }

    @GetMapping("/user/all/internal")
    public String userAllInternal() {
        ObjectMapper mapper = new ObjectMapper();
        User user = new User(1L, "Tom", "123123@163.com", "123456") ;
        String internalJson;
        try {
            internalJson = mapper.writerWithView(Views.Internal.class).writeValueAsString(user);
        } catch (JsonProcessingException e) {
            throw new RuntimeException(e);
        }
        return internalJson;
    }

輸出結果