基于自定義校驗注解(controller、method、(groups)分組的使用)

更新時間：2021年10月20日 10:29:46 作者：子書少卿

這篇文章主要介紹了基于自定義校驗注解(controller、method、(groups)分組的使用)，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教

1、首先創(chuàng)建兩個自定義校驗注解類

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;
 
/**
 * 自定義校驗注解
 */
@Constraint(validatedBy = {Name.NameUtil.class})
@Documented
@Retention(RUNTIME)
@Target({ElementType.ANNOTATION_TYPE, METHOD, ElementType.FIELD})
public @interface Name {
 
//     真坑,以下三個參數(shù)的名稱必須為這三個，不能為其他
    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.*;
 
/**
 * 自定義校驗注解
 */
@Constraint(validatedBy = {Sex.SexUtil.class})
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD, ElementType.FIELD})
public @interface Sex {
 
    //     真坑,以下三個參數(shù)的名稱必須為這三個，不能為其他
    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;
            }
        }
    }
}

實體bean

注意

@Valid在復(fù)雜類型上使用

如果bean該類包含具有其他復(fù)雜類型的字段，該字段應(yīng)進(jì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、校驗注解的使用

（spring、validation下的可以用觸發(fā)器；hibernate下的拋出異常）

1>、controller中的使用

    @RequestMapping(value = "/pAnnotation",method = RequestMethod.GET,produces = "application/json;charset=UTF-8")
    @ApiOperation(value = "測試自定義校驗注解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("沒有報錯");
        }
    }

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í)行驗證
//            Set<ConstraintViolation<T>> constraintViolations = validator.validate(t);
//            //打印校驗信息
//            if (!CollectionUtils.isEmpty(constraintViolations)) {
//                for (ConstraintViolation<T> constraintViolation : constraintViolations) {
//                    System.out.println(constraintViolation.getPropertyPath().toString() + ": " + constraintViolation.getMessage());
//                }
//            }
//    }
    ----------------------------寫法一 end------------------------------
//    ----------------------------寫法二 start------------------------------
//    當(dāng)Spring實例化此服務(wù)時，它將自動將一個Validator實例注入構(gòu)造函數(shù)。
//    此種寫法更優(yōu)秀
    private Validator validator;
 
    AnnotationCheck(Validator validator) {
        this.validator = validator;
    }
    public void checkAnnotation(T t){
 
            //執(zhí)行驗證
            Set<ConstraintViolation<T>> constraintViolations = validator.validate(t);
            //打印校驗信息
            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的使用

定義兩個空接口，分別代表E對象的增加校驗規(guī)則和修改校驗規(guī)則

/**
 * 可以在一個Model上面添加多套參數(shù)驗證規(guī)則，此接口定義添加Person模型新增時的參數(shù)校驗規(guī)則
 */
public interface CreateAction {
}
/**
 * 可以在一個Model上面添加多套參數(shù)驗證規(guī)則，此接口定義添加Person模型修改時的參數(shù)校驗規(guī)則
 */
public interface UpdateAction {
}

修改實體中的注解

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)建時姓名必須為小黑2"),
            @Name(groups = UpdateAction.class ,message = "修改時姓名必須為小黑2")
    })
    @NotNull
    private String name;
    private String age;
    @NotNull
    private String sex;
}

使用：此時只會對標(biāo)注了‘CreateAction.classd的注解生效，

1、controller

 @RequestMapping(value = "/pAnnotation3",method = RequestMethod.GET,produces = "application/json;charset=UTF-8")
    @ApiOperation(value = "測試自定義校驗注解-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("沒有報錯");
        }
    }

結(jié)果

創(chuàng)建時姓名必須為小黑2

2、method

  @RequestMapping(value = "/pAnnotation5",method = RequestMethod.GET,produces = "application/json;charset=UTF-8")
    @ApiOperation(value = "測試自定義校驗注解-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) {
// 沒有錯誤時的操作 TODO
        log.info("validateInCreate:{}", beanGroup);
        return "25347sfef";
    }
 
    @Validated(UpdateAction.class)
    public void validateInUpdate(@Valid E beanGroup) {
        log.info("validateInUpdate:{}", beanGroup);
    }
}

結(jié)果，異常拋出獲取

創(chuàng)建時姓名必須為小黑2

單個注解用在方法上（@Validated--以異常形式拋出）

---在業(yè)務(wù)上不太建議使用

1、實例化MethodValidationPostProcessor

@Bean
    public MethodValidationPostProcessor methodValidationPostProcessor() {
        return new MethodValidationPostProcessor();
    }

2、在所要實現(xiàn)方法參數(shù)校驗的類上面添加@Validated

如下---不需要的時候記得去掉，會影響方法上的注解

