后端服务器数据返回格式优化

在前文中，我们已经学习了如何优雅地校验传入的参数。接下来，让我们探讨后端服务器如何实现将数据返回给前端。

返回格式

通常情况下，后端返回给前端的数据采用JSON格式，定义如下：

{
    "code": "string",       
    "message": "string",
    "data": "object"
}

CODE 状态码

状态码用于表示返回的状态，通常在开发过程中根据需要添加。例如，接口返回用户权限异常可以使用状态码101，而数据参数异常可以使用状态码102。然而，这种方式可能导致状态码混乱。因此，可以参考阿里巴巴开发手册中的前后端规约以及异常日志中的内容。

U表示用户，后面4位数字编号为
#U1000～U1999 区间表示用户参数相关
#U2000～U2999 区间表示用户相关接口异常
...

通过这种方式，前端开发人员可以根据状态码快速了解大致的错误类型，并根据相关信息描述快速定位问题。

Message

Message字段相对较为简单，用于在发生错误时进行友好的提示。通常与状态码一起设计，例如：

@Data
public class Result {

    private String retCode;
    private String retMsg;
 
    //默认成功状态码
    public static final String SUCCESSCODE = "S0000";
    public static final String SUCCESSMSG = "成功";
    //默认失败状态码
    public static final String ERROR_CODE = "E2222";
    public static final String ERROR_MSG = "失败";

    public static final String COMMENT_CODE = "E3333";
    public static final String RUNNING_ERROR_MSG = "运行出错，请联系管理员";

    private Result() {
        this(SUCCESSCODE, SUCCESSMSG);
    }
}

接着在枚举中定义状态码：

@Getter
public enum UserResultConstants implements ResultConstats{

    NOT_ID("U1001","未正确输入用户id"),
    ADD_FAIL("U1002","新增用户失败"),
    UPDATE_FAIL("U1003","更新用户失败"),
    DELETE_FAIL("U1004","删除用户失败"),
    USERNAME_EXIST("U1005","用户名已存在"),
    USER_NOT_EXIST("U1006","用户不存在")
    ;

    private String code;
    private String message;

    private UserResultConstants(String code, String message){
        this.code = code;
        this.message = message;
    }

}

这样状态码和信息就会一一对应，便于维护。

Data

返回的数据体采用JSON格式，根据不同的业务采用不同的JSON结构。因此，我们需要设计一个返回体类Result：

@Data
public class Result {

    private String retCode;
    private String retMsg;
    private Object data;

    public static final String SUCCESSCODE = "0000";
    public static final String SUCCESSMSG = "成功";
    public static final String ERROR_CODE = "2222";
    public static final String ERROR_MSG = "失败";

    public static final String COMMENT_CODE = "3333";
    public static final String RUNNING_ERROR_MSG = "运行出错，请联系管理员";

    public Result() {
        this(SUCCESSCODE, SUCCESSMSG, null);
    }

    public Result(Object data) {
        this(SUCCESSCODE, SUCCESSMSG, data);
    }

    public Result(String retCode, String retMsg, Object data) {
        this.retCode = retCode;
        this.retMsg = retMsg;
        this.data = data;
    }

    public Result(String retCode, String retMsg) {
        this(retCode, retMsg, null);
    }
}

控制层 Controller

在控制层中处理业务请求并返回给前端，以用户管理为例：

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

    private final UserService userService;

    /**
     * 查询所有用户信息
     *
     * @return 返回所有用户信息
     */
    @GetMapping(value = "/list")
    public Result userList() {
        List<UserVo> users = userService.selectUserList();
        Result result = new Result(users);
        log.info("userList查询的用户信息为:{}", JsonMapper.toJson(users));
        return result;
    }
}

在获得用户对象后，我们使用Result构造方法进行包装赋值，然后返回。@RestController注解是@Controller和@ResponseBody的合集，表示这是个控制器bean，并且将函数的返回值直接填入HTTP响应体中，适合前后端分离架构下返回JSON数据格式。

构造方法的包装看起来有些繁琐，我们可以进行优化。

美观优化

我们可以在Result类中加入静态方法，使代码更加简洁：

@Data
public class Result {

