前言

不知道大家日常開發(fā)會不會有類似這樣的需求魔策，同個API接口不同版本需要返回不同響應(yīng)值匈子，不同角色需要看到不同響應(yīng)數(shù)據(jù)。接到類似這樣的需求闯袒，一般人的做法可能是針對不同的場景定義不同的DTO虎敦，今天給大家介紹一款在springboot項目中可以細(xì)粒度控制響應(yīng)值的大殺器@JsonView

什么是@JsonView？

@JsonView是Spring MVC中使用的Jackson注解政敢，用于在序列化和反序列化過程中控制JSON對象的特定字段其徙。例如，該注釋可以允許基于上下文僅返回對象的某些字段喷户。

@JsonView應(yīng)用場景

1. API版本控制： 當(dāng)你的API需要支持多個版本唾那，且不同版本間返回的數(shù)據(jù)結(jié)構(gòu)有所差異時，可以使用@JsonView來區(qū)分不同版本間的JSON輸出。為每個API版本定義一個對應(yīng)的視圖接口（如V1View、V2View等）旭斥，并在對象屬性上標(biāo)注相應(yīng)的視圖。在API控制器方法中，根據(jù)請求的版本信息指定要使用的視圖，確保返回的JSON只包含該版本所需的屬性。
2. 權(quán)限控制： 在實現(xiàn)基于角色的訪問控制（RBAC）的系統(tǒng)中爆袍，不同用戶角色可能對同一資源有不同的訪問權(quán)限蜘醋。例如，普通用戶只能查看某條記錄的基本信息，而管理員可以查看所有詳情琅捏。通過定義諸如PublicView、AdminView等視圖，并在屬性上標(biāo)注對應(yīng)權(quán)限，可以在序列化時根據(jù)當(dāng)前登錄用戶的權(quán)限級別決定返回哪些屬性。
3. 性能優(yōu)化： 在某些情況下驹吮，返回給客戶端的JSON數(shù)據(jù)可能包含大量屬性族沃，其中部分屬性的計算或獲取成本較高。為了提高響應(yīng)速度，可以為這些昂貴屬性定義一個特定的視圖（如DetailedView），并在默認(rèn)情況下僅返回基礎(chǔ)數(shù)據(jù)牍蜂。當(dāng)客戶端明確請求詳細(xì)信息時，才啟用包含這些屬性的視圖批什。
4. 敏感信息過濾： 對于包含敏感信息（如密碼驯妄、密鑰缘屹、個人隱私數(shù)據(jù)等）的對象炊昆，通常不希望在公開的API響應(yīng)中包含這些屬性。使用@JsonView瓶堕，可以創(chuàng)建一個不含敏感屬性的視圖（如PublicSafeView），確保在常規(guī)請求中不會泄露敏感信息任连。只有在安全的上下文中（如內(nèi)部服務(wù)調(diào)用或經(jīng)過特殊身份驗證的請求）诸蚕，才使用包含敏感屬性的視圖。
5. 前端定制化： 在構(gòu)建復(fù)雜的單頁面應(yīng)用程序（SPA）時，前端可能需要從后端獲取同一種資源的不同“視圖”释漆。例如差牛，列表視圖可能只需要對象的ID和標(biāo)題，而詳情視圖則需要完整的屬性集。通過在后端API中使用@JsonView，前端可以根據(jù)當(dāng)前界面的需求發(fā)起帶有特定視圖標(biāo)識的請求景鼠，從而減少不必要的網(wǎng)絡(luò)帶寬消耗和前端處理負(fù)擔(dān)结笨。
6. 測試與調(diào)試： 在開發(fā)和調(diào)試階段，有時需要快速查看對象的全部屬性胸嘴，或者專注于特定屬性的值绑青。@JsonView可以方便地切換JSON輸出的內(nèi)容，有助于開發(fā)者在不同場景下更高效地分析數(shù)據(jù)柏靶。

示例

示例一：在控制器的方法配置@JsonView并綁定視圖規(guī)則

