校验注解
用于判断是否为空,省去ifelse的逻辑校验。
简介
1、@NotNull
校验是否为null,不能校验空字符串
2、@NotBlank
用于String,校验不能为空,且trim()后长度大于0
3、@NotEmpty
用于集合,长度必须大于0
以上三个注解来自javax.validation.constraints.*,需要添加依赖。
<dependency>
<groupId>javax.validation</groupId>
<artifactId>validation-api</artifactId>
<version>2.0.1.Final</version>
</dependency>
需要配合@Valid或者@Validated使用。
4、@Valid
位于:javax.validation.Valid
使用范围:方法、属性、构造方法、参数、TYPE_USE(JDK1.8)
METHOD, FIELD, CONSTRUCTOR, PARAMETER, TYPE_USE
5、@Validated
位于:org.springframework.validation.annotation.Validated
适用范围:类型、方法、参数
ElementType.TYPE, ElementType.METHOD, ElementType.PARAMETER
使用
1、实体类标识该属性需要校验
public class CkmsValidateNewDto {
@NotBlank(message="适用场景编码sceneCode不能为空")
private String sceneCode;
@NotBlank(message="适用场景名称sceneName不能为空")
private String sceneName;
@Valid
private UserInfo userInfo;
@Valid
private PatientInfo patientInfo;
@NotNull
private List<DiagnosisInfo> diagnosisInfo;
//省略get、set方法
}
public class UserInfo {
@NotBlank(message="客户端IP地址不能为空")
private String ip;
@NotBlank(message="人员工号userId不能为空")
private String userId;
@NotBlank(message="人员姓名userName不能为空")
private String userName;
@NotBlank(message="角色编码roleCode不能为空")
private String roleCode;
private String roleName;
//省略get、set方法
}
说明:
CkmsValidateNewDto中用到了实体类UserInfo,其中也存在必填项的校验,所以在这里就得给userInfo属性加上@Valid注解。
注解后的message为提示信息。
2、Controller入参使用@Valid
使用该注解时,需要用BindingResult接收校验结果,校验不通过时,需要手动return,否则继续执行。
@PostMapping(value = "/test/validate")
public JSONObject validateApiTest(@Valid @RequestBody CkmsValidateNewDto params, HttpServletRequest request, BindingResult bindingResult) {
long c1 = System.currentTimeMillis();
JSONObject json = new JSONObject(true);
RestResult<?> result = new RestResult<>();
//注意:此处需要判断,并手动处理返回结果,获取message信息
if(bindingResult.hasErrors()){
result.setCode(1);
result.setMessage(bindingResult.getAllErrors().get(0).getDefaultMessage());
} else {
//正常执行逻辑
}
json = JSONObject.parseObject(JSON.toJSON(result).toString());
long c2 = System.currentTimeMillis();
logger.info("知识库智能提醒返回结果:{},总耗时:{}毫秒",json,c2-c1);
return json;
}
postman调用示例:
3、Controller使用@Validated
@PostMapping(value = "/validate")
public JSONObject validateApi(@Validated @RequestBody CkmsValidateNewDto params, HttpServletRequest request) {
}
校验不通过时,抛异常,如下:
需要定义全局异常捕获类,来返回提示信息,如下:(返回结果自定义)
package com.pkuhit.iihip.ckms.core;
import java.util.List;
import java.util.stream.Collectors;
import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import com.pkuhit.iihip.ckms.dto.RestResult;
import org.springframework.validation.ObjectError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestControllerAdvice;
/**
* @author: zjx
* @description:
* @date: 2022/7/5
*/
@RestControllerAdvice
public class GlobalExceptionHandler {
@ExceptionHandler(value = MethodArgumentNotValidException.class)
@ResponseBody
public JSONObject handleMethodArgumentNotValidException(MethodArgumentNotValidException e) {
JSONObject json = new JSONObject(true);
RestResult<?> result = new RestResult<>();
StringBuilder sb = new StringBuilder();
List<ObjectError> allErrors = e.getBindingResult().getAllErrors();
String message = allErrors.stream().map(s -> s.getDefaultMessage()).collect(Collectors.joining(";"));
result.setMessage(message);
result.setCode(1);
return JSONObject.parseObject(JSON.toJSON(result).toString());
}
}
postman调用示例: