@ControllerAdvice：你可以没用过，但是不能不了解

2024-06-24 11:12
文章标签 了解 不能不 controlleradvice 没用过

本文主要是介绍@ControllerAdvice：你可以没用过，但是不能不了解，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

1.概述

最近在梳理Spring MVC相关扩展点时发现了@ControllerAdvice这个注解，用于定义全局的异常处理、数据绑定、数据预处理等功能。通过使用 @ControllerAdvice，可以将一些与控制器相关的通用逻辑提取到单独的类中进行集中管理，从而减少代码重复，提升代码的可维护性。

定义如下

/*** Specialization of {@link Component @Component} for classes that declare* {@link ExceptionHandler @ExceptionHandler}, {@link InitBinder @InitBinder}, or* {@link ModelAttribute @ModelAttribute} methods to be shared across* multiple {@code @Controller} classes.* ........*/
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface ControllerAdvice {@AliasFor("basePackages")String[] value() default {};@AliasFor("value")String[] basePackages() default {};Class<?>[] basePackageClasses() default {};Class<?>[] assignableTypes() default {};Class<? extends Annotation>[] annotations() default {};}

从定义来看，@ControllerAdvice是@Component的一个派生注解，这就意味着使用该注解的类会被Spring扫描到放入bean容器中。从上面注释也可以得知@ControllerAdvice一般与这三个注解@ExceptionHandler，@InitBinder和@ModelAttribute配合使用，从而作用于所有的@Controller类的接口上。@ExceptionHandler想来我们并不陌生，是用来全局异常统一处理的，但另外两个注解@InitBinder和@ModelAttribute在日常中个人感觉并不常用，我们稍后会浅浅分析下它们是做什么用的。

2.@ExceptionHandler

这个注解我们并不陌生，进行统一异常处理使用的，程序由于运行时异常导致报错的结果，有些异常我们可能无法提前预知，接口不能正常返回结果，因此我们需要定义一个统一的全局异常来捕获这些信息，并作为一种结果返回给控制层。

先来看看没有进行全局异常处理的报错，搞一个Java常出现的示例如下：

    @GetMapping("/111")public void test111() {User user = null;String userNo = user.getUserNo();System.out.println(userNo);}

调接口报错如下：

{"timestamp": "2024-06-13T06:25:01.508+00:00","status": 500,"error": "Internal Server Error","path": "/test/111"
}

这对于前端来说是不太友好的。下面来看看全局统一异常处理

package com.shepherd.basedemo.advice;import lombok.extern.slf4j.Slf4j;
import org.springframework.http.HttpStatus;
import org.springframework.validation.BindingResult;
import org.springframework.web.HttpRequestMethodNotSupportedException;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.MissingServletRequestParameterException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.method.annotation.MethodArgumentTypeMismatchException;
import org.springframework.web.servlet.NoHandlerFoundException;import java.util.HashMap;
import java.util.Map;/*** @author fjzheng* @version 1.0* @date 2024/6/13 14:41*/
@ControllerAdvice
@Slf4j
public class GlobalExceptionHandler {/*** 全局异常处理* @param e* @return*/@ResponseBody@ResponseStatus(HttpStatus.OK)@ExceptionHandler(Exception.class)public ResponseVO exceptionHandler(Exception e){// 处理业务异常if (e instanceof BizException) {BizException bizException = (BizException) e;if (bizException.getCode() == null) {bizException.setCode(ResponseStatusEnum.BAD_REQUEST.getCode());}return ResponseVO.failure(bizException.getCode(), bizException.getMessage());} else if (e instanceof MethodArgumentNotValidException) {// 参数检验异常MethodArgumentNotValidException methodArgumentNotValidException = (MethodArgumentNotValidException) e;Map<String, String> map = new HashMap<>();BindingResult result = methodArgumentNotValidException.getBindingResult();result.getFieldErrors().forEach((item)->{String message = item.getDefaultMessage();String field = item.getField();map.put(field, message);});log.error("数据校验出现错误：", e);return ResponseVO.failure(ResponseStatusEnum.BAD_REQUEST, map);} else if (e instanceof HttpRequestMethodNotSupportedException) {log.error("请求方法错误：", e);return ResponseVO.failure(ResponseStatusEnum.BAD_REQUEST.getCode(), "请求方法不正确");} else if (e instanceof MissingServletRequestParameterException) {log.error("请求参数缺失：", e);MissingServletRequestParameterException ex = (MissingServletRequestParameterException) e;return ResponseVO.failure(ResponseStatusEnum.BAD_REQUEST.getCode(), "请求参数缺少: " + ex.getParameterName());} else if (e instanceof MethodArgumentTypeMismatchException) {log.error("请求参数类型错误：", e);MethodArgumentTypeMismatchException ex = (MethodArgumentTypeMismatchException) e;return ResponseVO.failure(ResponseStatusEnum.BAD_REQUEST.getCode(), "请求参数类型不正确：" + ex.getName());} else if (e instanceof NoHandlerFoundException) {NoHandlerFoundException ex = (NoHandlerFoundException) e;log.error("请求地址不存在：", e);return ResponseVO.failure(ResponseStatusEnum.NOT_EXIST, ex.getRequestURL());} else {//如果是系统的异常，比如空指针这些异常log.error("【系统异常】", e);return ResponseVO.failure(ResponseStatusEnum.SYSTEM_ERROR.getCode(), ResponseStatusEnum.SYSTEM_ERROR.getMsg());}}}

再次调用接口结果如下：

这时候正常返回统一的格式，方便前端处理。关于接口返回结果格式全局统一和异常统一处理详解请看之前总结的：Spring Boot如何优雅实现结果统一封装和异常统一处理

3.@InitBinder

该注解作用于方法上,用于将前端请求的特定类型的参数在到达controller之前进行处理，从而达到转换请求参数格式的目的。

先来看看我们接口示例：

