Bean Validator扩展
1、需求
在使用validator时,有个需求就是公用错误提示信息,什么意思?
举个例子:
@NotEmpty非空判断,在资源文件中我不想每个非空判断都写”不能为空“,只需要写”###“,然后提示信息自动会变成”###不能为空“
代码:
复制代码
public class User{
//资源文件中user.name.empty=用户名
@NotEmpty(key={user.name.empty})
private String name;
‘’’
}
复制代码
//加入name为空,则最终的错误提示为“用户名不能为空”(会自动加上“不能为空”信息)
2、实现方式
有两种实现方式
方式一:手动调用验证方法
注解
复制代码
@Target({FIELD, ANNOTATION_TYPE})
@Retention(RUNTIME)
@ReportAsSingleViolation
@Constraint(validatedBy = {})
@NotNull
@Size(min = 1)
public @interface NotEmpty {
String message() default "{key}{com.chyjr.hyb.validator.constraints.empty.message}";
Class<?>[] groups() default { };
Class<? extends Payload>[] payload() default { };
String key() default "";
}
复制代码
验证器
//验证器
复制代码
public class MyValidator {
private static final Logger log = LoggerFactory.getLogger(HybValidator.class);
private static Validator validator = null;
private static MessageInterpolator msgInterpolator = null;
static {
if (validator == null) {
LocalValidatorFactoryBean factory =
(LocalValidatorFactoryBean) ApplicationContextUtil.getBean("validator");
validator = factory.getValidator();
msgInterpolator = factory.getMessageInterpolator();
}
}
public static HybValidatorResult validate(Object object, Class<?>… groups) {
HybValidatorResult result = new HybValidatorResult();
Set<ConstraintViolation> violations = validator.validate(object, groups);
Map<String, String> map = new HashMap<>();
if (CollectionUtils.isEmpty(violations)) {
result.setErrors(false);
} else {
result.setErrors(true);
for (ConstraintViolation violation : violations) {
String path = violation.getPropertyPath().toString();
String message = violation.getMessage();
if (StringUtils.isBlank(path) || StringUtils.isBlank(message) || map.containsKey(path))
continue;
message = resolveMessage(message);
map.put(path, message);
}
result.setItems(map);
}
return result;
}
private static final Pattern elpattern = Pattern.compile("\\{[^{}]+\\}");
private static String resolveMessage(String message) {
Matcher matcher = elpattern.matcher(message);
try {
while (matcher.find()) {
String el = matcher.group();
//用资源文件信息替换message = {key}{my.empty.message}
//注解这里的key会替换成注解NotEmpty定义的key,即
//message = {user.name.empty}{my.empty.message}
String val = msgInterpolator.interpolate(el, null);
if (StringUtils.isBlank(val))
continue;
message = message.replace(el, val);
}
} catch (Exception e) {
log.error("验证引擎进行数据校验时出现异常, message:{}", message, e);
}
return message;
}
}
复制代码
使用
//调用验证方法获得验证结果
复制代码
HybValidatorResult bvr = HybValidator.validate(emp, CreateValidator.class);
//表示有错误
if (bvr.isErrors()) {
}
//资源文件内容
//my.empty.message=不能为空
//user.name.empty=用户名
复制代码
方式二:用spring自带的@Validated,无需调用验证方法
这里有个问题:@Validated注解不认注解@NotEmpty中的key,如何解决呢?
最终的实现方案:自定义验证器
代码:
注解
复制代码
@Documented
@Target({FIELD, ANNOTATION_TYPE})
@Retention(RUNTIME)
@ReportAsSingleViolation
//指定验证器
@Constraint(validatedBy = NotEmptyValidator.class)
public @interface NotEmpty {
String message() default "{my.empty.message}";
Class<?>[] groups() default { };
Class<? extends Payload>[] payload() default { };
String key() default "";
}
复制代码
验证器:自定义
复制代码
public class NotEmptyValidator extends AbstractValidator<NotEmpty,Object>{
@Override
public void initialize(NotEmpty notEmpty) {
}
@Override
public boolean doIsValid(Object value, ConstraintValidatorContext cc) {
return value != null;
}
}
/**
- 这里采用模板的设计模式
- @param constraintAnnotation
/
public abstract class AbstractValidator<A extends Annotation,T> implements ConstraintValidator<A,T>{
/*- 初始化由具体类实现
- @param constraintAnnotation
/
@Override
public abstract void initialize(A constraintAnnotation);
/* - 初始化具体由实现类实现
- @param value
- @param context
- @return
/
@Override
public boolean isValid(T value, ConstraintValidatorContext context){
//获取验证结果,采用模板方法
boolean result = doIsValid(value,context);
//当验证错误时修改默认信息
if(!result){
//改变默认提示信息
if(ConstraintValidatorContextImpl.class.isAssignableFrom(context.getClass())){
ConstraintValidatorContextImpl constraintValidatorContext =
(ConstraintValidatorContextImpl)context;
//获取默认提示信息
String defaultConstraintMessageTemplate =
context.getDefaultConstraintMessageTemplate();
Object key =
constraintValidatorContext.getConstraintDescriptor().getAttributes().get(“key”);
//禁用默认提示信息
context.disableDefaultConstraintViolation();
//设置提示语(在message前面加上key)
context.buildConstraintViolationWithTemplate(key + defaultConstraintMessageTemplate).addConstraintViolation();
}
}
return result;
}
/* - 真正验证方法
- @param value
- @param context
- @return
*/
public abstract boolean doIsValid(T value, ConstraintValidatorContext context);
}
复制代码
使用:
调用的时候只要在JavaBean前加上@Validated注解即可
总结:上述就是在工作中遇到的问题,并扩展了Validator