    //...

    public static Result ok() {
        return new Result();
    }

    public static Result ok(Object data) {
        return new Result(data);
    }

    public static Result ok(String retCode, String retMsg) {
        return new Result(retCode, retMsg);
    }

    public static Result error(String retCode, String retMsg) {
        return new Result(retCode, retMsg);
    }

}

然后改造Controller：

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

    private final UserService userService;

    /**
     * 查询所有用户信息
     *
     * @return 返回所有用户信息
     */
    @GetMapping(value = "/list")
    public Result userList() {
        List<UserVo> users = userService.selectUserList();
        log.info("userList查询的用户信息为:{}", JsonMapper.toJson(users));
        return Result.ok(users);
    }
}

代码变得更加简洁、美观。

优雅优化

上面我们在Result类中增加了静态方法，使得业务处理代码更加简洁。但是，这种方式存在几个问题：

• 每个方法的返回都是Result封装对象，没有业务含义。
• 在业务代码中，成功时调用Result.success，异常错误时调用Result.error，显得多余。

最好的方式是直接返回真实业务对象，不改变之前的业务方式：

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

    private final UserService userService;

    /**
     * 查询所有用户信息
     *
     * @return 返回所有用户信息
     */
    @GetMapping(value = "/list")
    public List<UserVo> userList() {
        List<UserVo> users = userService.selectUserList();
        log.info("userList查询的用户信息为:{}", JsonMapper.toJson(users));
        return users;
    }
}

这种方式非常直观，直接返回用户对象，非常完美。

那么，如何实现这种方案呢？

返回值优雅方案实现

要优化这段代码很简单，只需要借助SpringBoot提供的ResponseBodyAdvice即可。

ResponseBodyAdvice的作用是拦截Controller方法的返回值，统一处理返回值/响应体，一般用来统一返回格式，加解密，签名等。

重写返回体

@RestControllerAdvice
@RequiredArgsConstructor
public class ResponseAdvice implements ResponseBodyAdvice<Object> {

    private final ObjectMapper objectMapper;

    @Override
    public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
        return true;
    }

    @SneakyThrows
    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
        if (body instanceof String) {
            return objectMapper.writeValueAsString(Result.ok(body));
        }
        if (body instanceof Result) {
            return body;
        }
        return Result.ok(body);
    }
}

上面的代码判断是否需要对返回值进行包装，如果需要则直接进行包装。这里我们只处理了正常成功的包装，那么如果方法体报异常怎么办呢？

异常问题处理

此时存在一个问题，由于没有对异常进行处理，当调用的方法一旦出现异常，就会出现问题。因此，可以编写全局异常来统一返回格式的Result。

• 定义异常类

public class UserException extends RuntimeException {
    public UserException(String message) {
        super(message);
    }
}

• 全局异常类

@RestControllerAdvice
@Slf4j
@Order(value = Ordered.HIGHEST_PRECEDENCE)
public class GlobalExceptionHandler {

    @ExceptionHandler(value = UserException.class)
    public Result handlerUserException(UserException e, HttpServletRequest request) {
        String msg = e.getMessage();
        log.error("请求[ {} ] {} 的参数校验发生错误，错误信息：{}", request.getMethod(), request.getRequestURL(), msg, e);
        return Result.error(Result.COMMENT_CODE, msg);
    }
}

重写 Controller

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

    private final UserService userService;

    /**
     * 根据用户id查询用户信息
     *
     * @param id 用户id
     * @return 成功则返回用户信息
     */
    @GetMapping("/selectById")
    public UserVo selectById(@RequestParam(required = false) Integer id) {
        UserVo user = userService.selectUserById(id);
        log.info("selectById根据id:{}执行查询,查询的用户信息为:{}", id, JsonMapper.toJson(user));
        if (user == null) {
            throw new UserException("查询的用户不存在");
        }
        return user;
    }
}

通过以上步骤，我们实现了统一格式的返回，代码变得更加简洁、优雅。

关于作者

本文来自一线程序员Seven的探索与实践，持续学习迭代中~

本文已收录于我的个人博客：
https://www.seven97.top

公众号：seven97，欢迎关注~