Java에서 우아한 매개변수 확인을 구현하는 방법

1. 소개

메소드의 매개변수를 검증하려면 다음과 같이 작성하면 됩니다.

    public static void utilA(String a,BigDecimal b){
        if (StringUtils.isEmpty(a)){
            System.out.println("a不可为空");
            return;
        }
        if (b == null){
            System.out.println("b不可为空");
            return;
        }
        if (b.compareTo(BigDecimal.ZERO) != 1){
            System.out.println("b的取值范围不正确");
            return;
        }
        System.out.println("do something");
    }

기능적인 관점에서는 전혀 문제가 없습니다.

그러나 코드의 장기적인 유지 관리 측면에서 볼 때 코드 재사용률은 낮습니다. 검증 규칙이 너무 많으면 유지 관리가 어렵고 약간의 추구가 있는 엔지니어에게는 서투른 것처럼 보입니다. 큰 일은 여전히 ​​받아들이기 어렵습니다.

사전 조건(com.google)과 같은 일부 솔루션이 있지만 모든 시나리오에 적용하기 어렵고 사용하기에도 불편합니다.

2. 매개변수를 우아하게 검증하는 방법

Spring은 명확한 의미를 지닌 우아한 메소드 수준 검증을 공식적으로 권장합니다(입력 매개변수 검증, 반환값 검증)

2.1 공식 지침

Spring 공식 지침은 SpringBoot 문서에 있으며, 매개변수 검증을 위해 제공되는 솔루션입니다. (Validation)은 다음과 같습니다.

@Service
@Validated
public class MyBean {
 
    public Archive findByCodeAndAuthor(@Size(min = 8, max = 10) String code,
            Author author) {
        ...
    }
 
}

Spring Boot 공식 홈페이지 문서 "37. Validation"

즉, JSR-303 스펙을 사용하고 매개변수 검증을 위해 Annotation을 직접 사용한다는 것입니다.

(JSR-303은 Bean Validation이라고 하는 JAVA EE 6의 하위 사양이며 공식 참조 구현은 Hibernate Validator입니다.)

2.2 주석 사용 지침

2.2.1 주석 소개

간단합니다. 유형 매개변수(Non-Bean), 주석을 사용하여 매개변수 바로 앞에 제약 조건 규칙을 추가합니다. 주석은 다음과 같습니다.

@AssertTrue / @AssertFalse

Validation 적용 필드: boolean

Annotation 설명: 값이 true / false인지 확인

@DecimalMax / @DecimalMin

Validation 적용 필드: BigDecimal, BigInteger, String, byte, short, int, long

주석: 값이 지정된 소수점 값보다 작거나 같은지 확인하세요. 소수점 이하 자릿수에는 정밀도 문제가 있습니다.

@Digits

확인 해당 필드: BigDecimal, BigInteger, String ,byte, short, int, long

주석: 값의 수치 구성이 합법적인지 확인

속성 설명: 정수: 정수 부분의 자릿수를 지정합니다. 분수: 분수 부분의 자릿수를 지정합니다.

@Future / @Past

검증 적용 필드: 날짜, 달력

주석 설명: 값이 현재 시간 이후/이전인지 확인

속성 설명: Public

@Max / @Min

검증 적용 가능 필드: BigDecimal, BigInteger, String, byte, short, int, long

주석: 값이 지정된 정수 값보다 작거나 같은지 확인

속성 설명: Public

참고: 권장 사항 Stirng 및 Integer 유형을 사용하십시오. 양식에서 제출한 값이 ""

@NotNull / @Null

인 경우 int로 변환할 수 없으므로 int 유형을 사용하지 않는 것이 좋습니다.

주석: 값이 null이 아닌지 확인/비어 있음

속성 설명: Public

@NotBlank 제약 조건 문자열이 Null인지, 잘린 문자열의 길이가 0보다 큰지 확인(문자열에 대해서만),

@NotEmpty 요소가 Null인지 EMPTY인지 확인하세요.

@NotBlank와 @NotEmpty의 차이점: 공백(" ")은 NotEmpty에 적합하지만 NotBlank입니다. 확인 예외가 발생합니다

@Pattern

검증 적용 필드: 문자열

주석: 값에 정규 표현식이 포함되어 있는지 확인

속성 설명: regexp: 정규 표현식 플래그: Pattern.Flag를 지정하는 배열, 정규식의 관련 옵션을 나타냅니다.

@Size

검증 적용 필드: String, Collection, Map, Array

Annotation: 값이 길이 요구 사항을 충족하는지 확인

속성 설명: max: 최대 길이를 지정, min: 최소 길이를 지정합니다.

@Length(min=, max=): 특히 문자열 유형에 적용됨

@Valid

검증 적용 필드: 연관 객체를 재귀적으로 검증

참고: 연관 객체가 컬렉션 또는 배열인 경우, 그런 다음 해당 요소에 대해 재귀 검증을 수행합니다. 맵인 경우 값 부분을 검증합니다(재귀 검증 수행 여부)

속성 설명: None

@Range(min=, max=) 지정된 요소는 반드시 내에 있어야 합니다. 해당 범위

@CreditCardNumber 신용카드 인증

@Email 이메일 주소인지 확인합니다. null인 경우 인증을 수행하지 않고 인증에 통과됩니다.

@URL(protocol=,host=, port=,regexp=, flags=)

2.2.2

1을 사용하여 해당 필드에 주석을 추가합니다. 메서드 호출 시 전달된 실제 매개변수가 제약 조건 규칙과 일치하지 않으면 ConstraintViolationException이 직접 발생하여 매개변수 확인이 실패했음을 나타냅니다.

 <!-- https://mvnrepository.com/artifact/org.hibernate.validator/hibernate-validator -->
        <dependency>
            <groupId>org.hibernate.validator</groupId>
            <artifactId>hibernate-validator</artifactId>
            <version>6.1.5.Final</version>
        </dependency>

3.. Bean 유형 매개변수의 경우 Bean 내부의 각 필드에 제약 조건 주석을 추가한 다음 메서드 매개변수 앞에 @Validated 또는 @Valid 주석을 추가합니다. 예:

import javax.validation.constraints.Max;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotEmpty;
 
/**
 * @Author: wangxia
 * @Date: 2021/10/20 16:30
 */
public class TestPerson {
 
    @NotEmpty(message = "用户名不能为空")
    private String username;
 
    @Min(value = 0,message = "年龄不能小于0岁")
    @Max(value =150,message = "年龄不能大于150岁")
    private int age;
 
    public String getUsername() {
        return username;
    }
 
    public void setUsername(String username) {
        this.username = username;
    }
 
    public int getAge() {
        return age;
    }
 
    public void setAge(int age) {
        this.age = age;
    }
}

4. 예외를 적절하게 포착합니다. 이 단계는 생략할 수 있지만 요청 시 400 예외 프롬프트와 함께 직접 반환되므로 매우 우아하지 않습니다.

@RequestMapping("/")
@RestController
public class TestValidatController {
 
    @PostMapping("/testValid")
    public String testValid(@Validated @RequestBody TestPerson testPerson){
        return "测试成功";
    }
 
}

우아하게 잡힌 예외 프롬프트 추가:

우아하게 잡힌 예외 프롬프트를 추가하지 않음:

위 내용은 Java에서 우아한 매개변수 확인을 구현하는 방법의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!