Java程序中的配置文件的存放和讀取

關(guān)鍵字: 數據庫 屬性文件 類(lèi)路徑

大家可能經(jīng)常會(huì )遇到在Java程序中存取程序配置文件的需求，比如，為了能夠和不同的數據庫連接，我們經(jīng)常把數據庫連接的信息存放到屬性文件中，這些信息一般包括數據庫驅動(dòng)程序類(lèi)名、數據庫連接的URL，數據庫的用戶(hù)名和口令等等。為了便于程序的安裝或部署，我們經(jīng)常會(huì )把這些的配置文件存放到程序安裝的根目錄中。由于Java程序用包來(lái)分組類(lèi)，有時(shí)候將這些配置文件放入到讀取它們的類(lèi)所在的包目錄中會(huì )更好一些。比如，在下面的圖示中，將數據庫配置文件 database.properties放到數據庫讀取類(lèi)所在的包目錄就是一種比較清晰的存儲方案：

                        /-----------其它包目錄
                              |
                              |
                              -------edu.ec.database
                                                 |
                                                 |---------------ConnectionPool（數據庫連接池類(lèi)）
                                                 |
                                                 |---------------Dao（數據庫訪(fǎng)問(wèn)對象類(lèi)）
                                                 |
                                                 |---------------DaoFactory（Dao的工廠(chǎng)類(lèi)）
                                                 |
                                                 |---------------database.properties（數據庫配置屬性文件）
                                                 |
                                                 |---------------RecordSet（記錄集類(lèi)）
   
在這種存儲方案中，所有的與數據庫相關(guān)的類(lèi)和配置文件都在同一個(gè)包目錄中；在開(kāi)發(fā)過(guò)程中，配置文件和源文件也按采用這種方式進(jìn)行組織，這樣會(huì )使得程序的數據庫訪(fǎng)問(wèn)維護變得相當清晰明了。

大部分開(kāi)發(fā)工具在編譯打包這樣的源文件組織時(shí)，會(huì )自動(dòng)將相關(guān)配置文件和類(lèi)文件放到生成的目標文件夾中或JAR文件中。一般情況下，我們在發(fā)布自己的 Java程序時(shí)，都是以JAR或WAR形式將程序打包發(fā)布，而對應的配置文件也會(huì )按照上述的目錄格式被放到了JAR或WAR文件中，這樣，就實(shí)現了配置文件和程序文件打包在一起發(fā)布的目的。

現在的問(wèn)題是，我們如何讀取位于程序安裝文件中的配置文件的信息？比如，在上面的圖中， ConnectionPool是一個(gè)數據庫連接池類(lèi)，它需要在系統啟動(dòng)時(shí)自動(dòng)讀取存儲在database.properties中的數據庫連接和配置信息，以便設置相關(guān)的數據庫連接。這樣，我們 就需要在程序中測定目前程序安裝或部署的位置，以便讀取對應的屬性文件。

       在很多其他語(yǔ)言編寫(xiě)的程序中，我們可以利用一些系統提供的API或一些全局對象獲取目前應用程序運行所在的目錄。比如VB,我們可以使用Application對象測定當前程序的安裝位置，在Java程序中如何完成類(lèi)似的任務(wù)呢？

