Spring中@Valid和@Validated注解的差异

快来打我* 2022-11-17 03:37 150阅读 0赞

# 1.介绍 #

验证用户输入是我们大多数应用程序中的常见功能。 在Java生态系统中，专门使用Java标准Bean验证API来支持此功能。 而且，从4.0版本开始，它也与Spring很好地集成在一起。 @Valid和@Validated注释源自此Standard Bean API。

# 2.@Valid 和@Validated注解 #

在Spring中，使用JSR-303的\*\*@Valid批注进行方法级别验证。 此外，还可以使用它来标记成员属性以进行验证。 但是，此注释不支持组验证。\*\*

组有助于限制验证期间应用的约束。 UI向导是一种特殊的用例。 在这里，第一步，可能有一个特定的字段子组。 在随后的步骤中，可能存在另一个属于同一bean的组。 因此，需要在每个步骤中对这些有限的字段应用约束，但是@Valid不支持此约束。

在这种情况下，对于组级别，必须使用Spring的@Validated，这是此JSR-303的@Valid的变体。 在方法级别使用。 为了标记成员属性，继续使用@Valid注解。

# 3. 举例 #

考虑一个使用Spring Boot开发的简单的用户注册表单。 首先，只有名称和密码属性：

@Data
    public class UserAccount { 
        @NotNull
        @Size(min = 4, max = 15)
        private String password;
    
        @NotBlank
        private String name;
    }

接下来，看一下controller。 在这里，将使用带有@Valid批注的saveBasicInfo方法来验证用户输入：

@RequestMapping(value = "/saveBasicInfo", method = RequestMethod.POST)
        public String saveBasicInfo(@Valid UserAccount useraccount, BindingResult result) { 
            log.info("useraccount:{}",useraccount);
            if (result.hasErrors()) { 
                return "error";
            }
            return "success";
        }

测试

@Test
        public void test1() throws Exception { 
            MvcResult mvcResult = this.mockMvc.perform(MockMvcRequestBuilders.post("/saveBasicInfo")
                    .accept(MediaType.TEXT_HTML)
                    .param("name", "test123")
                    .param("password", "pass"))
                    .andExpect(status().isOk()).andDo(MockMvcResultHandlers.print()).andReturn();
            String contentAsString = mvcResult.getResponse().getContentAsString();
            assertEquals("error",contentAsString);
        }

在确认测试成功运行之后，现在扩展功能。 下一步的逻辑步骤是将其转换为多步骤注册表格，就像大多数向导一样。 第一步，其名称和密码保持不变。 在第二步中，将获取年龄和电话等其他信息。 因此，将使用以下其他字段来更新对象：

但是，这一次，注意到先前的测试失败。 这是因为没有传递“age”和“phone”字段。 为了支持此行为，需要组验证和@Validated注解。

为此，需要对字段进行分组以创建两个不同的组。 首先，需要创建两个标记接口。 每个组或每个步骤都有一个单独的名称。

第一步将具有BasicInfo接口，第二步将具有AdvanceInfo。 此外，更新UserAccount类以使用这些标记接口，如下所示：

public interface AdvanceInfo { 
    }

public interface BasicInfo { 
    }

@Data
    public class UserAccount { 
        @NotNull(groups = BasicInfo.class)
        @Size(min = 4, max = 15, groups = BasicInfo.class)
        private String password;
    
        @NotBlank(groups = BasicInfo.class)
        private String name;
    
        @Min(value = 18, message = "Age should not be less than 18", groups = AdvanceInfo.class)
        private int age;
    
        @NotBlank(groups = AdvanceInfo.class)
        private String phone;
    }

此外，更新controller，以使用@Validated注解而不是@Valid：

@RequestMapping(value = "/saveBasicInfoStep1", method = RequestMethod.POST)
    public String saveBasicInfoStep1(@Validated(BasicInfo.class)  UserAccount useraccount, BindingResult result) { 
            log.info("useraccount:{}",useraccount);
            if (result.hasErrors()) { 
                return "error";
            }
            return "success";
        }

测试

@Test
        public void test2() throws Exception { 
            MvcResult mvcResult =  this.mockMvc.perform(MockMvcRequestBuilders.post("/saveBasicInfoStep1")
                    .accept(MediaType.TEXT_HTML)
                    .param("name", "test123")
                    .param("password", "pass"))
                    .andExpect(status().isOk()).andDo(MockMvcResultHandlers.print()).andReturn();
            String contentAsString = mvcResult.getResponse().getContentAsString();
            assertEquals("success",contentAsString);;
    
        }

这也成功运行。 因此，可以看到@Validated的用法对于组验证至关重要。

# 4.使用@Valid注解标记嵌套对象 #

@Valid注解特别用于标记嵌套属性。 就会触发嵌套对象的验证。 例如，在当前的场景中，创建一个UserAddress对象：

@Data
    public class UserAddress { 
        @NotBlank
        private String countryCode;
    }

为了确保验证此嵌套对象，将使用@Valid注解包装属性：

public class UserAccount { 
        
        //...
        
        @Valid
        @NotNull(groups = AdvanceInfo.class)
        private UserAddress useraddress;
        
        // standard constructors / setters / getters / toString 
    }

# 5.利与弊 #

@Valid批注确保整个对象的验证。 重要的是，它执行整个对象图的验证。 但是，这为仅需要部分验证的方案带来了问题。

另一方面，可以使用@Validated进行组验证，包括上面的部分验证。 但是，在这种情况下，经过验证的实体必须知道其使用的所有组或用例的验证规则。

在这里，混合考虑，可能会产生反模式。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25pdWdhbmcwOTIw_size_16_color_FFFFFF_t_70]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25pdWdhbmcwOTIw_size_16_color_FFFFFF_t_70]: /images/20221022/62722b4a88504db190b7660961218bb7.png