百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术资源 > 正文

深入探讨 @Validated 失效场景及解决方案

lipiwang 2024-10-22 15:53 7 浏览 0 评论

在 Spring 开发中,@Validated 注解常用于参数校验,它依赖于 Hibernate Validator 或 JSR 303 实现的 Bean Validation。使用 @Validated 可以确保方法参数或对象属性符合预定义的约束条件,如非空、字符串长度、数值范围等。然而,在实际开发中,@Validated 有时可能会失效,导致参数校验未生效的问题。本文将详细分析这些失效场景并给出对应的解决方案。

一、常见的 @Validated 失效场景

1. 方法所在类未被 Spring 管理

@Validated 注解依赖 Spring 的 AOP(Aspect-Oriented Programming)代理机制来拦截方法并进行参数校验。如果一个类没有被 Spring 管理,@Validated 将无法生效。常见的情况包括使用 new 关键字创建对象。

示例:

public class UserService {
    @Validated
    public void createUser(@NotNull String username) {
        // 业务逻辑
    }
}

// 在某处手动创建该类实例
UserService userService = new UserService();
userService.createUser(null); // 校验无效

解决方案:

确保类被 Spring 容器管理,可以通过以下方式解决:

  • 使用 @Component 或其他类似注解(如 @Service, @Controller)将类纳入 Spring 容器管理。
  • 使用 @Autowired 或 ApplicationContext.getBean() 来获取该类的实例。

修改后代码:

@Service
public class UserService {
    @Validated
    public void createUser(@NotNull String username) {
        // 业务逻辑
    }
}

// 使用 Spring 容器获取 UserService 实例
@Autowired
private UserService userService;

userService.createUser(null); // 触发校验异常

2. 自调用导致 @Validated 失效

如果在类的内部调用自身的 @Validated 方法,由于 Spring AOP 代理的特性,内部方法调用不会触发代理逻辑,从而导致参数校验失效。

示例:

@Service
public class UserService {
    @Validated
    public void createUser(@NotNull String username) {
        // 业务逻辑
    }

    public void processUser() {
        // 内部调用
        createUser(null); // 校验无效
    }
}

解决方案:

  • 避免内部自调用,可以通过外部类或使用 Spring 的 AopContext 来解决。
  • 通过 AopContext.currentProxy() 获取当前代理对象。

修改后代码:

@Service
public class UserService {
    @Validated
    public void createUser(@NotNull String username) {
        // 业务逻辑
    }

    public void processUser() {
        // 使用代理对象调用
        ((UserService) AopContext.currentProxy()).createUser(null); // 触发校验异常
    }
}

3. 缺少 @Validated 注解或使用 @Valid

@Validated 注解必须放在类或方法上才能生效。有时开发者可能会错误地使用 @Valid,该注解通常用于嵌套对象校验,而非方法级别参数校验。

示例:

@Service
public class UserService {
    public void createUser(@Valid @NotNull String username) {
        // 业务逻辑
    }
}

在这种情况下,@Valid 对基本类型参数(如 String)无效,导致校验失效。

解决方案:

  • 使用 @Validated 注解在类或方法上,确保方法参数校验生效。

修改后代码:

@Service
@Validated
public class UserService {
    public void createUser(@NotNull String username) {
        // 业务逻辑
    }
}

4. 校验作用于控制器但未配置 @Validated

在 Spring MVC 中,参数校验常用于控制器方法的请求参数。如果控制器没有配置 @Validated,即使参数上有校验注解,也不会触发校验。

示例:

@RestController
public class UserController {
    @PostMapping("/user")
    public ResponseEntity<String> createUser(@NotNull @RequestBody User user) {
        // 业务逻辑
        return ResponseEntity.ok("User created");
    }
}

解决方案:

确保在控制器类或方法上使用 @Validated,如在类级别或方法级别上应用该注解。

修改后代码:

@RestController
@Validated
public class UserController {
    @PostMapping("/user")
    public ResponseEntity<String> createUser(@NotNull @RequestBody User user) {
        // 业务逻辑
        return ResponseEntity.ok("User created");
    }
}

5. 方法级别校验与接口类冲突

在使用接口定义服务时,如果将 @Validated 放在接口方法上,而不是在实现类上,可能导致校验无法生效。因为代理通常会作用于实现类,而不是接口。

示例:

public interface UserService {
    void createUser(@NotNull String username);
}

@Service
public class UserServiceImpl implements UserService {
    @Override
    public void createUser(String username) {
        // 业务逻辑
    }
}

这里,@NotNull 校验不会生效。

解决方案:

  • 将 @Validated 放在实现类上,或在实现类方法上使用 @Validated 注解。
  • 确保 @Validated 只作用于最终实际调用的方法上。

修改后代码:

@Service
@Validated
public class UserServiceImpl implements UserService {
    @Override
    public void createUser(@NotNull String username) {
        // 业务逻辑
    }
}

6. 校验分组使用错误

@Validated 支持分组校验,即根据不同的校验场景定义不同的校验组。如果在使用 @Validated 时未指定正确的校验组,可能导致校验不生效。

示例:

public class User {
    @NotNull(groups = CreateGroup.class)
    private String username;
}

@Service
public class UserService {
    @Validated(UpdateGroup.class) // 使用了错误的校验组
    public void createUser(@Valid User user) {
        // 业务逻辑
    }
}

解决方案:

  • 确保指定了正确的校验组。
  • 如果没有使用分组,可以省略 groups 参数。

修改后代码:

@Service
@Validated(CreateGroup.class)
public class UserService {
    public void createUser(@Valid User user) {
        // 业务逻辑
    }
}

二、总结

@Validated 作为 Spring 中常用的参数校验注解,能够帮助开发者在业务逻辑之前进行参数合法性校验,提升系统的鲁棒性。然而,开发过程中可能由于 Spring 容器管理、AOP 自调用、注解使用错误等多种原因导致其失效。通过本文对常见失效场景的分析及解决方案的讲解,希望开发者能够在项目中正确使用 @Validated,确保参数校验的有效性。

主要解决方案:

  1. 确保类被 Spring 容器管理。
  2. 避免自调用,使用代理调用方法。
  3. 在需要校验的地方正确使用 @Validated,而不是 @Valid。
  4. 校验控制器方法时,确保正确配置 @Validated。
  5. 确保接口实现类的校验注解正确配置。
  6. 合理使用校验分组,确保选择正确的校验组。

相关推荐

前端入门——css 网格轨道详细介绍

上篇前端入门——cssGrid网格基础知识整体大概介绍了cssgrid的基本概念及使用方法,本文将介绍创建网格容器时会发生什么?以及在网格容器上使用行、列属性如何定位元素。在本文中,将介绍:...

Islands Architecture(孤岛架构)在携程新版首页的实践

一、项目背景2022,携程PC版首页终于迎来了首次改版,完成了用户体验与技术栈的全面升级。作为与用户连接的重要入口,旧版PC首页已经陪伴携程走过了22年,承担着重要使命的同时,也遇到了很多问题:维护/...

HTML中script标签中的那些属性

HTML中的<script>标签详解在HTML中,<script>标签用于包含或引用JavaScript代码,是前端开发中不可或缺的一部分。通过合理使用<scrip...

CSS 中各种居中你真的玩明白了么

页面布局中最常见的需求就是元素或者文字居中了,但是根据场景的不同,居中也有简单到复杂各种不同的实现方式,本篇就带大家一起了解下,各种场景下,该如何使用CSS实现居中前言页面布局中最常见的需求就是元...

CSS样式更改——列表、表格和轮廓

上篇文章主要介绍了CSS样式更改篇中的字体设置Font&边框Border设置,这篇文章分享列表、表格和轮廓,一起来看看吧。1.列表List1).列表的类型<ulstyle='list-...

一文吃透 CSS Flex 布局

原文链接:一文吃透CSSFlex布局教学游戏这里有两个小游戏,可用来练习flex布局。塔防游戏送小青蛙回家Flexbox概述Flexbox布局也叫Flex布局,弹性盒子布局。它决定了...

css实现多行文本的展开收起

背景在我们写需求时可能会遇到类似于这样的多行文本展开与收起的场景:那么,如何通过纯css实现这样的效果呢?实现的难点(1)位于多行文本右下角的展开收起按钮。(2)展开和收起两种状态的切换。(3)文本...

css 垂直居中的几种实现方式

前言设计是带有主观色彩的,同样网页设计中的css一样让人摸不头脑。网上列举的实现方式一大把,或许在这里你都看到过,但既然来到这里我希望这篇能让你看有所收获,毕竟这也是前端面试的基础。实现方式备注:...

WordPress固定链接设置

WordPress设置里的最后一项就是固定链接设置,固定链接设置是决定WordPress文章及静态页面URL的重要步骤,从站点的SEO角度来讲也是。固定链接设置决定网站URL,当页面数少的时候,可以一...

面试发愁!吃透 20 道 CSS 核心题,大厂 Offer 轻松拿

前端小伙伴们,是不是一想到面试里的CSS布局题就发愁?写代码时布局总是对不齐,面试官追问兼容性就卡壳,想跳槽却总被“多列等高”“响应式布局”这些问题难住——别担心!从今天起,咱们每天拆解一...

3种CSS清除浮动的方法

今天这篇文章给大家介绍3种CSS清除浮动的方法。有一定的参考价值,有需要的朋友可以参考一下,希望对大家有所帮助。首先,这里就不讲为什么我们要清楚浮动,反正不清除浮动事多多。下面我就讲3种常用清除浮动的...

2025 年 CSS 终于要支持强大的自定义函数了?

大家好,很高兴又见面了,我是"高级前端进阶",由我带着大家一起关注前端前沿、深入前端底层技术,大家一起进步,也欢迎大家关注、点赞、收藏、转发!1.什么是CSS自定义属性CSS自...

css3属性(transform)的一个css3动画小应用

闲言碎语不多讲,咱们说说css3的transform属性:先上效果:效果说明:当鼠标移到a标签的时候,从右上角滑出二维码。实现方法:HTML代码如下:需要说明的一点是,a链接的跳转需要用javasc...

CSS基础知识(七)CSS背景

一、CSS背景属性1.背景颜色(background-color)属性值:transparent(透明的)或color(颜色)2.背景图片(background-image)属性值:none(没有)...

CSS 水平居中方式二

<divid="parent"><!--定义子级元素--><divid="child">居中布局</div>...

取消回复欢迎 发表评论: