spring boot 中使用 hibernate validate 校验

潇洒

发布于 2023-10-20 12:27:11

2330

发布于 2023-10-20 12:27:11

文章被收录于专栏：石头岛

spring boot 中使用 Hibernate validate 进行入参字段校验，一般用于web 接口入参校验，用起来非常方便。

spring boot 的配置


import org.hibernate.validator.HibernateValidator;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.validation.beanvalidation.MethodValidationPostProcessor;

import javax.validation.Validation;
import javax.validation.Validator;
import javax.validation.ValidatorFactory;

@Configuration
public class ValidatorConfiguration {


    @Bean
    /**
     * Method:  开启快速返回
     * Description: 
     *          如果参数校验有异常，直接抛异常，不会进入到 controller，使用全局异常拦截进行拦截
     * Author: liu kai
     * Date: 2018/7/12 17:33
     * 
     * @param 
     * @return org.springframework.validation.beanvalidation.MethodValidationPostProcessor
     */
    public MethodValidationPostProcessor methodValidationPostProcessor() {
        MethodValidationPostProcessor postProcessor = new MethodValidationPostProcessor();
        /**设置validator模式为快速失败返回*/
        postProcessor.setValidator(validator());
        return postProcessor;
    }

    @Bean
    public Validator validator(){
        ValidatorFactory validatorFactory = Validation.byProvider( HibernateValidator.class )
                .configure()
                .addProperty( "hibernate.validator.fail_fast", "true" )
                .buildValidatorFactory();
        Validator validator = validatorFactory.getValidator();
        return validator;
    }
}

controller 中使用

使用步骤:

在 controller 类上 @Validated
BindingResult result 这个不能省，必须要有，测试不加不行。
@Valid 加上这个注解

@Validated
public class NewsInfoController {
    /**
 * Method:  添加新闻
 * Description:
 * Author: pan ying
 * Date: 2018/6/13 17:43
 *
 * @param newsRequestVo
 * @return com.reapal.openapi.web.vo.ResultVo
 */
@RequestMapping(value = "/save" ,method={RequestMethod.POST,RequestMethod.GET})
@ResponseBody
public ResultVo saveNewsInfo(@RequestBody @Valid NewsRequestVo newsRequestVo, BindingResult result){
   ResultVo resultVo = new ResultVo();
   newsInfoBusiness.insert(newsRequestVo);
   return  resultVo;
}

实体类中使用

public class NewsInfo implements Serializable {
    private static final long serialVersionUID = 3148176768559230877L;
    

	/** id */
	private String id;
	/** 新闻编号 */
	private String newsNo;
	/** 标题 */
	@NotNull
	@Length(max=30, message="长度超过限制")
	private String title;
}

本文参与腾讯云自媒体同步曝光计划，分享自作者个人站点/博客。

原始发表：2018-08-03，如有侵权请联系 cloudcommunity@tencent.com 删除

spring