Spring Boot之验证模块应用总结2

素颜马尾好姑娘i 2022-02-28 16:14 216阅读 0赞

## DAO的验证模块 ##

对于Entity实体来说，同样可以基于validation注解来定义相关的验证逻辑。本节将通过相关示例来介绍如何使用这些注解简化日常的开发工作。

## Entity定义 ##

在Maven文件中引入：

<dependency>
           <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-jpa</artifactId>
    </dependency>

定义测试Entity：

@Entity
    @Data
    public class ProductEntity {
        @Id
        @GeneratedValue
        private Long id;
        //限购：1～5
        @Min(value = 1, message = "min Value is above zero")
        @Max(value = 10, message = "最大值不超过10")
        private int count;
    
        @Pattern(regexp = "^[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}$", message = "不符合IP规则")
        private String ipAddr;
    
        @Email(message = "email format error")
        @NotBlank
        private String email;
    
        @NotBlank(message = "name 不能为空")
        @Length(min=5, max = 10, message = "name长度在5到10个字符之间")
        private String name;
    }

在这个entity中，使用了不同注解针对这些字段进行验证，并自定义了相关的提示信息。  
在Spring Boot的DAO中，默认验证是打开的。如果要关闭验证逻辑，则需要将Spring Boot开关在配置文件中关闭，具体设置如下：

spring.jpa.properties.javax.persistence.validation.mode=none

## 单元测试 ##

为了进行单元测试，首先需要将相关依赖加到项目中：

<dependency>
                <groupId>com.h2database</groupId>
                <artifactId>h2</artifactId>
                <scope>test</scope>
          </dependency>

此为转为进行数据测试的H2测试数据库。  
测试代码：

@RunWith(SpringRunner.class)
    @DataJpaTest
    public class ProductEntityValidTest {
        @Autowired
        private TestEntityManager entityManager;
    
        @Autowired
        private ProductRepository productRepository;
    
        @Test(expected=ConstraintViolationException.class)
        public void testEntityInValidation() {
            ProductEntity product = badRequest();
    
            this.productRepository.save(product);
    
            //进行刷新之后，方可触发实际的validation逻辑检查
            this.productRepository.flush();
        }
    
        @Test
        public void testEntityValidation() {
            ProductEntity product = goodProduct();
    
            this.productRepository.save(product);
    
            //进行刷新之后，方可触发实际的validation逻辑检查
            this.productRepository.flush();
        }
    
        private ProductEntity badRequest() {
            ProductEntity product = new ProductEntity();
            product.setCount(12);
            product.setEmail("add");
            product.setIpAddr("12.33.");
            product.setName("abc");
    
            return product;
        }
    
        private ProductEntity goodProduct() {
            ProductEntity product = new ProductEntity();
            product.setName("zhangds");
            product.setCount(9);
            product.setEmail("abc@12.cn");
            product.setIpAddr("3.3.4.4");
    
            return product;
        }
    }

即可进行正常的功能验证操作。

## 总结 ##

在Entity这层进行验证，非常的简单，不需要进行大量冗余的逻辑代码验证，可以节省大量的开发工作量。