Walaupun anotasi standard Spring (@NotBlank, @NotNull, @Min, @Size, dll.) merangkumi banyak kes penggunaan semasa mengesahkan input pengguna, ada kalanya kita perlu mencipta logik pengesahan tersuai untuk jenis input yang lebih khusus . Dalam artikel ini, saya akan menunjukkan cara membuat anotasi tersuai untuk pengesahan.
Kami perlu menambah kebergantungan spring-boot-starter-validation pada fail pom.xml kami.
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-validation</artifactId> </dependency>
Mari kita buat anotasi tersuai untuk mengesahkan atribut fail, seperti sambungan fail, saiz fail dan jenis MIME.
@Target({ElementType.FIELD}) @Retention(RetentionPolicy.RUNTIME) @Documented @Constraint( validatedBy = {FileExtensionValidator.class} ) public @interface ValidFileExtension { String[] extensions() default {}; String message() default "{constraints.ValidFileExtension.message}"; Class<?>[] groups() default {}; Class<? extends Payload>[] payload() default {}; }
@Target({ElementType.FIELD}) @Retention(RetentionPolicy.RUNTIME) @Documented @Constraint( validatedBy = {FileMaxSizeValidator.class} ) public @interface ValidFileMaxSize { long maxSize() default Long.MAX_VALUE; // MB String message() default "{constraints.ValidFileMaxSize.message}"; Class<?>[] groups() default {}; Class<? extends Payload>[] payload() default {}; }
@Target({ElementType.FIELD}) @Retention(RetentionPolicy.RUNTIME) @Documented @Constraint( validatedBy = {FileMimeTypeValidator.class} ) public @interface ValidFileMimeType { String[] mimeTypes() default {}; String message() default "{constraints.ValidFileMimeType.message}"; Class<?>[] groups() default {}; Class<? extends Payload>[] payload() default {}; }
Mari kita pecahkan komponen anotasi ini:
public class FileExtensionValidator implements ConstraintValidator<ValidFileExtension, MultipartFile> { private List<String> extensions; @Override public void initialize(ValidFileExtension constraintAnnotation) { extensions = List.of(constraintAnnotation.extensions()); } @Override public boolean isValid(MultipartFile file, ConstraintValidatorContext constraintValidatorContext) { if (file == null || file.isEmpty()) { return true; } var extension = FilenameUtils.getExtension(file.getOriginalFilename()); return StringUtils.isNotBlank(extension) && extensions.contains(extension.toLowerCase()); } }
public class FileMaxSizeValidator implements ConstraintValidator<ValidFileMaxSize, MultipartFile> { private long maxSizeInBytes; @Override public void initialize(ValidFileMaxSize constraintAnnotation) { maxSizeInBytes = constraintAnnotation.maxSize() * 1024 * 1024; } @Override public boolean isValid(MultipartFile file, ConstraintValidatorContext constraintValidatorContext) { return file == null || file.isEmpty() || file.getSize() <= maxSizeInBytes; } }
@RequiredArgsConstructor public class FileMimeTypeValidator implements ConstraintValidator<ValidFileMimeType, MultipartFile> { private final Tika tika; private List<String> mimeTypes; @Override public void initialize(ValidFileMimeType constraintAnnotation) { mimeTypes = List.of(constraintAnnotation.mimeTypes()); } @SneakyThrows @Override public boolean isValid(MultipartFile file, ConstraintValidatorContext constraintValidatorContext) { if (file == null || file.isEmpty()) { return true; } var detect = tika.detect(TikaInputStream.get(file.getInputStream())); return mimeTypes.contains(detect); } }
Kelas ini adalah pelaksanaan antara muka ConstraintValidator dan mengandungi logik pengesahan sebenar.
Untuk FileMimeTypeValidator, kami akan menggunakan Apache Tika (kit alatan yang direka untuk mengekstrak metadata dan kandungan daripada pelbagai jenis dokumen).
Mari buat kelas TestUploadRequest yang bertujuan untuk mengendalikan muat naik fail, khususnya untuk fail PDF.
@Data public class TestUploadRequest { @NotNull @ValidFileMaxSize(maxSize = 10) @ValidFileExtension(extensions = {"pdf"}) @ValidFileMimeType(mimeTypes = {"application/pdf"}) private MultipartFile pdfFile; }
@RestController @Validated @RequestMapping("/test") public class TestController { @PostMapping(value = "/upload", consumes = {MediaType.MULTIPART_FORM_DATA_VALUE}) public ResponseEntity<String> testUpload(@Valid @ModelAttribute TestUploadRequest request) { return ResponseEntity.ok("test upload"); } }
Anotasi pengesahan tersuai juga boleh ditakrifkan pada peringkat kelas untuk mengesahkan gabungan medan dalam kelas.
Mari buat anotasi @PasswordMatches untuk memastikan dua medan kata laluan sepadan dalam satu kelas.
@Target({ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) @Documented @Constraint( validatedBy = {PasswordMatchesValidator.class} ) public @interface PasswordMatches { String message() default "{constraints.PasswordMatches.message}"; Class<?>[] groups() default {}; Class<? extends Payload>[] payload() default {}; }
public interface PasswordDto { String getPassword(); String getConfirmPassword(); }
public class PasswordMatchesValidator implements ConstraintValidator<PasswordMatches, PasswordDto> { @Override public boolean isValid(PasswordDto password, ConstraintValidatorContext constraintValidatorContext) { return StringUtils.equals(password.getPassword(), password.getConfirmPassword()); } }
Antara muka PasswordDto ialah antara muka untuk objek yang mengandungi kata laluan dan medan pengesahan kata laluan.
Kelas PasswordMatchesValidator melaksanakan antara muka ConstraintValidator dan mengandungi logik untuk mengesahkan bahawa kata laluan dan medan pengesahan kata laluan sepadan.
Mari kita buat kelas RegisterAccountRequest yang bertujuan untuk mengendalikan data pendaftaran pengguna.
@PasswordMatches @Data public class RegisterAccountRequest implements PasswordDto { @NotBlank private String username; @NotBlank @Email private String email; @NotBlank @ToString.Exclude private String password; @NotBlank @ToString.Exclude private String confirmPassword; }
@RestController @Validated @RequestMapping("/auth") public class AuthController { @PostMapping("/register") public ResponseEntity<String> register(@RequestBody @Valid RegisterAccountRequest request) { return ResponseEntity.ok("register success"); } }
Dalam artikel pendek ini, kami mendapati betapa mudahnya untuk membuat anotasi tersuai untuk mengesahkan medan atau kelas. Kod daripada artikel ini tersedia di Github saya.
Atas ialah kandungan terperinci Mencipta Anotasi Tersuai untuk Pengesahan dalam But Spring. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!