前言
項目中參數校驗十分重要,它可以保護我們應用程序的安全性和合法性。我想大家通常的做法是像下面這樣做的:
@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
}
這么做最大的優勢就是簡單直接,但是如果驗證邏輯很復雜,會導致這個類變得很龐大,而且上面是通過拋出異常來改變代碼執行流程,這也是一種不推薦的做法。
那么有什么更好的參數校驗的方式呢?本文就推薦一種通過責任鏈設計模式來優雅地實現參數的校驗功能,我們通過一個用戶注冊的例子來講明白如何實現。
- 有效的注冊數據——名字、姓氏、電子郵件、用戶名和密碼。
- 用戶名必須是唯一的。
- 電子郵件必須是唯一的。
定義用戶注冊和驗證結果類
- 定義一個
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
,因為我希望命令對象是不可變的。注冊用戶的數據應與注冊表中填寫的數據相同。
- 定義存儲驗證結果類
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;
}
}
- 在我看來,這是一種非常方便的方法返回類型,并且比拋出帶有驗證消息的異常要好。
- 既然是責任鏈,還需要定義一個“鏈”類
ValidationStep
,它是這些驗證步驟的超類,我們希望將它們相互“鏈接”起來。
public abstract class ValidationStep
核心驗證邏輯
現在我們開始進行參數校驗的核心邏輯,也就是如何把上面定義的類給串聯起來。
- 我們定義一個用于注冊驗證的接口類
SignUpValidationService
public interface SignUpValidationService {
ValidationResult validate(SignUpCommand command);
}
- 現在我們可以使用上面定義的類和責任鏈模式來輕松的實現,代碼如下:
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
方法是核心方法,其中調用linkWith
方法組裝參數的鏈式校驗器,其中涉及多個驗證類,先做基礎驗證,如果通過的話,去驗證用戶名是否重復,如果也通過的話,去驗證Email
是否重復。CommandConstraintsValidationStep
類,此步驟是一個基礎驗證,所有的javax validation annotation
都會被驗證,比如是否為空,Email
格式是否正確等等。這非常方便,我們不必自己編寫這些驗證器。如果一個對象是有效的,那么調用checkNext
方法讓流程進入下一步,checkNext
,如果不是,ValidationResult
將立即返回。UsernameDuplicationValidationStep
類,此步驟驗證用戶名是否重復,主要需要去查數據庫了。如果是,那么將立即返回無效的ValidationResult
,否則的話繼續往后走,去驗證下一步。EmailDuplicationValidationStep
類,電子郵件重復驗證。因為沒有下一步,如果電子郵件是唯一的,則將返回ValidationResult.valid()
。
總結
上面就是通過責任鏈模式來實現我們參數校驗的完整過程了,你學會了嗎?這種方式可以優雅的將驗證邏輯拆分到單獨的類中,如果添加新的驗證邏輯,只需要添加新的類,然后組裝到“校驗鏈”中。但是在我看來,這比較適合于用于校驗相對復雜的場景,如果只是簡單的校驗就完全沒必要這么做了,反而會增加代碼的復雜度。
聲明:本文內容及配圖由入駐作者撰寫或者入駐合作網站授權轉載。文章觀點僅代表作者本人,不代表電子發燒友網立場。文章及其配圖僅供工程師學習之用,如有內容侵權或者其他違規問題,請聯系本站處理。
舉報投訴
-
數據
+關注
關注
8文章
7242瀏覽量
91039 -
JAVA
+關注
關注
20文章
2985瀏覽量
106941 -
代碼
+關注
關注
30文章
4888瀏覽量
70274
發布評論請先 登錄
相關推薦
熱點推薦
如何用串口進行調試
串口是MCU最重要的一個通信端口,幾乎所有的嵌入式產品都會用到串口,可能是產品預研的時候用來調試,可能是與某一個外設連接收發數據,還可能用來對產品進行固件升級。這篇文章主要給大家介紹一下如何用串口進行調試,也就是打印log。

如何用labview進行CRC和LRC校驗
最近做的一個課題上用到MODBUS的ASCII模式或RTU模式,分別需要進行LRC和CRC校驗,接收方應該怎樣校驗呢? 查了查資料 LRC的檢驗(接收方)步驟: 步驟1:對除開始的冒號及結束的回車
發表于 05-11 16:13
曼徹斯特編碼解碼+CRC校驗,進行高速LVDS傳輸。。代碼
曼徹斯特編碼解碼+CRC校驗,進行高速LVDS傳輸。。代碼分兩部分。。。第一部分為曼徹斯特編碼,編碼位數和同步頭可以參數化設計,方便移植,數據后面緊接著8為校驗碼。。。第二部分為曼徹斯
發表于 07-17 22:20
如何利用區塊鏈進行存在性證明?
如果了解區塊鏈原理后,你可以很輕松的理解如何用區塊鏈進行存在性證明,上圖VB手拿最新以太坊區塊鏈高度和地址,再配以他的圖片很好的證明了他于區
發表于 09-22 09:00
?1663次閱讀
如何用SMART編寫CRC校驗算法程序
CRC即循環冗余校驗碼(Cyclic Redundancy Check):是數據通信領域中最常用的一種查錯校驗碼,其特征是信息字段和校驗字段的長度可以任意選定。

嵌入式C語言可以帶“默認參數”的函數嗎
使用C++開發過程序時,定義函數可以指定默認參數,例如 void fun(int x, int y=3); 在調用 fun() 時第二個參數可以不傳遞,此時 fun() 函數默認第二個
發表于 09-06 11:35
?1523次閱讀

什么是責任鏈?
責任鏈模式是行為模式的一種,它將需要觸發的Handler組成一條鏈,發送者將請求發給鏈的第一個接收者,并且沿著這條鏈傳遞,直到有一個Hand
SpringBoot Web應用如何進行參數校驗?(上)
的話就太繁瑣了,代碼可讀性極差。**Validator框架**就是為了解決開發人員在開發的時候少寫代碼,提升開發效率;Validator專門用來進行接口參數校驗,例如常見的必填校驗,e
SpringBoot Web應用如何進行參數校驗?(下)
代碼對接口參數一個個校驗的話就太繁瑣了,代碼可讀性極差。Validator框架就是為了解決開發人員在開發的時候少寫代碼,提升開發效率;Validator專門用來進行接口參數
什么是奇校驗和偶校驗?常見的奇偶校驗方式有哪些?
什么是奇校驗和偶校驗?常見的奇偶校驗方式有哪些? 1. 奇偶校驗是指在數字通信中采用一種技術對傳輸的數據進行
評論