springboot獲取項目目錄路徑的方法

springboot獲取項目目錄路徑

springboot部署後獲取項目的路徑

//獲取跟目錄(絕對路徑)
File path = new File(ResourceUtils.getURL("classpath:").getPath());
if(!path.exists()) path = new File("");
System.out.println("path:"+path.getAbsolutePath());
//如果上傳目錄爲/static/images/upload/，則可以如下獲取：
File upload = new File(path.getAbsolutePath(),"static/images/upload/");
if(!upload.exists()) upload.mkdirs();
System.out.println("upload url:"+upload.getAbsolutePath());
//在開發測試模式時，得到的地址爲：{項目跟目錄}/target/static/images/upload/
//在打包成jar正式發佈時，得到的地址爲：{發佈jar包目錄}/static/images/upload/

springboot獲取resources目錄資源文件9種方式

本文中提供了九種方式獲取resources目錄下文件的方式。

其中打印文件的方法如下：

/**
 * 根據文件路徑讀取文件內容
 *
 * @param fileInPath
 * @throws IOException
 */
public static void getFileContent(Object fileInPath) throws IOException {
    BufferedReader br = null;
    if (fileInPath == null) {
        return;
    }
    if (fileInPath instanceof String) {
        br = new BufferedReader(new FileReader(new File((String) fileInPath)));
    } else if (fileInPath instanceof InputStream) {
        br = new BufferedReader(new InputStreamReader((InputStream) fileInPath));
    }
    String line;
    while ((line = br.readLine()) != null) {
        System.out.println(line);
    }
    br.close();
}

方式一

主要核心方法是使用getResource和getPath方法，這裏的getResource("")裏面是空字符串

public void function1(String fileName) throws IOException {
    String path = this.getClass().getClassLoader().getResource("").getPath();//注意getResource("")裏面是空字符串
    System.out.println(path);
    String filePath = path + fileName;
    System.out.println(filePath);
    getFileContent(filePath);
}

方式二

主要核心方法是使用getResource和getPath方法，直接通過getResource(fileName)方法獲取文件路徑，注意如果是路徑中帶有中文一定要使用URLDecoder.decode解碼。

/**
 * 直接通過文件名getPath來獲取路徑
 *
 * @param fileName
 * @throws IOException
 */
public void function2(String fileName) throws IOException {
    String path = this.getClass().getClassLoader().getResource(fileName).getPath();//注意getResource("")裏面是空字符串
    System.out.println(path);
    String filePath = URLDecoder.decode(path, "UTF-8");//如果路徑中帶有中文會被URLEncoder,因此這裏需要解碼
    System.out.println(filePath);
    getFileContent(filePath);
}

方式三

直接通過文件名+getFile()來獲取文件。如果是文件路徑的話getFile和getPath效果是一樣的，如果是URL路徑的話getPath是帶有參數的路徑。

如下所示：

url.getFile()=/pub/files/foobar.txt?id=123456
url.getPath()=/pub/files/foobar.txt

使用getFile()方式獲取文件的代碼如下：

/**
 * 直接通過文件名+getFile()來獲取
 *
 * @param fileName
 * @throws IOException
 */
public void function3(String fileName) throws IOException {
    String path = this.getClass().getClassLoader().getResource(fileName).getFile();//注意getResource("")裏面是空字符串
    System.out.println(path);
    String filePath = URLDecoder.decode(path, "UTF-8");//如果路徑中帶有中文會被URLEncoder,因此這裏需要解碼
    System.out.println(filePath);
    getFileContent(filePath);
}

方式四（重要）

直接使用getResourceAsStream方法獲取流，上面的幾種方式都需要獲取文件路徑，但是在SpringBoot中所有文件都在jar包中，沒有一個實際的路徑，因此可以使用以下方式。

/**
 * 直接使用getResourceAsStream方法獲取流
 * springboot項目中需要使用此種方法，因爲jar包中沒有一個實際的路徑存放文件
 *
 * @param fileName
 * @throws IOException
 */
public void function4(String fileName) throws IOException {
    InputStream in = this.getClass().getClassLoader().getResourceAsStream(fileName);
    getFileContent(in);
}

方式五（重要）

主要也是使用getResourceAsStream方法獲取流，不使用getClassLoader可以使用getResourceAsStream("/配置測試.txt")直接從resources根路徑下獲取，SpringBoot中所有文件都在jar包中，沒有一個實際的路徑，因此可以使用以下方式。

/**
 * 直接使用getResourceAsStream方法獲取流
 * 如果不使用getClassLoader，可以使用getResourceAsStream("/配置測試.txt")直接從resources根路徑下獲取
 *
 * @param fileName
 * @throws IOException
 */
public void function5(String fileName) throws IOException {
    InputStream in = this.getClass().getResourceAsStream("/" + fileName);
    getFileContent(in);
}

方式六（重要）

通過ClassPathResource類獲取文件流，SpringBoot中所有文件都在jar包中，沒有一個實際的路徑，因此可以使用以下方式。

/**
 * 通過ClassPathResource類獲取，建議SpringBoot中使用
 * springboot項目中需要使用此種方法，因爲jar包中沒有一個實際的路徑存放文件
 *
 * @param fileName
 * @throws IOException
 */
public void function6(String fileName) throws IOException {
    ClassPathResource classPathResource = new ClassPathResource(fileName);
    InputStream inputStream = classPathResource.getInputStream();
    getFileContent(inputStream);
}

方式七

通過絕對路徑獲取項目中文件的位置，只是本地絕對路徑，不能用於服務器獲取。

/**
 * 通過絕對路徑獲取項目中文件的位置（不能用於服務器）
 * @param fileName
 * @throws IOException
 */
public void function7(String fileName) throws IOException {
    String rootPath = System.getProperty("user.dir");//E:\WorkSpace\Git\spring-framework-learning-example
    String filePath = rootPath + "\\chapter-2-springmvc-quickstart\\src\\main\\resources\\"+fileName;
    getFileContent(filePath);
}

方式八

通過new File("")獲取當前的絕對路徑，只是本地絕對路徑，不能用於服務器獲取。

/**
 * 通過絕對路徑獲取項目中文件的位置（不能用於服務器）
 * @param fileName
 * @throws IOException
 */
public void function8(String fileName) throws IOException {
    //參數爲空
    File directory = new File("");
    //規範路徑：getCanonicalPath() 方法返回絕對路徑，會把 ..\ 、.\ 這樣的符號解析掉
    String rootCanonicalPath = directory.getCanonicalPath();
    //絕對路徑：getAbsolutePath() 方法返回文件的絕對路徑，如果構造的時候是全路徑就直接返回全路徑，如果構造時是相對路徑，就返回當前目錄的路徑 + 構造 File 對象時的路徑
    String rootAbsolutePath =directory.getAbsolutePath();
    System.out.println(rootCanonicalPath);
    System.out.println(rootAbsolutePath);
    String filePath = rootCanonicalPath + "\\chapter-2-springmvc-quickstart\\src\\main\\resources\\"+fileName;
    getFileContent(filePath);
}

方式九

主要是通過設置環境變量，將文件放在環境變量中，原理也是通過絕對路徑獲取。

示例中我設置了一個環境變量：TEST_ROOT=E:\\WorkSpace\\Git\\spring-framework-learning-example

System.getenv("TEST_ROOT");
System.getProperty("TEST_ROOT")

通過設置環境變量的方式，然後通過絕對路徑獲取文件

/**
 * 通過絕對路徑獲取項目中文件的位置
 *
 * @param fileName
 * @throws IOException
 */
public void function9(String fileName) throws IOException {
    System.setProperty("TEST_ROOT","E:\\WorkSpace\\Git\\spring-framework-learning-example");
    //參數爲空
    String rootPath = System.getProperty("TEST_ROOT");
    System.out.println(rootPath);
    String filePath = rootPath + "\\chapter-2-springmvc-quickstart\\src\\main\\resources\\"+fileName;
    getFileContent(filePath);
}

springboot獲取項目目錄路徑的方法