Java读取jar包中的resource资源文件

目录

1、需求

2、问题

3、IDEA读取resource资源

3.1、方法1

3.2、方法2

4、打成jar包后读取resource资源

4.1、读取jar包中的资源文件

4.2、遍历jar包资源目录

4.2.1、环境判断

4.2.2、复制本地项目的资源文件

4.2.3、复制jar包里的资源文件

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

        通过相对路径读取：

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包中资源进行遍历。

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包资源目录

以复制resource资源目录为例，分别对本地和jar包中的资源进行复制。

如下所示：

我要复制resource资源目录下的template文件夹下的所有内容；

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

4.2.1、环境判断

public static void main(String[] args) throws URISyntaxException {
    // Test为当前类名
	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运行时，进行资源复制
		copyLocalResourcesFileToTemp(sourceDir + "/", "*", tempPath + "/" + sourceDir);
	} else {
		// 获取jar包所在路径
		String jarPath = uri.toString();
		uri = URI.create(jarPath.substring(jarPath.indexOf("file:"),jarPath.indexOf(".jar") + 4));
        // 打成jar包后，进行资源复制
		Test.copyJarResourcesFileToTemp(uri, tempPath, "BOOT-INF/classes/" + sourceDir);
	}
}

4.2.2、复制本地项目的资源文件

/**
     * 复制本地资源文件到指定目录
     * @param fileRoot      需要复制的资源目录文件夹
     * @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、复制jar包里的资源文件

/**
     * 复制jar包中的资源文件到指定目录
     * @param path          jar包所在路径
     * @param tempPath      保存目录
     * @param filePrefix    需要进行复制的资源文件目录：以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);
            }
        });
    }