在web项目启动时执行某个方法

在web项目启动时执行某个方法

1. 实现ServletContextListener接口

在web项目中有很多时候需要在项目启动时就执行一些方法，而且只需要执行一次，比如：加载解析自定义的配置文件、初始化数据库信息等等，在项目启动时就直接执行一些方法，可以减少很多繁琐的操作。

   在工作中遇到了项目初始数据需要跟其他项目同步的问题，也就是说在项目部署后，启动的时候就要同步另外一个项目的数据，这里写了个简单的实例，用的是监听器机制，创建一个类实现ServletContextListener 接口，实现里面的contextInitialized和contextDestroyed方法

复制代码
package com.test. listener;

import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
//创建的类名根据需要定义，但一定要实现ServletContextListener接口
public class WebContextListener implements ServletContextListener {

@Override
public void contextInitialized(ServletContextEvent arg0) {
    // TODO Auto-generated method stub
    //这里可以放你要执行的代码或方法    
}

@Override
public void contextDestroyed(ServletContextEvent arg0) {
    // TODO Auto-generated method stub
    
}

}
复制代码
　　其中contextInitialized方法是项目在启动初始化的时候就会执行的方法，contextDestroyed是在消亡的时候执行的方法，这里我们需要把随项目启动时执行的代码放在contextInitialized方法中。

然后在web.xml中为这个监听器添加配置

com.test. listener.WebContextListener 　　其中listenner-class配置的是上面定义的监听器类路径，这样就就可以了，部署好项目，启动就可以执行contextInitialized里面的代码了。

如果你需要在项目启动的时候加载解析你自定义的配置文件，可以将加载解析配置文件的代码放在contextInitialized方法里面，这样在你项目启动的时候就可以解析你配置文件里的信息了。

2. 创建单例bean ，类实现InitializingBean

spring初始化bean的时候，如果bean实现了InitializingBean接口，会自动调用afterPropertiesSet方法

import org.springframework.beans.factory.InitializingBean;
public class TestInitializingBean implements InitializingBean{
    @Override
    public void afterPropertiesSet() throws Exception {
        System.out.println("ceshi InitializingBean");        
    }
    public void testInit(){
        System.out.println("ceshi init-method");        
    }
}

配置文件

<bean id="testInitializingBean" class="com.TestInitializingBean" scope="singleton" ></bean>

main方法

public class Main {
    public static void main(String[] args){
        ApplicationContext context = new FileSystemXmlApplicationContext("/src/main/java/com/beans.xml");
    }
}

测试结果：

ceshi InitializingBean

可以 点击我 查看InitializingBean的作用。

那么问题来了，在配置bean的时候使用init-method配置也可以为bean配置初始化方法，那这两个哪个会先执行呢，接下来测试一下，修改配置文件，加上init-method:

<bean id="testInitializingBean" class="com.TestInitializingBean" init-method="testInit"></bean>

运行程序，得出结果：

ceshi InitializingBean
ceshi init-method

那么这种方式在spring中是怎么实现的呢，通过查看Spring加载bean的源码类AbstractAutowiredCapableBeanFactory可以看出其中的奥妙，AbstractAutowiredCapableBeanFactory类中的invokeInitMethods说的非常清楚，如下：

protected void invokeInitMethods(String beanName, final Object bean, RootBeanDefinition mbd) throws Throwable {
    //判断该bean是否实现了实现了InitializingBean接口，如果实现了InitializingBean接口，则只掉调用bean的afterPropertiesSet方法
    boolean isInitializingBean = (bean instanceof InitializingBean);
    if (isInitializingBean && (mbd == null || !mbd.isExternallyManagedInitMethod("afterPropertiesSet"))) {
        if (logger.isDebugEnabled()) {
            logger.debug("Invoking afterPropertiesSet() on bean with name '" + beanName + "'");
        }
         
        if (System.getSecurityManager() != null) {
            try {
                AccessController.doPrivileged(new PrivilegedExceptionAction<Object>() {
                    public Object run() throws Exception {
                        //直接调用afterPropertiesSet
                        ((InitializingBean) bean).afterPropertiesSet();
                        return null;
                    }
                },getAccessControlContext());
            } catch (PrivilegedActionException pae) {
                throw pae.getException();
            }
        }                
        else {
            //直接调用afterPropertiesSet
            ((InitializingBean) bean).afterPropertiesSet();
        }
    }
    if (mbd != null) {
        String initMethodName = mbd.getInitMethodName();
        //判断是否指定了init-method方法，如果指定了init-method方法，则再调用制定的init-method
        if (initMethodName != null && !(isInitializingBean && "afterPropertiesSet".equals(initMethodName)) &&
                !mbd.isExternallyManagedInitMethod(initMethodName)) {
            //进一步查看该方法的源码，可以发现init-method方法中指定的方法是通过反射实现
            invokeCustomInitMethod(beanName, bean, mbd);
        }
    }
}

总结：
1、Spring为bean提供了两种初始化bean的方式，实现InitializingBean接口，实现afterPropertiesSet方法，或者在配置文件中通过init-method指定，两种方式可以同时使用。

2、实现InitializingBean接口是直接调用afterPropertiesSet方法，比通过反射调用init-method指定的方法效率要高一点，但是init-method方式消除了对spring的依赖。

3、如果调用afterPropertiesSet方法时出错，则不调用init-method指定的方法。