@ControllerAdvice

Posted qiuwenli

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了@ControllerAdvice相关的知识,希望对你有一定的参考价值。

1. 处理全局异常

@ControllerAdvice
public class MyCustomException {
    @ExceptionHandler(MaxUploadSizeExceededException.class)
    public void myexception(MaxUploadSizeExceededException e, HttpServletResponse response) throws IOException {
        response.setContentType("text/html;charset=utf-8");
        PrintWriter out = response.getWriter();
        out.write("上传文件大小超出限制");
        out.flush();
        out.close();
    }

使用模板

导入thymeleaf模板

技术图片

@ExceptionHandler(MaxUploadSizeExceededException.class)
    public ModelAndView myexception(MaxUploadSizeExceededException e){
        ModelAndView mv = new ModelAndView("myerror");
        mv.addObject("error","上传文件大小超出限制");
        return mv;
    }

技术图片

2.预设全局数据

@ControllerAdvice
public class GlobalData {

    @ModelAttribute(value = "info")
    public Map<String,Object> mydata(){
        Map<String,Object> map = new HashMap<>();
        map.put("name","javaboy");
        map.put("address","www.javaboy.org");
        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();
        Set<String> keySet=map.keySet();
        for(String key:keySet){
            System.out.println(key+":"+map.get(key));
        }
        return "hello";
    }
}

运行

技术图片

3.请求参数预处理

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

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

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

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

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

  1. 给接口的变量取别名
@RestController
public class BookController {
    @PostMapping("/book")
    public void addBook(@ModelAttribute("b") Book book, @ModelAttribute("a") Author author){
        System.out.println(book);
        System.out.println(author);
    }
}
  1. 进行请求数据预处理

在@ControlllerAdvice标记的类中添加如下代码:

@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前缀

  1. 发送请求

技术图片

以上是关于@ControllerAdvice的主要内容,如果未能解决你的问题,请参考以下文章

springboot + @ControllerAdvice + @ExceptionHandler 实现全局异常拦截,不用

SpringBoot学习13:springboot异常处理方式3(使用@ControllerAdvice+@ExceptionHandle注解)

ControllerAdvice 有条件地处理异常

在 SpringBoot 应用程序的 ControllerAdvice 中访问 HttpSession

Spring的@ExceptionHandler和@ControllerAdvice统一处理异常

如何在同一个 SpringMvc 应用程序中有两个 ControllerAdvice