0
  • 聊天消息
  • 系统消息
  • 评论与回复
登录后你可以
  • 下载海量资料
  • 学习在线课程
  • 观看威廉希尔官方网站 视频
  • 写文章/发帖/加入社区
会员中心
创作中心

完善资料让更多小伙伴认识你,还能领取20积分哦,立即完善>

3天内不再提示

如何用责任链默认优雅地进行参数校验

jf_78858299 来源:JAVA旭阳 作者:JAVA旭阳 2023-04-06 15:00 次阅读

前言

项目中参数校验十分重要,它可以保护我们应用程序的安全性和合法性。我想大家通常的做法是像下面这样做的:

@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

核心验证逻辑

现在我们开始进行参数校验的核心逻辑,也就是如何把上面定义的类给串联起来。

  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
  • validate方法是核心方法,其中调用linkWith方法组装参数的链式校验器,其中涉及多个验证类,先做基础验证,如果通过的话,去验证用户名是否重复,如果也通过的话,去验证Email是否重复。
  • CommandConstraintsValidationStep类,此步骤是一个基础验证,所有的javax validation annotation都会被验证,比如是否为空,Email格式是否正确等等。这非常方便,我们不必自己编写这些验证器。如果一个对象是有效的,那么调用checkNext方法让流程进入下一步,checkNext,如果不是,ValidationResult 将立即返回。
  • UsernameDuplicationValidationStep类,此步骤验证用户名是否重复,主要需要去查数据库了。如果是,那么将立即返回无效的ValidationResult,否则的话继续往后走,去验证下一步。
  • EmailDuplicationValidationStep 类,电子邮件重复验证。因为没有下一步,如果电子邮件是唯一的,则将返回ValidationResult.valid()

总结

上面就是通过责任链模式来实现我们参数校验的完整过程了,你学会了吗?这种方式可以优雅的将验证逻辑拆分到单独的类中,如果添加新的验证逻辑,只需要添加新的类,然后组装到“校验链”中。但是在我看来,这比较适合于用于校验相对复杂的场景,如果只是简单的校验就完全没必要这么做了,反而会增加代码的复杂度。

声明:本文内容及配图由入驻作者撰写或者入驻合作网站授权转载。文章观点仅代表作者本人,不代表电子发烧友网立场。文章及其配图仅供工程师学习之用,如有内容侵权或者其他违规问题,请联系本站处理。 举报投诉
  • 数据
    +关注

    关注

    8

    文章

    7006

    浏览量

    88958
  • JAVA
    +关注

    关注

    19

    文章

    2966

    浏览量

    104707
  • 代码
    +关注

    关注

    30

    文章

    4780

    浏览量

    68539
收藏 人收藏

    评论

    相关推荐

    何用串口进行调试

    串口是MCU最重要的一个通信端口,几乎所有的嵌入式产品都会用到串口,可能是产品预研的时候用来调试,可能是与某一个外设连接收发数据,还可能用来对产品进行固件升级。这篇文章主要给大家介绍一下如何用串口进行调试,也就是打印log。
    的头像 发表于 03-23 10:02 4551次阅读
    如<b class='flag-5'>何用</b>串口<b class='flag-5'>进行</b>调试

    何用labview进行CRC和LRC校验

    最近做的一个课题上用到MODBUS的ASCII模式或RTU模式,分别需要进行LRC和CRC校验,接收方应该怎样校验呢? 查了查资料 LRC的检验(接收方)步骤: 步骤1:对除开始的冒号及结束的回车
    发表于 05-11 16:13

    曼彻斯特编码解码+CRC校验进行高速LVDS传输。。代码

    曼彻斯特编码解码+CRC校验进行高速LVDS传输。。代码分两部分。。。第一部分为曼彻斯特编码,编码位数和同步头可以参数化设计,方便移植,数据后面紧接着8为校验码。。。第二部分为曼彻斯
    发表于 07-17 22:20

    Matlab是如何用系统辨识并进行PID参数调节呢

    Matlab是如何用系统辨识并进行PID参数调节呢?有哪些基本步骤呢?
    发表于 11-19 06:27

    如何利用区块进行存在性证明?

    如果了解区块原理后,你可以很轻松的理解如何用区块进行存在性证明,上图VB手拿最新以太坊区块高度和地址,再配以他的图片很好的证明了他于区
    发表于 09-22 09:00 1480次阅读

    自制继电器电压电流参数校验

    笔者研制出一种针对继电保护用的电压,电流继电器整定值校验测试仪。便于威廉希尔官方网站 人员对继电器的整定值进行校验和调整。
    的头像 发表于 01-26 08:18 3067次阅读
    自制继电器电压电流<b class='flag-5'>参数</b><b class='flag-5'>校验</b>仪

    何用SMART编写CRC校验算法程序

    CRC即循环冗余校验码(Cyclic Redundancy Check):是数据通信领域中最常用的一种查错校验码,其特征是信息字段和校验字段的长度可以任意选定。
    的头像 发表于 11-26 09:50 9278次阅读
    如<b class='flag-5'>何用</b>SMART编写CRC<b class='flag-5'>校验</b>算法程序

    嵌入式C语言可以带“默认参数”的函数吗

    使用C++开发过程序时,定义函数可以指定默认参数,例如 void fun(int x, int y=3); 在调用 fun() 时第二个参数可以不传递,此时 fun() 函数默认第二个
    发表于 09-06 11:35 1420次阅读
    嵌入式C语言可以带“<b class='flag-5'>默认</b><b class='flag-5'>参数</b>”的函数吗

    何用MATLAB进行电路仿真

    本文演示如何用MATLAB进行电路仿真,测量RLC电路的电压。我用的是R2014a,不同版本软件界面稍有差别。
    的头像 发表于 08-09 17:14 1.3w次阅读

    什么是责任

    责任模式是行为模式的一种,它将需要触发的Handler组成一条,发送者将请求发给的第一个接收者,并且沿着这条传递,直到有一个Hand
    的头像 发表于 02-16 14:41 935次阅读

    SpringBoot Web应用如何进行参数校验?(上)

    的话就太繁琐了,代码可读性极差。**Validator框架**就是为了解决开发人员在开发的时候少写代码,提升开发效率;Validator专门用来进行接口参数校验,例如常见的必填校验,e
    的头像 发表于 05-11 10:31 601次阅读

    SpringBoot Web应用如何进行参数校验?(下)

    代码对接口参数一个个校验的话就太繁琐了,代码可读性极差。Validator框架就是为了解决开发人员在开发的时候少写代码,提升开发效率;Validator专门用来进行接口参数
    的头像 发表于 05-11 10:37 518次阅读

    责任设计模式详解

    责任模式是一种行为设计模式, 允许你将请求沿着处理者进行发送。收到请求后, 每个处理者均可对请求进行处理, 或将其传递给
    的头像 发表于 05-22 15:12 433次阅读
    <b class='flag-5'>责任</b><b class='flag-5'>链</b>设计模式详解

    何用MATLAB进行电路仿真?

    本文演示如何用MATLAB进行电路仿真,测量RLC电路的电压。我用的是R2014a,不同版本软件界面稍有差别。
    的头像 发表于 05-26 09:47 4919次阅读
    如<b class='flag-5'>何用</b>MATLAB<b class='flag-5'>进行</b>电路仿真?

    什么是奇校验和偶校验?常见的奇偶校验方式有哪些?

    什么是奇校验和偶校验?常见的奇偶校验方式有哪些? 1. 奇偶校验是指在数字通信中采用一种威廉希尔官方网站 对传输的数据进行
    的头像 发表于 10-17 16:28 1w次阅读