spring中afterPropertiesSet方法与init-method配置描述

---恢复内容开始---

今天看了前辈们写的代码用到了afterPropertiesSet()的方法，就好好整理了spring的bean加载

1. InitializingBean.afterPropertiesSet()

Spring中InitializingBean接口类为bean提供了定义初始化方法的方式，它仅仅包含一个方法：afterPropertiesSet()。
Bean实现这个接口，在afterPropertiesSet()中编写初始化代码：

public class AlarmQueue<T> implements InitializingBean, DisposableBean, Component {
    private static final CLogger logger = Utils.getLogger(AlarmQueue.class);

    @Autowired
    ThreadFacade thf;
    @Autowired
    private CloudBus bus;

    private RedisTemplate redisTemplate;
    private String key;
    private RedisConnectionFactory factory;
    private RedisConnection connection;
    private Lock lock = new ReentrantLock();//基于底层IO阻塞考虑
    private Thread alarmThread;
    private boolean isInit = true;
    private boolean isClosed;

    public void setRedisTemplate(RedisTemplate redisTemplate) {
        this.redisTemplate = redisTemplate;
    }

    public void setKey(String key) {
        this.key = key;
    }

    @Override
    public void afterPropertiesSet() throws Exception {//
        logger.info("============== afterPropertiesSet =================");
        factory = redisTemplate.getConnectionFactory();
        connection = RedisConnectionUtils.getConnection(factory);
        alarmThread = new AlarmThread();
        alarmThread.setDaemon(true);
        alarmThread.start();
    }

    class AlarmThread extends Thread {
        @Override
        public void run() {
            try {
                if (isInit) {
                    Thread.sleep(30000);
                    isInit = false;
                }

                logger.info("============== AlarmThread Start =================");
                while (true) {
                    T value = takeFromTail(0);
                    if (value != null) {
                        try {
                            // listener.onMessage(value);
                            HandleAlarmMsg amsg = new HandleAlarmMsg();
                            amsg.setAlarmValue(value.toString());
                            bus.makeTargetServiceIdByResourceUuid(amsg, AlarmConstant.SERVICE_ID_ALARM_LOG, Platform.getUuid());
                            bus.send(amsg);
                        } catch (Exception e) {
                            logger.error(String.format("fail to handle alarm!Alarm content: %s, Error: %s", value.toString(), e.getMessage()));
                        }
                    }
                }
            } catch (InterruptedException e) {
                throw new RuntimeException(String.format("Alarm thread InterruptedException! Error: %s", e.getMessage()));
            }
        }
    }

    public T takeFromTail(int timeout) throws InterruptedException {
        lock.lockInterruptibly();
        try {
            List<byte[]> results = connection.bRPop(timeout, key.getBytes());
            if (CollectionUtils.isEmpty(results)) {
                return null;
            }
            return (T) redisTemplate.getValueSerializer().deserialize(results.get(1));
        } catch (Exception e) {
            throw new RuntimeException(String.format("fail to take value from queue %s! Error: ", this.key, e.getMessage()));
        } finally {
            lock.unlock();
        }
    }

    @Override
    public void destroy() throws Exception {
        if (isClosed) {
            return;
        }
        shutdown();
        RedisConnectionUtils.releaseConnection(connection, factory);
        isClosed = true;
    }

    private void shutdown() {
        AlarmThread.interrupted();
    }

    @Override
    public boolean start() {
        return true;
    }

    @Override
    public boolean stop() {
        return true;
    }
}

在xml配置文件中并不需要对bean进行特殊的配置，Spring在在配置文件完成该bean的所有赋值后，会检查该bean是否实现了InitializingBean接口，如果实现就调用bean的afterPropertiesSet方法。

2. init-method配置

Spring虽然可以通过InitializingBean完成一个bean初始化后调用这个bean自定义方法，但是这种方式要求bean实现InitializingBean接口。一但bean实现了InitializingBean接口，那么这个bean的代码就和Spring耦合到一起了。可以使用Spring提供的init-method的功能来执行一个bean自定义的初始化方法。
以下代码中，类MonitorKafka不实现任何Spring的接口，定义一个没有参数的方法monitorKafkaMsg()。

public class AlarmLogManagerImpl extends AbstractService implements ApiMessageInterceptor {

    private static final CLogger logger = Utils.getLogger(AlarmLogManagerImpl.class);
    @Autowired
    private CloudBus bus;
    @Autowired
    private DatabaseFacade dbf;
    @Autowired
    private ThreadFacade thf;
    @Autowired
    private RESTFacade restf;
    @Autowired
    private SmsService smsService;
    @Autowired
    private MailService mailService;

  ....  
}

<bean id="AlarmLogManager" class="com.syscxp.alarm.log.AlarmLogManagerImpl"init-method="AlarmLogManager" destroy-method="destroy"> 
.... 

</bean>

注：destroy-method是该bean销毁前调用指定的方法。
init-method配置中的monitorKafkaMsg()方法将会在该bean初始化完成后被调用，Spring要求init-method是一个无参数的方法，否则会抛出异常，Spring将中止这个Bean的后续处理，并且抛出一个 org.springframework.beans.factory.BeanCreationException异常。

总结：
1. InitializingBean和init-method可以一起使用，Spring会先处理InitializingBean再处理init-method。init-method是通过反射执行的，而afterPropertiesSet是直接执行的，所以 afterPropertiesSet的执行效率比init-method要高，不过init-method消除了bean对Spring依赖，推荐使用init-method。
2. 如果一个bean被定义为非单例的，那么afterPropertiesSet和init-method在bean的每一个实例被创建时都会执行。单例bean的afterPropertiesSet和init-method只在bean第一次被实例时调用一次。一般情况下afterPropertiesSet和init-method都应用在单例的bean上。
3. @PostConstruct和@PreDestory可以通过在类方法上注解方式实现类似的功能。