实现 ResponseBodyAdvice 定制化JSON 返回字段

最新推荐文章于 2024-08-02 09:42:12 发布

深圳市热心市民市民

最新推荐文章于 2024-08-02 09:42:12 发布

阅读量3k

点赞数

分类专栏： Spring Boot 文章标签： ResponseBodyAdvice 定制化JSON

本文链接：https://blog.csdn.net/u013107634/article/details/89457762

版权

通过创建CustomReturnJson注解并应用在Controller的方法上，可以实现细粒度的JSON返回字段控制，确保每个接口仅返回指定字段，如id、topicName和topicImg。主要逻辑集中在ResponseBodyAdvice的beforeBodyWrite方法中，该方法在JSON响应发送前进行处理。

摘要由CSDN通过智能技术生成

细粒度定制化JSON返回字段，精确控制每一个接口方法返回的字段

1. 创建注解CustomReturnJson 标注在controller 的方法上。示例：

    @RequestMapping("/testJson")
    @ResponseBody
    @CustomReturnJson(include = {"id","topicName","topicImg"})
    public Object testJson(@RequestParam("name")String name){
        Topic topic = topicService.getByTopicName(name);
        return ResultVO.success(topic);
    }

只返回 id topicName,topicImg 字段

import java.lang.annotation.*;

/**
 * @author XXX
 * Date: 2019/4/11
 * Description:该注解配合 @ResponseBody 一起使用来细粒度定制返回的json @see {CustomReturnResponseBody.class}
 */
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface CustomReturnJson {

    /**
     * 返回的json包含哪些字段
     */
    String[] include() default {};

}