- 1 ResponseBodyAdvice的简介
- 2 ResponseBodyAdvice的使用
- 1 准备一个SpringBoot项目环境
- 2 添加一个响应拦截类
- 3 添加一个返回包装类
- 4 添加控制类
- 5 接口测试
1 ResponseBodyAdvice的简介ResponseBodyAdvice可以在注解@ResponseBody将返回值处理成相应格式之前操作返回值。实现这个接口即可完成相应操作。可用于对response 数据的一些统一封装或者加密等操作
ResponseBodyAdvice接口和之前记录的RequestBodyAdvice接口类似, RequestBodyAdvice是请求到Controller之前拦截,做相应的处理操作, 而ResponseBodyAdvice是对Controller返回的{@code @ResponseBody}or a {@code ResponseEntity} 后,{@code HttpMessageConverter} 类型转换之前拦截, 进行相应的处理操作后,再将结果返回给客户端.
ResponseBodyAdvice的源代码:
public interface ResponseBodyAdvice{ boolean supports(MethodParameter returnType, Class> converterType); @Nullable T beforeBodyWrite(@Nullable T body, MethodParameter returnType, MediaType selectedContentType, Class> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response); }
说明:
- supports方法: 判断是否要执行beforeBodyWrite方法,true为执行,false不执行. 通过该方法可以选择哪些类或那些方法的response要进行处理, 其他的不进行处理.
- beforeBodyWrite方法: 对response方法进行具体操作处理
2 ResponseBodyAdvice的使用 1 准备一个SpringBoot项目环境 2 添加一个响应拦截类{@code @ResponseBody} 返回响应体, 例如List集合
{@code ResponseEntity} 返回响应实体对象,例如User对象
@ControllerAdvice public class baseResponseBodyAdvice implements ResponseBodyAdvice3 添加一个返回包装类
@Data @AllArgsConstructor @NoArgsConstructor public class baseResponse4 添加控制类{ private T data; private int status = 200; private String message; private long srvTime = System.currentTimeMillis(); public baseResponse(String message) { this.message = message; } public baseResponse setData(T data) { this.data = data; return this; } public static baseResponse ok() { return new baseResponse<>("操作成功"); } public static baseResponse ok(T data) { return new baseResponse ("操作成功").setData(data); } }
@Controller
@RequestMapping("/hello")
public class HelloWorld {
// 此处数据从数据库中查询, 案例中也可以使用伪数据代替
@Autowired
private UserMapper userMapper;
// {@code ResponseEntity} 案列
@GetMapping("/one")
@ResponseBody
public User one() {
List users = userMapper.selectAll();
System.out.println(users.get(0));
return users.get(0);
}
// {@code @ResponseBody} 案列
@GetMapping("/list")
@ResponseBody
public List list() {
List users = userMapper.selectAll();
System.out.println(users);
return users;
}
}
5 接口测试
浏览器访问: http://localhost:8080/hello/one
User(id=1, username=李子柒, phone=77777, icon=李子柒的头像, queryTime=Wed Oct 27 20:47:02 CST 2021) 响应拦截成功
浏览器访问: http://localhost:8080/hello/list
[User(id=1, username=李子柒, phone=77777, icon=李子柒的头像, queryTime=Wed Oct 27 20:46:58 CST 2021)] 响应拦截成功
ps: 如果直接响应字符串返回,则会报类型转换异常.
