使用ResponseBodyAdvice接口对返回数据做统一格式封装（对Controller的增强）

最新推荐文章于 2025-05-15 14:56:32 发布

原创最新推荐文章于 2025-05-15 14:56:32 发布 · 669 阅读

1 ·

CC 4.0 BY-SA版权

SpringBoot 专栏收录该内容

15 篇文章

订阅专栏

本文介绍了一种在Spring框架中使用@ControllerAdvice和ResponseBodyAdvice注解封装API响应结果的方法，通过自定义PostResponseAdvice类实现对所有Controller返回结果的统一处理，以增强应用的统一性和可读性。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

@ControllerAdvice注解不能少

ResponseBody增强类

package com.qifeng.authdemo.advice;

import com.qifeng.authdemo.view.JsonView;
import org.springframework.core.MethodParameter;
import org.springframework.http.MediaType;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;

import javax.print.attribute.standard.JobSheets;

/**
 * @author zengqifeng
 * @version 1.0
 * @date 2019/12/12 18:09
 */
@ControllerAdvice
public class PostResponseAdvice implements ResponseBodyAdvice {
    @Override
    public boolean supports(MethodParameter methodParameter, Class aClass) {
        return true;
    }

    @Override
    public Object beforeBodyWrite(Object o, MethodParameter methodParameter, MediaType mediaType, Class aClass, ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) {
        //Controller的返回结果在这里封装
        JsonView<Object> jsonView = new JsonView<>();
        jsonView.setCode(200);
        jsonView.setMessage("success");
        jsonView.setData(o);
        return jsonView;
    }
}

JsonView类

package com.qifeng.authdemo.view;

/**
 * @author zengqifeng
 * @version 1.0
 * @date 2019/12/12 18:08
 */
public class JsonView<T> extends View {
    private Integer code;
    private String message;
    private T data;

    public JsonView(Integer code, String message, T data) {
        this.code = code;
        this.message = message;
        this.data = data;
    }

    public JsonView(Integer code, String message) {
        this.code = code;
        this.message = message;
    }

    public JsonView() {
    }

    public Integer getCode() {
        return code;
    }

    public void setCode(Integer code) {
        this.code = code;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }

    public T getData() {
        return data;
    }

    public void setData(T data) {
        this.data = data;
    }
}