Springboot使用Validator校验参数

Author: yadong.zhang

README.md

@@ -24,6 +24,7 @@ My Springboot modules
 - [x] 19. [Springboot集成SpringRestdocs生成Api文档](https://github.com/zhangyd-c/springboot/tree/master/springboot-restdocs)
 - [x] 20. [Springboot开启HTTPS](https://github.com/zhangyd-c/springboot/tree/master/springboot-ssl)
 - [x] 21. [Springboot整合Swagger2](https://github.com/zhangyd-c/springboot/tree/master/springboot-swagger)
+- [x] 21. [Springboot使用Validator校验](https://github.com/zhangyd-c/springboot/tree/master/springboot-validator)
 
 ## 生命不息，折腾不止！
 ### 更多信息，请关注：
@@ -36,5 +37,5 @@ My Springboot modules
 ### 有任何问题可以
 - [new issue](https://github.com/zhangyd-c/springboot/issues)
 - [给我留言](http://www.flyat.cc/guestbook)
-
+- [![qq](http://pub.idqqimg.com/wpa/images/group.png "加入QQ群")](http://shang.qq.com/wpa/qunwpa?idkey=818382ba0fc222dffc0da6f71aa207bfaf93bafb856e1c852e56de5911cb4c19)
 ### 如果喜欢，请多多分享、多多Star

pom.xml

@@ -27,6 +27,7 @@
         <module>springboot-docker</module>
         <module>springboot-swagger</module>
         <module>springboot-interceptor</module>
+        <module>springboot-validator</module>
     </modules>
 
 	<parent>

springboot-validator/README.md

@@ -0,0 +1,59 @@
+# Springboot + validator 2017-10-10
+
+### 前言
+
+> The method validation feature supported by Bean Validation 1.1 is automatically enabled as long as a JSR-303 implementation (e.g. Hibernate validator) is on the classpath. This allows bean methods to be annotated with `javax.validation` constraints on their parameters and/or on their return value. Target classes with such annotated methods need to be annotated with the `@Validated` annotation at the type level for their methods to be searched for inline constraint annotations.
+
+#### 常用注解
+
+> @Null	只能是null   
+  @NotNull 不能为null 注意用在基本类型上无效，基本类型有默认初始值   
+  @AssertFalse 必须为false   
+  @AssertTrue	必须是true   
+  
+> 字符串/数组/集合检查：(字符串本身就是个数组)   
+  @Pattern(regexp="reg") 验证字符串满足正则   
+  @Size(max, min) 验证字符串、数组、集合长度范围   
+  @NotEmpty 验证字符串不为空或者null   
+  @NotBlank 验证字符串不为null或者trim()后不为空   
+  
+> 数值检查：同时能验证一个字符串是否是满足限制的数字的字符串   
+  @Max 规定值得上限int   
+  @Min 规定值得下限   	
+  @DecimalMax("10.8")	以传入字符串构建一个BigDecimal，规定值要小于这个值    
+  @DecimalMin 可以用来限制浮点数大小   
+  @Digits(int1, int2) 限制一个小数，整数精度小于int1；小数部分精度小于int2   
+  @Digits 无参数，验证字符串是否合法   	
+  @Range(min=long1,max=long2) 检查数字是否在范围之间   
+  这些都包括边界值   
+  
+> 日期检查：Date/Calendar   
+  @Past 限定一个日期，日期必须是过去的日期   
+  @Future 限定一个日期，日期必须是未来的日期   
+  
+> 其他验证：   
+  @Vaild 递归验证，用于对象、数组和集合，会对对象的元素、数组的元素进行一一校验   
+  @Email 用于验证一个字符串是否是一个合法的右键地址，空字符串或null算验证通过   
+  @URL(protocol=,host=,port=,regexp=,flags=) 用于校验一个字符串是否是合法URL   
+
+#### 注意
+
+@Validated 和 BindingResult 是一一对应的，如果有多个@Validated，那么每个@Validated后面跟着的BindingResult就是这个@Validated的验证结果，顺序不能乱，比如
+    
+````
+@RequestMapping("/saveUser")
+public ModelAndView saveUser(@Validated User user, BindingResult userResult, @Validated Other other, BindingResult otherResult, Model model) {
+    ......
+}
+````
+userResult对应user实体类的校验结果，otherResult对应other类的校验结果
+#### 如下异常
+```
+HV000030: No validator could be found for constraint 'javax.validation.constraints.Pattern' validating type 'java.lang.Integer'. Check configuration for 'phone'
+```
+定义属性时将phone类型设置为Integer了， @Pattern只能作用于String类型的属性，所以报上面的错。    
+
+
+#### 更多...
+
+[https://docs.spring.io/spring-boot/docs/current-SNAPSHOT/reference/htmlsingle/#boot-features-validation](https://docs.spring.io/spring-boot/docs/current-SNAPSHOT/reference/htmlsingle/#boot-features-validation)

springboot-validator/pom.xml

@@ -0,0 +1,26 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <parent>
+        <artifactId>springboot</artifactId>
+        <groupId>com.zyd</groupId>
+        <version>0.0.1-SNAPSHOT</version>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+
+    <artifactId>springboot-validator</artifactId>
+    <packaging>jar</packaging>
+
+    <name>springboot-validator</name>
+    <url>http://maven.apache.org</url>
+
+    <properties>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    </properties>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-freemarker</artifactId>
+        </dependency>
+    </dependencies>
+</project>

springboot-validator/src/main/java/com/zyd/Applaction.java

@@ -0,0 +1,12 @@
+package com.zyd;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+@SpringBootApplication
+public class Applaction {
+	public static void main(String[] args) throws Exception {
+		SpringApplication.run(Applaction.class, args);
+	}
+}
+

springboot-validator/src/main/java/com/zyd/config/ValidatorConfig.java

@@ -0,0 +1,45 @@
+/**
+ * Copyright [2016-2017] [yadong.zhang]
+ * <p>
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * <p>
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.zyd.config;
+
+import org.springframework.context.annotation.Configuration;
+import org.springframework.core.annotation.Order;
+import org.springframework.validation.MessageCodesResolver;
+import org.springframework.validation.Validator;
+import org.springframework.validation.beanvalidation.LocalValidatorFactoryBean;
+import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
+
+/**
+ * springboot
+ * Created by yadong.zhang on com.zyd.config
+ * @Author: yadong.zhang
+ * @Date: 2017/10/10 13:43
+ */
+@Configuration
+@Order(0)
+public class ValidatorConfig extends WebMvcConfigurerAdapter {
+
+    @Override
+    public Validator getValidator() {
+        LocalValidatorFactoryBean bean = new LocalValidatorFactoryBean();
+        return bean;
+    }
+
+    @Override
+    public MessageCodesResolver getMessageCodesResolver() {
+        return null;
+    }
+}

springboot-validator/src/main/java/com/zyd/controller/IndexController.java

@@ -0,0 +1,74 @@
+/**
+ * Copyright [2016-2017] [yadong.zhang]
+ * <p>
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * <p>
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.zyd.controller;
+
+import com.zyd.model.Other;
+import com.zyd.model.User;
+import org.springframework.stereotype.Controller;
+import org.springframework.ui.Model;
+import org.springframework.validation.BindingResult;
+import org.springframework.validation.FieldError;
+import org.springframework.validation.annotation.Validated;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.servlet.ModelAndView;
+
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * springboot
+ * Created by yadong.zhang on com.zyd.controller
+ *
+ * @Author: yadong.zhang
+ * @Date: 2017/10/10 13:41
+ */
+@Controller
+public class IndexController {
+
+    @RequestMapping("/")
+    public ModelAndView index() {
+
+        return new ModelAndView("index");
+    }
+
+    @RequestMapping("/saveUser")
+    public ModelAndView saveUser(@Validated User user, BindingResult userResult, @Validated Other other, BindingResult otherResult, Model model) {
+        List<Map<String, String>> errorList = new ArrayList<>();
+
+        loadErrorList(userResult, errorList);
+        loadErrorList(otherResult, errorList);
+
+        model.addAttribute("user", user);
+        model.addAttribute("other", other);
+        model.addAttribute("errorList", errorList);
+        return new ModelAndView("index");
+    }
+
+    private void loadErrorList(BindingResult userResult, List<Map<String, String>> errorList) {
+        Map<String, String> map = null;
+        if (userResult.hasErrors()) {
+            List<FieldError> errors = userResult.getFieldErrors();
+            for (FieldError error : errors) {
+                map = new HashMap<String, String>();
+                map.put("field", error.getField());
+                map.put("message", error.getDefaultMessage());
+                errorList.add(map);
+            }
+        }
+    }
+}

springboot-validator/src/main/java/com/zyd/model/Other.java

@@ -0,0 +1,60 @@
+/**
+ * Copyright [2016-2017] [yadong.zhang]
+ * <p>
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * <p>
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.zyd.model;
+
+import org.hibernate.validator.constraints.Length;
+
+import javax.validation.constraints.Pattern;
+
+/**
+ * springboot
+ * Created by yadong.zhang on com.zyd.model
+ *
+ * @Author: yadong.zhang
+ * @Date: 2017/10/10 13:45
+ */
+public class Other {
+
+    @Length(max = 18, min = 15, message = "身份证长度为15或者18位")
+    private String idcard;
+
+    @Pattern(regexp = "[0-9]{11}", message = "手机号格式错误")
+    private String phone;
+
+    public String getIdcard() {
+        return idcard;
+    }
+
+    public void setIdcard(String idcard) {
+        this.idcard = idcard;
+    }
+
+    public String getPhone() {
+        return phone;
+    }
+
+    public void setPhone(String phone) {
+        this.phone = phone;
+    }
+
+    @Override
+    public String toString() {
+        return "Other{" +
+                "idcard='" + idcard + '\'' +
+                ", phone=" + phone +
+                '}';
+    }
+}