基于自定義校驗(yàn)注解(controller、method、(groups)分組的使用)
更新時(shí)間：2021年10月20日 10:29:46 作者：子書少卿
這篇文章主要介紹了基于自定義校驗(yàn)注解(controller、method、(groups)分組的使用)，具有很好的參考價(jià)值，希望對大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教
1、首先創(chuàng)建兩個(gè)自定義校驗(yàn)注解類
package com.example.demo.annotation;
import com.example.demo.interface2.CreateAction;
import javax.validation.Constraint;
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import javax.validation.Payload;
import java.lang.annotation.*;
import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
/**
* 自定義校驗(yàn)注解
*/
@Constraint(validatedBy = {Name.NameUtil.class})
@Documented
@Retention(RUNTIME)
@Target({ElementType.ANNOTATION_TYPE, METHOD, ElementType.FIELD})
public @interface Name {
// 真坑,以下三個(gè)參數(shù)的名稱必須為這三個(gè)，不能為其他
String message() default "姓名必須為小黑";
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER})
@Retention(RUNTIME)
@Documented
@interface List{
Name [] value();
}
class NameUtil implements ConstraintValidator<Name,String>, CreateAction {
@Override
public void initialize(Name constraintAnnotation) {
// TODO 可以用以初始化數(shù)據(jù)
}
@Override
public boolean isValid(String s, ConstraintValidatorContext constraintValidatorContext) {
if("小黑".equals(s)){
return true;
}else{
return false;
}
}
}
}
package com.example.demo.annotation;
import javax.validation.Constraint;
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import javax.validation.Payload;
import java.lang.annotation.*;
/**
* 自定義校驗(yàn)注解
*/
@Constraint(validatedBy = {Sex.SexUtil.class})
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD, ElementType.FIELD})
public @interface Sex {
// 真坑,以下三個(gè)參數(shù)的名稱必須為這三個(gè)，不能為其他
String message() default "性別必須為女";
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
class SexUtil implements ConstraintValidator<Sex, Object> {
@Override
public void initialize(Sex constraintAnnotation) {
// TODO 可以用以初始化數(shù)據(jù)
}
@Override
public boolean isValid(Object s, ConstraintValidatorContext constraintValidatorContext) {
// System.out.println(s.toString());
// System.out.println(s.getClass().getName());
if("女".equals(s)){
return true;
}else{
return false;
}
}
}
}
實(shí)體bean
注意
@Valid在復(fù)雜類型上使用
如果bean該類包含具有其他復(fù)雜類型的字段，該字段應(yīng)進(jìn)行驗(yàn)證，則該字段也需要使用注釋@Valid，復(fù)雜類型（對象）中的字段也需要注釋@Valid
package com.example.demo.entity;
import com.example.demo.annotation.Name;
import com.example.demo.annotation.Sex;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import javax.validation.constraints.NotNull;
@Data
@NoArgsConstructor
@AllArgsConstructor
@Sex(message = "性別必須為女2")
public class E {
private int id;
@Name(message = "姓名必須為小黑2")
@NotNull
private String name;
private String age;
@NotNull
private String sex;
}
2、校驗(yàn)注解的使用
（spring、validation下的可以用觸發(fā)器；hibernate下的拋出異常）
1>、controller中的使用
@RequestMapping(value = "/pAnnotation",method = RequestMethod.GET,produces = "application/json;charset=UTF-8")
@ApiOperation(value = "測試自定義校驗(yàn)注解controller層")
public void pAnnotation(@Valid E e ,BindingResult bindingResult){
p1.pAnnotation(e,bindingResult);
}
public void pAnnotation(E e , BindingResult bindingResult) {
if (bindingResult.hasErrors()){
bindingResult.getAllErrors().forEach(s-> {
System.out.println(s.getDefaultMessage());
});
}else{
System.out.println("沒有報(bào)錯(cuò)");
}
}
2>、方法中觸發(fā)注解
package com.example.demo.util;
import com.example.demo.interface2.CreateAction;
import com.example.demo.interface2.UpdateAction;
import org.springframework.stereotype.Component;
import org.springframework.util.CollectionUtils;
import org.springframework.validation.annotation.Validated;
import javax.validation.ConstraintViolation;
import javax.validation.Validation;
import javax.validation.Validator;
import java.util.Set;
@Component
public class AnnotationCheck<T> {
----------------------------寫法一 start------------------------------
// private static Validator validator = Validation.buildDefaultValidatorFactory().getValidator();
//
// public void checkAnnotation(T t){
//
// //執(zhí)行驗(yàn)證
// Set<ConstraintViolation<T>> constraintViolations = validator.validate(t);
// //打印校驗(yàn)信息
// if (!CollectionUtils.isEmpty(constraintViolations)) {
// for (ConstraintViolation<T> constraintViolation : constraintViolations) {
// System.out.println(constraintViolation.getPropertyPath().toString() + ": " + constraintViolation.getMessage());
// }
// }
// }
----------------------------寫法一 end------------------------------
// ----------------------------寫法二 start------------------------------
// 當(dāng)Spring實(shí)例化此服務(wù)時(shí)，它將自動(dòng)將一個(gè)Validator實(shí)例注入構(gòu)造函數(shù)。
// 此種寫法更優(yōu)秀
private Validator validator;
AnnotationCheck(Validator validator) {
this.validator = validator;
}
public void checkAnnotation(T t){
//執(zhí)行驗(yàn)證
Set<ConstraintViolation<T>> constraintViolations = validator.validate(t);
//打印校驗(yàn)信息
if (!CollectionUtils.isEmpty(constraintViolations)) {
for (ConstraintViolation<T> constraintViolation : constraintViolations) {
System.out.println(constraintViolation.getPropertyPath().toString() + ": " + constraintViolation.getMessage());
}
}
}
// ----------------------------寫法二 end------------------------------
}
調(diào)用：
annotationCheck.checkAnnotation(e);
3>、分組groups的使用
定義兩個(gè)空接口，分別代表E對象的增加校驗(yàn)規(guī)則和修改校驗(yàn)規(guī)則
/**
* 可以在一個(gè)Model上面添加多套參數(shù)驗(yàn)證規(guī)則，此接口定義添加Person模型新增時(shí)的參數(shù)校驗(yàn)規(guī)則
*/
public interface CreateAction {
}
/**
* 可以在一個(gè)Model上面添加多套參數(shù)驗(yàn)證規(guī)則，此接口定義添加Person模型修改時(shí)的參數(shù)校驗(yàn)規(guī)則
*/
public interface UpdateAction {
}
修改實(shí)體中的注解
package com.example.demo.entity;
import com.example.demo.annotation.Name;
import com.example.demo.annotation.Sex;
import com.example.demo.interface2.CreateAction;
import com.example.demo.interface2.UpdateAction;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import javax.validation.constraints.NotNull;
@Data
@NoArgsConstructor
@AllArgsConstructor
@Sex(message = "性別必須為女2")
public class E {
private int id;
@Name.List({
@Name(groups = CreateAction.class ,message = "創(chuàng)建時(shí)姓名必須為小黑2"),
@Name(groups = UpdateAction.class ,message = "修改時(shí)姓名必須為小黑2")
})
@NotNull
private String name;
private String age;
@NotNull
private String sex;
}
使用：此時(shí)只會(huì)對標(biāo)注了‘CreateAction.classd的注解生效，
1、controller
@RequestMapping(value = "/pAnnotation3",method = RequestMethod.GET,produces = "application/json;charset=UTF-8")
@ApiOperation(value = "測試自定義校驗(yàn)注解-groups分組")
public void pAnnotation3( @Validated({CreateAction.class}) E e,BindingResult bindingResult){
if (bindingResult.hasErrors()){
bindingResult.getAllErrors().forEach(s-> {
System.out.println(s.getDefaultMessage());
});
}else{
System.out.println("沒有報(bào)錯(cuò)");
}
}
結(jié)果
創(chuàng)建時(shí)姓名必須為小黑2
2、method
@RequestMapping(value = "/pAnnotation5",method = RequestMethod.GET,produces = "application/json;charset=UTF-8")
@ApiOperation(value = "測試自定義校驗(yàn)注解-groups分組-方法")
public String pAnnotation5( E e){
return p1.pAnnotation3(e);
}
public String pAnnotation3(E e) {
// try {
beanGroupService.validateInCreate(e);
// annotationCheck.checkAnnotation(e);
// }catch (Exception ee){
// System.out.println(ee.toString());
// }
return "qqqq";
// annotationCheck.checkAnnotation(e);
}
package com.example.demo.service;
import com.example.demo.annotation.Name;
import com.example.demo.entity.E;
import com.example.demo.interface2.CreateAction;
import com.example.demo.interface2.UpdateAction;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Service;
import org.springframework.validation.annotation.Validated;
import javax.validation.Valid;
@Validated
@Service
@Slf4j
public class BeanGroupService {
@Validated(CreateAction.class)
public String validateInCreate(@Valid E beanGroup) {
// 沒有錯(cuò)誤時(shí)的操作 TODO
log.info("validateInCreate:{}", beanGroup);
return "25347sfef";
}
@Validated(UpdateAction.class)
public void validateInUpdate(@Valid E beanGroup) {
log.info("validateInUpdate:{}", beanGroup);
}
}
結(jié)果，異常拋出獲取
創(chuàng)建時(shí)姓名必須為小黑2
單個(gè)注解用在方法上（@Validated--以異常形式拋出）
---在業(yè)務(wù)上不太建議使用
1、實(shí)例化MethodValidationPostProcessor
@Bean
public MethodValidationPostProcessor methodValidationPostProcessor() {
return new MethodValidationPostProcessor();
}
2、在所要實(shí)現(xiàn)方法參數(shù)校驗(yàn)的類上面添加@Validated
如下---不需要的時(shí)候記得去掉，會(huì)影響方法上的注解
@RestController
@Validated
public class ValidateController {
}
3、在方法上面添加校驗(yàn)規(guī)則
@RequestMapping(value = "/test", method = RequestMethod.GET)
public String paramCheck(@Length(min = 10) @RequestParam String name) {
System.out.println(name);
return null;
}
當(dāng)（不管是controller層還是service層的）方法上面的參數(shù)校驗(yàn)失敗,spring 框架就回拋出異常，可以使用統(tǒng)一異常處理來處理（ExceptionResolver）---各個(gè)框架拋出的異常不一致
{
"timestamp": "2020-05-07T11:51:00.141+0000",
"status": 500,
"error": "Internal Server Error",
"message": "An Errors/BindingResult argument is expected to be declared immediately after the model attribute, the @RequestBody or the @RequestPart arguments to which they apply: public void com.example.demo.controller.PracticeController.pAnnotation4(java.lang.String,org.springframework.validation.BindingResult)",
"path": "/practice/pAnnotation4"
}
自定義注解是BindException錯(cuò)誤，其他組件的注解是ConstraintViolationException
注意，我們必須@Validated在類級(jí)別將Spring的注釋添加到控制器，以告訴Spring評(píng)估方法參數(shù)上的約束注釋。
該@Validated注解只計(jì)算在這種情況下，一流的水平，即使它允許在使用方法（我們將了解它為什么在方法層面討論時(shí)允許確認(rèn)團(tuán)組更高版本）。
與請求正文驗(yàn)證相反，驗(yàn)證失敗將觸發(fā)ConstraintViolationException 而不是MethodArgumentNotValidException。Spring沒有為此異常注冊默認(rèn)的異常處理程序，因此默認(rèn)情況下它將導(dǎo)致HTTP狀態(tài)為500（內(nèi)部服務(wù)器錯(cuò)誤）的響應(yīng)。
如果我們想返回一個(gè)HTTP狀態(tài)400（這很有意義，因?yàn)榭蛻舳颂峁┝艘粋€(gè)無效的參數(shù)，這使它成為一個(gè)錯(cuò)誤的請求），我們可以向contoller中添加一個(gè)自定義的異常處理程序：來統(tǒng)一處理特定異常
可以用作統(tǒng)一處理注解信息的統(tǒng)一方式
@RestController
@Validated
class ValidateParametersController {
// request mapping method omitted
@ExceptionHandler(ConstraintViolationException.class)
@ResponseStatus(HttpStatus.BAD_REQUEST)
ResponseEntity<String> handleConstraintViolationException(ConstraintViolationException e) {
return new ResponseEntity<>("not valid due to validation error: " + e.getMessage(), HttpStatus.BAD_REQUEST);
}
}
其他的一些注解
<!--jsr 303--> <dependency> <groupId>javax.validation</groupId> <artifactId>validation-api</artifactId> <version>1.1.0.Final</version> </dependency> <!-- hibernate validator--> <dependency> <groupId>org.hibernate</groupId> <artifactId>hibernate-validator</artifactId> <version>5.2.0.Final</version> </dependency>
JSR提供的校驗(yàn)注解：
@Null：被注釋的元素必須為 null@NotNull：被注釋的元素必須不為 null@AssertTrue：被注釋的元素必須為 true@AssertFalse：被注釋的元素必須為 false@Min(value)：被注釋的元素必須是一個(gè)數(shù)字，其值必須大于等于指定的最小值@Max(value)：被注釋的元素必須是一個(gè)數(shù)字，其值必須小于等于指定的最大值@DecimalMin(value)：被注釋的元素必須是一個(gè)數(shù)字，其值必須大于等于指定的最小值@DecimalMax(value)：被注釋的元素必須是一個(gè)數(shù)字，其值必須小于等于指定的最大值@Size(max=, min=)：被注釋的元素的大小必須在指定的范圍內(nèi)@Digits (integer, fraction)：被注釋的元素必須是一個(gè)數(shù)字，其值必須在可接受的范圍內(nèi)@Past：被注釋的元素必須是一個(gè)過去的日期@Future：被注釋的元素必須是一個(gè)將來的日期@Pattern(regex=,flag=)：被注釋的元素必須符合指定的正則表達(dá)式
Hibernate Validator提供的校驗(yàn)注解：
@NotBlank(message =)：驗(yàn)證字符串非null，且trim后長度必須大于0@Email：被注釋的元素必須是電子郵箱地址@Length(min=,max=)：被注釋的字符串的大小必須在指定的范圍內(nèi)@NotEmpty：被注釋的字符串的必須非空@Range(min=,max=,message=)：被注釋的元素必須在合適的范圍內(nèi)
以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。
相關(guān)文章
在SpringBoot中如何利用Redis實(shí)現(xiàn)互斥鎖
當(dāng)我們利用Redis存儲(chǔ)熱點(diǎn)數(shù)據(jù)時(shí),突然就過期失效或者被刪除了,導(dǎo)致大量請求同時(shí)訪問數(shù)據(jù)庫,增加了數(shù)據(jù)庫的負(fù)載,為減輕數(shù)據(jù)庫的負(fù)載我們利用互斥鎖,本文重點(diǎn)介紹在SpringBoot中如何利用Redis實(shí)現(xiàn)互斥鎖,感興趣的朋友一起看看吧2023-09-09
Java調(diào)用dll文件的實(shí)現(xiàn)解析
這篇文章主要介紹了Java調(diào)用dll文件的實(shí)現(xiàn)解析，具有很好的參考價(jià)值，希望對大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2022-02-02
這篇文章主要介紹了Java?Map雙列集合使用,使你的代碼更高效,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-12-12
Spring 中如何根據(jù)環(huán)境切換配置 @Profile
這篇文章主要介紹了Spring中如何根據(jù)環(huán)境切換配置@Profile的操作，具有很好的參考價(jià)值，希望對大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2021-08-08
三分鐘帶你掌握J(rèn)ava開發(fā)圖片驗(yàn)證碼功能方法
這篇文章主要來為大家詳細(xì)介紹Java實(shí)現(xiàn)開發(fā)圖片驗(yàn)證碼的具體方法，文中的示例代碼講解詳細(xì)，具有一定的借鑒價(jià)值，需要的可以參考一下2023-02-02
本文主要介紹了java8中@Contended注解的使用，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2023-07-07
Java手動(dòng)創(chuàng)建線程池代碼實(shí)例
這篇文章主要介紹了Java手動(dòng)創(chuàng)建線程池代碼實(shí)例,FixedThreadPool或者SingleThreadPool,允許的請求隊(duì)列長度為Integer.MAX_VALUE,可能會(huì)堆積大量的請求,從而導(dǎo)致OOM,需要的朋友可以參考下2023-12-12
解決沒有@RunWith 和 @SpringBootTest注解或失效問題
這篇文章主要介紹了解決沒有@RunWith 和 @SpringBootTest注解或失效問題，具有很好的參考價(jià)值，希望對大家有所幫助。一起跟隨小編過來看看吧2020-04-04
這篇文章主要介紹了Java中的@Accessors使用詳解,@RequiredArgsConstructor是Lombok的一個(gè)注解,簡化了我們對setter和getter方法操作,它可以作用在類上,也可以作用在類的單個(gè)屬性上,需要的朋友可以參考下2024-01-01
這篇文章主要介紹了淺談mac下maven的安裝配置與使用，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-07-07