SpringMVC 使用JSR-303進行校驗 @Valid

時間 2019-11-12

標籤 springmvc 使用 jsr 進行校驗 valid 欄目 Spring 简体版

原文原文鏈接

注意：1 public String save(@ModelAttribute("house") @Valid House entity, BindingResult result,HttpServletRequest request, Model model) BindingResult 必須放在model,request前面css

　　　2 validation-api-1.0.0.GA.jar是JDK的接口；hibernate-validator-4.2.0.Final.jar是對上述接口的實現。hibernate-validator-4.2.0.Final能夠，可是hibernate-validator-4.3.0.Final報錯html

驗證註解前端	驗證的數據類型java	說明git
@AssertFalseweb	Boolean,boolean正則表達式	驗證註解的元素值是falsespring
@AssertTruejson	Boolean,booleanapi	驗證註解的元素值是true
@NotNull	任意類型	驗證註解的元素值不是null
@Null	任意類型	驗證註解的元素值是null
@Min(value=值)	BigDecimal，BigInteger, byte, short, int, long，等任何Number或CharSequence（存儲的是數字）子類型	驗證註解的元素值大於等於@Min指定的value值
@Max（value=值）	和@Min要求同樣	驗證註解的元素值小於等於@Max指定的value值
@DecimalMin(value=值)	和@Min要求同樣	驗證註解的元素值大於等於@ DecimalMin指定的value值
@DecimalMax(value=值)	和@Min要求同樣	驗證註解的元素值小於等於@ DecimalMax指定的value值
@Digits(integer=整數位數, fraction=小數位數)	和@Min要求同樣	驗證註解的元素值的整數位數和小數位數上限
@Size(min=下限, max=上限)	字符串、Collection、Map、數組等	驗證註解的元素值的在min和max（包含）指定區間以內，如字符長度、集合大小
@Past	java.util.Date, java.util.Calendar; Joda Time類庫的日期類型	驗證註解的元素值（日期類型）比當前時間早
@Future	與@Past要求同樣	驗證註解的元素值（日期類型）比當前時間晚
@NotBlank	CharSequence子類型	驗證註解的元素值不爲空（不爲null、去除首位空格後長度爲0），不一樣於@NotEmpty，@NotBlank只應用於字符串且在比較時會去除字符串的首位空格
@Length(min=下限, max=上限)	CharSequence子類型	驗證註解的元素值長度在min和max區間內
@NotEmpty	CharSequence子類型、Collection、Map、數組	驗證註解的元素值不爲null且不爲空（字符串長度不爲0、集合大小不爲0）
@Range(min=最小值, max=最大值)	BigDecimal,BigInteger,CharSequence, byte, short, int, long等原子類型和包裝類型	驗證註解的元素值在最小值和最大值之間
@Email(regexp=正則表達式, flag=標誌的模式)	CharSequence子類型（如String）	驗證註解的元素值是Email，也能夠經過regexp和flag指定自定義的email格式
@Pattern(regexp=正則表達式, flag=標誌的模式)	String，任何CharSequence的子類型	驗證註解的元素值與指定的正則表達式匹配
@Valid	任何非原子類型	指定遞歸驗證關聯的對象；如用戶對象中有個地址對象屬性，若是想在驗證用戶對象時一塊兒驗證地址對象的話，在地址對象上加@Valid註解便可級聯驗證

SpringMVC 使用JSR-303進行校驗 @Valid

博客分類：

SpringMVC - 基礎篇

1、準備校驗時使用的JAR

說明：

validation-api-1.0.0.GA.jar是JDK的接口；

hibernate-validator-4.2.0.Final.jar是對上述接口的實現。

------------------------------------------------------------------------------------------------

新增一個測試的pojo bean ,增長jsr 303格式的驗證annotation

Java代碼

@NotEmpty
private String userName;
@Email
private String email;

在controller 類中的handler method中，對須要驗證的對象前增長@Valid 標誌

Java代碼

