參數(shù)校驗和異常處理也是后臺代碼中很重要的一部分继阻，如果每次都自己寫代碼做校驗就會很繁瑣，所以spring框架中也提供了validation組件來直接做參數(shù)校驗挪凑，本文就是講述validation組件的一些常見的用法，以及順便講一下如何全局的處理異常。
- 首先依然是先要在build.gradle的dependencies中添加依賴包
implementation "org.springframework.boot:spring-boot-starter-validation"
- 接著只要直接在java bean中配置參數(shù)條件就可以了纺酸，例如我們給teacher的幾個屬性加一些條件
@Size(max=4, min=2, message="老師姓名應(yīng)為2-4字")
private String name;
@NotNull(message="老師性別不能為空")
@Min(value = 0, message = "性別值只能為0或1，0:女址否，1:男")
@Max(value = 1, message = "性別值只能為0或1餐蔬，0:女碎紊，1:男")
private Integer gender;
@NotNull(message="老師年齡不能為空")
@Min(value = 20, message = "老師年齡不能小于20")
@Max(value = 70, message = "老師年齡不能大于70")
這里的注解約束還有很多其他的，具體可以參考SpringBoot使用Validation校驗參數(shù)中的說明樊诺。也可以查看Hibernate Validator的官方文檔仗考，里面有更詳細(xì)的說明，還有一些不是很常見的特殊的注解約束词爬。
- 然后就可以在controller接口的參數(shù)前加上需要校驗的注解秃嗜，注解有兩種，一個是@Valid顿膨，一個是@Validated锅锨，這兩個大部分情況使用是一樣的。例如恋沃，這樣加上：
@PostMapping(value = "/addTeacher", consumes = { "application/x-www-form-urlencoded" })
@ResponseBody
public ResponseData addTeacher(@Validated Teacher teacher)
{
if(teacher.getFile() != null){
String fileName = FileUtil.upload(teacher.getFile(), path, teacher.getFile().getOriginalFilename());
if ( fileName!= null){
teacher.setImageUrl(fileName);
}
}
teacherMapper.insertTeacher(teacher);
ResponseData responseData = ResponseData.ok();
return responseData;
}
然后我們來運(yùn)行試試
可以看到返回了默認(rèn)格式的錯誤信息的json字符串必搞。
但是由于這個信息格式是默認(rèn)的，和我們自己定義的不一樣囊咏，前端可能就無法辨認(rèn)恕洲，這時就有兩個方法可以處理：
第一個方法是使用BindingResult，我們可以用BindingResult接收驗證的結(jié)果梅割，如果錯誤霜第，再按我們自己定義的格式返回錯誤信息。
@PostMapping(value = "/addTeacher", consumes = { "application/x-www-form-urlencoded" })
@ResponseBody
public ResponseData addTeacher(@Validated Teacher teacher, BindingResult bindingResult)
{
if (bindingResult.hasErrors()) {
ResponseData responseData = new ResponseData(400, bindingResult.getFieldError().getDefaultMessage());
return responseData;
}
if(teacher.getFile() != null){
String fileName = FileUtil.upload(teacher.getFile(), path, teacher.getFile().getOriginalFilename());
if ( fileName!= null){
teacher.setImageUrl(fileName);
}
}
teacherMapper.insertTeacher(teacher);
ResponseData responseData = ResponseData.ok();
return responseData;
}
結(jié)果就會變成這樣
第二個方法則就要引入本文的第二個課題了炮捧，就是全局的處理異常庶诡。因為如果每個校驗的異常都要這樣寫的話，那也是非常麻煩了咆课。所以Spring也提供了非常方便的全局異常的注解末誓，就是@RestControllerAdvice和@ExceptionHandler。我們就可以構(gòu)建如下的全局異常處理的類：
@RestControllerAdvice
public class GlobalExceptionHandler {
/**
* 處理Validated校驗異常
* <p>
* 注: 常見的ConstraintViolationException異常书蚪， 也屬于ValidationException異常
*
* @param e
* 捕獲到的異常
* @return 返回給前端的data
*/
@ResponseStatus(code = HttpStatus.BAD_REQUEST)
@ExceptionHandler(value = {BindException.class, ValidationException.class, MethodArgumentNotValidException.class})
public ResponseData handleParameterVerificationException(Exception e) {
String msg = null;
/// BindException
if (e instanceof BindException) {
// getFieldError獲取的是第一個不合法的參數(shù)(P.S.如果有多個參數(shù)不合法的話)
FieldError fieldError = ((BindException) e).getFieldError();
if (fieldError != null) {
msg = fieldError.getDefaultMessage();
}
/// MethodArgumentNotValidException
} else if (e instanceof MethodArgumentNotValidException) {
BindingResult bindingResult = ((MethodArgumentNotValidException) e).getBindingResult();
// getFieldError獲取的是第一個不合法的參數(shù)(P.S.如果有多個參數(shù)不合法的話)
FieldError fieldError = bindingResult.getFieldError();
if (fieldError != null) {
msg = fieldError.getDefaultMessage();
}
/// ValidationException 的子類異常ConstraintViolationException
} else if (e instanceof ConstraintViolationException) {
/*
* ConstraintViolationException的e.getMessage()形如
* {方法名}.{參數(shù)名}: {message}
* 這里只需要取后面的message即可
*/
msg = e.getMessage();
if (msg != null) {
int lastIndex = msg.lastIndexOf(':');
if (lastIndex >= 0) {
msg = msg.substring(lastIndex + 1).trim();
}
}
/// ValidationException 的其它子類異常
} else {
msg = "處理參數(shù)時異常";
}
ResponseData responseData = new ResponseData(400, msg);
return responseData;
}
@ExceptionHandler
@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
public ResponseData handleException(Exception ex){
if (ex instanceof DataIntegrityViolationException) { // 數(shù)據(jù)庫操作異常
if(ex.toString().contains("a foreign key constraint fails")){ //外鍵關(guān)聯(lián)問題喇澡，具體前端可以根據(jù)發(fā)送的請求判斷
return new ResponseData(5001, "a foreign key constraint fails");
}
}
return new ResponseData(500, "Internal Server Error");
}
}
這里我寫了兩個方法，一個是專門處理參數(shù)校驗異常的殊校，我把它定義為BadRequest一類的返回晴玖，我主要考慮了三種參數(shù)異常的捕獲，例如前面的結(jié)果为流，就是BindException呕屎，在未加BindResult的處理之前，我們可以從控制臺打印的日志看出敬察。
其實這個就是當(dāng)參數(shù)為Java bean且傳參方式為RequestParam就是直接在url地址上傳參的方式時校驗會返回的異常秀睛。
而第二種MethodArgumentNotValidException則是同樣參數(shù)為Java bean但是傳參方式為@RequestBody且applicationType為application/json的時候校驗會返回的異常，我們可以試一下
而第三種ConstraintViolationException呢莲祸，則是參數(shù)為普通類型的直接在參數(shù)前加校驗條件的異常返回類型蹂安。例如在findSubjects的參數(shù)上加上校驗
@GetMapping(value = "/subjects")
public ResponseDataNew<ListWithPageData<Subject>> findSubjects(final String name, @Min(value = 0, message = "頁碼不能小于0")final Integer index, final Integer size){
Page<Subject> page = PageHelper.startPage(index + 1, size);
List<Subject> subjectList = subjectMapper.findSubjects(name);
ResponseDataNew<ListWithPageData<Subject>> response = new ResponseDataNew<>();
response.ok();
ListWithPageData<Subject> data = new ListWithPageData<>();
data.setPageCount(page.getPages());
data.setTotal(page.getTotal());
data.setList(subjectList);
response.setData(data);
return response;
}
這里還涉及到@Validated的另一個用法椭迎，就是加在類上的注解，只有這樣
@RestController
@RequestMapping(value = "/subject")
@Validated
public class SubjectController {
...
}
直接加在參數(shù)前的校驗注解才會有用田盈。傳入index為-1時就會拋出這個異常
另外我還寫了一個方法用來捕獲其他類型的異常畜号，比如這個外鍵關(guān)聯(lián)的異常。@ExceptionHandler這個注解就是可以指定捕獲的Exception的類型允瞧，如果沒有指定简软，那么就會捕獲任意類型。
此外瓷式，@Validated還支持分組替饿，比如當(dāng)我們新建一條數(shù)據(jù)時，id是必然為空的贸典，而更新數(shù)據(jù)時视卢，id又必須不為空，這時就可以用到這個廊驼。
（1）首先据过，我們在entity包中分別建兩個接口Insert和Update
public interface Insert extends Default {
}
public interface Update extends Default {
}
（2）接著，以Subject為例妒挎，需要在id上加兩組注解
@Schema(example = "1")
@Null(groups = {Insert.class})
@NotNull(groups = {Update.class}, message="id不能為空")
private Long id;
（3）分別在新增和更新的接口上加上對應(yīng)的注解绳锅，如下
@PostMapping(value = "/addSubject", consumes = { "application/x-www-form-urlencoded" })
public ResponseData addSubject(@Validated(value = Insert.class) Subject subject){
subjectMapper.insertSubject(subject.getName());
ResponseData responseData = ResponseData.ok();
return responseData;
}
@PostMapping(value = "/editSubject", consumes = { "application/x-www-form-urlencoded" })
public ResponseData editSubject(@Validated(value = Update.class) Subject subject)
{
subjectMapper.updateSubject(subject.getId(), subject.getName());
ResponseData responseData = ResponseData.ok();
return responseData;
}
但是這樣加完會有個問題，就是在swagger上酝掩，我們會發(fā)現(xiàn)addSubject的接口id的參數(shù)仍然是required的鳞芙，這似乎是一個bug。而用Postman測試期虾，結(jié)果則是正常的
不過原朝，我也試了一下，如果把傳參方式改為@RequestBody就是application/json的話也可以解決這個問題镶苞。
需要注意的是@Valid是不支持這樣分組的喳坠，這是這兩個注解其中一個差異。
@Validated和@Valid還有一個差異在于@Valid支持嵌套校驗茂蚓、而@Validated不支持壕鹉。這是什么意思呢？比如我需要做一個批量新增的功能聋涨，所以我傳參的時候會傳一個list晾浴，就像這樣
@PostMapping(value = "/addSubjects")
public ResponseData addSubjects(@Validated(value = Insert.class) @RequestBody List<Subject> subjects){
subjectMapper.insertSubjects(subjects);
ResponseData responseData = ResponseData.ok();
return responseData;
}
但是這時候我們加的這個@Validated的注解會發(fā)現(xiàn)是不起作用的，就是因為它不支持嵌套牍白，而要驗證的對象包在List中脊凰。這時我們只能把它改為@Valid，分組也就沒辦法使用了淹朋。還要注意的是同樣要在SubjectController類上加了@Validated注解才有用笙各。
不過也還有一種方法可以同時解決這兩個問題，就是自定義實現(xiàn)一個List ValidatedList础芍，這個方法的話可以參考使用@Validated校驗List接口參數(shù)的兩種方式這篇博客杈抢。
最后再說一下的是，validation還支持自定義的校驗仑性，這個也可以參考SpringBoot使用Validation校驗參數(shù)這篇博客惶楼，我這里也就不再詳細(xì)說明了。
代碼依舊可以參考我在github上面的代碼https://github.com/ahuadoreen/studentmanager诊杆。
參考文檔
SpringBoot使用Validation校驗參數(shù)
Spring 參數(shù)校驗的異常處理
使用@Validated校驗List接口參數(shù)的兩種方式
