如何使用責任鏈預設優雅地進行引數校驗？

JAVA旭陽發表於2023-03-28

前言

專案中引數校驗十分重要，它可以保護我們應用程式的安全性和合法性。我想大家通常的做法是像下面這樣做的:

@Override
public void validate(SignUpCommand command) {
    validateCommand(command); // will throw an exception if command is not valid
    validateUsername(command.getUsername()); // will throw an exception if username is duplicated
    validateEmail(commend.getEmail()); // will throw an exception if email is duplicated
}

這麼做最大的優勢就是簡單直接，但是如果驗證邏輯很複雜，會導致這個類變得很龐大，而且上面是透過丟擲異常來改變程式碼執行流程，這也是一種不推薦的做法。

那麼有什麼更好的引數校驗的方式呢？本文就推薦一種透過責任鏈設計模式來優雅地實現引數的校驗功能，我們透過一個使用者註冊的例子來講明白如何實現。

  • 有效的註冊資料——名字、姓氏、電子郵件、使用者名稱和密碼。
  • 使用者名稱必須是唯一的。
  • 電子郵件必須是唯一的。

定義使用者註冊和驗證結果類

  1. 定義一個SignUpCommand類用來接受使用者註冊的屬性資訊。並且使用 @Value 註解讓這個類不可變。
import lombok.Value;

import javax.validation.constraints.*;

@Value
public class SignUpCommand {

    @Min(2)
    @Max(40)
    @NotBlank
    private final String firstName;

    @Min(2)
    @Max(40)
    @NotBlank
    private final String lastName;

    @Min(2)
    @Max(40)
    @NotBlank
    private final String username;

    @NotBlank
    @Size(max = 60)
    @Email
    private final String email;

    @NotBlank
    @Size(min = 6, max = 20)
    private final String rawPassword;
  • 使用javax.validation中的註解如@NotBlank、@Size來驗證使用者註冊資訊是否有效。
  • 使用lombok的註解@Value，因為我希望命令物件是不可變的。註冊使用者的資料應與登錄檔中填寫的資料相同。
  1. 定義儲存驗證結果類ValidationResult，如下所示：
@Value
public class ValidationResult {
    private final boolean isValid;
    private final String errorMsg;

    public static ValidationResult valid() {
        return new ValidationResult(true, null);
    }

    public static ValidationResult invalid(String errorMsg) {
        return new ValidationResult(false, errorMsg);
    }

    public boolean notValid() {
        return !isValid;
    }
}
  • 在我看來，這是一種非常方便的方法返回型別，並且比丟擲帶有驗證訊息的異常要好。
  1. 既然是責任鏈，還需要定義一個“鏈”類ValidationStep，它是這些驗證步驟的超類，我們希望將它們相互“連結”起來。
public abstract class ValidationStep<T> {

    private ValidationStep<T> next;

    public ValidationStep<T> linkWith(ValidationStep<T> next) {
        if (this.next == null) {
            this.next = next;
            return this;
        }
        ValidationStep<T> lastStep = this.next;
        while (lastStep.next != null) {
            lastStep = lastStep.next;
        }
        lastStep.next = next;
        return this;
    }

    public abstract ValidationResult validate(T toValidate);

    protected ValidationResult checkNext(T toValidate) {
        if (next == null) {
            return ValidationResult.valid();
        }

        return next.validate(toValidate);
    }
}

核心驗證邏輯

現在我們開始進行引數校驗的核心邏輯，也就是如何把上面定義的類給串聯起來。

  1. 我們定義一個用於註冊驗證的介面類SignUpValidationService
public interface SignUpValidationService {
    ValidationResult validate(SignUpCommand command);
}
  1. 現在我們可以使用上面定義的類和責任鏈模式來輕鬆的實現，程式碼如下：
import lombok.AllArgsConstructor;
import org.springframework.stereotype.Service;

import javax.validation.ConstraintViolation;
import javax.validation.Validation;
import javax.validation.Validator;
import javax.validation.ValidatorFactory;
import java.util.Set;

@Service
@AllArgsConstructor
public class DefaultSignUpValidationService implements SignUpValidationService {

    private final UserRepository userRepository;

    @Override
    public ValidationResult validate(SignUpCommand command) {
        return new CommandConstraintsValidationStep()
                .linkWith(new UsernameDuplicationValidationStep(userRepository))
                .linkWith(new EmailDuplicationValidationStep(userRepository))
                .validate(command);
    }

    private static class CommandConstraintsValidationStep extends ValidationStep<SignUpCommand> {

        @Override
        public ValidationResult validate(SignUpCommand command) {
            try (ValidatorFactory validatorFactory = Validation.buildDefaultValidatorFactory()) {
                final Validator validator = validatorFactory.getValidator();
                final Set<ConstraintViolation<SignUpCommand>> constraintsViolations = validator.validate(command);

                if (!constraintsViolations.isEmpty()) {
                    return ValidationResult.invalid(constraintsViolations.iterator().next().getMessage());
                }
            }
            return checkNext(command);
        }
    }

    @AllArgsConstructor
    private static class UsernameDuplicationValidationStep extends ValidationStep<SignUpCommand> {

        private final UserRepository userRepository;

        @Override
        public ValidationResult validate(SignUpCommand command) {
            if (userRepository.findByUsername(command.getUsername()).isPresent()) {
                return ValidationResult.invalid(String.format("Username [%s] is already taken", command.getUsername()));
            }
            return checkNext(command);
        }
    }

    @AllArgsConstructor
    private static class EmailDuplicationValidationStep extends ValidationStep<SignUpCommand> {

        private final UserRepository userRepository;

        @Override
        public ValidationResult validate(SignUpCommand command) {
            if (userRepository.findByEmail(command.getEmail()).isPresent()) {
                return ValidationResult.invalid(String.format("Email [%s] is already taken", command.getEmail()));
            }
            return checkNext(command);
        }
    }
}
  • validate方法是核心方法，其中呼叫linkWith方法組裝引數的鏈式校驗器，其中涉及多個驗證類，先做基礎驗證，如果透過的話，去驗證使用者名稱是否重複，如果也透過的話，去驗證Email是否重複。
  • CommandConstraintsValidationStep類，此步驟是一個基礎驗證，所有的javax validation annotation都會被驗證，比如是否為空，Email格式是否正確等等。這非常方便，我們不必自己編寫這些驗證器。如果一個物件是有效的，那麼呼叫checkNext方法讓流程進入下一步，checkNext，如果不是，ValidationResult 將立即返回。
  • UsernameDuplicationValidationStep類，此步驟驗證使用者名稱是否重複，主要需要去查資料庫了。如果是，那麼將立即返回無效的ValidationResult，否則的話繼續往後走，去驗證下一步。
  • EmailDuplicationValidationStep 類，電子郵件重複驗證。因為沒有下一步，如果電子郵件是唯一的，則將返回ValidationResult.valid()。

總結

上面就是透過責任鏈模式來實現我們引數校驗的完整過程了，你學會了嗎?這種方式可以優雅的將驗證邏輯拆分到單獨的類中，如果新增新的驗證邏輯，只需要新增新的類，然後組裝到“校驗鏈”中。但是在我看來，這比較適合於用於校驗相對複雜的場景，如果只是簡單的校驗就完全沒必要這麼做了，反而會增加程式碼的複雜度。

歡迎關注個人公眾號【JAVA旭陽】交流學習

相關文章