@RequestMapping("/valid")
public String valid(@ModelAttribute("vm") [color=red]@Valid[/color] ValidModel vm, BindingResult result) {
if (result.hasErrors()) {
return "validResult";
}
return "helloworld";
}

增長顯示驗證結果的jsp以下

Jsp代碼

<%@ taglib prefix="form" uri="http://www.springframework.org/tags/form"%>
<html>
<head>
<title>Reservation Form</title>
<style>
.error {
color: #ff0000;
font-weight: bold;
}
</style>
</head>
<body>
<form:form method="post" modelAttribute="vm">
<form:errors path="*" cssClass="error" />
<table>
<tr>
<td>Name</td>
<td><form:input path="userName" />
</td>
<td><form:errors path="userName" cssClass="error" />
</td>
</tr>
<tr>
<td>email</td>
<td><form:input path="email" />
</td>
<td><form:errors path="email" cssClass="error" />
</td>
</tr>
<tr>
<td colspan="3"><input type="submit" />
</td>
</tr>
</table>
</form:form>
</body>
</html>

訪問 http://localhost:8080/springmvc/valid?userName=winzip&email=winzip
查看驗證結果。
二：自定義jsr 303格式的annotation
參考hibernate validator 4 reference 手冊中3.1節，增長一個自定義要求輸入內容爲定長的annotation驗證類
新增annotation類定義

Java代碼

@Target( { METHOD, FIELD, ANNOTATION_TYPE })
@Retention(RUNTIME)
@Constraint(validatedBy = FixLengthImpl.class)
public @interface FixLength {
int length();
String message() default "{net.zhepu.web.valid.fixlength.message}";
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
}

及具體的驗證明現類以下

Java代碼

public class FixLengthImpl implements ConstraintValidator<FixLength, String> {
private int length;
@Override
public boolean isValid(String validStr,
ConstraintValidatorContext constraintContext) {
if (validStr.length() != length) {
return false;
} else {
return true;
}
}
@Override
public void initialize(FixLength fixLen) {
this.length = fixLen.length();
}
}

爲使自定義驗證標註的message正常顯示，須要修改servlet context配置文件，新增messageSource bean,以下

Xml代碼

<bean id="messageSource"
class="org.springframework.context.support.ReloadableResourceBundleMessageSource"
p:fallbackToSystemLocale="true" p:useCodeAsDefaultMessage="false"
p:defaultEncoding="UTF-8">
<description>Base message source to handle internationalization
</description>
<property name="basenames">
<list>
<value>classpath:valid/validation</value>
</list>
</property>
</bean>

表示spring 將從路徑valid/validation.properties中查找對於的message。
新增valid bean 引用新增的messageSource bean，表示valid message將從messageSource bean 注入。

Xml代碼

<bean id="validator"
class="org.springframework.validation.beanvalidation.LocalValidatorFactoryBean"
p:validationMessageSource-ref="messageSource">
<description>Enable the bean validation provider, and configure it to
use the messageSource when resolving properties</description>
</bean>

修改 <mvc:annotation-driven> 增長對validator bean的引用

Xml代碼

<mvc:annotation-driven validator="validator" />

最後修改以前新增的pojo bean ，新增一個mobileNO屬性並增長對自定義標註的引用

Java代碼

@FixLength(length=11)
private String mobileNO;

在前端jsp中也增長新字段的支持

Jsp代碼

<tr>
<td>mobileno</td>
<td><form:input path="mobileNO" />
</td>
<td><form:errors path="mobileNO" cssClass="error" />
</td>
</tr>

可訪問url http://localhost:8080/springmvc/valid?userName=winzip&email=winzip&mobileNO=138188888
來查看修改的結果。

三 json輸入的驗證
Spring mvc 3.0.5中對於json格式的輸入直接使用@valid標註有問題，目前這個bug還未修復 (見 SPR-6709)，預計在3.1 m2版本中會修復。
在此以前，能夠經過以下幾種方式來對json（或xml）格式的輸入來進行驗證。
1：在handler method中直接對輸入結果進行驗證

