Bean初始化操作-SpringMVC中@ControllerAdvice注解的三种使用场景

Posted 2023-02-23 张铎（信念）

一. Bean初始化操作

1. 简介

很多时间当一个Bean被创建出来后，我们希望做一些初始化操作，如初始化数据、缓存预热等。有以下三种方法：

• 初始化方法initMethod
• 注解@PostConstruct
• InitializingBean的afterPropertiesSet方法

2. 三种方法实现

先准备一个类用于测试，代码如下：

public class BeanLifeCheck implements InitializingBean 
    private static final Logger logger = LoggerFactory.getLogger(BeanLifeCheck.class);

    @Value("$spring.application.name")
    private String applicationName;

    public BeanLifeCheck() 
        logger.info("BeanLifeCheck: Construct " + applicationName);
    

    public void initMethod() 
        logger.info("BeanLifeCheck: initMethod " + applicationName);
    

    @PostConstruct
    public void postConstruct() 
        logger.info("BeanLifeCheck: postConstruct " + applicationName);
    

    @Override
    public void afterPropertiesSet() throws Exception 
        logger.info("BeanLifeCheck: afterPropertiesSet " + applicationName);
    

2.1 初始化方法initMethod

这个以前是通过xml配置文件来定义的，现在可以直接定义在@Bean注解上，如下：

@Bean(initMethod = "initMethod")
public BeanLifeCheck beanLifeCheck() 
  return new BeanLifeCheck();

2.2 注解@PostConstruct

直接在方法上加注解即可：

@PostConstruct
public void postConstruct() 
  logger.info("BeanLifeCheck: postConstruct " + applicationName);

2.3 InitializingBean的afterPropertiesSet方法

需要类实现接口InitializingBean，如下：

@Override
public void afterPropertiesSet() throws Exception 
  logger.info("BeanLifeCheck: afterPropertiesSet " + applicationName);

3. 总结

运行后的执行日志及顺序如下：

c.r.springweb.day210911.BeanLifeCheck    : BeanLifeCheck: 构造方法 null
c.r.springweb.day210911.BeanLifeCheck    : BeanLifeCheck: @postConstruct注解 testBeanInit
c.r.springweb.day210911.BeanLifeCheck    : BeanLifeCheck: 实现InitializingBean接口afterPropertiesSet testBeanInit
c.r.springweb.day210911.BeanLifeCheck    : BeanLifeCheck: initMethod testBeanInit

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

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

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

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

1. 全局异常处理

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

@ControllerAdvice
public class MyGlobalExceptionHandler 
    @ExceptionHandler(Exception.class)
    public String ExceptionInfo(Exception e)
        System.out.println("出现异常："+e.getMessage());
        return "hello";
    

1.1 Controller测试

@RestController
public class TestController 
    @GetMapping("/test")
    public String test()
        int i = 1/0;
        System.out.println(i);
        return i+"";
    

访问：http://127.0.0.1:8080/test

 

1.2 总结

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

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

2. 全局数据绑定

全局数据绑定功能可以用来做一些初始化的数据操作，我们可以将一些公共的数据定义在添加了 @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 的接口中，都可以获取到这里定义的数据：

@GetMapping("/hello")
public String hello(Model model)
    Map<String, Object> map = model.asMap();
    System.out.println(map);
    System.out.println(map.get("md"));
    return "hello";

 

3. 全局数据预处理

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

@Data
public class Book 
    private String name;
    private Long price;

@Data
public class Author 
    private String name;
    private Integer age;

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

解决步骤如下:

3.1 给接口中的变量取别名

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

3.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.3 发送请求

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

 打印如下