SpringMVC中@controllerAdvice注解的详细解释

SpringMVC中@controllerAdvice注解的详细解释

目录1.全局异常处理2.全局数据绑定3.全局数据预处理总结

这是一个增强的 Controller。使用这个 Controller ，可以实现三个方面的功能：

1.全局异常处理；

2.全局数据绑定

3.全局数据预处理

1.全局异常处理

使用 @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，则数组越界异常就不会进到这个方法中来。

2.全局数据绑定

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

@ControllerAdvice

public class MyGlobalExceptionHandler {

@ModelAttribute(name = "md")

public Map mydata() {

HashMap 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 map = model.asMap();

System.out.println(map);

}

}

输出结果：

3.全局数据预处理

考虑我有两个实体类，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前缀.

总结

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。