springmvc項目使用@Valid+BindingResult遇到的問題

今天在一個老的dubbo+springmvc結構的項目做一個接口。通過controller的方式,因為參數復雜,所以想通過@valid+BindingResult的方式做參數校驗。

在springcloude+springboot中,maven的依賴無需你去考慮,一般都引用好瞭。但是在老的springmvc中,還是需要你自己添加一下引用的。

看瞭網上的一些資料,往往都忽略著這部分,所以@valid一致無效,也不報錯,BindingResult的errors數量是0。後來經過多方查找,資料拼湊,終於解決瞭這個問題。這裡記錄一下。

第一步:pom.xml中引入

javax.validation和hibernate-validator

<!-- springmvc的參數valid校驗依賴 開始 -->
		<dependency>
			<groupId>javax.validation</groupId>
			<artifactId>validation-api</artifactId>
			<version>2.0.1.Final</version>
		</dependency>
		<dependency>
			<groupId>org.hibernate</groupId>
			<artifactId>hibernate-validator</artifactId>
			<version>6.0.16.Final</version>
		</dependency>
<!-- springmvc的參數valid校驗依賴 結束 -->

之前我隻引入瞭javax的驗證,這樣做系統不會報錯。就是bindingResult返回的errors一直為0。校驗不起作用。

第二步:創建需要校驗的參數bean類

需要引入的類:

import javax.validation.constraints.Min;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Pattern;
@Component
public class UserScheduleByManualBean implements Serializable { 
	/**
	 * 
	 */
	private static final long serialVersionUID = 8093326646402381469L; 
	@NotBlank(message = "賽事不能為空")
	private String matchEventName; // 賽事名稱
 
	@NotBlank(message = "發槍時間不能為空")
	@Pattern(regexp = "((([0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]{1}|[0-9]{1}[1-9][0-9]{2}|[1-9][0-9]{3})-(((0[13578]|1[02])-(0[1-9]|[12][0-9]|3[01]))|((0[469]|11)-(0[1-9]|[12][0-9]|30))|(02-(0[1-9]|[1][0-9]|2[0-8]))))|((([0-9]{2})(0[48]|[2468][048]|[13579][26])|((0[48]|[2468][048]|[3579][26])00))-02-29))\\s([0-1][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])$", message = "發槍格式錯誤")
	private String gunTime; // 發槍時間
	
	@NotNull(message = "國傢ID不能為空")
	@Min(value = 0,message = "國傢ID數據格式錯誤")
	private int dicCountryId; // 國傢ID
	
	@NotBlank(message = "國傢名稱不能為空")
	private String countryName; // 國傢名稱
	
	@NotNull(message = "省份ID不能為空")
	@Min(value = 0,message = "省份ID數據格式錯誤")
	private int dicProvinceId; // 省份ID
	@NotBlank(message = "省份名稱不能為空")
	private String provinceName; // 省份名稱
	
	@NotNull(message = "城市ID不能為空")
	@Min(value = 0,message = "城市ID數據格式錯誤")
	private int dicCityId; // 城市ID
	@NotBlank(message = "城市名稱不能為空")
	private String cityName; // 城市名稱	
	
	private String projectName; // 項目名稱
	private String remarks; // 說明 可以為空
	private String bib; // 賽號 可以為空
 
    //get和set方法忽略
}

這裡一定要註意兩個問題

1: bean上加@Component註解,並且spring配置要掃描到這個包,否則也不生效。

2: @valid方式校驗,有很多限制註解(後面附表)。不通的限制註解,對應的數據類型不一樣。比如:@Pattern註解,隻能在String類型上使用。我一開始希望int的屬性也直接通過正則做校驗。結果報錯:HV000030: No validator could be found for constraint ‘javax.validation.constraints.Pattern’ validating type ‘java.lang.Integer’

3: 註解可以多個

第三步:寫controller類

首先,我們先創建一個BaseController抽象類,其中有BindingResult校驗方法,其他所有的controller繼承該類實現校驗。

