Java如何讀取jar包中的resource資源文件

更新時間：2022年08月17日 17:18:26 作者：零點冰.

這篇文章主要介紹了Java如何讀取jar包中的resource資源文件，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教

1、需求

在Java項目中，需要讀取resource資源目錄下的文件，以及遍歷指定資源目錄下的所有文件，并且在讀取文件時保留文件相對路徑。

2、問題

在IDEA中運行時，可以獲取并遍歷指定資源，但是將Java項目打成jar包運行后，就無法獲取resource資源目錄下的文件。

3、IDEA讀取resource資源

編譯后，資源文件放在target目錄下，每一個資源文件實實在在存在于磁盤中。

3.1、方法1

直接通過絕對路徑讀取，如果file是目錄，也可以通過listFiles遞歸遍歷目錄下文件：

String absolutePath = "資源文件絕對路徑";
File file = new File(absolutePath);
if (file.isDirectory()) {
? ? File[] children = file.listFiles();
}

3.2、方法2

通過相對路徑讀?。?/p>

String path = "template"; ? ?//相對resource路徑
File file = ResourceUtils.getFile(ResourceUtils.CLASSPATH_URL_PREFIX + path);
if (file.isDirectory()) {
? ? File[] children = file.listFiles();
}

4、打成jar包后讀取resource資源

以上兩種方法無法讀取jar包中的資源文件。

打成jar包后，jar包是一個單獨的文件而不是文件夾，所以通過文件路徑是無法定位到資源文件的。此時，可通過類加載器讀取jar包中的資源文件。

4.1、讀取jar包中的資源文件

這種方式只能讀取jar包中單個文件，因為讀取出來的是InputStream流，無法保留文件相對于resource的路徑，所以無法對jar包中資源進(jìn)行遍歷。

String path = "/resource相對路徑";
InputStream is = this.class.getResourceAsStream(path);
byte[] buff = new byte[1024];
String filePath = "保存文件路徑";
String fileName = "保存文件名";
File file = new File(filePath + fileName);
FileUtils.copyInputStreamToFile(is, file);

4.2、遍歷jar包資源目錄

以復(fù)制resource資源目錄為例，分別對本地和jar包中的資源進(jìn)行復(fù)制。

如下所示：

我要復(fù)制resource資源目錄下的template文件夾下的所有內(nèi)容；

然后保存到C:/Users/ASUS/Desktop/savePath文件夾下。

4.2.1、環(huán)境判斷

public static void main(String[] args) throws URISyntaxException {
? ? // Test為當(dāng)前類名
?? ?URI uri = Test.class.getProtectionDomain().getCodeSource().getLocation().toURI();
?? ?// tempPath: 文件保存路徑
?? ?String tempPath = "C:/Users/ASUS/Desktop/savePath";
?? ?String sourceDir = "template"; ?//資源文件夾
?? ?if (uri.toString().startsWith("file")) {
? ? ? ? // IDEA運行時，進(jìn)行資源復(fù)制
?? ??? ?copyLocalResourcesFileToTemp(sourceDir + "/", "*", tempPath + "/" + sourceDir);
?? ?} else {
?? ??? ?// 獲取jar包所在路徑
?? ??? ?String jarPath = uri.toString();
?? ??? ?uri = URI.create(jarPath.substring(jarPath.indexOf("file:"),jarPath.indexOf(".jar") + 4));
? ? ? ? // 打成jar包后，進(jìn)行資源復(fù)制
?? ??? ?Test.copyJarResourcesFileToTemp(uri, tempPath, "BOOT-INF/classes/" + sourceDir);
?? ?}
}

4.2.2、復(fù)制本地項目的資源文件

