解决 @Validate 在 Service 层的单元测试不生效

以你之姓@ 2023-01-19 13:59 454阅读 0赞

`@Validate`、`@Vaild` 注解之前被用在 controller 层做 requestBody 参数校验。项目打算将 controller 层变薄，requestBody 放到 service 层做校验，那这样的话，之前相关的单侧也要移到 service 层才可以。结果发现 这两个注解在 service 层的单测中不生效，开始搞事情。

[这种方式稍微麻烦些，有更简单的解决办法][Link 1]。

代码不能直接贴，写了个简化版的。

@Service
    @Validated
    public class UserService { 
        
        public void save(@Valid CreateUserCommand command){ 
            // 保存 user 的代码......
        }
    }
    
    // ---
    public class CreateUserCommand { 
      @NotBlank
      private String name;
    
      @Min(1)
      private int age;
    
      public CreateUserCommand(String name, int age) { 
        this.name = name;
        this.age = age;
      }
    }

单测：

@RunWith(SpringRunner.class)
    public class UserServiceTest { 
    	@Test
        public void should_throw_exception_when_age_smaller_than_zero(){ 
            CreateUserCommand command = new CreateUserCommand("deigo", -1);
            UserService service = new UserService();
            service.save(command);
        }
    }

`age == -1` ,单测应该报错，但是结果却是测试通过了，说明注解没有生效。

**原因很简单：service 是我手动创建的，不可生成代理。**

![image-20210510202856291][]

IOC 容器中的确也是没有的。

单测正确的打开方式：

@RunWith(SpringJUnit4ClassRunner.class)
    @ContextConfiguration(classes = { UserServiceTest.Config.class})
    public class UserServiceTest { 
    
        public static class Config { 
            @Bean
            public MethodValidationPostProcessor methodValidationPostProcessor() { 
                return new MethodValidationPostProcessor();
            }
    
    		// 注入 UserService 的 bean。
            @Bean
            public UserService userService() { 
                return new UserService();
            }
        }
    	
    	// 在从 IOC 容器中拿出来。
    	@Autowired
        private UserService service;
    
    	@Test
    	public void should_throw_exception_when_age_smaller_than_zero() { 
    		CreateUserCommand command = new CreateUserCommand("deigo", -1);
    		try { 
    		service.save(command);
    		} catch (ConstraintViolationException e) { 
    			System.out.println(e.getConstraintViolations().size());
              // 结果是 1。 
    		}
    }

上面算的是最原始的版本，但实际项目中不会这么简单的。

@Service
    @Validated
    public class UserService { 
    
        private UserRepository userRepository;
    
        @Autowired
        public UserService(UserRepository userRepository) { 
            this.userRepository = userRepository;
        }
    
        public void save(@Valid CreateUserCommand command){ 
            // .....
            // 反正就是干了件别的事情。
            Account account = userRepository.ofAccount(command.getName());
            // ..... 
            userRepository.save(...)
        }
    }
    
    // ---
    public class CreateUserCommand { 
      @NotBlank
      @UserNameExistConstraint // name不能重复
      private String name;
    
      @Min(value = 1)
      private int age;
    
      public CreateUserCommand(String name, int age) { 
        this.name = name;
        this.age = age;
      }
    }
    
    // ---
    @Documented
    @Constraint(validatedBy = UserNameExistValidator.class)
    @Target({ ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER})
    @Retention(RetentionPolicy.RUNTIME)
    public @interface UserNameExistConstraint { 
      String message() default "{user.name.exist}";
    
      Class[] groups() default { };
    
      Class[] payload() default { };
    }
    
    // ---
    @Component
    public class UserNameExistValidator
        implements ConstraintValidator<UserNameExistConstraint, String> { 
    
      @Autowired private UserRepository userRepository;
    
      @Override
      public boolean isValid(String name, ConstraintValidatorContext context) { 
        // 从数据库中查下 name 是不是已经有了。
          if (userRepository.ofId(name).isPresent()) { 
          return false;
        }
        return true;
      }
    }

代码意图很明显，userRepository 专门负责持久化相关的，而它是在创建 userService 时注进来的。自定义校验 UserNameExistValidator 查看 name 是否已经存在了。

这种场景下，单测的打开放是这这样的。

@ContextConfiguration(classes = { UserServiceTest.Config.class})
    @RunWith(SpringJUnit4ClassRunner.class)
    public class UserServiceTest { 
      
      public static class Config { 
    
        private static UserRepository instance;
    
        public static UserRepository getInstance() { 
          if (instance == null) { 
            instance = Mockito.mock(UserRepository.class);
          }
          return instance;
        }
    	
        @Bean
        public Validator validator() { 
          return new LocalValidatorFactoryBean();
        }
    	
        @Bean
        public MethodValidationPostProcessor methodValidationPostProcessor(Validator validator) { 
          MethodValidationPostProcessor methodValidationPostProcessor =
              new MethodValidationPostProcessor();
          methodValidationPostProcessor.setValidator(validator);
          return methodValidationPostProcessor;
        }
    
        @Bean
        public UserService userCreateService() { 
          return new UserService(getInstance());
        }
    
        @Bean
        public UserRepository resourceRepository(){ 
            return getInstance();
        }
      }
    
      @Autowired
      private UserService service;
    
      @Autowired
      private UserRepository userRepository;
    
      @Test
      public void should_create_new_user_succeed(){ 
        CreateUserCommand command = new CreateUserCommand("deigo", 10);
        // mock name 没有重复 
        when(userRepository.ofId(command.getName())).thenReturn(Mockito.mock(Optional.empty()));
    	// 给 name mock 一个账户
        when(userRepository.ofId(command.getName())).thenReturn(Mockito.mock(Optional.empty()));
        // 执行创建。
        service.save(command);
      }
    }

简单说明下：

之所以有这两块代码，是为了能将 userRepository 注入到 UserNameExistValidator 中。否则 `userRepository == null` ，校验永远都在报空指针异常。

@Bean
    public Validator validator() { 
        return new LocalValidatorFactoryBean();
    }
    
    @Bean
    public MethodValidationPostProcessor methodValidationPostProcessor(Validator validator) { 
        MethodValidationPostProcessor methodValidationPostProcessor =
            new MethodValidationPostProcessor();
        methodValidationPostProcessor.setValidator(validator);
        return methodValidationPostProcessor;
    }

之所以设计单例，是因为，UserNameExistValidator 和 UserService 方法中都要注入 userRepository。如果不使用单例，会给 UserNameExistValidator 和 UserService 注入不一样的 userRepository。如果这样，那测试案例中的 mock 就说不清楚了，总会有一个挂掉。（也许这个地方还有更好的解决方案）

private static UserRepository instance;
    
    public static UserRepository getInstance() { 
        if (instance == null) { 
            instance = Mockito.mock(UserRepository.class);
        }
        return instance;
    }

一个单测，这个下午就这么过去了…

[Link 1]: https://blog.csdn.net/yy_diego/article/details/116782679
[image-20210510202856291]: https://raw.githubusercontent.com/diego1109/pictures/main/20210510202856.png