注：本示例以springboot web項目來演示，因為springboot的web包本身就含有Jackson包溃论，因此無需引入其他jar

1屎蜓、定義視圖規(guī)則接口

public interface AdminJsonView extends PrivateJsonView {
}
public interface UserJsonView extends ProtectedJsonView {
}
public interface PublicJsonView {
}

注： 上述的AdminJsonView、UserJsonView钥勋、PrivateJsonView、ProtectedJsonView均繼承PublicJsonView算灸，具體可以查看下方demo鏈接代碼

2、定義需要渲染的視圖model

@Data
@AllArgsConstructor
@NoArgsConstructor
@Builder
public class User {

    @JsonView(PublicJsonView.class)
    private String username;

    @JsonView(PublicJsonView.class)
    private String fullname;

    @JsonView(PublicJsonView.class)
    private Integer age;

    @JsonView({UserJsonView.class,AdminJsonView.class})
    private String email;

    @JsonView(AdminJsonView.class)
    private String phone;

    @JsonView(PublicJsonView.class)
    private Address address;



}

@Data
@AllArgsConstructor
@NoArgsConstructor
@Builder
public class Address {

    @JsonView({UserJsonView.class, AdminJsonView.class})
    private String streetName;

    @JsonView(PublicJsonView.class)
    private String city;

    @JsonView(PublicJsonView.class)
    private String country;

    @JsonView(AdminJsonView.class)
    private String fullAddress;
}

3荐吵、定義演示controller

@RestController
@RequestMapping("user")
@RequiredArgsConstructor
public class UserController {


    @GetMapping("public")
    @JsonView(PublicJsonView.class)
    public User publicUser(){
        return UserUtil.generateUser();
    }

    @GetMapping("default")
    @JsonView(UserJsonView.class)
    public User defaultUser(){
        return UserUtil.generateUser();
    }

    @GetMapping("admin")
    @JsonView(AdminJsonView.class)
    public User adminUser(){
        return UserUtil.generateUser();
    }
}

在每個方法上用@JsonView指定返回對象時使用哪個視圖User，然后對3個方法進(jìn)行測試，通過瀏覽器訪問

1捍靠、publicJsonView場景

ed3c7a38298bbe17c76afd6c014791a5_f592f0a154256a915248b69adfaa17e6.png

2榨婆、userJsonView場景

cf5faa818ba4e1d70e5c5b1bc6c933bb_0475612dc4c78a5ebe06b7d67ea606e3.png

3、adminJsonView場景

0a9849ce717cf4d875ce5c17d0728ada_c443bbbbb677592054339a6186202789.png

通過瀏覽器訪問的結(jié)果褒侧，可以看到不同的視圖返回不同的響應(yīng)值良风。

因為每個控制器方法只能指定一個@Jsonview注解闷供，因此上述的示例比較適用于API不同版本響應(yīng)不同值的場景，如果我們想通過一個方法就可以控制不同的響應(yīng)值輸出疑俭，我們就可以采用示例二的做法

示例二：通過MappingJacksonValue來控制視圖

示例以不同token響應(yīng)不同視圖為例

1婿失、編寫維系token與jsonview視圖規(guī)則的映射綁定

public class UserJsonViewFactory implements JsonViewFactory {

    private Map<String,Class<? extends PublicJsonView>> jsonViewClassMap = new ConcurrentHashMap<>();
    @Override
    public Class<? extends PublicJsonView> getJsonViewClass(HttpServletRequest request,Object... body) {
        String token = request.getHeader("token");
        if(StringUtils.isEmpty(token)){
            return null;
        }
        return jsonViewClassMap.get(token);
    }

    @Override
    public void initJsonViewClasses() {
        jsonViewClassMap.put("123", PublicJsonView.class);
        jsonViewClassMap.put("456", UserJsonView.class);
        jsonViewClassMap.put("789", AdminJsonView.class);
    }
}

2、編寫控制器

