springboot中controller层代码优雅写法

在基于spring框架的项目开发中，必然会遇到controller层，它可以很方便的对外提供数据接口服务，也是非常关键的出口，所以非常有必要进行规范统一，使其既简洁又优雅。
controller层的职责为负责接收和响应请求，一般不负责具体的逻辑业务的实现。controller主要工作如下：

• 接收请求并解析参数；
• 调用service层执行具体的业务逻辑（可能包含参数校验）；
• 捕获业务异常做出反馈；
• 业务逻辑执行成功做出响应；

目前controller层代码会存在的问题：

• 参数校验过多地耦合了业务代码，违背了单一职责原则；
• 可能在多个业务逻辑中抛出同一个异常，导致代码重复；
• 各种异常反馈和成功响应格式不统一，接口对接不友好；

优雅写法一：统一返回结构
统一返回值类型，无论项目前后端是否分离都是非常必要的，方便对接接口的前端开发人员更加清晰地知道这个接口的调用是否成功，不能仅仅简单地看返回值是否为 null 就判断成功与否，因为有些接口的设计就是如此。
统一返回结构，通过状态码就能清楚的知道接口的调用情况：

@Data
public class ResponseData {

    private Boolean status = true;
    private int code = 200;
    private String message;
    private T data;

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

    public static ResponseData ok(Object data,String message) {
        return new ResponseData(data,message);
    }

    public static ResponseData fail(String message,int code) {
        ResponseData responseData= new ResponseData();
        responseData.setCode(code);
        responseData.setMessage(message);
        responseData.setStatus(false);
        responseData.setData(null);
        return responseData;
    }

    public ResponseData() {
        super();
    }

    public ResponseData(T data) {
        super();
        this.data = data;
    }

    public ResponseData(T data,String message) {
        super();
        this.data = data;
        this.message=message;
    }

}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

@AllArgsConstructor
@Data
public enum ResponseCode {

    SYS_FAIL(1, "操作失败"),
    SYS_SUCESS(200, "操作成功"),
    SYSTEM_ERROR_CODE_403(403, "权限不足"),
    SYSTEM_ERROR_CODE_404(404, "未找到请求资源"),
	；
	
	private int code;
    private String msg;
}
1
2
3
4
5
6
7
8
9
10
11
12
13

统一返回结构后，就可以在controller中使用了，但是每个controller都这么写，都是很重复的工作，所以还可以继续想办法处理统一返回结构。

优雅写法二：统一包装处理
Spring 中提供了一个类 ResponseBodyAdvice ，能帮助我们实现上述需求：

ResponseBodyAdvice 是对 Controller 返回的内容在 HttpMessageConverter 进行类型转换之前拦截，进行相应的处理操作后，再将结果返回给客户端。这样就可以把统一包装处理的工作放到这个类里面，其中supports判断是否要交给beforeBodyWrite 方法执行，true为需要，false为不需要，beforeBodyWrite 是对response的具体处理。

@RestControllerAdvice(basePackages = "com.example.demo")
public class ResponseAdvice implements ResponseBodyAdvice