針對Properties中實時性要求不高的配置參數，用Java緩存起來

　　Properties常用於項目中參數的配置，當項目中某段程序需要獲取動態參數時，就從Properties中讀取該參數，使程序是可配置的、靈活的。

　　有些配置參數要求立即生效，有些則未必：

　　一、實時性要求非常高。項目中，有些參數要求實時性非常高，即在系統運行中，IT人員修改了該參數值，該新參數值要求立即在程序中生效；

　　二、實時性要求不高。其實，並不是每個配置參數都要求實時性那么高，有些配置參數基本不會在項目運行當中修改，或即使在運行當中修改，也只要求其在下一次項目啟動時生效。

　　針對第二種情況，鑒於程序讀取Properties文件，IO損耗大、效率較低的現狀，我們可以在項目啟動時，預先將Properties的信息緩存起來，以備程序運行當中方便、快捷地使用。

 

　　初步想法：在項目啟動加載Listener時，將需要緩存的Properties以鍵值對形式緩存起來。

 

kick off：

 

首先，需要一個類存儲Properties，並提供接口實現“緩存Properties”和“讀取Properties”的動作

package com.nicchagil.propertiescache;

import java.io.IOException;
import java.io.InputStream;
import java.util.Hashtable;
import java.util.Map;
import java.util.Properties;

import org.apache.log4j.Logger;

public class PropertiesCacher {
    
    private static final Logger logger = Logger.getLogger(PropertiesCacher.class);
    
    // Properties Cache
    public static Map<String, Properties> pMap = new Hashtable<String, Properties> ();
    
    /**
     * Set properties to properties cache
     * @param pName
     * @throws IOException
     */
    public static void setProperties(String pName) throws IOException {
        
        Properties properties = new Properties();
        InputStream is = null;
        
        try {
            is = PropertiesCacher.class.getResourceAsStream(pName);
            properties.load(is);
            
        } finally {
            
            if (is != null) {
                is.close();
            }
            
        }
        
        logger.info("Load to properties cache : " + pName);
        pMap.put(pName, properties);
    }
    
    /**
     * Get properties by properties path
     * @param pName
     * @return
     */
    public static Properties getProperties(String pName) {
        return pMap.get(pName);
    }
    
    /**
     * Get properties value by properties path & key
     * @param pName
     * @param key
     * @return
     */
    public static String getPropertiesValue(String pName, String key) {
        if (pMap.get(pName) == null) {
            return "";
        }
        
        return pMap.get(pName).getProperty(key);
    }

}

 

然后，我們需要在項目啟動時，觸發“緩存Properties”這個動作，這里使用Listener

package com.nicchagil.propertiescache;

import java.io.IOException;

import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;

import org.apache.log4j.Logger;

public class PropertiesListener implements ServletContextListener {
    
    private final Logger logger = Logger.getLogger(PropertiesListener.class);

    @Override
    public void contextDestroyed(ServletContextEvent event) {
        
    }

    @Override
    public void contextInitialized(ServletContextEvent event) {
        try {
            // Load config.properties
            PropertiesCacher.setProperties("/resource/config.properties");
            
            // Load log4j.properties
            PropertiesCacher.setProperties("/log4j.properties");
            
        } catch (IOException e) {
            // TODO Auto-generated catch block
            
            logger.error(e.getMessage(), e);
            e.printStackTrace();
        }
    }
    
}

 

作為web項目，配置了Listener，當然需要在web.xml注冊一下了

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" id="WebApp_ID" version="2.5">
  <display-name>XlsExporterDemo</display-name>
  <welcome-file-list>
    <welcome-file>index.html</welcome-file>
    <welcome-file>index.htm</welcome-file>
    <welcome-file>index.jsp</welcome-file>
    <welcome-file>default.html</welcome-file>
    <welcome-file>default.htm</welcome-file>
    <welcome-file>default.jsp</welcome-file>
  </welcome-file-list>
  <listener>
    <listener-class>com.nicchagil.propertiescache.PropertiesListener</listener-class>
  </listener>
  <servlet>
    <description></description>
    <display-name>DebugPropertiesCacheServlet</display-name>
    <servlet-name>DebugPropertiesCacheServlet</servlet-name>
    <servlet-class>com.nicchagil.propertiescache.DebugPropertiesCacheServlet</servlet-class>
  </servlet>
  <servlet-mapping>
    <servlet-name>DebugPropertiesCacheServlet</servlet-name>
    <url-pattern>/DebugPropertiesCacheServlet</url-pattern>
  </servlet-mapping>
</web-app>

 

最后，自己新建倆properties用於測試，一個是log4j.properties，放在編譯根路徑下；一個是config.properties，放在編譯根路徑的resource文件夾下。key值和value值自定義。

這兩個properties是本人測試用的，當然你也可以用自己滴，但需要相應地修改PropertiesListener的加載動作哦~

 

dà gōng gào chéng

 

現在寫一個簡單滴Servlet來測試一下是否能成功讀取，其中這個Servlet在上述滴web.xml一並注冊了，可見“DebugPropertiesCacheServlet”

package com.nicchagil.propertiescache;

import java.io.IOException;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class DebugPropertiesCacheServlet extends HttpServlet {
    private static final long serialVersionUID = 1L;
       
    public DebugPropertiesCacheServlet() {
        super();
    }

    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        String pfile = request.getParameter("pfile");
        String key = request.getParameter("key");

        if (pfile == null || key == null) {
            System.out.println(PropertiesCacher.pMap);
        } 
        
        if (pfile != null && key == null) {
            System.out.println(PropertiesCacher.getProperties(pfile));
        }
        
        if (pfile != null && key != null) {
            System.out.println(PropertiesCacher.getPropertiesValue(pfile, key));
        }
        
    }

    protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        this.doPost(request, response);
    }

}

 

最后，做個簡單的測試，使用瀏覽器分別訪問以下url（其中參數可能需要自行改一下），並查看console是否打印正確滴信息

http://localhost:8080/XlsExporterDemo/DebugPropertiesCacheServlet

http://localhost:8080/XlsExporterDemo/DebugPropertiesCacheServlet?pfile=/resource/config.properties

http://localhost:8080/XlsExporterDemo/DebugPropertiesCacheServlet?pfile=/resource/config.properties&key=url

 

Oh year，成功了！！！