通過(guò)責(zé)任鏈模式來(lái)實(shí)現(xiàn)我們參數(shù)校驗(yàn)的完整過(guò)程了，你學(xué)會(huì)了嗎?這種方式可以優(yōu)雅的將驗(yàn)證邏輯拆分到單獨(dú)的類中，如果添加新的驗(yàn)證邏輯，只需要添加新的類，然后組裝到“校驗(yàn)鏈”中。但是在我看來(lái)，這比較適合于用于校驗(yàn)相對(duì)復(fù)雜的場(chǎng)景，如果只是簡(jiǎn)單的校驗(yàn)就完全沒(méi)必要這么做了，反而會(huì)增加代碼的復(fù)雜度。
前言
項(xiàng)目中參數(shù)校驗(yàn)十分重要，它可以保護(hù)我們應(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)勢(shì)就是簡(jiǎn)單直接，但是如果驗(yàn)證邏輯很復(fù)雜，會(huì)導(dǎo)致這個(gè)類變得很龐大，而且上面是通過(guò)拋出異常來(lái)改變代碼執(zhí)行流程，這也是一種不推薦的做法。
那么有什么更好的參數(shù)校驗(yàn)的方式呢？本文就推薦一種通過(guò)責(zé)任鏈設(shè)計(jì)模式來(lái)優(yōu)雅地實(shí)現(xiàn)參數(shù)的校驗(yàn)功能，我們通過(guò)一個(gè)用戶注冊(cè)的例子來(lái)講明白如何實(shí)現(xiàn)。
- 有效的注冊(cè)數(shù)據(jù)——名字、姓氏、電子郵件、用戶名和密碼。
- 用戶名必須是唯一的。
- 電子郵件必須是唯一的。
定義用戶注冊(cè)和驗(yàn)證結(jié)果類
- 定義一個(gè)SignUpCommand類用來(lái)接受用戶注冊(cè)的屬性信息。并且使用 @Value 注解讓這個(gè)類不可變。
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來(lái)驗(yàn)證用戶注冊(cè)信息是否有效。
- 使用lombok的注解@Value，因?yàn)槲蚁Ｍ顚?duì)象是不可變的。注冊(cè)用戶的數(shù)據(jù)應(yīng)與注冊(cè)表中填寫(xiě)的數(shù)據(jù)相同。
- 定義存儲(chǔ)驗(yàn)證結(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;
}
}
- 在我看來(lái)，這是一種非常方便的方法返回類型，并且比拋出帶有驗(yàn)證消息的異常要好。
- 既然是責(zé)任鏈，還需要定義一個(gè)“鏈”類ValidationStep，它是這些驗(yàn)證步驟的超類，我們希望將它們相互“鏈接”起來(lái)。
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);
}
}核心驗(yàn)證邏輯
現(xiàn)在我們開(kāi)始進(jìn)行參數(shù)校驗(yàn)的核心邏輯，也就是如何把上面定義的類給串聯(lián)起來(lái)。
- 我們定義一個(gè)用于注冊(cè)驗(yàn)證的接口類SignUpValidationService
public interface SignUpValidationService {
ValidationResult validate(SignUpCommand command);
}- 現(xiàn)在我們可以使用上面定義的類和責(zé)任鏈模式來(lái)輕松的實(shí)現(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<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方法是核心方法，其中調(diào)用linkWith方法組裝參數(shù)的鏈?zhǔn)叫ｒ?yàn)器，其中涉及多個(gè)驗(yàn)證類，先做基礎(chǔ)驗(yàn)證，如果通過(guò)的話，去驗(yàn)證用戶名是否重復(fù)，如果也通過(guò)的話，去驗(yàn)證Email是否重復(fù)。
- CommandConstraintsValidationStep類，此步驟是一個(gè)基礎(chǔ)驗(yàn)證，所有的javax validation annotation都會(huì)被驗(yàn)證，比如是否為空，Email格式是否正確等等。這非常方便，我們不必自己編寫(xiě)這些驗(yàn)證器。如果一個(gè)對(duì)象是有效的，那么調(diào)用checkNext方法讓流程進(jìn)入下一步，checkNext，如果不是，ValidationResult 將立即返回。
- UsernameDuplicationValidationStep類，此步驟驗(yàn)證用戶名是否重復(fù)，主要需要去查數(shù)據(jù)庫(kù)了。如果是，那么將立即返回?zé)o效的ValidationResult，否則的話繼續(xù)往后走，去驗(yàn)證下一步。
- EmailDuplicationValidationStep 類，電子郵件重復(fù)驗(yàn)證。因?yàn)闆](méi)有下一步，如果電子郵件是唯一的，則將返回ValidationResult.valid()。
總結(jié)
上面就是通過(guò)責(zé)任鏈模式來(lái)實(shí)現(xiàn)我們參數(shù)校驗(yàn)的完整過(guò)程了，你學(xué)會(huì)了嗎?這種方式可以優(yōu)雅的將驗(yàn)證邏輯拆分到單獨(dú)的類中，如果添加新的驗(yàn)證邏輯，只需要添加新的類，然后組裝到“校驗(yàn)鏈”中。但是在我看來(lái)，這比較適合于用于校驗(yàn)相對(duì)復(fù)雜的場(chǎng)景，如果只是簡(jiǎn)單的校驗(yàn)就完全沒(méi)必要這么做了，反而會(huì)增加代碼的復(fù)雜度。
