SpringBoot中@ControllerAdvice如何使用

最新推荐文章于 2022-10-13 21:21:19 发布

陌笙Diary

最新推荐文章于 2022-10-13 21:21:19 发布

阅读量657

点赞数

分类专栏： SpringBoot 文章标签： java spring boot

本文链接：https://blog.csdn.net/mr_accompany/article/details/104197743

版权

SpringBoot 专栏收录该内容

13 篇文章 0 订阅

订阅专栏

@ControllerAdvice介绍

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

全局异常处理
全局数据绑定
全局数据预处理

@ControllerAdvice使用

1. 全局异常处理

直接定义异常处理类

@ControllerAdvice
public class GlobalExceptionHandler {
    @ExceptionHandler(Exception.class)
    public ModelAndView handleException(Exception e) {
        String msg = "服务器内部错误：" + e.getMessage();
        if (msg == null || msg.equals("")) {
            msg = "服务器内部错误";
        }
        ModelAndView mv = new ModelAndView();
        mv.addObject("status", 500);
        mv.addObject("message", msg);
        mv.setViewName("error");
        return mv;
    }
}

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

error.html

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
    <script th:inline="javascript">
        const status = [[${status}]];
        const message = [[${message}]];
        if (status==500){
            alert(message);
        }
    </script>
</body>
</html>

2. 全局数据绑定

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

@ControllerAdvice
public class GlobalDataHandler {
    /**
     * 全局数据绑定
     * @return
     */
    @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

@GetMapping("/global")
public String global(Model model) {
    Map<String, Object> map = model.asMap();//全局数据
    System.out.println(map);
    int i = 1 / 0;
    return "global controller advice";
}

启动项目进行测试
在这里插入图片描述

3. 全局数据预处理

使用我们之前定义的Book和Author实体类

@Data //生成getter,setter等函数
@ConfigurationProperties(prefix = "author") //根据属性的前缀自动将 Spring 容器中对应的数据注入到对象对应的属性中
public class Author {
    private Long id;
    private Integer age;
    private String sex;
    private String name;
}

@Data //生成getter,setter等函数
public class Book {
    @Value("${book.id}") //将属性注入到 Book 对象中
    private Long id;
    @Value("${book.name}")
    private String name;
    @Value("${book.author}")
    private String author;
}

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

定义一个添加书籍的接口：
给接口中的变量取别名

@PostMapping("/addBook")
public String addBook(@ModelAttribute("b") Book book, @ModelAttribute("a") Author author) {
System.out.println(book);
System.out.println(author);
return "添加"+book.getName()+"("+author.getName()+" 著)成功！";
}

进行请求数据预处理
在 @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前缀。

测试：
请求发送时,通过给不同对象的参数添加不同的前缀,可以实现参数的区分
在这里插入图片描述

总结

@ControllerAdvice常用的用法比较简单，在SSM项目中使用较多，现在的SpringBoot+SpringCloud微服务中更是离不开它。

陌笙Diary

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
SpringBoot中@ControllerAdvice如何使用

@ControllerAdvice介绍@ControllerAdvice，顾明思意，这是一个增强的Controller，很多初学者可能都没有听说过这个注解，实际上，这是一个SpringMVC非常有用的注解，使用这个 Controller ，可以实现三个方面的功能：全局异常处理全局数据绑定全局数据预处理@ControllerAdvice使用1. 全局异常处理直接定义异常处理类@C...
复制链接

扫一扫