Spring Boot中如何复用自定义的统一成功响应？

要实现成功响应逻辑的全局复用，完全不需要在每个接口重复写ObjectMapper初始化、JSON节点拼接、HttpServletResponse流操作的冗余代码，核心只需要搭建两层基础组件，就能达到你预期的极简返回效果：

核心组件搭建 #

1. 统一响应实体类 #

把你手动拼接的code、success、msg字段封装为标准POJO，替代每次裸用ObjectNode构建JSON节点的写法，同时预留data字段支持后续接口返回业务数据的场景：

// 可通过Lombok的@Data注解省去手写get/set方法的成本
@Data
public class ApiResponse<T> {
    /** 业务状态码 */
    private Integer code;
    /** 操作是否成功 */
    private Boolean success;
    /** 提示信息 */
    private String msg;
    /** 业务返回数据 */
    private T data;
}

2. 响应构建工具类 #

这个类就是统一响应逻辑的封装载体，把所有成功响应的构建逻辑收拢为全局可调用的静态方法，不需要每个接口重复实现：

public class ResponseUtils {
    /**
     * 无额外返回数据的成功响应
     */
    public static <T> ResponseEntity<ApiResponse<T>> success() {
        ApiResponse<T> result = new ApiResponse<>();
        result.setCode(200);
        result.setSuccess(true);
        result.setMsg("OK");
        // 依托Spring内置的ResponseEntity机制返回，不需要手动操作HttpServletResponse
        return ResponseEntity.ok(result);
    }

    /**
     * 带业务数据的成功响应
     */
    public static <T> ResponseEntity<ApiResponse<T>> success(T data) {
        ApiResponse<T> result = new ApiResponse<>();
        result.setCode(200);
        result.setSuccess(true);
        result.setMsg("OK");
        result.setData(data);
        return ResponseEntity.ok(result);
    }

    /**
     * 自定义提示语的成功响应
     */
    public static <T> ResponseEntity<ApiResponse<T>> success(String msg, T data) {
        ApiResponse<T> result = new ApiResponse<>();
        result.setCode(200);
        result.setSuccess(true);
        result.setMsg(msg);
        result.setData(data);
        return ResponseEntity.ok(result);
    }
}

改造后的接口效果 #

组件封装完成后，之前单接口里的大段冗余逻辑可以全部删除，写法完全匹配你预期的效果：

@PostMapping("/notice")
public ResponseEntity<ApiResponse<Object>> createNotice(@RequestBody @Valid NoticeDto noticeDto) {
    noticeService.createNotice(noticeDto);
    // 直接调用工具类方法返回即可
    return ResponseUtils.success();
    // 如果需要把新建的通知ID返回给前端，直接传入参数即可：
    // return ResponseUtils.success("保存成功", notice.getId());
}

补充说明 #

你之前代码里手动设置响应状态码、ContentType、字符编码、写PrintWriter输出流的逻辑完全没有必要保留：当接口返回ResponseEntity对象时，Spring MVC会自动通过内置的Jackson消息转换器，把返回的POJO序列化为JSON格式，自动完成响应头设置、字符编码适配，既避免了之前手写流容易出现的乱码、流冲突问题，也完全适配Spring的请求处理链路。
如果后续需要进一步压缩重复代码量，还可以通过ResponseBodyAdvice接口实现全局响应增强，自动把所有接口的返回值包装为统一的ApiResponse结构，连每个接口手动调用success()的步骤都可以省去。

内容的提问来源于stack exchange，提问作者DD DD