用SpringBoot写的后端API接口

• 使用注解，进行参数校验

• 统一结果返回

• 统一异常处理

• 唠叨几句

1. 使用注解，统一参数校验

假设小田螺实现一个注册用户的功能，在controller 层，他会先进行校验参数，如下：

@RestController
@RequestMapping
public class UserController {

    @RequestMapping("addUser")
    public String addUser(UserParam userParam) {

        if (StringUtils.isEmpty(userParam.getUserName())) {
            return "用户名不能为空";
        }
        if (StringUtils.isEmpty(userParam.getPhone())) {
            return "手机号不能为空";
        }
        if (userParam.getPhone().length() > 11) {
            return "手机号不能超过11";
        }
        if (StringUtils.isEmpty(userParam.getEmail())) {
            return "邮箱不能为空";
        }

        //省略其他参数校验

        //todo 插入用户信息表
        return "SUCCESS";
    }

}

以上代码有什么问题嘛？其实没什么问题，就是校验有点辣眼睛。正常的添加用户业务还没写，参数校验就一大堆啦。假设后来，小田螺又接了一个需求：编辑用户信息。实现编辑用户信息前，也是先校验信息，如下：

@RequestMapping("editUser")
public String editUser(UserParam userParam) {

    if (StringUtils.isEmpty(userParam.getUserName())) {
        return "用户名不能为空";
    }
    if (StringUtils.isEmpty(userParam.getPhone())) {
        return "手机号不能为空";
    }
    if (userParam.getPhone().length() > 11) {
        return "手机号不能超过11";
    }
    
    if (StringUtils.isEmpty(userParam.getEmail())) {
        return "邮箱不能为空";
    }

    //省略其他参数校验

    //todo 编辑用户信息表
    return "SUCCESS";
}

我们可以使用注解的方式，来进行参数校验，这样代码更加简洁，也方便统一管理。实际上， spring boot有个validation的组件，我们可以拿来即用。引入这个包即可：

<depend