    @GetMapping("/222")public void test222(User user) {System.out.println(user);}

@Data
public class User {private Long id;private Date birthday;
}

postman调接口：

报错了：

org.springframework.validation.BindException: org.springframework.validation.BeanPropertyBindingResult: 1 errors
Field error in object 'user' on field 'birthday': rejected value [2024-06-30 12:00:00]; codes [typeMismatch.user.birthday,typeMismatch.birthday,typeMismatch.java.util.Date,typeMismatch]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [user.birthday,birthday]; arguments []; default message [birthday]]; default message [Failed to convert property value of type 'java.lang.String' to required type 'java.util.Date' for property 'birthday'; nested exception is org.springframework.core.convert.ConversionFailedException: Failed to convert from type [java.lang.String] to type [@com.fasterxml.jackson.annotation.JsonFormat @com.alibaba.excel.annotation.ExcelProperty java.util.Date] for value [2024-06-30 12:00:00]; nested exception is java.lang.IllegalArgumentException]

这时候使用@InitBinder就能解决了

@ControllerAdvice
public class GlobalAdviceHandler {@InitBinderpublic void initBinder(WebDataBinder binder) {// 自定义数据绑定逻辑binder.registerCustomEditor(Date.class, new CustomDateEditor(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"), false));}
}

重新调接口控制台就正常输出了。但请注意@InitBinder仅作用于get接口，对于post接口的@RequestBody接收参数并不起效

    @PostMapping("/111")public void test111(@RequestBody User user) {System.out.println(user);}

针对于json传参我们可以在接参的实体日期字段上添加@JsonFormat(pattern = “yyyy-MM-dd HH:mm:ss”, timezone = “GMT+8”)

@Data
public class User {private Long id;@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")private Date birthday;
}

或者在配置文件配置如下：

spring:jackson:date-format: yyyy-MM-dd HH:mm:sslocale: zh_CNtime-zone: GMT+8default-property-inclusion: non_null

4.@ModelAttribute

该注解作用于方法和请求参数上，在方法上时设置一个值，可以直接在进入controller后传入该参数。全局绑定登录上下文参数：

@ControllerAdvice
public class GlobalAdviceHandler {@ModelAttribute("loginUser")public LoginUser setLoginUser() {return RequestUserHolder.getCurrentUser();}
}

接口方法就能使用@ModelAttribute绑定获取参数了

