为了实现判断Controller方法上是否有 JsonResult 注解并修改返回值类型为 Result，我们可以通过实现 ResponseBodyAdvice 接口完成此操作。
- 创建一个类并实现
ResponseBodyAdvice接口：
@RestControllerAdvice
public class ResultResponseAdvice implements ResponseBodyAdvice<Object> {
//...
}
- 实现
supports方法，判断返回值类型是否需要修改。如果返回 true，则执行beforeBodyWrite方法；如果返回 false，则不执行。
@Override
public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
return returnType.getMethodAnnotation(JsonResult.class) != null;
}
- 实现
beforeBodyWrite方法，将返回值类型转换为Result。
@RestControllerAdvice
public class JsonResultAdvice implements ResponseBodyAdvice<Object> {
@Override
public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
return returnType.getMethodAnnotation(JsonResult.class) != null;
}
@Override
public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
if (body instanceof Result) return new JSONObject(body);
JsonResult anno = returnType.getMethodAnnotation(JsonResult.class);
int code = anno.code();
String message = anno.message();
Result result = new Result().setCode(code).setMessage(message).setData(body);
return new JSONObject(result);
}
}
-
Result类的实现
@Data
@Accessors(chain = true)
public class Result {
private int code;
private Object data;
private String message;
}
-
JsonResult注解的实现
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface JsonResult {
int code() default 0;
String message() default "success";
@AliasFor("message")
String value() default "success";
}
上述代码中，ResultResponseAdvice 类实现了 ResponseBodyAdvice 接口，并被 @RestControllerAdvice 注解标记为全局控制器通知。supports 方法判断方法上是否有 JsonResult 注解，如果有则返回 true，否则返回 false。beforeBodyWrite 方法将返回值类型转换为 Result。
最后，我们将 Result 类作为返回值的封装类，将原返回值作为其 data 属性返回，同时可以通过 code 和 message 属性设置返回状态码和信息。
示例：
@GetMapping("/get/simple")
@JsonView(UserView.Simple.class)
@JsonResult
public UserDto getSimple() {
return userDto;
}
{
"code": 0,
"data": {
"id": 1,
"name": "yimin",
"age": 20,
"createTime": "2023-05-26T15:35:20.243"
},
"message": "success"
}
@GetMapping("/get/simple")
@JsonView(UserView.Simple.class)
@JsonResult("这是返回的user信息")
public UserDto getSimple() {
return userDto;
}
{
"code": 0,
"data": {
"id": 1,
"name": "yimin",
"age": 20,
"createTime": "2023-05-26T15:34:07.795"
},
"message": "这是返回的user信息"
}
