Android Studio 中合并jar包 - fatjar插件

jar.png

在开发中我们经常需要将某个模块以JAR包的形式输出，在打包的同时需要将它所依赖的多个JAR都整合到本JAR中，这样我们就可以直接使用“java －jar”命令执行它，而不用设置classpath或者部署所依赖的JAR，别的开发者也可以很方便的引用这个JAR。

在eclipse中有一个fatjar的插件可以很方便的完成这个需求，但是在android studio中我还没有发现这样的插件。想了下这类插件的原理也就是简单的文件读写，所以决定自己动手实现一个。

（本文出处：http://www.jianshu.com/p/be46b3891d0e）

JAR文件格式

动手写代码之前我们先了解下JAR文件格式。在软件领域，JAR文件（Java归档：Java ARchive）是一种软件包文件格式，通常用于聚合大量的Java类文件、相关的元数据（manifest文件）和资源（文本、图片等）文件到一个文件，便于分发的Java平台的应用软件或库。JAR文件是一种归档文件，以ZIP格式构建，以.jar为文件扩展名。用户可以使用JDK自带的jar命令创建或提取JAR文件。也可以使用其他zip压缩工具，不过压缩时zip文件头里的条目顺序很重要，因为Manifest资源配置文件常需放在首位。

jar_format.png

Manifest资源配置文件是JAR中包含的特殊文件，它被用来定义扩展或档案打包相关数据。Manifest文件中的条目定义这个JAR文件如何被使用。例如，类路径条目由其他JAR文件的绝对或相对路径的列表组成，用于指定在加载本JAR文件时同时加载的其他JAR文件。虽然旨在简化JAR的使用，但在实践中证明Manifest文件是非常脆弱的，因为入口点JAR在创建时依赖于所有相关的JAR的确切位置。一旦需要更改依赖库的位置，必需重建Manifest文件。本文实现的fatjarCreator工具，将所依赖的相关JAR都打包到本JAR中，可以避免这样的问题。

manifest.png

fatjarCreator工具的制作

因为jar文件实际是一个文件包，所以jar文件读写和普通的文件读写有一定的区别，我们需要先将jar包中的每个文件遍历出来再依次进行文件读写。幸运的是软件包 java.util.jar 提供了读写JAR 文件的类，如JarFile.class、JarOutputStream.class、Manifest.class、JarEntry.class等。这个合并工具本身也是用Java写的，完成后也是一个jar包，我将它命名为fatjarCreator.jar。核心逻辑如下：

    public void create(ArrayListjarPaths, String output) {
        String jarPath = "";
        Manifest manifest = getManifest();   //获取outJar的manifest
        FileOutputStream fos = new FileOutputStream(output);
        JarOutputStream jos = new JarOutputStream(fos, manifest);  //根据输出路径和manifest创建输出流
        for (int i = 0; i < jarPaths.size(); i++) {
            jarPath = jarsPaths.get(i);
            JarFile jarFile = new JarFile(jarPath);
            Enumeration entities = jarFile.entries();  
            while (entities.hasMoreElements()) {  
                JarEntry entry = (JarEntry) entities.nextElement();  //遍历jar文件中的每个文件节点

                //在写目录中的文件时，目录会自动创建
                //meta-inf使用我们上面获取的manifest，不使用之前的了meta-inf
                if (entry.isDirectory() || entry.getName().toLowerCase().startsWith("meta-inf")) {  
                    continue;  
                }  

                InputStream in = jarFile.getInputStream(entry);
                copyData2Jar(in, jos, entry.getName());
            }  

            jarFile.close();  
        }
    } 

    private void copyData2Jar(InputStream in, JarOutputStream jos, String newEntryName) {
        int bufferSize;  
        byte[] buffer = new byte[1024]; 
   
        jos.putNextEntry(new JarEntry(newEntryName));  //在outJar中的创建文件节点

        while ((bufferSize = in.read(buffer, 0, buffer.length)) != -1) {  
             jos.write(buffer, 0, bufferSize);  
        }  

        in.close();  
        jos.closeEntry();  
    }

    private Manifest getManifest() {  
        Manifest manifest = new Manifest();  
        Attributes attribute = manifest.getMainAttributes();  
        attribute.putValue("Manifest-Version", "1.0");  
        attribute.putValue("Created-By","fat jar plugin");  
        return manifest;  
    }  

同理我们也可以将一些资源（文本、图片等）文件打到JAR包中。这样合并JAR文件的方法我们就写好了，使用时只需要传入待合并的JAR文件的路径和输出文件的路径就可以了。通常需要合并的文件较多，如果使用命令行传入参数的方式，那么执行命令会很长，为了更方便的使用，我们可以用配置文件来传入文件路径。我这里使用了如下xml文件来作为配置文件，增删改查合并JAR文件时候只需要修改对应的配置文件即可。

到这里我们就可以将实现的代码输出成一个可执行的fatjarCreator.jar。把它和上面个的配置文件fatjar_config.xml放在同一目录下，然后双击fatjarCreator.jar或者命令行执行“Java -jar fatjarCreator.jar”，我们都可以在我们设置的输出路径下看到合并后的JAR文件了。

配置gradle

我们的目的是想在Android Studio中更方便的合并JAR文件，现在合并的功能已经实现了，如何才能在AS中调用这个小工具呢？在module的build.gradle中创建一个名为createFatjar的task。然后我们可以在命令行中执行“gradle createFatjar”命令或者在AS右边的gradle栏中双击createFatjar来执行合并任务。需要把fatjarCreator.jar和fatjar_config.xml放在build.gradle所在目录。

task createFatjar (type: JavaExec) {
  javaexec { 
    main="-jar";        
    args=["fatjarCreator.jar"];
  }
}

代码

为了文章的简洁，文中的示例代码省略了很多，如入口方法，xml的解析等。想要获取完整项目代码的同学可以点击代码获取。