    // 使用@PostMapping("/student")public ResponseVO<Long> addStudent(@ModelAttribute("loginUser") LoginUser loginUser, @RequestBody Student student){return ResponseVO.success(studentService.addStudent(loginUser, student));}

其实完全没必要这么做，需要登录上下文信息时候直接使用RequestUserHolder.getCurrentUser()获取即可，看你怎么选择啦，是喜欢通过方法参数传递登录信息上下文，还是用的地方再获取。

5.@ControllerAdvice实现原理

我们都知道Spring MVC的核心处理器是DispatcherServlet，项目启动时会调用 DispatcherServlet 的 #initStrategies(ApplicationContext context) 方法，初始化 Spring MVC 的各种组件

protected void initStrategies(ApplicationContext context) {// 初始化 MultipartResolverinitMultipartResolver(context);// 初始化 LocaleResolverinitLocaleResolver(context);// 初始化 ThemeResolverinitThemeResolver(context);// 初始化 HandlerMappingsinitHandlerMappings(context);// 初始化 HandlerAdaptersinitHandlerAdapters(context);// 初始化 HandlerExceptionResolvers initHandlerExceptionResolvers(context);// 初始化 RequestToViewNameTranslatorinitRequestToViewNameTranslator(context);// 初始化 ViewResolversinitViewResolvers(context);// 初始化 FlashMapManagerinitFlashMapManager(context);
}

一次请求会通过DispatcherServlet的#doDispatch(HttpServletRequest request, HttpServletResponse response) 方法，执行请求的分发

	protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception {HttpServletRequest processedRequest = request;HandlerExecutionChain mappedHandler = null;boolean multipartRequestParsed = false;WebAsyncManager asyncManager = WebAsyncUtils.getAsyncManager(request);try {ModelAndView mv = null;Exception dispatchException = null;try {processedRequest = checkMultipart(request);multipartRequestParsed = (processedRequest != request);// Determine handler for the current request.// 获得请求对应的 HandlerExecutionChain 对象mappedHandler = getHandler(processedRequest);if (mappedHandler == null) {noHandlerFound(processedRequest, response);return;}// Determine handler adapter for the current request.// 获得当前 handler 对应的 HandlerAdapter 对象HandlerAdapter ha = getHandlerAdapter(mappedHandler.getHandler());// Process last-modified header, if supported by the handler.String method = request.getMethod();boolean isGet = "GET".equals(method);if (isGet || "HEAD".equals(method)) {long lastModified = ha.getLastModified(request, mappedHandler.getHandler());if (new ServletWebRequest(request, response).checkNotModified(lastModified) && isGet) {return;}}if (!mappedHandler.applyPreHandle(processedRequest, response)) {return;}// Actually invoke the handler.mv = ha.handle(processedRequest, response, mappedHandler.getHandler());if (asyncManager.isConcurrentHandlingStarted()) {return;}applyDefaultViewName(processedRequest, mv);mappedHandler.applyPostHandle(processedRequest, response, mv);}catch (Exception ex) {dispatchException = ex;}catch (Throwable err) {// As of 4.3, we're processing Errors thrown from handler methods as well,// making them available for @ExceptionHandler methods and other scenarios.dispatchException = new NestedServletException("Handler dispatch failed", err);}processDispatchResult(processedRequest, response, mappedHandler, mv, dispatchException);}catch (Exception ex) {triggerAfterCompletion(processedRequest, response, mappedHandler, ex);}catch (Throwable err) {triggerAfterCompletion(processedRequest, response, mappedHandler,new NestedServletException("Handler processing failed", err));}finally {if (asyncManager.isConcurrentHandlingStarted()) {// Instead of postHandle and afterCompletionif (mappedHandler != null) {mappedHandler.applyAfterConcurrentHandlingStarted(processedRequest, response);}}else {// Clean up any resources used by a multipart request.if (multipartRequestParsed) {cleanupMultipart(processedRequest);}}}}

Spring MVC是通过处理器适配器来进行具体方法的调用执行的，这时候来到适配器RequestMappingHandlerAdapter

@Override
public void afterPropertiesSet() {// Do this first, it may add ResponseBody advice beans//  初始化 ControllerAdvice 相关initControllerAdviceCache();// 初始化 argumentResolvers 属性if (this.argumentResolvers == null) {List<HandlerMethodArgumentResolver> resolvers = getDefaultArgumentResolvers();this.argumentResolvers = new HandlerMethodArgumentResolverComposite().addResolvers(resolvers);}// 初始化 initBinderArgumentResolvers 属性if (this.initBinderArgumentResolvers == null) {List<HandlerMethodArgumentResolver> resolvers = getDefaultInitBinderArgumentResolvers();this.initBinderArgumentResolvers = new HandlerMethodArgumentResolverComposite().addResolvers(resolvers);}// 初始化 returnValueHandlers 属性if (this.returnValueHandlers == null) {List<HandlerMethodReturnValueHandler> handlers = getDefaultReturnValueHandlers();this.returnValueHandlers = new HandlerMethodReturnValueHandlerComposite().addHandlers(handlers);}
}

private void initControllerAdviceCache() {if (getApplicationContext() == null) {return;}// <1> 扫描 @ControllerAdvice 注解的 Bean 们，并将进行排序List<ControllerAdviceBean> adviceBeans = ControllerAdviceBean.findAnnotatedBeans(getApplicationContext());AnnotationAwareOrderComparator.sort(adviceBeans);List<Object> requestResponseBodyAdviceBeans = new ArrayList<>();//  遍历 ControllerAdviceBean 数组for (ControllerAdviceBean adviceBean : adviceBeans) {Class<?> beanType = adviceBean.getBeanType();if (beanType == null) {throw new IllegalStateException("Unresolvable type for ControllerAdviceBean: " + adviceBean);}// 扫描有 @ModelAttribute ，无 @RequestMapping 注解的方法，添加到 modelAttributeAdviceCache 中Set<Method> attrMethods = MethodIntrospector.selectMethods(beanType, MODEL_ATTRIBUTE_METHODS);if (!attrMethods.isEmpty()) {this.modelAttributeAdviceCache.put(adviceBean, attrMethods);}// 扫描有 @InitBinder 注解的方法，添加到 initBinderAdviceCache 中Set<Method> binderMethods = MethodIntrospector.selectMethods(beanType, INIT_BINDER_METHODS);if (!binderMethods.isEmpty()) {this.initBinderAdviceCache.put(adviceBean, binderMethods);}// 如果是 RequestBodyAdvice 或 ResponseBodyAdvice 的子类，添加到 requestResponseBodyAdviceBeans 中if (RequestBodyAdvice.class.isAssignableFrom(beanType)) {requestResponseBodyAdviceBeans.add(adviceBean);}if (ResponseBodyAdvice.class.isAssignableFrom(beanType)) {requestResponseBodyAdviceBeans.add(adviceBean);}}// 将 requestResponseBodyAdviceBeans 添加到 this.requestResponseBodyAdvice 属性种if (!requestResponseBodyAdviceBeans.isEmpty()) {this.requestResponseBodyAdvice.addAll(0, requestResponseBodyAdviceBeans);}	
}

这就是@ControllerAdvice的实现原理底层分析咯。

这篇关于@ControllerAdvice：你可以没用过，但是不能不了解的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1089986。

相关文章

一文带你了解SpringBoot中启动参数的各种用法

一文带你了解SpringBoot中启动参数的各种用法

《一文带你了解SpringBoot中启动参数的各种用法》在使用SpringBoot开发应用时,我们通常需要根据不同的环境或特定需求调整启动参数,那么,SpringBoot提供了哪些方式来配置这些启动参... 目录一、启动参数的常见传递方式二、通过命令行参数传递启动参数三、使用 application.pro
阅读更多...
一文带你深入了解Python中的GeneratorExit异常处理

一文带你深入了解Python中的GeneratorExit异常处理

《一文带你深入了解Python中的GeneratorExit异常处理》GeneratorExit是Python内置的异常,当生成器或协程被强制关闭时,Python解释器会向其发送这个异常,下面我们来看... 目录GeneratorExit：协程世界的死亡通知书什么是GeneratorExit实际中的问题案例
阅读更多...
关于数据埋点，你需要了解这些基本知识

关于数据埋点，你需要了解这些基本知识

产品汪每天都在和数据打交道，你知道数据来自哪里吗？ 移动app端内的用户行为数据大多来自埋点，了解一些埋点知识，能和数据分析师、技术侃大山，参与到前期的数据采集，更重要是让最终的埋点数据能为我所用，否则可怜巴巴等上几个月是常有的事。   埋点类型 根据埋点方式，可以区分为： 手动埋点半自动埋点全自动埋点 秉承“任何事物都有两面性”的道理：自动程度高的，能解决通用统计，便于统一化管理，但个性化定
阅读更多...
速了解MySQL 数据库不同存储引擎

速了解MySQL 数据库不同存储引擎

快速了解MySQL 数据库不同存储引擎 MySQL 提供了多种存储引擎，每种存储引擎都有其特定的特性和适用场景。了解这些存储引擎的特性，有助于在设计数据库时做出合理的选择。以下是 MySQL 中几种常用存储引擎的详细介绍。 1. InnoDB 特点： 事务支持：InnoDB 是一个支持 ACID（原子性、一致性、隔离性、持久性）事务的存储引擎。行级锁：使用行级锁来提高并发性，减少锁竞争
阅读更多...
PHP: 深入了解一致性哈希

PHP: 深入了解一致性哈希

前言 随着memcache、redis以及其它一些内存K/V数据库的流行，一致性哈希也越来越被开发者所了解。因为这些内存K/V数据库大多不提供分布式支持(本文以redis为例)，所以如果要提供多台redis server来提供服务的话，就需要解决如何将数据分散到redis server，并且在增减redis server时如何最大化的不令数据重新分布，这将是本文讨论的范畴。 取模算法 取模运
阅读更多...
Weex入门教程之1，了解Weex

Weex入门教程之1，了解Weex

【资料合集】Weex Conf回顾集锦：讲义PDF+活动视频！ PDF分享：链接：http://pan.baidu.com/s/1hr8RniG 密码：fa3j 官方教程：https://weex-project.io/cn/v-0.10/guide/index.html 用意 主要是介绍Weex，并未涉及开发方面，好让我们开始开发之前充分地了解Weex到底是个什么。 以下描述主要摘取于
阅读更多...
Java了解相对较多！

Java了解相对较多！

我是对Java了解相对较多，而对C#则是因工作需要才去看了一下，C#跟Java在语法上非常相似，而最初让我比较困惑的就是委托、事件部分，相信大多数初学者也有类似的困惑。经过跟Java的对比学习，发现这其实跟Java的监听、事件是等同的，只是表述上不同罢了。 　　委托+事件是观察者模式的一个典型例子，所谓的委托其实就是观察者，它会关心某种事件，一旦这种事件被触发，这个观察者就会行动。 　　下
阅读更多...
使用WebP解决网站加载速度问题，这些细节你需要了解

使用WebP解决网站加载速度问题，这些细节你需要了解

说到网页的图片格式，大家最常想到的可能是JPEG、PNG，毕竟这些老牌格式陪伴我们这么多年。然而，近几年，有一个格式悄悄崭露头角，那就是WebP。很多人可能听说过，但到底它好在哪？你的网站或者项目是不是也应该用WebP呢？别着急，今天咱们就来好好聊聊WebP这个图片格式的前世今生，以及它值不值得你花时间去用。 为什么会有WebP？ 你有没有遇到过这样的情况？网页加载特别慢，尤其是那
阅读更多...
初步了解VTK装配体

初步了解VTK装配体

VTK还不太了解，根据资料， vtk.vtkAssembly 是 VTK库中的一个重要类，允许通过将多个vtkActor对象组合在一起来创建复杂的3D模型。 import vtkimport mathfrom vtk.util.colors import *filenames = ["cylinder.stl","sphere.stl","torus.stl"]dt = 1.0renW
阅读更多...
Post-Training有多重要？一文带你了解全部细节

Post-Training有多重要？一文带你了解全部细节

1. 简介 随着LLM学界和工业界日新月异的发展，不仅预训练所用的算力和数据正在疯狂内卷，后训练（post-training）的对齐和微调方法也在不断更新。InstructGPT、WebGPT等较早发布的模型使用标准RLHF方法，其中的数据管理风格和规模似乎已经过时。近来，Meta、谷歌和英伟达等AI巨头纷纷发布开源模型，附带发布详尽的论文或报告，包括Llama 3.1、Nemotron 340
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2