Java代碼

@RequestMapping("/validJson1")
@ResponseBody
public JsonResult processSubmitjson(@RequestBody ValidModel vm,
HttpServletRequest request) {
JsonResult jsonRst = new JsonResult();
Set<ConstraintViolation<ValidModel>> set = validator.validate(vm);
for (ConstraintViolation<ValidModel> violation : set) {
String propertyPath = violation.getPropertyPath().toString();
;
String message = violation.getMessage();
log.error("invalid value for: '" + propertyPath + "': "
+ message);
}
if (!set.isEmpty()){
jsonRst.setSuccess(false);
jsonRst.setMsg("輸入有誤!");
return jsonRst;
}
jsonRst.setSuccess(true);
jsonRst.setMsg("輸入成功!");
return jsonRst;
}

可經過修改後的helloworld.jsp中的json valid test1按鈕進行調用測試。

2：將此驗證邏輯封裝爲一個AOP，當需驗證的對象前有@valid標註和@RequestBody標註時開始驗證
新增handler method以下

Java代碼

@RequestMapping("/validJson2")
@ResponseBody
public JsonResult testJson4(@RequestBody @Valid ValidModel vm){
log.info("handle json for valid");
return new JsonResult(true,"return ok");
}

這裏沒有對輸入值作任何驗證，全部的驗證都在AOP中完成。
修改pom.xml增長對AOP相關類庫的引用。

Xml代碼

<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjweaver</artifactId>
<version>1.6.11</version>
</dependency>
<dependency>
<groupId>cglib</groupId>
<artifactId>cglib</artifactId>
<version>2.2.2</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-aop</artifactId>
<version>${org.springframework.version}</version>
</dependency>

修改servet context xml，增長對aop的支持。

Xml代碼

<aop:aspectj-autoproxy proxy-target-class="true" />

最後，新增AOP類

Java代碼

public class CustomerValidatorAOP {
private Validator validator;
@Pointcut("@annotation(org.springframework.web.bind.annotation.RequestMapping)")
private void controllerInvocation() {
}
@Around("controllerInvocation()")
public Object aroundController(ProceedingJoinPoint joinPoint) throws Throwable {
MethodSignature methodSignature = (MethodSignature) joinPoint.getSignature();
Method method = methodSignature.getMethod();
Annotation[] annotationList = method.getAnnotations();
/* for(Annotation anno:annotationList){
System.out.println(ResponseBody.class.isInstance(anno));
}
*/
Annotation[][] argAnnotations = method.getParameterAnnotations();
String[] argNames = methodSignature.getParameterNames();
Object[] args = joinPoint.getArgs();
for (int i = 0; i < args.length; i++) {
if (hasRequestBodyAndValidAnnotations(argAnnotations[i])) {
Object ret = validateArg(args[i], argNames[i]);
if(ret != null){
return ret;
}
}
}
return joinPoint.proceed(args);
}
private boolean hasRequestBodyAndValidAnnotations(Annotation[] annotations) {
if (annotations.length < 2)
return false;
boolean hasValid = false;
boolean hasRequestBody = false;
for (Annotation annotation : annotations) {
if (Valid.class.isInstance(annotation))
hasValid = true;
else if (RequestBody.class.isInstance(annotation))
hasRequestBody = true;
if (hasValid && hasRequestBody)
return true;
}
return false;
}
private JsonResult validateArg(Object arg, String argName) {
BindingResult result = getBindingResult(arg, argName);
validator.validate(arg, result);
if (result.hasErrors()) {
JsonResult jsonresult = new JsonResult();
jsonresult.setSuccess(false);
jsonresult.setMsg("fail");
return jsonresult;
}
return null;
}
private BindingResult getBindingResult(Object target, String targetName) {
return new BeanPropertyBindingResult(target, targetName);
}
@Required
public void setValidator(Validator validator) {
this.validator = validator;
}