整合Spring MVC，mybatis，hibernate,freemarker框架实现的自定义注解Validator验证机制实现对敏感词过滤的代码分享

   服务器端的数据验证，对于一个WEB应用来说是非常重要的，而Spring从3.0开始支持JSR-303规范，它定义了一些标准的验证约束，同时也提供了一个可扩展的自定义方式来满足不同的开发需要，大象以SSM3为基础，结合实例来说明如何通过Spring MVC用自定义约束注解的方式来实现Validator验证。
    在实现功能之前，我们需要在pom文件里添加一些必须的依赖：    

[xml]  view plain copy

1. <dependency>  
2.     <groupId>javax.validation</groupId>  
3.     <artifactId>validation-api</artifactId>  
4.     <version>1.0.0.GA</version>  
5. </dependency>  
6. <dependency>  
7.     <groupId>org.hibernate</groupId>  
8.     <artifactId>hibernate-validator</artifactId>  
9.     <version>4.0.2.GA</version>  
10. </dependency>  

validation-api 是 JSR-303 规范的标准接口， hibernate-validator 则是这套接口的一个实现，而 hibernate-validator 的实现里面又会用到 slf4j ，所以还需要加上这两个 jar 包。有了这些，我们就可以在此基础上实现自定义注解约束扩展了。

本篇还是以 SSM3 为基础，以对角色名称添加屏蔽词为例来说明如何实现这些功能。
首先需要定义这样一个屏蔽词注解：

[java]  view plain copy

1. @Documented  
2. @Constraint(validatedBy = {WordsValidator.class})  
3. @Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER})  
4. @Retention(RUNTIME)  
5. public @interface Words {  
6.       
7.     String message() default "{constraint.default.words.message}";  
8.   
9.     Class<?>[] groups() default {};  
10.   
11.     Class<? extends Payload>[] payload() default {};  
12.       
13.     String filed() default "";  
14. }  

 

上面这个注解类，message(),groups()和payload()这三个方法是注解验证的标准格式，filed()表示验证的字段名称，{constraint.default.words.message}是从ValidationMessages.properties资源文件中获取的，这个文件的位置就在resources目录下面。
    现在定义了验证接口，就需要有处理接口的实现，WordsValidator.class就是用来处理这个的：

 

[java]  view plain copy

1. public class WordsValidator implements ConstraintValidator<Words, String> {  
2.   
3.     @Override  
4.     public void initialize(Words wordsAnnotation) {  
5.     }  
6.   
7.     @Override  
8.     public boolean isValid(String value, ConstraintValidatorContext context) {  
9.         if (StringUtils.isBlank(value))  
10.             return Boolean.TRUE;  
11.         // 此处可以加载敏感词库,不过只列举了一个  
12.         return !StringUtils.trim(value).equals("最代码");  
13.     }  
14. }   

这里大象为了说明实现的方法，简化了处理，实际开发中，可以改进一下，通过使用屏蔽词库对 value 值进行过滤。下面是一个测试类，对此注解进行一个简单的测试。

[java]  view plain copy

1. @Test  
2. public void testWords(){  
3.     AnnotationDescriptor<Words> descriptor = new AnnotationDescriptor<Words>(Words.class);  
4.     Words words = AnnotationFactory.create(descriptor);  
5.     WordsValidator wordsValidator = new WordsValidator();  
6.     wordsValidator.initialize(words);  
7.     Assert.assertTrue(wordsValidator.isValid(null, null));  
8.     Assert.assertTrue(wordsValidator.isValid("", null));  
9.     Assert.assertTrue(wordsValidator.isValid("  ", null));  
10.     Assert.assertFalse(wordsValidator.isValid("  菠萝大象    ", null));  
11.     Assert.assertTrue(wordsValidator.isValid("大象", null));  
12.     Assert.assertTrue(wordsValidator.isValid("   大象  ", null));  
13. }  

RoleController 的 save 方法需要加入验证以及错误处理：

 

[java]  view plain copy

1. @RequestMapping(value = "/save", method = RequestMethod.POST)  
2. public String save(@Valid Role role, BindingResult result, Model model) {  
3.     if (result.hasErrors()) {  
4.         model.addAttribute("entity", role);  
5.         model.addAttribute("error", result.getAllErrors());  
6.         return "base/role_edit";  
7.     }  
8.     roleService.save(role);  
9.     return "redirect:/role";  
10. }  

页面上想要显示验证的错误信息，最方便的就是直接使用 spring-webmvc 里的 org.springframework.web.servlet.view.freemarker 下 的 spring.ftl 文件，它里面定义了很多的宏命令，同时还可以添加自定义的宏命令：

[java]  view plain copy

1. <#macro showErrors>  
2.     <#if error?exists>  
3.     <script type="text/javascript">  
4.         <#list error as e>  
5.         $("[for='${e.field}']").show().text("${e.defaultMessage}");  
6.         </#list>  
7.     </script>  
8.     </#if>  
9. </#macro>    

role_edit.html 这个页面的变动不大，主要就是四点，具体的可以查看源码。

1 、引入并定义 < #import"/common/spring.ftl" as spring/> 

2 、在角色名 input 后面增加 < label class="error" for="name" style="display:none;"></label> 

3 、然后加入 jquery.js ，用来解析 showErrors 中的脚本 

4 、使用 < @spring.showErrors/> 

最后，要想让这些功能都能正常的运行起来，需要改下 servlet-context.xml 文件

[xml]  view plain copy

1. <bean class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter">  
2.     <property name="webBindingInitializer">  
3.         <bean class="org.springframework.web.bind.support.ConfigurableWebBindingInitializer">  
4.             <property name="validator" ref="validator" />  
5.         </bean>  
6.     </property>  
7. </bean>  
8.   
9. <bean id="validator" class="org.springframework.validation.beanvalidation.LocalValidatorFactoryBean" />  

项目截图：

运行截图：