我要评论一、案例（参数校验的必要性）
传统方式（无注解）的缺点：
// 需要手动校验每个字段，代码冗余且易出错
public string register(user user) {
// 手动校验每个字段
if (user.getemail() == null || !isvalidemail(user.getemail())) {
throw new illegalargumentexception("邮箱格式错误");
}
if (user.getpassword().length() < 8) {
throw new illegalargumentexception("密码长度需≥8位");
}
// 校验逻辑与业务代码耦合，难以复用
}问题总结：
- 代码冗余：相同校验逻辑重复编写
- 维护困难：校验规则分散，修改成本高
- 可读性差：业务逻辑被大量
if-else淹没
注解方式的优势：
public class user {
@email(message = "邮箱格式不合法") // 一行注解替代复杂校验
private string email;
@size(min = 8, message = "密码长度需≥8位")
private string password;
}
@postmapping("/register")
public string register(@valid @requestbody user user) {
// 校验逻辑由框架自动处理
return "success";
}核心优势：
- 声明式校验：通过注解自动完成参数验证
- 代码简洁：减少冗余的
if-else判断 - 统一规范：标准化校验规则，降低维护成本
二、@valid 注解
简介
- java标准注解（javax.validation）
- 用于触发 bean validation 校验机制
- 可校验方法参数和成员属性
springboot配置
<!-- pom.xml 必须依赖 -->
<dependency>
<groupid>org.springframework.boot</groupid>
<artifactid>spring-boot-starter-validation</artifactid>
</dependency>使用示例
public class user {
@notnull(message = "用户名不能为空")
private string name;
@min(value = 18, message = "年龄必须≥18岁")
private integer age;
}
@postmapping("/users")
public string createuser(@valid @requestbody user user) { // 触发校验
return "success";
}全局异常处理（核心实践）
@restcontrolleradvice
public class globalexceptionhandler {
// 处理@valid/@validated抛出的校验异常
@exceptionhandler(methodargumentnotvalidexception.class)
public responseentity<map<string, string>> handlevalidationexception(methodargumentnotvalidexception ex) {
map<string, string> errors = new hashmap<>();
ex.getbindingresult().getfielderrors().foreach(error ->
errors.put(error.getfield(), error.getdefaultmessage()));
return responseentity.badrequest().body(errors);
}
}效果：自动返回结构化错误信息（字段名+错误描述）
三、@validated 注解
简介
- spring框架注解（org.springframework.validation.annotation）(@validated是spring框架提供的，导入springboot的依赖就会自动导入这个依赖)
- 支持分组校验（group validation）
- 可标注在类、方法、参数上
核心功能
// 分组接口定义
public interface creategroup {}
public interface updategroup {}
public class user {
@notblank(groups = creategroup.class)
private string name;
@notnull(groups = {creategroup.class, updategroup.class})
private integer age;
}
// 使用分组校验
@postmapping("/users")
public string createuser(@validated(creategroup.class) @requestbody user user) {
return "success";
}四、常用校验注解
最常用的注解：
| 注解 | 说明 | 示例 |
|---|---|---|
| @notnull | 值不能为null | @notnull(message="字段必填") |
| @notblank | 字符串非空（trim后） | 适用于用户名、密码等 |
| @min/@max | 数值范围限制 | @min(18) |
| @pattern | 正则表达式校验 | @pattern(regexp="^1[3-9]\\d{9}$") |
| @valid | 嵌套对象校验 | 用于对象内的子对象属性 |
比较常用的注解：
| 注解 | 适用类型 | 说明 | 示例 |
|---|---|---|---|
| @future | date | 日期必须在未来 | @future(message="截止时间无效") |
| @digits | 数值类型 | 整数位和小数位限制 | @digits(integer=3, fraction=2) |
| @negative | 数值类型 | 必须为负数 | 常用于财务系统 |
| @notempty | 集合/字符串 | 集合非空或字符串长度>0 | 比@notblank更宽松 |
组合注解（自定义）
// 自定义手机号校验注解
@documented
@constraint(validatedby = phonevalidator.class)
@target({field, parameter})
@retention(runtime)
public @interface phone {
string message() default "手机号格式不合法";
class<?>[] groups() default {};
class<? extends payload>[] payload() default {};
}
// 校验逻辑实现
public class phonevalidator implements constraintvalidator<phone, string> {
private static final pattern phone_pattern = pattern.compile("^1[3-9]\\d{9}$");
@override
public boolean isvalid(string value, constraintvalidatorcontext context) {
return value != null && phone_pattern.matcher(value).matches();
}
}使用场景：复用企业特定校验规则（如公司内部员工编号）
五、@valid 与 @validated 区别
| 特性 | @valid | @validated |
|---|---|---|
| 标准规范 | jsr-303/jsr-349 标准 | spring 框架扩展 |
| 分组校验 | 不支持 | 支持 |
| 嵌套校验 | 需要显式添加@valid | 不自动支持嵌套校验 |
| 作用位置 | 方法参数、成员属性 | 类、方法、参数 |
六、高频问题与最佳实践
常见问题排查
注解不生效：
- 检查是否忘记添加
@valid/@validated - 确保校验对象未被
@requestbody等注解错误包裹
嵌套校验失败：
- 确认在嵌套对象属性上添加了
@valid
性能优化建议
- 避免过度校验：在controller层做基础校验，复杂逻辑放到service层
- 使用分组校验：减少不必要的校验开销
高级技巧
// 动态分组校验（根据请求参数决定校验组）
@validated
@restcontroller
public class usercontroller {
@postmapping("/users")
public string createuser(
@requestparam string type,
@validated({default.class, type.equals("vip") ? vipgroup.class : default.class})
@requestbody user user
) {
return "success";
}
}实现原理：利用spring el表达式动态选择校验组
七、重点总结
优先使用场景：
- 优先使用
@valid的场景：嵌套对象校验、与非spring框架整合 - 优先使用
@validated的场景：需要分组校验、校验service层方法参数
配置要点：
- 要想使用
@valid必须添加spring-boot-starter-validation依赖 - 校验失败会抛出
methodargumentnotvalidexception
最佳实践：
// 嵌套校验示例
public class order {
@valid // 必须显式添加
private user user;
}
// 分组校验示例
@validated(updategroup.class)
public void updateuser(@requestbody user user) {}校验流程：
请求参数 → 注解声明 → 自动校验 → 异常处理（@controlleradvice）
相较传统参数校验优势：
- 减少70%以上的参数校验代码量
- 通过统一异常处理实现错误响应的标准化
- 提升代码可维护性和团队协作效率
总结
以上为个人经验，希望能给大家一个参考，也希望大家多多支持代码网。
发表评论