Solon 框架详解（六）- Solon的校验框架使用、定制与扩展
Solon 详解系列文章：
Solon 框架详解（一）- 快速入门
Solon 框架详解（二）- Solon的核心
Solon 框架详解（三）- Solon的web开发
Solon 框架详解（四）- Solon的事务传播机制
Solon 框架详解（五）- Solon扩展机制之Solon Plugin
Solon 框架详解（六）- Solon的校验框架使用、定制与扩展
Solon 框架详解（七）- Solon Ioc 的注解对比Spring及JSR330
Solon 框架详解（八）- Solon的缓存框架使用和定制
Solon 框架详解（九）- 渲染控制之定制统一的接口输出
Solon 框架详解（十）- Solon 的常用配置
Solon 框架详解（十一）- Solon Cloud 的配置说明
在业务的实现过程中，尤其是对外接口开发，我们需要对请求进行大量的验证并返回错误状态码和描述。lombok 框架有很多很赞的注解，但是人家是throw一个异常，这与有些需求不一定能匹配。
该文将介绍Solon的扩展验证框架：solon.validation 的使用和扩展（ org.noear:solon-web 已包含）。效果如下：
@Valid
@Controller
public class UserController {
@NoRepeatSubmit //重复提交验证
@Whitelist //白名单验证
@NotNull({"name", "mobile", "icon", "code"}) //非NULL验证
@Numeric({"code"})
@Mapping("/user/add")
public void addUser(String name, @Pattern("^http") String icon, @Validated User user){
//...
}
}
@Data
public class User {
@NotNull
private String nickname;
@Email
private String email;
}
相较于 Spring 的 Validator 是争对 Bean，Solon 则是争对 Context（即http参数）。这点区别非常大，Solon 的设计是在 Action 执行之前对 http 参数进行校验。
| 注解 | 作用范围 | 说明 |
|---|---|---|
| Date | 参数 或 字段 | 校验注解的参数值为日期格式 |
| DecimalMax(value) | 参数 或 字段 | 校验注解的参数值小于等于@ DecimalMax指定的value值 |
| DecimalMin(value) | 参数 或 字段 | 校验注解的参数值大于等于@ DecimalMin指定的value值 |
| 参数 或 字段 | 校验注解的参数值为电子邮箱格式 | |
| Length(min, max) | 参数 或 字段 | 校验注解的参数值长度在min和max区间内 |
| Logined | 控制器 或 动作 | 校验用户是否已登录 |
| Max(value) | 参数 或 字段 | 校验注解的参数值小于等于@Max指定的value值 |
| Min(value) | 参数 或 字段 | 校验注解的参数值大于等于@Min指定的value值 |
| NoRepeatSubmit | 控制器 或 动作 | 校验本次请求没有重复 |
| NotBlacklist | 控制器 或 动作 | 校验本次请求不在黑名单范围内 |
| NotBlank | 动作 或 参数 或 字段 | 校验注解的参数值不是空白 |
| NotEmpty | 动作 或 参数 或 字段 | 校验注解的参数值不是空 |
| NotNull | 动作 或 参数 或 字段 | 校验注解的参数值不是null |
| NotZero | 动作 或 参数 或 字段 | 校验注解的参数值不是0 |
| Null | 动作 或 参数 | 校验注解的参数值是null |
| Numeric | 动作 或 参数 | 校验注解的参数值为数字格式 |
| Pattern(value) | 参数 或 字段 | 校验注解的参数值与指定的正则表达式匹配 |
| Size(min, max) | 参数 或 字段 | 校验注解的集合长度在min和max区间内 |
| Whitelist | 控制器 或 动作 | 校验本次请求在白名单范围内 |
| Validated | 参数 或 字段 | 为实体参数 或 实体字段启用验证能力 |
| Valid | 控制器 或 动作 | 为控制器 或 动作启用验证能力 |
可作用在 [动作 或 参数] 上的注解，加在动作上时可支持多个参数的校验。
一、定制使用
solon.extend.validation 通过 ValidatorManager，提供了一组定制和扩展接口。
1、@NoRepeatSubmit 改为分布式锁
NoRepeatSubmit 默认使用了本地延时锁。如果是分布式环境，需要定制为分布式锁：
public class NoRepeatSubmitCheckerNew implements NoRepeatSubmitChecker {
@Override
public boolean check(String key, int seconds) {
//使用分布式锁
//
return LockUtils.tryLock(XWaterAdapter.global().service_name(), key, seconds);
}
}
ValidatorManager.setNoRepeatSubmitChecker(new NoRepeatSubmitCheckerNew());
或者 完全重写 NoRepeatSubmitValidator，并进行重新注册
2、@Whitelist 实现验证
框架层面没办法为 Whitelist 提供一个名单库，所以需要通过一个接口实现完成对接。
public class WhitelistCheckerNew implements WhitelistChecker {
@Override
public boolean check(Whitelist anno, Context ctx) {
String ip = IPUtils.getIP(ctx);
return WaterClient.Whitelist.existsOfServerIp(ip);
}
}
ValidatorManager.setWhitelistChecker(new WhitelistCheckerNew());
或者 完全重写 WhitelistValidator，并进行重新注册
3、改造校验输出
solon.extend.validation 默认输出 http 400 状态 + json；尝试改改去掉 http 400 状态。
@Configuration
public class Config {
@Bean //Solon 的 @Bean 也支持空函数，为其它提运行申明
public void adapter() {
ValidatorManager.setFailureHandler((ctx, ano, rst, message) -> {
ctx.setHandled(true);
ctx.setRendered(true);
if (Utils.isEmpty(message)) {
message = new StringBuilder(100)
.append("@")
.append(ano.annotationType().getSimpleName())
.append(" verification failed")
.toString();
}
ctx.output(message);
return true;
});
}
}
二、添一个扩展注解
1、先定义个校验注解 @Date
偷懒一下，直接把自带的扔出来了。只要看着能自己搞就行了:-P
@Target({ElementType.PARAMETER}) //只让它作用到参数，不管作用在哪，最终都是对Context的校验
@Retention(RetentionPolicy.RUNTIME)
public @interface Date {
@Note("日期表达式, 默认为：ISO格式") //用Note注解，是为了用时还能看到这个注释
String value() default "";
String message() default "";
}
2、添加 @Date 的校验器实现类
public class DateValidator implements Validator<Date> {
@Override
public String message(Date anno) {
return anno.message();
}
/**
* 校验实体的字段
* */
@Override
public Result validateOfEntity(Class<?> clz, Date anno, String name, Object val0, StringBuilder tmp) {
if (val0 instanceof String == false) {
return Result.failure(clz.getSimpleName() + "." + name);
}
String val = (String) val0;
if (val == null || verify(anno, val) == false) {
return Result.failure(clz.getSimpleName() + "." + name);
} else {
return Result.succeed();
}
}
/**
* 校验上下文的参数
* */
@Override
public Result validateOfContext(Context ctx, Date anno, String name, StringBuilder tmp) {
String val = ctx.param(name);
if (val == null || verify(anno, val) == false) {
return Result.failure(name);
} else {
return Result.succeed();
}
}
private boolean verify(Date anno, String val) {
try {
if (Utils.isEmpty(anno.value())) {
DateTimeFormatter.ISO_LOCAL_DATE_TIME.parse(val);
} else {
DateTimeFormatter.ofPattern(anno.value()).parse(val);
}
return true;
} catch (Exception ex) {
return false;
}
}
}
3、注册到校验管理器
@Configuration
public class Config {
@Bean
public void adapter() {
//
// 此处为注册验证器。如果有些验证器重写了，也是在此处注册
//
ValidatorManager.register(Date.class, new DateValidator());
}
}
4、使用一下
@Valid
@Controller
public class UserController extends VerifyController{
@Mapping("/user/add")
public void addUser(String name, @Date("yyyy-MM-dd") String birthday){
//...
}
}
附：Solon项目地址
- gitee: https://gitee.com/noear/solon
- github: https://github.com/noear/solon
