SpringBoot定义统一的controller返回格式

一.定义接口返回包装类

package com.example.auth.filter;

import com.fasterxml.jackson.annotation.JsonInclude;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.experimental.Accessors;

@Data
@NoArgsConstructor
@AllArgsConstructor
@Accessors(chain = true)
@JsonInclude(JsonInclude.Include.NON_NULL)
public class Response<T> {

    private int code;
    private String msg;
    private T data;

    public static <T> Response<T> ok(T data) {
        int okCode = 200;
        return new Response<>(okCode, "请求成功", data);
    }
}

 2、编写ResponseBodyAdvice接口实现

（controller的值返回成功后会走这里的方法，对结果进行二次封装。@RestControllerAdvice注解和ResponseBodyAdvice接口实现统一处理controller返回）

package com.example.auth.config;

import com.alibaba.fastjson.JSON;
import com.example.auth.filter.Response;
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.RestControllerAdvice;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;

@RestControllerAdvice(basePackages = "com.example.auth.provider.controller")
public class ApiResponseBody implements ResponseBodyAdvice<Object> {

    @Override
    public boolean supports(MethodParameter returnType, Class converterType) {
        return true;
    }

    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType
            , Class selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
        // 防止二次封装
        if (body instanceof Response) {
            return body;
        }

		// 处理controller返回为字符串时, 转换报异常的bug（默认使用的jackson转换器会报类型转换的错，感兴趣可以跟下源代码）
		//（如果使用FastJsonHttpMessageConverter，则不需要加下面if判断）
        if (body instanceof String) {
            return JSON.toJSONString(Response.ok(body));
        }
        
        return Response.ok(body);
    }
}

3.controller编写

package com.example.auth.provider.controller;

import com.example.auth.provider.model.User;
import io.swagger.annotations.Api;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.jws.soap.SOAPBinding;


@RestController
@Api(tags = {"接口鉴权"})
@RequestMapping(value = "/authentication")
public class UserController {

    @PostMapping("/getUser")
    public User getUser(int id) {
        User user1 = new User(1, "王云召");
        User user2 = new User(2, "王云盼");
        User user3 = new User(3, "啥也不是");
        User user4= new User();
        if (id == user1.getId()) {
            return user1;
        } else if (id == user2.getId()) {
            return user2;
        }
        return user4;
    }

}

4.结果