使用Spring的Validator接口在Bean验证中自定义消息

时间:2016-09-15 19:04:31

标签: java spring spring-boot bean-validation spring-validator

我正在使用Spring Boot 1.3.5和Rest Controllers,一切正常。

我也在官方文档中使用Spring的验证示例技术(JSR-303 Bean Validation API和Spring的验证器界面,我尝试了两者并遇到了同样的问题)并且验证工作正常,但我无法配置自定义消息。

我已经配置了messages.properties文件,我可以很好地访问这个文件上的消息。但是,此验证似乎无法读取或访问通过spring boot自动配置的消息源(messages.properties)。

我可以通过@Autowired直接从控制器中注入的消息源对象访问消息(代码中有注释)。但是,Spring的验证器接口或JSR-303 Bean Validation的绑定结果似乎无法访问MessageSource中加载的messages.properties。我得到的结果是我的错误有代码但没有默认消息。

这是我的Application类:

@SpringBootApplication
@ImportResource({ "classpath:security/cas-context.xml", "classpath:security/cas-integration.xml",
    "classpath:security/security.xml" })
@EnableAutoConfiguration(exclude = VelocityAutoConfiguration.class) // http://stackoverflow.com/questions/32067759/spring-boot-starter-cache-velocity-is-missing

public class Application extends SpringBootServletInitializer {

@Override
protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
    return application.sources(Application.class);
}

public static void main(String[] args) {
    SpringApplication.run(Application.class, args);
}

@Bean
public ServletRegistrationBean cxfServlet() {
    return new ServletRegistrationBean(new CXFServlet(), "/services/*");
}

@Bean(name = Bus.DEFAULT_BUS_ID)
public SpringBus springBus() {
    return new SpringBus();
}

@Bean
public Nfse nfseService() {
    return new NfseImpl();
}

@Bean
public Endpoint endpoint() {
    EndpointImpl endpoint = new EndpointImpl(springBus(), nfseService());
    endpoint.publish("/nfseSOAP");
    return endpoint;
}

}

这是我的Bean:

public class Protocolo {

private Long id;

@NotNull
@Min(1)
@Max(1)
private String protocolo;

private StatusProtocoloEnum status;

public Long getId() {
    return id;
}

public void setId(Long id) {
    this.id = id;
}

public String getProtocolo() {
    return protocolo;
}

public void setProtocolo(String protocolo) {
    this.protocolo = protocolo;
}

public StatusProtocoloEnum getStatus() {
    return status;
}

public void setStatus(StatusProtocoloEnum status) {
    this.status = status;
}

}

这是我的休息控制器:

@RestController
public class ProtocoloController {

@Autowired
private MessageSource messageSource;

@Autowired
private ProtocoloDAO protocoloDAO;

@RequestMapping(value = "/prot", method = RequestMethod.POST)
public void testar(@Valid @RequestBody Protocolo p) {
    Authentication auth = SecurityContextHolder.getContext().getAuthentication();
    System.out.println(auth.getAuthorities());
    System.out.println(messageSource.getMessage("protocolo.tamanho", null, null)); 
// IN THIS PART I'M ABLE TO PRINT THE MESSAGE IF VALIDATION IS DISABLED
    System.out.println(p.getProtocolo());
}

}

所以,这段代码工作正常,因为我用无效的Protocolo调用方法,所以不调用该方法。但是,我的angularJS客户端收到响应,其中填充了错误代码,但所有默认消息都为空,因为验证没有看到我加载的messages.properties。

有没有办法让我的Spring验证接口或JSR-303验证在spring boot中加入了message.properties(messagesource)?我怎么能纠正这个?如果有必要,我也可以粘贴我的Spring Validation接口的代码示例。

非常感谢,

塔西西奥。

测试代码:

@RestController
public class ProtocoloController {

@Autowired
private MessageSource messageSource;

@Autowired
private ProtocoloDAO protocoloDAO;

@RequestMapping(value = "/prot", method = RequestMethod.POST)
public void testar(@Valid @RequestBody Protocolo p, BindingResult bindingResult) {
    System.out.println(messageSource.getMessage("Min.protocolo.protocolo", null, null));
    if (bindingResult.hasErrors()) {
               System.out.println(bindingResult.getFieldError().getDefaultMessage());
System.out.println(bindingResult.getFieldError().getCode());
    }
    System.out.println(p.getProtocolo());
}

}

3 个答案:

答案 0 :(得分:6)

编辑: Spring Boot 1.5.3中的已知错误请参阅https://github.com/spring-projects/spring-boot/issues/8979

Spring Boot ,因为 1.5.3 你需要这样做

@Configuration
public class ValidationMessageConfig {

    @Bean
    public LocalValidatorFactoryBean mvcValidator(MessageSource messageSource) {

        LocalValidatorFactoryBean factory = new LocalValidatorFactoryBean();
        factory.setValidationMessageSource(messageSource);

        return factory;
    }
}

然后它会起作用。

使用 1.5.2及之前版本,您可以扩展WebMVcConfigurerAdapter

@Configuration
public class ProfileMvcConfig extends WebMvcConfigurerAdapter {

    private MessageSource messageSource;

    @Autowired
    public ProfileMvcConfig(MessageSource messageSource) {

        this.messageSource = messageSource;
    }

    /**
     * This method is overridden due to use the {@link MessageSource message source} in bean validation.
     *
     * @return  A Validator using the {@link MessageSource message source} in bean validation.
     */
    @Override
    public Validator getValidator() {

        LocalValidatorFactoryBean factory = new LocalValidatorFactoryBean();
        factory.setValidationMessageSource(messageSource);

        return factory;
    }
}

另见documentation

答案 1 :(得分:0)

在Spring Boot应用程序中,MessageSource配置了MessageSourceAutoConfiguration,您不需要自动装配它。对于jsr303,在messages.properties文件中创建正确的键值对。对于" protocolo"字段,您应该在属性文件中有以下值。

NotNull.protocolo.protocolo=Field cannot be left blank
Min.protocolo.protocolo=Minimum value must be {1}

您还可以在代码中检查属性文件中的消息,如下所示。

public void testar(@Valid @RequestBody Protocolo p,BindingResult bindingResult) {
if(bindingResult.hasErrors()) {
    System.out.println(bindingResult.getFieldError().getDefaultMessage());
    }
}

答案 2 :(得分:0)

我在custom message in Spring validation中解决了此问题,请阅读答案的最后一部分。

还要选中this example

我使用了带有自定义注释的自定义验证器。我需要在自定义验证器中更改代码。

公共类PersonValidator实现ConstraintValidator {

    @Override
    public boolean isValid(final Person person, final ConstraintValidatorContext context) { 
        if (somethingIsInvalid()) {
            context.disableDefaultConstraintViolation();
            context.buildConstraintViolationWithTemplate("Something is invalid.").addConstraintViolation();
            return false;
        }

        return true;
    }
}