ResponseBodyAdvice 接口实现自定义返回数据类型
api接口中都是需要定义一个统一的响应头来返回json数据
一般方法是通过在返回时构造一个响应头对象如下:
public class ApiR extends HashMap<String, Object> {
private static final long serialVersionUID = 1L;
public ApiR() {
put("code", 200);
put("msg", "success");
}
public static ApiR error() {
return error(500, "未知异常,请联系管理员");
}
public static ApiR error(String msg) {
return error(500, msg);
}
public static ApiR error(int code, String msg) {
ApiR r = new ApiR();
r.put("code", code);
r.put("msg", msg);
return r;
}
public static ApiR ok(String msg) {
ApiR r = new ApiR();
r.put("msg", msg);
return r;
}
public static ApiR ok(Object obj) {
ApiR r = new ApiR();
r.put("code",200);
r.put("results", obj);
return r;
}
public static ApiR ok(Map<String, Object> map) {
ApiR r = new ApiR();
r.putAll(map);
return r;
}
public static ApiR ok() {
return new ApiR();
}
public static ApiR setResults(Object object) {
ApiR r = ApiR.ok();
r.put("code",200);
r.put("results", object);
return r;
}
@Override
public ApiR put(String key, Object value) {
super.put(key, value);
return this;
}
}
在返回是使用ApiR
return ApiR.setResults(list);
这种弊端是每个响应都需要加响应头对象。
我们可以通过统一响应处理
统一处理的响应头对象
@Data
@NoArgsConstructor
@AllArgsConstructor
public class CommonResponse<T> implements Serializable {
private Integer code;
private String msg;
private T data;
public CommonResponse(Integer code, String msg) {
this.code = code;
this.msg = msg;
}
}
通过@RestControllerAdvice来实现,ResponseBodyAdvice的作用是在响应体返回之前做一些自定义的处理工作。通常,我们会实现ResponseBodyAdvice接口,并包装统一的响应返回。
@RestControllerAdvice
public class CommonResponseDataAdvice implements ResponseBodyAdvice<Object> {
@Override
@SuppressWarnings("all")
public boolean supports(MethodParameter methodParameter, Class<? extends HttpMessageConverter<?>> aClass) {
//如果类有IgnoreResponseAdvice这个注解就不处理
if(methodParameter.getDeclaringClass().isAnnotationPresent(
IgnoreResponseAdvice.class
)){
return false;
}
//如果方法有IgnoreResponseAdvice这个注解就不处理
if(methodParameter.getMethod().isAnnotationPresent(
IgnoreResponseAdvice.class
)){
return false;
}
return true;
}
//Object,这个就是原始的Controller返回的内容。我们也就是需要对它进行包装
@Override
public Object beforeBodyWrite(Object o, MethodParameter methodParameter, MediaType mediaType, Class<? extends HttpMessageConverter<?>> aClass, ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) {
CommonResponse<Object> response = new CommonResponse<>(0,"");
//如果是null response不需要设置data
if(null == o){
return response;
//如果o是CommonResponse实例 强转
}else if(o instanceof CommonResponse){
response = (CommonResponse<Object>) o;
}else{
// 否则, 把响应对象作为 CommonResponse 的 data 部分
response.setData(o);
}
return response;
}
}
统一异常处理
业务异常类
public class ReException extends Exception{
public ReException(String message){
super(message);
}
}
异常处理,也需要统一响应头
@RestControllerAdvice
public class GlobalExceptionAdvice {
@ExceptionHandler(value = ReException.class)
public CommonResponse<String> handlerReException(HttpServletRequest request,ReException re){
//统一异常接口的响应
//建议使用枚举
CommonResponse<String> response = new CommonResponse<>(-1,"business error");
response.setData(re.getMessage());
return response;
}
}
统一配置json
通过继承WebMvcConfigurer类重写configureMessageConverters方法
MappingJackson2HttpMessageConverter实现了HttpMessageConverter接口。HttpMessageConverter接口有canRead和canWrite方法。完成json转化
@Configuration
public class WebConfiguration implements WebMvcConfigurer{
@Override
public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
converters.clear();
converters.add(new MappingJackson2HttpMessageConverter());
}
}
验证:@Valid 用在方法、构造函数、方法参数和成员属性(字段)上,不能分组
实体类
@NotNull
@Size(min=2, message="Name should have atleast 2 characters")
private String name;
相关注解参数
空检查
@Null 验证对象是否为null
@NotNull 验证对象是否不为null, 无法查检长度为0的字符串
@NotBlank 检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前后空格.
@NotEmpty 检查约束元素是否为NULL或者是EMPTY.
Booelan检查
@AssertTrue 验证 Boolean 对象是否为 true
@AssertFalse 验证 Boolean 对象是否为 false
长度检查
@Size(min=, max=) 验证对象(Array,Collection,Map,String)长度是否在给定的范围之内
@Length(min=, max=) Validates that the annotated string is between min and max included.
日期检查
@Past 验证 Date 和 Calendar 对象是否在当前时间之前
@Future 验证 Date 和 Calendar 对象是否在当前时间之后
@Pattern 验证 String 对象是否符合正则表达式的规则
数值检查,建议使用在Stirng,Integer类型,不建议使用在int类型上,因为表单值为“”时无法转换为int,但可以转换为Stirng为"",Integer为null
@Min 验证 Number 和 String 对象是否大等于指定的值
@Max 验证 Number 和 String 对象是否小等于指定的值
@DecimalMax 被标注的值必须不大于约束中指定的最大值. 这个约束的参数是一个通过BigDecimal定义的最大值的字符串表示.小数存在精度
@DecimalMin 被标注的值必须不小于约束中指定的最小值. 这个约束的参数是一个通过BigDecimal定义的最小值的字符串表示.小数存在精度
@Digits 验证 Number 和 String 的构成是否合法
@Digits(integer=,fraction=) 验证字符串是否是符合指定格式的数字,interger指定整数精度,fraction指定小数精度。
@Range(min=, max=) Checks whether the annotated value lies between (inclusive) the specified minimum and maximum.
@Range(min=10000,max=50000,message="range.bean.wage")
private BigDecimal wage;
@Valid 递归的对关联对象进行校验, 如果关联对象是个集合或者数组,那么对其中的元素进行递归校验,如果是一个map,则对其中的值部分进行校验.(是否进行递归验证)
@CreditCardNumber信用卡验证
@Email 验证是否是邮件地址,如果为null,不进行验证,算通过验证。
@ScriptAssert(lang= ,script=, alias=)
@URL(protocol=,host=, port=,regexp=, flags=)
使用
public ResponseEntity<Object> createUser(@Valid @RequestBody User user) {
验证:@Validated可以用在类型、方法和方法参数上。但是不能用在成员属性(字段)上,能分组
建立空接口
public interface AdvanceInfo {
}
空接口为一组
@Min(value = 18, message = "Age should not be less than 18", groups = AdvanceInfo.class)
private int age;
使用@Validated
public ResponseEntity<Object> createUser(Validated(AdvanceInfo .class) @RequestBody User user) {