Java程序并沒(méi)有類(lèi)似于VB那種全局對象，但如果我們觀(guān)察位于上述目錄結構中的database.properties文件，應該發(fā)現其處于應用程序的CLASSPATH中，這樣，我們就可以使用Java中的類(lèi)裝載器中的相關(guān)的方法，讀出這些配置文件的信息，該類(lèi)名為ClassLoader。比如，在上例中，我們可以先得到ConnectinPool的類(lèi)裝載器，然后測定ConnectionPool類(lèi)所在的包路徑，然后利用 ConnectionPool所在的包目錄讀出database.properties文件的信息，對應的偽代碼如下：

            ClassLoader loader=ConnectionPool.class.getClassLoader();
            得到ConnectionPool所在的包名;
            將包名轉換為對應的目錄名，存入一個(gè)名為path的字符串變量中;
           調用loader的getResourceAsStream(path+"database.properties")，得到輸入流
          
          下面是一個(gè)可實(shí)際運行的樣例代碼片段，它可自動(dòng)測定傳入的類(lèi)所在的包目錄，返回傳入的屬性文件所代表的輸入流。它還有一個(gè)附加的功能：如果屬性文件直接放到了當前類(lèi)所在的根目錄（比如位于JAR文件的根目錄或WAR文件的WEB-INF/classes目錄中）、系統的用戶(hù)目錄系統、系統其他的類(lèi)路徑中時(shí)，它也可以找到；當然，如果還是找不到，它將返回null。具體的代碼如下：


        public class PropHelper{
                      /**
                       *guessPropFile:
                       *@param cls:和要尋找的屬性文件處于相同的包中的任意的類(lèi)
                       *@param propFile:要尋找的屬性文件名
                       */
                   public   static java.io.InputStream guessPropFile(Class cls,String propFile){
                                try{
                                      //得到類(lèi)的類(lèi)裝載器
                                      ClassLoader loader=cls.getClassLoader();
                                     
                                      //先從當前類(lèi)所處路徑的根目錄中尋找屬性文件
                                      java.io.InputStream in=loader.getResourceAsStream(propFile);
                                      if(in!=null) return in;
                                     
                                      //沒(méi)有找到，就從該類(lèi)所處的包目錄中查找屬性文件
                                     Package pack=cls.getPackage();
                                     if(pack!=null){
                                              String packName=pack.getName();
                                              String path="";
                                              if(packName.indexOf(".") < 0 )
                                                 path=packName+"/";
                                              else{
                                                       int start=0,end=0;
                                                       end=packName.indexOf(".");
                                                       while(end!=-1){
                                                             path=path+packName.substring(start,end)+"/";
                                                             start=end+1;
                                                            end=packName.indexOf(".",start);
                                                        }
                                                       path=path+packName.substring(start)+"/";
                                              }
                                              in=loader.getResourceAsStream(path+propFile);
                                              if(in!=null) return in;
                                   }
                                  
                                  //如果沒(méi)有找到，再從當前系統的用戶(hù)目錄中進(jìn)行查找
                                  java.io.File f=null;
                                  String curDir=System.getProperty("user.dir");
                                  f=new java.io.File(curDir,propFile);
                                  if(f.exists()) return new java.io.FileInputStream(f);
                                 
                                  //如果還是沒(méi)有找到，則從系統所有的類(lèi)路徑中查找
                                  String classpath=System.getProperty("java.class.path");
                                  String[] cps=classpath.split(System.getProperty("path.separator"));
                                 
                                  for(int i=0;i < cps.length; i++){
                                           f=new java.io.File(cps[i],propFile);
                                           if(f.exists()) break;
                                           f=null;
                                   }
                                  if(f!=null) return new java.io.FileInputStream(f);
                                  return null;
                            }catch(Exception e){throw new RuntimeException(e);}
                  
                     }
        }
        
使用舉例：利用上述的方法，可在ConnectionPool中自動(dòng)查找和ConnectionPool處于同一個(gè)包目錄中的database.properties的輸入流，并利用該輸入流讀入對應的屬性值的代碼如下：
       public class ConnectionPool{
            //靜態(tài)初始化器，將在ConnectionPools加載時(shí)自動(dòng)執行
           static{
               java.util.Properties dbProp=new java.util.Properties();
               java.io.InputStream in=PropHelper.guessPropFile(edu.ec.database.ConnectionPool.class,"database.properties");
               if(in!=null) dbProp.load(in);
               //利用dbProp，為相應的數據源對象設置相關(guān)的屬性，比如C3P0........
            }
     }

評論