引入的java類:

       import org.springframework.validation.BindingResult;
       import javax.validation.Valid;
public abstract class BaseController { 
	/**
	 * 校驗通過bean當參數的驗證結果方法
	 * @param bindingResult
	 * @return
	 */
	protected Map<String, Object> validate(BindingResult bindingResult) { 
		Map<String, Object> ret = new HashMap<>();
		boolean isTrue = true;
		StringBuilder sb = new StringBuilder("");
		if (bindingResult.hasErrors()) {
			bindingResult.getAllErrors().forEach(o ->{
                FieldError error = (FieldError) o;
                sb.append("|" + error.getDefaultMessage());//	添加錯誤信息
            });
			isTrue = false;
		} 
		ret.put("isTrue", isTrue);
		ret.put("message", sb.toString());// 錯誤信息
		return ret;
	}
}

其次,我們創建業務的controller類,繼承BaseController。

@Api(value = "TestController-API", description = "測試操作接口")
@Controller
@RequestMapping("testController/*")
public class TestController extends BaseController { 
    @RequestMapping(value = "tstex", method = RequestMethod.POST, produces = "application/json;charset=UTF-8")
	@ApiOperation(value = "測試異常方法", notes = "測試異常方法")
	public @ResponseBody String tstex(@Valid @RequestBody UserScheduleByManualBean userScheduleByManualBean,
			BindingResult bindingResult) {
		Map<String, Object> ret = new HashMap<>();
 
		// 校驗userScheduleByManualBean是否合法
		Map<String, Object> validRet = validate(bindingResult);
		boolean isTrue = (Boolean) validRet.get("isTrue");
		if (!isTrue) {
			// 參數不合法
			String erroMsg = (String) validRet.get("message");
			ret.put("resultCode", “0001”);
			ret.put("resultDesc", “參數錯誤” + erroMsg);
			return JsonUtil.gson_ObjectToJSON(ret);
		} 
		ret.put("resultCode", “0000”);
		ret.put("resultDesc", “成功”);
		return JsonUtil.gson_ObjectToJSON(ret);
	}
}

這裡需要註意的問題:@Valid和@RequestBody是有位置關系的,必須@Valid在前面。BindingResult bindingResult作為參數傳遞進來,然後通過validate校驗參數,並設置統一的返回結果。

通過swagger運行結果如下:

附 件

限制註解 說明 限制類型 樣例
@Null 限制隻能為null 全部 @Null(message=””)
@NotNull 限制必須不為null 全部 @NotNull(message=””)
@AssertFalse 限制必須為false
@AssertTrue 限制必須為true
@DecimalMax(value) 限制必須為一個不大於指定值的數字
@DecimalMin(value) 限制必須為一個不小於指定值的數字
@Digits(integer,fraction) 限制必須為一個小數,且整數部分的位數不能超過integer,小數部分的位數不能超過fraction
@Future 限制必須是一個將來的日期
@Max(value) 限制必須為一個不大於指定值的數字 int @Max(value=100,message=””)
@Min(value) 限制必須為一個不小於指定值的數字 int @Min(value=100,message=””)
@Past 限制必須是一個過去的日期
@Pattern(value) 限制必須符合指定的正則表達式 String

@Pattern(regexp=””,message=””)

@Size(max,min) 限制字符長度必須在min到max之間
@NotEmpty 驗證註解的元素值不為null且不為空(字符串長度不為0、集合大小不為0) String

@NotEmpty(message = “”)

@NotBlank 驗證註解的元素值不為空(不為null、去除首位空格後長度為0),不同於@NotEmpty,@NotBlank隻應用於字符串且在比較時會去除字符串的空格 String

@NotBlank(message = “”)

@Email 驗證註解的元素值是Email,也可以通過正則表達式和flag指定自定義的email格式 String

以上為個人經驗,希望能給大傢一個參考,也希望大傢多多支持WalkonNet。

推薦閱讀: