@param注解_Spring的@ControllerAdvice注解作用原理探究

在Spring里,我们可以使用@ControllerAdvice来声明一些全局性的东西,最常见的是结合@ExceptionHandler注解用于全局异常的处理。

@ControllerAdvice是在类上声明的注解,其用法主要有三点:

  • @ExceptionHandler注解标注的方法:用于捕获Controller中抛出的不同类型的异常,从而达到异常全局处理的目的;
  • @InitBinder注解标注的方法:用于请求中注册自定义参数的解析,从而达到自定义请求参数格式的目的;
  • @ModelAttribute注解标注的方法:表示此方法会在执行目标Controller方法之前执行 。

看下具体用法:

// 这里@RestControllerAdvice等同于@ControllerAdvice + @ResponseBody

在Controller里取出@ModelAttribute标注的方法返回的UserDetails对象:

RestController

这里当入参为examOpDate=2019-06-10时,Spring会使用我们上面@InitBinder注册的类型转换器将2019-06-10转换examOpDate对象:

@PostMapping

@ExceptionHandler标注的多个方法分别表示只处理特定的异常。这里需要注意的是当Controller抛出的某个异常多个@ExceptionHandler标注的方法都适用时,Spring会选择最具体的异常处理方法来处理,也就是说@ExceptionHandler(Exception.class)这里标注的方法优先级最低,只有当其它方法都不适用时,才会来到这里处理。

下面我们看看Spring是怎么实现的,首先前端控制器DispatcherServlet对象在创建时会初始化一系列的对象:

public 

对于@ControllerAdvice 注解,我们重点关注initHandlerAdapters(context)和initHandlerExceptionResolvers(context)这两个方法。

initHandlerAdapters(context)方法会取得所有实现了HandlerAdapter接口的bean并保存起来,其中就有一个类型为RequestMappingHandlerAdapter的bean,这个bean就是@RequestMapping注解能起作用的关键,这个bean在应用启动过程中会获取所有被@ControllerAdvice注解标注的bean对象做进一步处理,关键代码在这里:

public 

经过这里处理之后,@ModelAttribute和@InitBinder就能起作用了,至于DispatcherServlet和RequestMappingHandlerAdapter是如何交互的这就是另一个复杂的话题了,此处不赘述。

再来看DispatcherServlet的initHandlerExceptionResolvers(context)方法,方法会取得所有实现了HandlerExceptionResolver接口的bean并保存起来,其中就有一个类型为ExceptionHandlerExceptionResolver的bean,这个bean在应用启动过程中会获取所有被@ControllerAdvice注解标注的bean对象做进一步处理,关键代码在这里:

public 

当Controller抛出异常时,DispatcherServlet通过ExceptionHandlerExceptionResolver来解析异常,而ExceptionHandlerExceptionResolver又通过ExceptionHandlerMethodResolver 来解析异常, ExceptionHandlerMethodResolver 最终解析异常找到适用的@ExceptionHandler标注的方法是这里:

public 

整个@ControllerAdvice处理的流程就是这样,这个设计还是非常灵活的。

源码github地址,各位同学可以试着去运行下项目熟悉这个流程:

jufeng98/java-master​github.com
v2-0849d83edf67eb757240e58424966d0f_ipico.jpg
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
@Param注解是一种常见的Java注解,用于标记方法参数的相关信息。它的重要性主要体现在以下几个方面: 1. 提供参数说明:通过使用@Param注解,可以为方法参数提供详细的说明,包括参数的用途、限制条件、取值范围等。这样可以增加代码的可读性和可维护性,方便其他开发人员理解和正确使用方法。 2. 参数校验:@Param注解可以与参数校验框架(如Hibernate Validator)结合使用,实现对方法参数的自动校验。通过在参数上添加相应的注解,可以定义参数的校验规则,如非空、长度限制、正则表达式等。在方法调用时,校验框架会自动检查参数的合法性,减少了手动编写校验代码的工作量。 3. 自动生成文档:一些文档生成工具(如Swagger)可以通过解析@Param注解来生成API文档。通过在方法参数上添加注解,可以将参数信息自动转化为文档中的参数说明,方便其他开发人员查阅和使用。 4. 参数映射:某些框架(如Spring MVC)可以通过@Param注解将HTTP请求中的参数自动映射到方法的参数上。通过在方法参数上添加注解,可以指定请求参数的名称、是否必需等属性,框架会自动将请求参数的值赋给方法参数,简化了参数获取和转换的过程。 总之,@Param注解在Java开发中具有重要的作用,可以提供参数说明、参数校验、文档生成和参数映射等功能,提高了代码的可读性、可维护性和开发效率。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值