springmvc项目使用@Valid+BindingResult遇到的问题

目录

• 第一步：pom.xml中引入
• javax.validation和hibernate-validator
• 第二步：创建需要校验的参数bean类
• 这里一定要注意两个问题
• 第三步：写controller类
• 附 件

今天在一个老的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运行结果如下：

附 件

以上为个人经验，希望能给大家一个参考，也希望大家多多支持我们。