@RestController
@RequestMapping("user")
@RequiredArgsConstructor
public class UserController {

    private final UserJsonViewFactory userJsonViewFactory;

    

    @GetMapping("getUserByToken")
    public MappingJacksonValue getUserByToken(HttpServletRequest request){
        MappingJacksonValue mappingJacksonValue = new MappingJacksonValue(UserUtil.generateUser());
        Class<? extends PublicJsonView> roleViewByToken = userJsonViewFactory.getJsonViewClass(request);
        if(roleViewByToken != null){
            mappingJacksonValue.setSerializationView(roleViewByToken);
        }

        return mappingJacksonValue;

    }

   
}

3哩照、測試不同token的響應(yīng)值情況

[root@master01 ~]# curl http://localhost:8080/user/getUserByToken -H 'token:123'
{"username":"hanzhize","fullname":"韓志澤","age":23,"address":{"city":"汕頭","country":"Senegal"}}

[root@master01 ~]# curl http://localhost:8080/user/getUserByToken -H 'token:456'
{"username":"luzhehan","fullname":"盧哲瀚","age":25,"email":"luzhehan@qq.com","address":{"streetName":"韓路","city":"汕尾","country":"Macao"}}

[root@master01  ~]# curl http://localhost:8080/user/getUserByToken -H 'token:789'
{"username":"denghao","fullname":"鄧浩","age":2,"email":"denghao@qq.com","phone":"334-44107556","address":{"streetName":"張街","city":"庫爾勒","country":"Congo","fullAddress":"Suite 236 龔橋3號, 張家口, 豫 196243"}}

通過測試可以發(fā)現(xiàn)不同的token返回不同的響應(yīng)值飘弧，雖然上述實現(xiàn)通過一個方法就可以控制不同的響應(yīng)值輸出砚著，但是實際開發(fā)過程中，如果我們是一個已經(jīng)在運行的項目稽穆，業(yè)務(wù)對象比較多，把原有的業(yè)務(wù)對象改成mappingJacksonValue版确，這樣改的成本就有點高乎折。因此還有沒有更優(yōu)雅的方式，接下來就看下示例三的做法

示例三：通過ResponseBodyAdvice+objectMapper實現(xiàn)

示例仍然以不同token響應(yīng)不同視圖為例吓蘑，維系token與jsonview視圖規(guī)則的映射綁定同示例二

1、編寫ResponseBodyAdvice

@RestControllerAdvice
@Slf4j
public class JsonViewReponseBodyAdvice implements ResponseBodyAdvice<Object>, ApplicationContextAware {

    private final ObjectMapper objectMapper;

    private final JsonViewProperty jsonViewProperty;

    private ApplicationContext applicationContext;

    public JsonViewReponseBodyAdvice(JsonViewProperty jsonViewProperty) {
        this.jsonViewProperty = jsonViewProperty;
        objectMapper = new ObjectMapper();

    }
    @Override
    public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
        if(!jsonViewProperty.isEnabled() || returnType.hasMethodAnnotation(JsonView.class) || CollectionUtils.isEmpty(jsonViewProperty.getJsonViewModelClasses())){
            return false;
        }

        return isMatchJsonViewModel(Objects.requireNonNull(returnType.getMethod()).getReturnType());

    }

    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
        if(body == null){
            return null;
        }
        Class<? extends PublicJsonView> jsonViewClass = getJsonViewClass(body,request);

        try {
            if(jsonViewClass != null){
                objectMapper.setConfig(objectMapper.getSerializationConfig().withView(jsonViewClass));
            }
            String json = objectMapper.writeValueAsString(body);
            return objectMapper.readValue(json,body.getClass());
        } catch (Exception e) {
            log.error("json序列化異常",e);
        }finally {
            // 重置ObjectMapper的JsonView配置
            objectMapper.setConfig(objectMapper.getSerializationConfig().withView(null));
        }
        return body;
    }

    private Class<? extends PublicJsonView> getJsonViewClass(Object body,ServerHttpRequest request) {
        if(body == null || !isMatchJsonViewModel(body.getClass())){
            return null;
        }

        JsonViewFactory jsonViewFactory = getJsonViewFactory(body);

        ServletServerHttpRequest servletServerHttpRequest = (ServletServerHttpRequest) request;

        return jsonViewFactory.getJsonViewClass(servletServerHttpRequest.getServletRequest(),body);


    }

    private JsonViewFactory getJsonViewFactory(Object body){
        if(body == null){
            return null;
        }

        return applicationContext.getBean(body.getClass().getName() + JSON_VIEW_FACTORY_SUFFIX,JsonViewFactory.class);

    }


    private boolean isMatchJsonViewModel(Class<?> modelClz){
        return jsonViewProperty.getJsonViewModelClasses().stream().anyMatch(clazz -> clazz.equals(modelClz));
    }

    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        this.applicationContext = applicationContext;
    }
}

2、編寫controller

@RestController
@RequestMapping("user")
public class UserController {

    @GetMapping("/get")
    public User getUser(){
        return UserUtil.generateUser();
    }
}

3伟叛、在application.yml做如下配置

lybgeek:
  jsonview:
    enabled: true
    ignore-null-property-value: true
    json-view-factory-map:
      com.github.lybgeek.jsonview.user.model.User: com.github.lybgeek.jsonview.user.roleview.factory.UserJsonViewFactory

注： json-view-factory-map主要是用來維系視圖對象bean和生產(chǎn)視圖規(guī)則工廠的綁定

3脐嫂、測試不同token的響應(yīng)值情況

[root@master01 ~]# curl http://localhost:8080/user/get -H 'token:123'
{"username":"zhengminghui","fullname":"鄭明輝","age":0,"address":{"city":"唐山","country":"Ghana"}}

[root@master01 ~]# curl http://localhost:8080/user/get -H 'token:456'
{"username":"fengyuze","fullname":"馮雨澤","age":0,"email":"fengyuze@qq.com","address":{"streetName":"賀儂","city":"陽泉","country":"Faroe Islands"}}

[root@master01 ~]# curl http://localhost:8080/user/get -H 'token:789'
{"username":"lu:jinpeng","fullname":"呂晉鵬","age":20,"email":"lu:jinpeng@qq.com","phone":"48000096798","address":{"streetName":"姚路","city":"德州","country":"Colombia","fullAddress":"孫儂95號, 濰坊, 澳 406722"}

通過測試可以發(fā)現(xiàn)不同token其響應(yīng)的視圖也是不一樣的

總結(jié)

@JsonView主要應(yīng)用于需要根據(jù)業(yè)務(wù)邏輯、安全要求侥蒙、性能考慮或API設(shè)計原則動態(tài)調(diào)整JSON輸出內(nèi)容的場景匀奏，幫助開發(fā)者精確控制序列化過程，實現(xiàn)數(shù)據(jù)暴露的靈活性和安全性娃善。不過這邊有幾點注意事項

• @JsonView不處理持久層上的過濾，而只處理視圖層上的過濾饲齐。這意味著它不會減少數(shù)據(jù)庫的負(fù)載咧最；從數(shù)據(jù)庫中獲取完整的對象，但只有部分對象被序列化并發(fā)送給客戶端滥搭。

• 默認(rèn)情況下捣鲸，@JsonView 不適用于子對象。如果有嵌套對象并且想要將 @JsonView 應(yīng)用于它們愁溜，則需要手動將 @JsonView 注釋添加到子對象的每個字段外厂。

最后Jackson有個@JsonFilter注解也可以實現(xiàn)上述效果，不過它與@JsonView 有所不同渐扮，主要適用于更復(fù)雜、動態(tài)的過濾場景墓律，特別是在需要對對象樹中的多個嵌套層級或集合元素進(jìn)行條件篩選。感興趣的朋友可以去了解下

demo鏈接

https://github.com/lyb-geek/springboot-learning/tree/master/springboot-jsonview