当前位置: 首页 > news >正文

SpringMVC 中 @ControllerAdvice 注解的三种使用场景

@ControllerAdvice ,很多初学者可能都没有听说过这个注解,实际上,这是一个非常有用的注解,顾名思义,这是一个增强的 Controller。使用这个 Controller ,可以实现三个方面的功能:

  1. 全局异常处理
  2. 全局数据绑定
  3. 全局数据预处理

灵活使用这三个功能,可以帮助我们简化很多工作,需要注意的是,这是 SpringMVC 提供的功能,在 Spring Boot 中可以直接使用,下面分别来看。

全局异常处理

使用 @ControllerAdvice 实现全局异常处理,只需要定义类,添加该注解即可定义方式如下:

@ControllerAdvice
public class MyGlobalExceptionHandler {
    @ExceptionHandler(Exception.class)
    public ModelAndView customException(Exception e) {
        ModelAndView mv = new ModelAndView();
        mv.addObject("message", e.getMessage());
        mv.setViewName("myerror");
        return mv;
    }
}

在该类中,可以定义多个方法,不同的方法处理不同的异常,例如专门处理空指针的方法、专门处理数组越界的方法...,也可以直接向上面代码一样,在一个方法中处理所有的异常信息。

@ExceptionHandler 注解用来指明异常的处理类型,即如果这里指定为 NullpointerException,则数组越界异常就不会进到这个方法中来。

全局数据绑定

全局数据绑定功能可以用来做一些初始化的数据操作,我们可以将一些公共的数据定义在添加了 @ControllerAdvice 注解的类中,这样,在每一个 Controller 的接口中,就都能够访问导致这些数据。

使用步骤,首先定义全局数据,如下:

@ControllerAdvice
public class MyGlobalExceptionHandler {
    @ModelAttribute(name = "md")
    public Map<String,Object> mydata() {
        HashMap<String, Object> map = new HashMap<>();
        map.put("age", 99);
        map.put("gender", "男");
        return map;
    }
}

使用 @ModelAttribute 注解标记该方法的返回数据是一个全局数据,默认情况下,这个全局数据的 key 就是返回的变量名,value 就是方法返回值,当然开发者可以通过 @ModelAttribute 注解的 name 属性去重新指定 key。

定义完成后,在任何一个Controller 的接口中,都可以获取到这里定义的数据:

@RestController
public class HelloController {
    @GetMapping("/hello")
    public String hello(Model model) {
        Map<String, Object> map = model.asMap();
        System.out.println(map);
        int i = 1 / 0;
        return "hello controller advice";
    }
}

全局数据预处理

考虑我有两个实体类,Book 和 Author,分别定义如下:

public class Book {
    private String name;
    private Long price;
    //getter/setter
}
public class Author {
    private String name;
    private Integer age;
    //getter/setter
}

此时,如果我定义一个数据添加接口,如下:

@PostMapping("/book")
public void addBook(Book book, Author author) {
    System.out.println(book);
    System.out.println(author);
}

这个时候,添加操作就会有问题,因为两个实体类都有一个 name 属性,从前端传递时 ,无法区分。此时,通过 @ControllerAdvice 的全局数据预处理可以解决这个问题

解决步骤如下:

1.给接口中的变量取别名

@PostMapping("/book")
public void addBook(@ModelAttribute("b") Book book, @ModelAttribute("a") Author author) {
    System.out.println(book);
    System.out.println(author);
}

2.进行请求数据预处理
在 @ControllerAdvice 标记的类中添加如下代码:

@InitBinder("b")
public void b(WebDataBinder binder) {
    binder.setFieldDefaultPrefix("b.");
}
@InitBinder("a")
public void a(WebDataBinder binder) {
    binder.setFieldDefaultPrefix("a.");
}

@InitBinder("b") 注解表示该方法用来处理和Book和相关的参数,在方法中,给参数添加一个 b 前缀,即请求参数要有b前缀.

3.发送请求

请求发送时,通过给不同对象的参数添加不同的前缀,可以实现参数的区分.

相关文章:

  • Java 枚举
  • Zabbix 3.0 从入门到精通(zabbix使用详解)
  • Spring中IOC的优点与缺点
  • Complex类的实现
  • Java装配模式
  • 归并排序(递归实现)
  • 归并排序(非递归)
  • Java中final、finally和finalize的区别
  • 归并排序(自然分组)
  • STM32概述
  • 软件工程学科的诞生
  • 软件开发过程模型综述
  • 算法设计题--数组元素换位
  • 数组换位问题-比较容易理解的解法
  • C语言形参与实参的复习
  • 深入了解以太坊
  • 【162天】黑马程序员27天视频学习笔记【Day02-上】
  • CNN 在图像分割中的简史:从 R-CNN 到 Mask R-CNN
  • JavaScript创建对象的四种方式
  • Java方法详解
  • jquery ajax学习笔记
  • magento 货币换算
  • webpack项目中使用grunt监听文件变动自动打包编译
  • web标准化(下)
  • 从0到1:PostCSS 插件开发最佳实践
  • 从伪并行的 Python 多线程说起
  • 深入 Nginx 之配置篇
  • 应用生命周期终极 DevOps 工具包
  • 原生 js 实现移动端 Touch 滑动反弹
  • kubernetes资源对象--ingress
  • 摩拜创始人胡玮炜也彻底离开了,共享单车行业还有未来吗? ...
  • ​Python 3 新特性:类型注解
  • #LLM入门|Prompt#1.8_聊天机器人_Chatbot
  • (3)(3.5) 遥测无线电区域条例
  • (DFS + 剪枝)【洛谷P1731】 [NOI1999] 生日蛋糕
  • (黑客游戏)HackTheGame1.21 过关攻略
  • (六) ES6 新特性 —— 迭代器(iterator)
  • (转)清华学霸演讲稿:永远不要说你已经尽力了
  • (转)为C# Windows服务添加安装程序
  • (转载)从 Java 代码到 Java 堆
  • (总结)Linux下的暴力密码在线破解工具Hydra详解
  • .Net 4.0并行库实用性演练
  • .net core 3.0 linux,.NET Core 3.0 的新增功能
  • .NET 中小心嵌套等待的 Task,它可能会耗尽你线程池的现有资源,出现类似死锁的情况
  • .net流程开发平台的一些难点(1)
  • .NET面试题解析(11)-SQL语言基础及数据库基本原理
  • .pub是什么文件_Rust 模块和文件 - 「译」
  • /bin/bash^M: bad interpreter: No such file or directory
  • @html.ActionLink的几种参数格式
  • @Transactional类内部访问失效原因详解
  • [C++]类和对象【上篇】
  • [CF226E]Noble Knight's Path
  • [DNS网络] 网页无法打开、显示不全、加载卡顿缓慢 | 解决方案
  • [Electron] 将应用打包成供Ubuntu、Debian平台下安装的deb包
  • [GN] DP学习笔记板子