@RestController
@Validated
public class ValidateController {
}

3、在方法上面添加校驗規(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ù)校驗失敗,spring 框架就回拋出異常，可以使用統(tǒng)一異常處理來處理（ExceptionResolver）---各個框架拋出的異常不一致

{
  "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錯誤，其他組件的注解是ConstraintViolationException

注意，我們必須@Validated在類級別將Spring的注釋添加到控制器，以告訴Spring評估方法參數(shù)上的約束注釋。

該@Validated注解只計算在這種情況下，一流的水平，即使它允許在使用方法（我們將了解它為什么在方法層面討論時允許確認(rèn)團組更高版本）。

與請求正文驗證相反，驗證失敗將觸發(fā)ConstraintViolationException 而不是MethodArgumentNotValidException。Spring沒有為此異常注冊默認(rèn)的異常處理程序，因此默認(rèn)情況下它將導(dǎo)致HTTP狀態(tài)為500（內(nèi)部服務(wù)器錯誤）的響應(yīng)。

如果我們想返回一個HTTP狀態(tài)400（這很有意義，因為客戶端提供了一個無效的參數(shù)，這使它成為一個錯誤的請求），我們可以向contoller中添加一個自定義的異常處理程序：來統(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提供的校驗注解：

@Null：被注釋的元素必須為 null
@NotNull：被注釋的元素必須不為 null
@AssertTrue：被注釋的元素必須為 true
@AssertFalse：被注釋的元素必須為 false
@Min(value)：被注釋的元素必須是一個數(shù)字，其值必須大于等于指定的最小值
@Max(value)：被注釋的元素必須是一個數(shù)字，其值必須小于等于指定的最大值
@DecimalMin(value)：被注釋的元素必須是一個數(shù)字，其值必須大于等于指定的最小值
@DecimalMax(value)：被注釋的元素必須是一個數(shù)字，其值必須小于等于指定的最大值
@Size(max=, min=)：被注釋的元素的大小必須在指定的范圍內(nèi)
@Digits (integer, fraction)：被注釋的元素必須是一個數(shù)字，其值必須在可接受的范圍內(nèi)
@Past：被注釋的元素必須是一個過去的日期
@Future：被注釋的元素必須是一個將來的日期
@Pattern(regex=,flag=)：被注釋的元素必須符合指定的正則表達(dá)式

Hibernate Validator提供的校驗注解：

@NotBlank(message =)：驗證字符串非null，且trim后長度必須大于0
@Email：被注釋的元素必須是電子郵箱地址
@Length(min=,max=)：被注釋的字符串的大小必須在指定的范圍內(nèi)
@NotEmpty：被注釋的字符串的必須非空
@Range(min=,max=,message=)：被注釋的元素必須在合適的范圍內(nèi)

以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。

您可能感興趣的文章:

欧美bbbwbbbw肥妇,免费乱码人妻系列日韩,一级黄片

軟件下載

源碼下載

軟件編程

網(wǎng)絡(luò)編程

在線工具

數(shù)據(jù)庫

CMS

常用工具

基于自定義校驗注解(controller、method、(groups)分組的使用)

目錄

1、首先創(chuàng)建兩個自定義校驗注解類

2、校驗注解的使用

1>、controller中的使用

2>、方法中觸發(fā)注解

3>、分組groups的使用

單個注解用在方法上（@Validated--以異常形式拋出）

1、實例化MethodValidationPostProcessor

2、在所要實現(xiàn)方法參數(shù)校驗的類上面添加@Validated

3、在方法上面添加校驗規(guī)則

相關(guān)文章

最新評論

大家感興趣的內(nèi)容

最近更新的內(nèi)容

常用在線小工具

基于自定義校驗注解(controller、method、(groups)分組的使用)

目錄

1、首先創(chuàng)建兩個自定義校驗注解類

2、校驗注解的使用

1>、controller中的使用

2>、方法中觸發(fā)注解

3>、分組groups的使用

單個注解用在方法上（@Validated--以異常形式拋出）

1、實例化MethodValidationPostProcessor

2、在所要實現(xiàn)方法參數(shù)校驗的類上面添加@Validated

3、在方法上面添加校驗規(guī)則

相關(guān)文章

最新評論

大家感興趣的內(nèi)容

最近更新的內(nèi)容

常用在線小工具

基于自定義校驗注解(controller、method、(groups)分組的使用)

1、首先創(chuàng)建兩個自定義校驗注解類

2、校驗注解的使用

1>、controller中的使用

2>、方法中觸發(fā)注解

3>、分組groups的使用

1、實例化MethodValidationPostProcessor

2、在所要實現(xiàn)方法參數(shù)校驗的類上面添加@Validated

3、在方法上面添加校驗規(guī)則