Spring Boot에서 검증을 위한 사용자 정의 주석 생성

Spring Boot에서 검증을 위한 사용자 정의 주석 생성

1. 개요

Spring 표준 주석(@NotBlank, @NotNull, @Min, @Size 등)은 사용자 입력을 검증할 때 많은 사용 사례를 다루지만, 보다 구체적인 유형의 입력에 대해 사용자 정의 검증 로직을 생성해야 할 때가 있습니다. . 이 기사에서는 유효성 검사를 위한 사용자 정의 주석을 생성하는 방법을 설명합니다.

2. 설정

pom.xml 파일에 spring-boot-starter-validation 종속성을 추가해야 합니다.

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

3. 사용자 정의 필드 수준 유효성 검사

3.1 주석 생성

파일 확장자, 파일 크기, 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 {};
}

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

이 특수효과의 구성요소를 분석해 보겠습니다.

• @Constraint: 유효성 검사 논리를 담당하는 유효성 검사기 클래스를 지정합니다.
• @Target({ElementType.FIELD}): 이 주석이 필드에만 적용될 수 있음을 나타냅니다.
• message(): 유효성 검사에 실패할 경우 기본 오류 메시지입니다.

3.2 유효성 검사기 만들기

• 파일 확장 유효성 검사기

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

이러한 클래스는 ConstraintValidator 인터페이스의 구현이며 실제 유효성 검사 논리를 포함합니다.
FileMimeTypeValidator의 경우 Apache Tika(다양한 유형의 문서에서 메타데이터와 콘텐츠를 추출하도록 설계된 툴킷)를 사용합니다.

3.3 주석 적용

특히 PDF 파일에 대한 파일 업로드 처리를 위한 TestUploadRequest 클래스를 만들어 보겠습니다.

@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}): 이 주석이 유형 선언을 대상으로 함을 나타냅니다.

4. 사용자 정의 클래스 수준 검증

클래스 내 필드 조합의 유효성을 검사하기 위해 클래스 수준에서 사용자 정의 유효성 검사 주석을 정의할 수도 있습니다.

4.1 주석 생성

클래스에서 두 개의 비밀번호 필드가 일치하는지 확인하기 위해 @PasswordMatches 주석을 만들어 보겠습니다.

@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 유효성 검사기 만들기

• 비밀번호Dto

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

PasswordDto 인터페이스는 비밀번호와 비밀번호 확인 필드가 포함된 개체에 대한 인터페이스입니다.
PasswordMatchesValidator 클래스는 ConstraintValidator 인터페이스를 구현하고 비밀번호와 비밀번호 확인 필드가 일치하는지 확인하는 논리를 포함합니다.

4.3 주석 적용

사용자 등록 데이터를 처리하기 위한 RegisterAccountRequest 클래스를 만들어 보겠습니다.

@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. 요약

이 짧은 기사에서 우리는 필드나 클래스를 확인하기 위해 사용자 정의 주석을 만드는 것이 얼마나 쉬운지 알아냈습니다. 이 기사의 코드는 내 Github에서 확인할 수 있습니다.

• 스프링 부트 마이크로서비스
• 사용자 서비스

6. 참고자료

• 배둥. (n.d.). Spring MVC 사용자 정의 유효성 검사기. 검색됨 https://www.baeldung.com/spring-mvc-custom-validator에서

위 내용은 Spring Boot에서 검증을 위한 사용자 정의 주석 생성의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!