您好,登錄后才能下訂單哦!
本篇內(nèi)容介紹了“Java怎么使用責任鏈默認優(yōu)雅地進行參數(shù)校驗”的有關(guān)知識,在實際案例的操作過程中,不少人都會遇到這樣的困境,接下來就讓小編帶領(lǐng)大家學習一下如何處理這些情況吧!希望大家仔細閱讀,能夠?qū)W有所成!
項目中參數(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ù)雜,會導致這個類變得很龐大,而且上面是通過拋出異常來改變代碼執(zhí)行流程,這也是一種不推薦的做法。
那么有什么更好的參數(shù)校驗的方式呢?本文就推薦一種通過責任鏈設(shè)計模式來優(yōu)雅地實現(xiàn)參數(shù)的校驗功能,我們通過一個用戶注冊的例子來講明白如何實現(xiàn)。
有效的注冊數(shù)據(jù)——名字、姓氏、電子郵件、用戶名和密碼。
用戶名必須是唯一的。
電子郵件必須是唯一的。
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<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); } }
現(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<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ù)的鏈式校驗器,其中涉及多個驗證類,先做基礎(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()
。
“Java怎么使用責任鏈默認優(yōu)雅地進行參數(shù)校驗”的內(nèi)容就介紹到這里了,感謝大家的閱讀。如果想了解更多行業(yè)相關(guān)的知識可以關(guān)注億速云網(wǎng)站,小編將為大家輸出更多高質(zhì)量的實用文章!
免責聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點不代表本網(wǎng)站立場,如果涉及侵權(quán)請聯(lián)系站長郵箱:is@yisu.com進行舉報,并提供相關(guān)證據(jù),一經(jīng)查實,將立刻刪除涉嫌侵權(quán)內(nèi)容。