如何用責任鏈默認優(yōu)雅地進行參數(shù)校驗

前言

項目中參數(shù)校驗十分重要，它可以保護我們應(yīng)用程序的安全性和合法性。我想大家通常的做法是像下面這樣做的:

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

這么做最大的優(yōu)勢就是簡單直接，但是如果驗證邏輯很復(fù)雜，會導(dǎo)致這個類變得很龐大，而且上面是通過拋出異常來改變代碼執(zhí)行流程，這也是一種不推薦的做法。

那么有什么更好的參數(shù)校驗的方式呢？本文就推薦一種通過責任鏈設(shè)計模式來優(yōu)雅地實現(xiàn)參數(shù)的校驗功能，我們通過一個用戶注冊的例子來講明白如何實現(xiàn)。

• 有效的注冊數(shù)據(jù)——名字、姓氏、電子郵件、用戶名和密碼。
• 用戶名必須是唯一的。
• 電子郵件必須是唯一的。

定義用戶注冊和驗證結(jié)果類

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，因為我希望命令對象是不可變的。注冊用戶的數(shù)據(jù)應(yīng)與注冊表中填寫的數(shù)據(jù)相同。

2. 定義存儲驗證結(jié)果類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;
    }
}

• 在我看來，這是一種非常方便的方法返回類型，并且比拋出帶有驗證消息的異常要好。

3. 既然是責任鏈，還需要定義一個“鏈”類ValidationStep，它是這些驗證步驟的超類，我們希望將它們相互“鏈接”起來。

public abstract class ValidationStep

核心驗證邏輯

現(xiàn)在我們開始進行參數(shù)校驗的核心邏輯，也就是如何把上面定義的類給串聯(lián)起來。

1. 我們定義一個用于注冊驗證的接口類SignUpValidationService

public interface SignUpValidationService {
    ValidationResult validate(SignUpCommand command);
}

2. 現(xiàn)在我們可以使用上面定義的類和責任鏈模式來輕松的實現(xiàn)，代碼如下：

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

• validate方法是核心方法，其中調(diào)用linkWith方法組裝參數(shù)的鏈式校驗器，其中涉及多個驗證類，先做基礎(chǔ)驗證，如果通過的話，去驗證用戶名是否重復(fù)，如果也通過的話，去驗證Email是否重復(fù)。
• CommandConstraintsValidationStep類，此步驟是一個基礎(chǔ)驗證，所有的javax validation annotation都會被驗證，比如是否為空，Email格式是否正確等等。這非常方便，我們不必自己編寫這些驗證器。如果一個對象是有效的，那么調(diào)用checkNext方法讓流程進入下一步，checkNext，如果不是，ValidationResult 將立即返回。
• UsernameDuplicationValidationStep類，此步驟驗證用戶名是否重復(fù)，主要需要去查數(shù)據(jù)庫了。如果是，那么將立即返回無效的ValidationResult，否則的話繼續(xù)往后走，去驗證下一步。
• EmailDuplicationValidationStep 類，電子郵件重復(fù)驗證。因為沒有下一步，如果電子郵件是唯一的，則將返回ValidationResult.valid()。

總結(jié)

上面就是通過責任鏈模式來實現(xiàn)我們參數(shù)校驗的完整過程了，你學(xué)會了嗎?這種方式可以優(yōu)雅的將驗證邏輯拆分到單獨的類中，如果添加新的驗證邏輯，只需要添加新的類，然后組裝到“校驗鏈”中。但是在我看來，這比較適合于用于校驗相對復(fù)雜的場景，如果只是簡單的校驗就完全沒必要這么做了，反而會增加代碼的復(fù)雜度。