Java項目讀取resources資源文件路徑那點事

  今天在Java程序中讀取resources資源下的文件,因爲對Java結構瞭解不透徹,遇到不少坑。正常在Java工程中讀取某路徑下的文件時,能夠採用絕對路徑和相對路徑,絕對路徑沒什麼好說的,相對路徑,即相對於當前類的路徑。在本地工程和服務器中讀取文件的方式有所不一樣,如下圖配置文件爲例:java

 

(1)本地讀取資源文件

  Java類中須要讀取properties中的配置文件,能夠採用文件(File)方式進行讀取:web

File file = new File("src/main/resources/properties/test.properties");
InputStream in = new FileInputStream(file);

  注意:當在IDEA中運行(不部署在服務器上),能夠讀取到該文件;spring

  緣由:JavaWeb項目部署服務器中,會將項目打包成Jar包或者war包,此時就不會存在 src/main/resources 目錄,JVM會在編譯項目時,主動將 java文件編譯成 class文件 和 resources 下的靜態文件放在 target/classes目錄下;服務器

  理解:Java文件只有編譯成 class文件纔會被JVM執行,本地執行時會,當前項目即爲Java進程的工做空間,雖然class文件在target/classes目錄下,可是target/classes不是class文件運行的目錄,只是存放的目錄,運行目錄仍是在IDEA的模塊下,因此運行時會找到 src/main/resources 資源文件!this

(2)服務器(Tomcat)讀取資源文件

  當工程部署到Tomcat中時,按照上邊方式,則會拋出異常:FileNotFoundException。緣由:Java工程打包部署到Tomcat中時,properties的路徑變到頂層(classes下),這是由Maven工程結構決定的。由Maven構建的web工程,主代碼放在src/main/java路徑下,資源放在src/main/resources路徑下,當構建jar包 或 war包時,JVM虛擬機會自動編譯java文件爲class文件存放在 target/classes目錄下,resource資源下的文件會原封不動的拷貝一份到 target/classes 目錄下:spa

  

  方式一:此時讀取資源文件時,採用流(Stream)的方式讀取,並經過JDK中Properties類加載,能夠方便的獲取到配置文件中的信息:指針

InputStream in = this.getClass().getResourceAsStream("/properties/test.properties");
Properties properties = new Properties();
properties.load(in);
properties.getProperty("name");

重點理解:class.getResourceAStream() 與 class.getClassLoader().getResorceAsStream() 的區別code

  

1) InputStream inStream = PropertiesTest.class.getResourceAsStream("test.properties"); 

​2) inStream = PropertiesTest.class.getResourceAsStream("/com/test/demo/test.properties") 

3) inStream = PropertiesTest.class.getClassLoader().getResourceAsStream("com/test/demo/test.properties");

 1)第一種和第二種方式採用 Class 對象去加載,第三種方式採用 ClassLoader 對象去加載資源文件,之因此 Class 能夠加載資源文件,是由於 Class 類封裝的 ClassLoader 的 getResourceAsStream() 方法,從 Class 類中的源碼能夠看出:component

public InputStream getResourceAsStream(String name) {
        name = resolveName(name);
        ClassLoader cl = getClassLoader0();
        if (cl==null) {
            // A system class.
            return ClassLoader.getSystemResourceAsStream(name);
        }
        return cl.getResourceAsStream(name);
 }

 理由:​​之因此這樣作無疑仍是方便客戶端的調用,省的每次獲取ClassLoader才能加載資源文件的麻煩!server

 2).class 是獲取當前類的 class 對象,getClassLoader()是獲取當前的類加載器,什麼是類加載器?簡單點說,就是用來加載java類的,類加載器就是負責把class文件加載進內存中,並建立一個java.lang.Class類的一個實例,也就是class對象,而且每一個類的類加載器都不相同,getResourceAsStream(path)是用來獲取資源的,由於這是ClassLoader(類加載器)獲取資源,而類加載器默認是從 classPath 下獲取資源的,由於這下面有class文件。因此這段代碼總的意思是經過類加載器在 classPath 目錄下獲取資源,而且是以流的形式。咱們知道在Java中全部的類都是經過加載器加載到虛擬機中的,並且類加載器之間存在父子關係,就是子知道父,父不知道子,這樣不一樣的子加載的類型之間是沒法訪問的(雖然它們都被放在方法區中),因此在這裏經過當前類的加載器來加載資源也就是保證是和類類型是同一個加載器加載的。 

(3)class.getClassLoader().getResourceAsStream() 和 class.getResouceAsStream() 的區別

  a)class.getClassLoader().getResourceAsStream(String name)  默認從classpath中找文件(文件放在resources目錄下),name不能帶"/",不然會拋空指針。採用相對路徑, "/"就至關於當前進程的根目錄,即項目根目錄;

inStream = PropertiesTest.class.getClassLoader().getResourceAsStream("com/test/demo/test.properties");

      b)class.getResourceAsStream(String name) 是採用絕對路徑,絕對路徑是相對於 classpath 根目錄的路徑,"/" 就表明着 classpath,因此 name 屬性須要前面加上 "/";

 

inStream = PropertiesTest.class.getResourceAsStream("/com/test/demo/test.properties")

  方式二:採用Spring註解

  若是工程中使用Spring,能夠經過註解的方式獲取配置信息,但須要將配置文件放到Spring配置文件中掃描後,才能將配置信息放入上下文。

<context:component-scan base-package="com.xxxx.service"/>
 <context:property-placeholder location="classpath:properties/xxx.properties" ignore-unresolvable="true"/>

  而後在程序中能夠使用 @Value進行獲取properties文件中的屬性值,以下:

@Value("${xxxt.server}")
 private static String serverUrl;

  方式三:採用Spring配置

  也能夠在Spring配置文件中讀取屬性值,賦予類成員變量

<?xml version="1.0" encoding="UTF-8"?>
  <beans xmlns="http://www.springframework.org/schema/beans"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://www.springframework.org/schema/beans 
      http://www.springframework.org/schema/beans/spring-beans-4.0.xsd">
      
      <bean id="propertyConfigurer" class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
          <property name="location" value="classpath:properties/xxx.properties"/>
      </bean>
     
     <bean id="service" class="com.xxxx.service.ServiceImpl">
<property name="serverUrl" value="${xxxt.server}" /> </bean> </beans>

  天天進步一點點,繼續前進......

相關文章
相關標籤/搜索