Spring容器初始化完成后执行某个类的某个方法


原文链接:https://blog.csdn.net/honghailiang888/article/details/73333821/

一、背景知识及需求

在做WEB项目时,经常在项目第一次启动时利用WEB容器的监听、Servlet加载初始化等切入点为数据库准备数据,这些初始化数据是系统开始运行前必须的数据,例如权限组、系统选项、默认管理员等等。而项目采用了Spring依赖注入来管理对象,而servlet并不受Spring的管理。若此时在servlet中注入Spring管理的对象,则无法使用,如下:


   
   
   
  1. public class InitServlet extends HttpServlet {
  2. @Autowired
  3. private IProductService productService;
  4. @Autowired
  5. private IUserService userService;
  6. ......
  7. }

这个时候是无法使用上述中的两个service的,因为InitServlet不受Spring容器管理。虽然可以用getBean的方式手动获取service,但是违反了使用Spring的初衷。

该篇文章也在之前【Spring实战】系列的基础上进行优化和深入分析,本篇就是在更换了hsqldb数据库并初始化了商品、普通用户和管理员用户需求时产生的。

二、Spring提供的解决方案

1、InitializingBean

直接上代码


   
   
   
  1. /**
  2. * Created by Administrator on 2017/6/15.
  3. * spring容器启动后,初始化数据(产生一个默认商品、普通用户和管理员用户)
  4. */
  5. @Component
  6. public class InitServlet implements InitializingBean {
  7. @Autowired
  8. private IProductService productService;
  9. @Autowired
  10. private IUserService userService;
  11. @Override
  12. public void afterPropertiesSet() throws Exception {
  13. /**库中没有商品则声明一个*/
  14. List<Product> products = productService.getProductList();
  15. if ( null == products || products.isEmpty()){
  16. Product product = new Product();
  17. product.setProductName( "Mango");
  18. product.setQuantity( 100);
  19. product.setUnit( "个");
  20. product.setUnitPrice( 100);
  21. productService.saveProduct(product);
  22. }
  23. /**库中没有用户则添加普通用户和管理员用户*/
  24. List<MangoUser> mangoUsers = userService.getUserList();
  25. if( null == mangoUsers || mangoUsers.isEmpty()){
  26. MangoUser mangoUser = new MangoUser();
  27. mangoUser.setUserName( "mango");
  28. mangoUser.setPassword(StringUtil.md5( "123456"));
  29. mangoUser.setRole( "ROLE_USER");
  30. userService.saveUser(mangoUser);
  31. MangoUser mangoUser1 = new MangoUser();
  32. mangoUser1.setUserName( "manager");
  33. mangoUser1.setPassword(StringUtil.md5( "123456"));
  34. mangoUser1.setRole( "ROLE_MANAGER");
  35. userService.saveUser(mangoUser1);
  36. }
  37. }
  38. }

若采用XML来配置Bean的话,可以指定属性init-method。

2、ApplicationListener


   
   
   
  1. /**交给Spring管理,如果不是自动扫描加载bean的方式,则在xml里配一个即可*/
  2. @Component
  3. public class InitData implements ApplicationListener<ContextRefreshedEvent> {
  4. @Autowired
  5. private IProductService productService;
  6. @Autowired
  7. private IUserService userService;
  8. @Override
  9. public void onApplicationEvent(ContextRefreshedEvent event) {
  10. if (event.getApplicationContext().getParent() == null) {
  11. /**库中没有商品则声明一个*/
  12. List<Product> products = productService.getProductList();
  13. if ( null == products || products.isEmpty()){
  14. Product product = new Product();
  15. product.setProductName( "Mango");
  16. product.setQuantity( 100);
  17. product.setUnit( "个");
  18. product.setUnitPrice( 100);
  19. productService.saveProduct(product);
  20. }
  21. /**库中没有用户则添加普通用户和管理员用户*/
  22. List<MangoUser> mangoUsers = userService.getUserList();
  23. if( null == mangoUsers || mangoUsers.isEmpty()){
  24. MangoUser mangoUser = new MangoUser();
  25. mangoUser.setUserName( "mango");
  26. mangoUser.setPassword(StringUtil.md5( "123456"));
  27. mangoUser.setRole( "ROLE_USER");
  28. userService.saveUser(mangoUser);
  29. MangoUser mangoUser1 = new MangoUser();
  30. mangoUser1.setUserName( "manager");
  31. mangoUser1.setPassword(StringUtil.md5( "123456"));
  32. mangoUser1.setRole( "ROLE_MANAGER");
  33. userService.saveUser(mangoUser1);
  34. }
  35. }
  36. }
  37. }

注意是监听的ContextRefreshedEvent事件。

在web 项目中(spring mvc),系统会存在两个容器,一个是root application context ,另一个就是我们自己的 projectName-servlet context(作为root application context的子容器)。这种情况下,就会造成onApplicationEvent方法被执行两次。为了避免上面提到的问题,我们可以只在root application context初始化完成后调用逻辑代码,其他的容器的初始化完成,则不做任何处理。

event.getApplicationContext().getParent() == null

3、@PostConstruct


   
   
   
  1. /**
  2. * Created by Administrator on 2017/6/15.
  3. * spring容器启动后,初始化数据(产生一个默认商品、普通用户和管理员用户)
  4. */
  5. @Component
  6. public class InitMango{
  7. @Autowired
  8. private IProductService productService;
  9. @Autowired
  10. private IUserService userService;
  11. @PostConstruct
  12. public void init() {
  13. /**库中没有商品则声明一个*/
  14. List<Product> products = productService.getProductList();
  15. if ( null == products || products.isEmpty()){
  16. Product product = new Product();
  17. product.setProductName( "Mango");
  18. product.setQuantity( 100);
  19. product.setUnit( "个");
  20. product.setUnitPrice( 100);
  21. productService.saveProduct(product);
  22. }
  23. /**库中没有用户则添加普通用户和管理员用户*/
  24. List<MangoUser> mangoUsers = userService.getUserList();
  25. if( null == mangoUsers || mangoUsers.isEmpty()){
  26. MangoUser mangoUser = new MangoUser();
  27. mangoUser.setUserName( "mango");
  28. mangoUser.setPassword(StringUtil.md5( "123456"));
  29. mangoUser.setRole( "ROLE_USER");
  30. userService.saveUser(mangoUser);
  31. MangoUser mangoUser1 = new MangoUser();
  32. mangoUser1.setUserName( "manager");
  33. mangoUser1.setPassword(StringUtil.md5( "123456"));
  34. mangoUser1.setRole( "ROLE_MANAGER");
  35. userService.saveUser(mangoUser1);
  36. }
  37. }
  38. }

下篇文章会分析其原理和源码实现。

三、代码托管

https://github.com/honghailiang/SpringMango

四、实现原理

其实现原理在【Spring实战】Spring注解工作原理源码解析中均能找到答案,简单说明下:

1)在bean创建的过程中,初始化时会先调用@PostConstruct注解标注的方法,而后调用实现InitializingBean接口的afterPropertiesSet方法

2)在finishRefresh()会分发事件,


   
   
   
  1. // Publish the final event.
  2. // publishEvent new ContextRefreshedEvent(this));
关心ContextRefreshedEvent事件的bean中的onApplicationEvent方法会被调用

3)建议使用@PostConstruct注解,减少Spring的侵入性以及耦合性


免责声明!

本站转载的文章为个人学习借鉴使用,本站对版权不负任何法律责任。如果侵犯了您的隐私权益,请联系本站邮箱yoyou2525@163.com删除。



 
粤ICP备18138465号  © 2018-2025 CODEPRJ.COM