SpringBoot增强Controller方法@ControllerAdvice注解的使用详解
更新时间：2023年10月12日 10:31:19 作者：fengyehongWorld
这篇文章主要介绍了SpringBoot增强Controller方法@ControllerAdvice注解的使用详解,@ControllerAdvice,是Spring3.2提供的新注解,它是一个Controller增强器,可对controller进行增强处理,需要的朋友可以参考下
一. @ControllerAdvice注解作用
@ControllerAdvice ，是Spring3.2提供的新注解，它是一个Controller增强器，可对controller进行增强处理。
- 配合@ExceptionHandler注解，进行全局异常处理。
- 配合@InitBinder注解，用来设置WebDataBinder，用于自动绑定前台请求参数到Model中，全局数据预处理，多用于表单提交数据或者url传参。
- 配合@ModelAttribute注解，让Controller类中所有的方法都可以获取到通过@ModelAttribute注解设置的值，进行全局数据绑定。
注意： @ControllerAdvice 注解将作用在所有Controller层的方法上。
二. @ControllerAdvice注解 + assignableTypes属性
作用：增强指定 .class 的类，非指定的Controller类不会被增强
2.1 @ControllerAdvice增强类
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ModelAttribute;
import javax.servlet.http.HttpServletRequest;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
// 指定增强S001LoginController和S002LogoutController
@ControllerAdvice(assignableTypes = {S001LoginController.class, S002LogoutController.class})
public class S_Controller {
@Autowired
private HttpServletRequest request;
// 方式1: @ModelAttribute注解的使用
@ModelAttribute
public void initData1(Model model) {
request.setAttribute("num1", 66);
model.addAttribute("userMail", List.of("123@mail.com", "456@mail.com"));
}
// 方式2: @ModelAttribute注解的使用
@ModelAttribute(name = "userInfo")
public Map<String, String> initData2() {
request.setAttribute("num2", 99);
return new HashMap<>(){
{
put("name", "贾飞天");
put("age", "18");
}
};
}
// 捕获S001LoginController或S002LogoutController类中的Exception异常
@ExceptionHandler(Exception.class)
public void exceptionHandle(Exception ex) {
System.out.println(ex.getMessage());
}
}2.2 Controller层
目录结构如下
- s_controller包
- S001LoginController.java
- S002LogoutController.java
- S003Controller.java
说明
- @ControllerAdvice增强类中，指定对S001LoginController.java和S002LogoutController.java进行了增强，因此这两个类中可以获取到增强类中放入的数据，并且这两个类中抛出的Exception异常也会被增强类所捕获。
- 由于S003Controller.java并没有被增强，因此该类无法获取增强类中放入的数据，并且抛出的异常也无法被增强类捕获。
S001LoginController.java
有2种方式可以获取出@ControllerAdvice增强类中放入Model中的数据
- model.asMap()
- @ModelAttribute("key名称") 类型 变量名
还可以通过request.getAttribute("key名称")来获取放入request的attribute中的数据。
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import java.util.List;
import java.util.Map;
@Controller
@RequestMapping("/ss001")
public class S001LoginController {
@Autowired
private HttpServletRequest request;
@GetMapping("/init")
public ModelAndView init(Model model) {
// ?方式1: 获取出@ControllerAdvice增强类中提前放入Model中的数据
Map<String, Object> mapInfo = model.asMap();
Object userMailObj = mapInfo.get("userMail");
List<String> userMailList = (List<String>)userMailObj;
System.out.println(userMailList); // [123@mail.com, 456@mail.com]
Map<String, String> userInfoMap = (Map<String, String>) mapInfo.get("userInfo");
System.out.println(userInfoMap); // {name=贾飞天, age=18}
// ?获取出@ControllerAdvice增强类中提前放入request的attribute中的数据
Integer num1 = (Integer) request.getAttribute("num1");
System.out.println(num1); // 66
Integer num2 = (Integer) request.getAttribute("num2");
System.out.println(num2); // 99
ModelAndView modelAndView = new ModelAndView();
modelAndView.setViewName("s001");
return modelAndView;
}
@GetMapping("/showInfo")
@ResponseBody
public void showInfo(
// ?方式2: 获取出@ControllerAdvice增强类中提前放入Model中的数据
@ModelAttribute("userMail") List<String> userMail
, @ModelAttribute("userInfo") Map<String, String> userInfo
) {
System.out.println(userMail); // [123@mail.com, 456@mail.com]
System.out.println(userInfo); // {name=贾飞天, age=18}
}
}S002LogoutController.java
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;
import java.util.Map;
@Controller
@RequestMapping("/ss002")
public class S002LogoutController {
@GetMapping("/init")
public ModelAndView init(Model model) {
// 获取出@ControllerAdvice增强类中提前放入Model中的数据
Map<String, Object> mapInfo = model.asMap();
System.out.println(mapInfo);
// 代码出现异常
int num = 1 / 0;
ModelAndView modelAndView = new ModelAndView();
modelAndView.setViewName("s002");
return modelAndView;
}
}S003Controller.java
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;
@Controller
@RequestMapping("/ss003")
public class S003Controller {
@GetMapping("/init")
public ModelAndView init() {
int num = 1 / 0;
ModelAndView modelAndView = new ModelAndView();
modelAndView.setViewName("s003");
return modelAndView;
}
}2.3 效果
获取数据
异常
三. @ControllerAdvice注解 + basePackages属性
增强指定包下面所有的Controller
3.1 @ControllerAdvice增强类
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
@ControllerAdvice(basePackages = {"com.example.jmw.t_controller"})
public class T_Controller {
@ExceptionHandler(Exception.class)
public void exceptionHandle(Exception ex) {
System.out.println(ex.getMessage());
}
}四. @ControllerAdvice注解 + annotations属性
增强标记了 指定注解 的所有的Controller
4.1 自定义注解
import java.lang.annotation.*;
@Documented
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface ControllerMarkAnnotation {
}4.2 @ControllerAdvice增强类
mport org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
@ControllerAdvice(annotations = ControllerMarkAnnotation.class)
public class X_Controller {
@ExceptionHandler(Exception.class)
public void exceptionHandle(Exception ex) {
System.out.println(ex.getMessage());
}
}到此这篇关于SpringBoot增强Controller方法@ControllerAdvice注解的使用详解的文章就介绍到这了,更多相关SpringBoot的@ControllerAdvice注解内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！
相关文章
使用Mybatis-plus可以很方便的实现批量新增和批量修改,不仅比自己写foreach遍历方便很多,而且性能也更加优秀,下面这篇文章主要给大家介绍了关于Mybatis-Plus批量添加或修改数据的3种方式,需要的朋友可以参考下2023-05-05
这篇文章主要为大家详细介绍了Java线程池复用线程的秘密，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下，希望您能够多多关注2022-03-03
这篇文章主要介绍了java验证用户是否已经登录，java实现自动登录，感兴趣的小伙伴们可以参考一下2016-04-04
这篇文章主要为大家详细介绍了java实现周期性执行定时任务，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2022-09-09
这篇文章主要介绍了Java分支循环与数组核心知识点总结的相关资料,理解循环与分支结构是掌握编程的基础,重复执行操作的循环和基于条件的执行路径分支有助于构建复杂的程序逻辑,需要的朋友可以参考下2026-01-01
MQTT是一个基于客户端-服务器的消息发布/订阅传输协议,MQTT协议是轻量、简单、开放和易于实现的,这些特点使它适用范围非常广泛,这篇文章主要介绍了Java对接MQTT协议的完整实现,需要的朋友可以参考下2025-08-08
本文主要介绍了Mybatis分页查询主从表的实现示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧2024-09-09
这篇文章主要介绍了用idea操作hbase数据库，并映射到hive,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下2023-03-03
WebSocket 是基于TCP/IP协议,独立于HTTP协议的通信协议,本文将使用Spring结合WebSocket实现实时通信功能,有需要的小伙伴可以参考一下2024-01-01
这篇文章主要介绍了SpringBoot Import及自定义装配实现方法解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下2020-08-08
最新评论