Android Studio(3.x) 利用gradle生成jar,并打到system/framework生成动态库

先简单的介绍一下需求

做一个数据收集的模块,分两种方式集成:
(1)打到artifactory上
(2)生成jar,放到system/vendor下,然后打到system/framework,变成动态库

第一种方式,之前已经做过,不在本文记录下,有兴趣的同学自行搜索,记录下第二种方式
首先提供两篇文章,介绍下动态库和静态库以及dex的加载问题:

https://blog.csdn.net/striver_jt/article/details/89226380
https://www.jianshu.com/p/a350876a66e1
如果你只关心打成jar包,那么不需要看上面的文件了;
如果你还想关心下打成的jar包怎么使用,那么可以看下,之所以看这两个文章,是因为我在操作的过程中,发现生成的jar,直接导出项目可以用,但是放到源码,整编后就不能用了,然后就一知半解的看了下。

闲话少叙,开始讲解:

总共分为三步:

Step1:生成jar
Step2:转换成dex jar,并放置到源码中
Step3:在项目中使用

Step1:生成jar

如果你只是要将Module打成库,给别的Android Studio项目使用,建议你打成AAR,简洁方便,还能包含资源。
在Android Studio中生成jar的方式,基本都是copy,因为module在编译的过程中会自己生成jar,在网上搜到的大多数的方式,其实都是在做copy的事情。
1.新建一个lib module,我的module的名字叫datacollectionlib
2.修改gradle文件,确认gradle的第一行是
apply plugin:'com.android.library'
而不是
applyplugin:'com.android.application'
前者代表的是library,后者代表的是application
3.编写命令
先给出一个Android Studio 2.x版本上命令提供参考:
在module的gradle文件中的android 模块里,编写如下代码

        task makeJar(type: Copy) {
                //删除存在的
                delete 'build/libs/com.rambo.datacollection.jar'
                //设置拷贝的文件
                from('build/intermediates/bundles/release/')
                //打进jar包后的文件目录
                into('build/libs/')
                //将classes.jar放入build/libs/目录下
                //include ,exclude参数来设置过滤
                //(我们只关心classes.jar这个文件)
                include('classes.jar')
                //重命名
                rename ('classes.jar', 'com.rambo.datacollection.jar')
        }
        makeJar.dependsOn(build)

结果,是不是发现在3.0上行不通了???
其实只是路径换了,我使用的3.6.1上的路径如下:

Android Studio 3.6.1 classes.jar的路径


image.png

所以我们要做的,就是把classes的路径换下,也许在以后的Android Studio版本里,路径还是会变化,我们要做的就是,在build目录下找到classes.jar的路径,填写正确的路径即可。
上面的操作,其实就是一个copy,rename的过程,如果你的module里还引用了第三方的jar中,这个如何打包呢,我建议采用如下方式:

task makeJar(type: Jar) {
    delete 'build/mylib.jar'//删除旧的jar
    destinationDir = file('build/libs')//指定新jar包存放目录
    archivesBaseName = "mylib"//指定新jar包名字
    from file('build/classes/java/main')//你写的代码的来源,编译后能找到你代码的路径。因人而异,有可能是 from('build/intermediates/bundles/release/classes.jar')
    //第三方库的jar包存放位置
    from(project.zipTree("libs/fastjson-1.2.55.jar"))
    from(project.zipTree("libs/okhttp-3.10.0.jar"))
    from(project.zipTree("libs/okio-2.2.1.jar"))
    from(project.zipTree("libs/kotlin-stdlib-1.3.11.jar"))
}
makeJar.dependsOn(build)

type由‘Copy’变成了‘Jar’

至于执行task生成对应的jar的方式有两种:
1.点击Android Studio最右侧的Gradle栏目,选择对应的module,找到对应的task(在other目录下),直接执行即可

image.png

2.通过Gradle命令执行
我的代码需要通过jenkins来生成,所以需要通过命令的方式
gradlew ::datacollectionlib::makeJar
前面的两个双引号后面的代表的是module,后面的两个的双引号后面的代表的是task名称

最后去对应的目录下取一下文件就可以了,如果是直接用在项目里,到这一步就结束了。

Step2:转换成dex jar,并放置到源码中

如果你看到这一步,那么你最好看下文章一开始发的两个链接的第一个链接。Android分静态库和动态库,我的理解是,静态库是跟项目相关的,我一个项目需要
用A这个库,那么项目就包含了A这个库,如果库发生了变化,那么对应的项目也需要重新编译下;如果是动态库,这个A库一旦被加载了,
需要使用A库的项目都可以去用,并且A库的内容一旦变化了,相关的项目并不需要重新编译。
我在实际的操作中,我的库是需要做成动态库,是不放在任何项目中的,直接放到源码里的。一开始直接用step1生成的jar包,打到系统里了,结果发现总是报ClassNotFound的exception,
当时挺奇怪,因为在system/framework下,库是存在的,对应的permission文件也是有的。后来同事提示说,是不是打的dex的jar,
库并没有加载起来。
后来经过验证,确实是上述问题,知道问题后就很简单了:
找到android sdk platform-tools目录,直接一下命令:

dx --dex --output=dest.jar origin.jar

dest.jar就是需要生成的jar的文件,origin.jar就是之前生成的那个jar。两者的区别,dest.jar放到
Android Studio里看到的是dex文件,后者能够看到相关的代码

接下来,我们要编写一个permission 的xml文件,做动态库的时候是必须要有这个文件的:
文件的命名我建议用packgae的名称,jar包也是如此,比如说我的命名如下:
com.ruan.datacollection.jar
com.ruan.datacollection.xml

<?xml version="1.0" encoding="utf-8"?>
<permissions>
    <library name="com.ruan.datacollection"
            file="/system/framework/com.ruan.datacollection.jar"/>
</permissions>

为了验证我们上面的操作是否有效,我们可以进行如下操作:
1.将com.ruan.datacollection.jar放置到system/framework目录
2.将com.ruan.datacollection.xml放置到system/etc/permissions/目录
然后重启下设备,看看库是否可用(第三步会说到怎么使用)

如果采用mk文件的方式,在prebuilt.mk中写入下面两条命令

PRODUCT_COPY_FILES += vendor/***/DataCollection/com.ruan.datacollection.jar:system/framework/com.ruan.datacollection.jar
PRODUCT_COPY_FILES += vendor/***/DataCollection/com.ruan.datacollection.xml:system/etc/permissions/com.ruan.datacollection.xml

整编下,确认这两个文件有cp到对应的目录就可以了

Step3:在项目中使用

因为我的项目,是需要在各个Android Studio项目中使用,所以我就介绍这种方式了,如果是需要在源码中使用,请自行搜索下如何编写mk

因为我们的库是动态库,按理说,项目是不需要放jar包的,但是如果没有对应的文件,会导致项目编译不过,所以还是需要有jar包的
并且这个jar包不能使用后来生成的那个dex的jar,因为dex的jar中不包含源码,会找不到类。
如果你以前有将framework.jar导入Android Studio的经验,这一步就很简单了

先在app目录下新建一个providedLibs这个目录,将最初的jar包放置到该目录下
在gradle文件里,编写一下代码

compileOnly fileTree(dir: 'providedLibs', include: ['*.jar'])

这个compileOnly表示这个库只是参与了编译,而不在实际的打包中,在之前的Android Studio版本中,这个词叫provided

这样就可以的
Tips:如果你run到一个没有配置该动态库的设备上,会报错,ClassNotFound

一点点拓展

前面提到的动态库需要采用dex的,这个其实也是Android 热更新的原理,感兴趣的可以看看ClassLoader

推荐阅读更多精彩内容