Erstellen benutzerdefinierter Anmerkungen zur Validierung in Spring Boot

Erstellen benutzerdefinierter Anmerkungen zur Validierung in Spring Boot

1. Übersicht

Während Spring-Standardanmerkungen (@NotBlank, @NotNull, @Min, @Size usw.) viele Anwendungsfälle bei der Validierung von Benutzereingaben abdecken, gibt es Zeiten, in denen wir eine benutzerdefinierte Validierungslogik für einen spezifischeren Eingabetyp erstellen müssen . In diesem Artikel werde ich zeigen, wie man benutzerdefinierte Anmerkungen zur Validierung erstellt.

2. Einrichtung

Wir müssen die Spring-Boot-Starter-Validation-Abhängigkeit zu unserer pom.xml-Datei hinzufügen.

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

3. Validierung auf benutzerdefinierter Feldebene

3.1 Annotation erstellen

Lassen Sie uns benutzerdefinierte Anmerkungen erstellen, um Dateiattribute wie Dateierweiterung, Dateigröße und MIME-Typ zu validieren.

• Gültige Dateierweiterung

@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 {};
}

• ValidFileMaxSize

@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 {};
}

• FileMimeTypeValidator

@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 {};
}

Lassen Sie uns die Komponenten dieser Anmerkungen aufschlüsseln:

• @Constraint: Gibt die Validatorklasse an, die für die Validierungslogik verantwortlich ist.
• @Target({ElementType.FIELD}): Gibt an, dass diese Annotation nur auf Felder angewendet werden kann.
• message(): Die Standardfehlermeldung, wenn die Validierung fehlschlägt.

3.2 Erstellen des Validators

• FileExtensionValidator

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());
    }
}

• FileMaxSizeValidator

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;
    }
}

• FileMimeTypeValidator

@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);
    }
}

Diese Klassen sind Implementierungen der ConstraintValidator-Schnittstelle und enthalten die eigentliche Validierungslogik.
Für FileMimeTypeValidator verwenden wir Apache Tika (ein Toolkit zum Extrahieren von Metadaten und Inhalten aus zahlreichen Dokumenttypen).

3.3 Anwenden der Anmerkung

Lassen Sie uns eine TestUploadRequest-Klasse erstellen, die für die Verarbeitung von Datei-Uploads gedacht ist, insbesondere für eine PDF-Datei.

@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");
    }
}

• @Target({ElementType.TYPE}): Gibt an, dass diese Annotation auf eine Typdeklaration abzielt.

4. Benutzerdefinierte Validierung auf Klassenebene

Eine benutzerdefinierte Validierungsanmerkung kann auch auf Klassenebene definiert werden, um eine Kombination von Feldern innerhalb einer Klasse zu validieren.

4.1 Annotation erstellen

Lassen Sie uns die Annotation @PasswordMatches erstellen, um sicherzustellen, dass zwei Passwortfelder in einer Klasse übereinstimmen.

@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 {};
}

4.2 Erstellen des Validators

• PasswortDto

public interface PasswordDto {
    String getPassword();

    String getConfirmPassword();
}

• PasswordMatchesValidator

public class PasswordMatchesValidator implements ConstraintValidator<PasswordMatches, PasswordDto> {

    @Override
    public boolean isValid(PasswordDto password, ConstraintValidatorContext constraintValidatorContext) {
        return StringUtils.equals(password.getPassword(), password.getConfirmPassword());
    }
}

Die PasswordDto-Schnittstelle ist eine Schnittstelle für Objekte, die ein Passwort und ein Feld zur Passwortbestätigung enthalten.
Die Klasse „PasswordMatchesValidator“ implementiert die Schnittstelle „ConstraintValidator“ und enthält die Logik zur Überprüfung, ob die Felder „Passwort“ und „Passwort bestätigen“ übereinstimmen.

4.3 Anwenden der Anmerkung

Lassen Sie uns eine RegisterAccountRequest-Klasse erstellen, die für die Verarbeitung von Benutzerregistrierungsdaten vorgesehen ist.

@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");
    }
}

5. Zusammenfassung

In diesem kurzen Artikel haben wir herausgefunden, wie einfach es ist, benutzerdefinierte Anmerkungen zu erstellen, um ein Feld oder eine Klasse zu überprüfen. Der Code aus diesem Artikel ist auf meinem Github verfügbar.

• spring-boot-microservices
• Benutzerservice

6. Referenzen

• Baeldung. (o.J.). Benutzerdefinierter Spring MVC-Validator. Abgerufen von https://www.baeldung.com/spring-mvc-custom-validator

Das obige ist der detaillierte Inhalt vonErstellen benutzerdefinierter Anmerkungen zur Validierung in Spring Boot. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!