Spring MVC Zookeeper統合構成管理

資料の抜粋:http://www.big-mouth.cn/blog/65.html
 
背景説明:Spring MVCフレームワークに基づく開発プロジェクトでは、データベース構成、サードパーティ構成情報、環境パス構成情報が多数存在するため、Mavenのprofile方式を用いて各種構成情報を管理してきた(この方式はあまり紹介しない)ため、メンテナンス面ではコストが高い.以上の場合、zookeeperを用いて異なる構成情報を統一的に管理する準備をします(もちろん、他のキャッシュツールでも構いませんが、原理は同じです).
 
第一歩:zookeeperサービス側のインストール(資料が多く、ここでは説明しない)
 
ステップ2:javaにapache.zookeeeper.ZooKeeperサードパーティAPIを導入します.
 

<dependency>
	<groupId>org.apache.zookeeper</groupId>
	<artifactId>zookeeper</artifactId>
	<version>3.4.6</version>
</dependency>

 
 
ステップ3:zookeeperツールクラス(単純ツールクラス)の作成
 

package cn.com.timerbin.zookeeper.demo;
import java.io.IOException;
import java.io.UnsupportedEncodingException;
import java.util.List;
import org.apache.zookeeper.KeeperException;
import org.apache.zookeeper.ZooKeeper;

public class ZookeeperClientUtil {
	private ZooKeeper zk;
	//zookeeper  
	private String servers;
	//      
	private int sessionTimeout = 40000;
	
	private String mainPath;
	
	public ZooKeeper getAliveZk() {
		ZooKeeper aliveZk = zk;
		if (aliveZk != null && aliveZk.getState().isAlive()) {
			return aliveZk;
		} else {
			zkReconnect();
			return zk;
		}
	}
	public synchronized void zkReconnect() {
		close();
		try {
			connect();
		} catch (IOException e) {
		}
	}
	public synchronized void close() {
		if (zk != null) {
			try {
				zk.close();
			} catch (InterruptedException e) {
			}
			zk = null;
		}
	}
	private synchronized void connect() throws IOException {
		if (zk == null  && !StringUtils.isBlank(servers))
			zk = new ZooKeeper(servers, sessionTimeout, null);
	}
	public String getData(String path) {
		String result = null;
		try {
			byte [] data = getAliveZk().getData(path, Boolean.TRUE,null);
			if(null != data){
				result = new String(data, "UTF-8");
			}
		} catch (KeeperException e) {
		} catch (InterruptedException e) {
		} catch (UnsupportedEncodingException e) {
		}
		return result ;
	}
	public List<String> getChildren(){
		List<String> data = null;
		try {
			data = getAliveZk().getChildren(mainPath, Boolean.TRUE);
		} catch (KeeperException e) {
		} catch (InterruptedException e) {
		}
		return data;
	}
	public void setSessionTimeout(int sessionTimeout) {
		this.sessionTimeout = sessionTimeout;
	}
	public String getMainPath() {
		return mainPath;
	}
	public void setMainPath(String mainPath) {
		this.mainPath = mainPath;
	}
	public void setServers(String servers) {
		this.servers = servers;
	}
}

注意:このツール・クラスは参照用のみです.zk.getChildren()/zk.getData()メソッドのWatcherパラメータが使用されていることに注意してください.
 
 
ステップ4:SpringプロファイルでのZookeeperClientUtilの構成定義
 

<bean id="zookeeperClient" class="cn.com.timerbin.zookeeper.demo.ZookeeperClientUtil">
           <property name="servers" value="127.0.0.1:2181" />
           <property name="mainPath" value="/configuration/allconfig" />
 </bean>

 
 
 
ステップ5:プロファイル・プロファイル・プロファイルの書き換え
 

package cn.com.timerbin.zookeeper.demo;
import java.util.List;
import java.util.Properties;
import org.springframework.beans.BeansException;
import org.springframework.beans.PropertyValue;
import org.springframework.beans.factory.BeanInitializationException;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
import org.springframework.beans.factory.config.PropertyOverrideConfigurer;
import org.springframework.beans.factory.config.PropertyPlaceholderConfigurer;
import cn.com.timerbin.zookeeper.demo.ZookeeperClientUtil;
public class ZooKeeperPropertyPlaceholderConfigurer extends PropertyPlaceholderConfigurer {
	
	private ZookeeperClientUtil configurationClient;

	public void setConfigurationClient(ZookeeperClientUtil configurationClient) {
		this.configurationClient = configurationClient;
	}

	@Override
    protected void processProperties(ConfigurableListableBeanFactory beanFactoryToProcess, Properties props)
            throws BeansException {
        try {
        	List<String> list= configurationClient.getChildren();
        	for(String key:list){
        		String value = configurationClient.getData(configurationClient.getMainPath()+"/"+key);
        		if(!StringUtils.isBlank(value)){
        			props.put(key,value);
        		}
        	}
        } catch (Exception e) {
        }
        super.processProperties(beanFactoryToProcess, props);
        
    }
}

 
 
ステップ6:SpringプロファイルでZooKeeperPropertyPlaceholderConfigurerの構成定義
 

<bean id="zooKeeperPropertyPlaceholderConfigurer" class="cn.com.timerbin.zookeeper.demo.ZooKeeperPropertyPlaceholderConfigurer">
	<property name="configurationClient" ref="zookeeperClient"></property>
	<property name="order" value="1" />
	<property name="ignoreUnresolvablePlaceholders" value="true" />
</bean>

 ここで、ignoreUnresolvablePlaceholders:このPropertyPlaceholderが解析できない場合に無視するかどうかを設定します.
 
注意:手順6で構成に次の情報が設定されている場合

<property name="locations">
	<list>
		<value>classpath:application.properties</value>
	</list>
</property>

 このとき第5部のprocessPropertiesメソッドのpropsには既にアプリケーション.properties構成におけるすべての構成情報が含まれており、ツールクラス(ZookeeperClientUtil)におけるいくつかの構成パラメータの設定についてもpropsに基づいて設定を定義することが考えられる!