无法从JAR文件中读取自定义Manifest属性？原因及解决方案
修改JAR包的Manifest文件并读取自定义属性，看似简单的操作，却可能遇到意想不到的问题。本文将深入探讨这一问题，并提供切实可行的解决方案。
你可能遇到这样的情况：你使用Filesystem API成功地将自定义属性添加到JAR包的MANIFEST.MF文件中，通过解压JAR包检查，确认属性已经存在。然而，当你使用JarFile API尝试读取这些属性时，却发现它们不见了，Attributes.getValue(String)方法返回NULL。
以下是一个示例代码，用于修改JAR包的Manifest文件并尝试读取自定义属性：
import java.io.*; import java.net.URI; import java.net.URISyntaxException; import java.nio.file.*; import java.nio.file.attribute.BasicFileAttributes; import java.util.HashMap; import java.util.Map; import java.util.jar.Attributes; import java.util.jar.JarFile; import java.util.jar.Manifest; public class ManifestModifier { public static void main(String[] args) throws IOException, URISyntaxException { File jar = new File("C:Usersemployee1234Desktopauth-0.1.3.jar"); // 替换为你的JAR文件路径 String testVersion = "1.2.3"; Map<String, String> env = new HashMap<>(); env.put("create", "true"); // Mount the jar try (FileSystem fileSystem = FileSystems.newFileSystem(jarFileToURI(jar), env)) { // Read the manifest ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream(); Path manifestPath = fileSystem.getPath("/META-INF/MANIFEST.MF"); Files.copy(manifestPath, byteArrayOutputStream); // Convert the manifest bytes to a string and construct a string builder StringBuilder manifestData = new StringBuilder(byteArrayOutputStream.toString().trim()); // Add the custom manifest attribute manifestData.append(" "); manifestData.append("Deployments-Version: "); manifestData.append(testVersion); // Write the manifest back to the jar Files.copy(new ByteArrayInputStream(manifestData.toString().getBytes()), manifestPath, StandardCopyOption.REPLACE_EXISTING); // Try-with-resources closes the mounted jar } // This part doesn't work try (JarFile jarFile = new JarFile(jar)) { Manifest manifest = jarFile.getManifest(); System.out.println(manifest.getMainAttributes().getValue("Deployments-Version")); } } // Stolen from java.io.File with some modifications private static URI jarFileToURI(File jarFile) throws URISyntaxException { String sp = slashify(jarFile.getAbsoluteFile().getPath(), false); if (sp.startsWith("//")) sp = "//" + sp; return new URI("jar:file", null, sp, null); } // Stolen from java.io.File; private static String slashify(String path, boolean isDirectory) { String p = path; if (File.separatorChar != '/') p = p.replace(File.separatorChar, '/'); if (!p.startsWith("/")) p = "/" + p; if (!p.endsWith("/") && isDirectory) p = p + "/"; return p; } }
问题原因分析：
问题的根源在于Manifest文件的格式要求。每个属性条目必须以换行符分隔，并且整个Manifest文件也必须以换行符结尾。在上面的代码中，虽然添加了属性，但缺少了结尾的换行符，导致JarFile API无法正确解析Manifest文件。
解决方案：
确保在添加自定义属性后，以及整个Manifest文件的末尾，都添加换行符。修改代码如下：
manifestData.append(" ").append("Deployments-Version: ").append(testVersion).append(" ");
通过在属性值后添加额外的换行符，确保Manifest文件的格式正确，JarFile API就能正确读取自定义属性。
完整代码示例：
import java.io.*; import java.net.URI; import java.net.URISyntaxException; import java.nio.file.*; import java.nio.file.attribute.BasicFileAttributes; import java.util.HashMap; import java.util.Map; import java.util.jar.Attributes; import java.util.jar.JarFile; import java.util.jar.Manifest; public class ManifestModifier { public static void main(String[] args) throws IOException, URISyntaxException { File jar = new File("C:Usersemployee1234Desktopauth-0.1.3.jar"); // 替换为你的JAR文件路径 String testVersion = "1.2.3"; Map env = new HashMap<>(); env.put("create", "true"); // Mount the jar try (FileSystem fileSystem = FileSystems.newFileSystem(jarFileToURI(jar), env)) { // Read the manifest ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream(); Path manifestPath = fileSystem.getPath("/META-INF/MANIFEST.MF"); Files.copy(manifestPath, byteArrayOutputStream); // Convert the manifest bytes to a string and construct a string builder StringBuilder manifestData = new StringBuilder(byteArrayOutputStream.toString().trim()); // Add the custom manifest attribute manifestData.append(" ").append("Deployments-Version: ").append(testVersion).append(" "); // Write the manifest back to the jar Files.copy(new ByteArrayInputStream(manifestData.toString().getBytes()), manifestPath, StandardCopyOption.REPLACE_EXISTING); // Try-with-resources closes the mounted jar } // This part now works try (JarFile jarFile = new JarFile(jar)) { Manifest manifest = jarFile.getManifest(); System.out.println(manifest.getMainAttributes().getValue("Deployments-Version")); } } // Stolen from java.io.File with some modifications private static URI jarFileToURI(File jarFile) throws URISyntaxException { String sp = slashify(jarFile.getAbsoluteFile().getPath(), false); if (sp.startsWith("//")) sp = "//" + sp; return new URI("jar:file", null, sp, null); } // Stolen from java.io.File; private static String slashify(String path, boolean isDirectory) { String p = path; if (File.separatorChar != '/') p = p.replace(File.separatorChar, '/'); if (!p.startsWith("/")) p = "/" + p; if (!p.endsWith("/") && isDirectory) p = p + "/"; return p; } }
总结与注意事项：
- 修改JAR包的Manifest文件时，务必注意Manifest文件的格式要求。
- 确保每个属性条目以及整个Manifest文件都以换行符结尾。
- 使用FileSystem API修改JAR包内容时，需要正确处理文件流的打开和关闭，避免资源泄露。
- 在实际应用中，应根据具体需求选择合适的API来操作JAR包，例如，如果只是读取Manifest文件，使用JarFile API即可。如果需要修改JAR包内容，则需要使用FileSystem API。
通过理解Manifest文件的格式要求，并正确地添加换行符，你就可以成功地从JAR文件中读取自定义Manifest属性了。希望本文能够帮助你解决类似问题。
© 版权声明
文章版权归作者所有，未经允许请勿转载。
THE END