/**
? ? ?* 復(fù)制本地資源文件到指定目錄
? ? ?* @param fileRoot ? ? ?需要復(fù)制的資源目錄文件夾
? ? ?* @param regExpStr ? ? 資源文件匹配正則，*表示匹配所有
? ? ?* @param tempParent ? ?保存地址
? ? ?*/
? ? public static void copyLocalResourcesFileToTemp(String fileRoot, String regExpStr, String tempParent) {
? ? ? ? try {
? ? ? ? ? ? ResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
? ? ? ? ? ? Resource[] resources = resolver.getResources(fileRoot + regExpStr);
? ? ? ? ? ? for (Resource resource : resources) {
? ? ? ? ? ? ? ? File newFile = new File(tempParent, resource.getFilename());
? ? ? ? ? ? ? ? if (newFile.exists()) {
? ? ? ? ? ? ? ? ? ? newFile.delete();
? ? ? ? ? ? ? ? }
? ? ? ? ? ? ? ? InputStream stream = null;
? ? ? ? ? ? ? ? try {
? ? ? ? ? ? ? ? ? ? stream = resource.getInputStream();
? ? ? ? ? ? ? ? } catch (Exception e) {
? ? ? ? ? ? ? ? ? ? // 如果resource為文件夾時，會報異常，這里直接忽略這個異常
? ? ? ? ? ? ? ? }
? ? ? ? ? ? ? ? if (stream == null) {
? ? ? ? ? ? ? ? ? ? newFile.mkdirs();
? ? ? ? ? ? ? ? ? ? copyLocalResourcesFileToTemp(fileRoot + resource.getFilename() ?+ "/", regExpStr, tempParent + "/" + resource.getFilename());
? ? ? ? ? ? ? ? } else {
? ? ? ? ? ? ? ? ? ? if (!newFile.getParentFile().exists()) {
? ? ? ? ? ? ? ? ? ? ? ? newFile.getParentFile().mkdirs();
? ? ? ? ? ? ? ? ? ? }
? ? ? ? ? ? ? ? ? ? org.apache.commons.io.FileUtils.copyInputStreamToFile(stream, newFile);
? ? ? ? ? ? ? ? }
? ? ? ? ? ? }
? ? ? ? } catch (Exception e) {
? ? ? ? ? ? log.error("failed to copy local source template", e);
? ? ? ? }
? ? }

4.2.3、復(fù)制jar包里的資源文件

/**
     * 復(fù)制jar包中的資源文件到指定目錄
     * @param path          jar包所在路徑
     * @param tempPath      保存目錄
     * @param filePrefix    需要進(jìn)行復(fù)制的資源文件目錄：以BOOT-INF/classes/開頭
     */
    public static void copyJarResourcesFileToTemp(URI path, String tempPath, String filePrefix) {
        try {
            List<Map.Entry<ZipEntry, InputStream>> collect =
                    readJarFile(new JarFile(path.getPath()), filePrefix).collect(Collectors.toList());
            for (Map.Entry<ZipEntry, InputStream> entry : collect) {
                // 文件相對路徑
                String key = entry.getKey().getName();
                // 文件流
                InputStream stream = entry.getValue();
                File newFile = new File(tempPath + key.replaceAll("BOOT-INF/classes", ""));
                if (!newFile.getParentFile().exists()) {
                    newFile.getParentFile().mkdirs();
                }
                org.apache.commons.io.FileUtils.copyInputStreamToFile(stream, newFile);
            }
        } catch (IOException e) {
            log.error("failed to copy jar source template", e);
        }
    }

@SneakyThrows
    public static Stream<Map.Entry<ZipEntry, InputStream>> readJarFile(JarFile jarFile, String prefix) {
        Stream<Map.Entry<ZipEntry, InputStream>> readingStream =
                jarFile.stream().filter(entry -> !entry.isDirectory() && entry.getName().startsWith(prefix))
                        .map(entry -> {
                            try {
                                return new AbstractMap.SimpleEntry<>(entry, jarFile.getInputStream(entry));
                            } catch (IOException e) {
                                return new AbstractMap.SimpleEntry<>(entry, null);
                            }
                        });
        return readingStream.onClose(() -> {
            try {
                jarFile.close();
            } catch (IOException e) {
                log.error("failed to close jarFile", e);
            }
        });
    }

以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。

您可能感興趣的文章: