由于官方的Android Gradle插件无法解析在dependencies中声明的.so库依赖,所以编译时不会把.so文件自动拷贝到jniLibs目录下,这个插件主要就是为了解决这个问题的,并且提供so文件重命名和abi过滤的实用功能.
另外如果你是使用maven和android-maven-plugin 构建Android项目,并且项目里面有native依赖库的,如果现在想转移到Gradle构建系统上来,那么这个插件正好合适. 开源项目地址:https://github.com/linsea/native-dependencies-plugin
##使用说明 1. 引入插件
1buildscript { 2 repositories { 3 maven { 4 url "https://plugins.gradle.org/m2/" 5 } 6 } 7 dependencies { 8 classpath "gradle.plugin.com.github.linsea:native-dependencies-plugin:0.2.1" 9 } 10} 11 12//在*主模块*项目中(比如APP项目中)应用插件, 13//否则可能遇到Android官方插件中的这个BUG:https://code.google.com/p/android/issues/detail?id=158630 14apply plugin: "com.github.linsea.native-dependencies"
2. 声明Native依赖库
Native依赖库的声明还是像通常一样写在dependencies里面,但要加上classifier和ext,比如:
1dependencies { 2 compile "org.ffmpeg:algorithm:1.2.3:armeabi-v7a@so" 3}
如果你之前使用maven,应该明白这对应maven里面如下的声明:
1<dependency> 2 <groupId>org.ffmpeg</groupId> 3 <artifactId>algorithm</artifactId> 4 <version>1.2.3</version> 5 <classifier>armeabi-v7a</classifier> 6 <type>so</type> 7</dependency>
3. 配置so文件的过滤与重命名规则
3.1 soFilters
在主模块的build.gradle文件中添加一个nativeso块,里面必须有一个soFilters属性,表示项目支持的平台架构种类, 通过这个属性区分so文件的类别属于哪个平台架构,以便拷贝时把相应类别的so文件放到jniLibs下面的相应目录中. 被依赖的so文件的文件名中必须包含这个类别标识符,比如所有armeabi-v7a平台的相应so文件,在仓库中文件的命名 必须包含有armeabi-v7a这个串,否则无法区别这个so文件到底是属于哪个平台的,也就无法拷贝.
3.2 renaming
通常Linux平台的so库文件有一定的命名规则,比如有lib前缀,但是有些开发者提供的库并没有按这些规则来命名,如果 命名与加载时没有对应起来,Android是加载不到so库的.如果APP中引用多个库,而命名又五花八门,为了能使我们把so库 拷贝到jniLibs下后Android可以加载到库,有时我们需要重命名so文件.
**renaming**就是定义命名规则的,一条renaming规则可以对应一个或多个so文件的命名,regex是以正则表达式的 方式匹配so文件名,如果匹配到任意一次,则so文件名不会再继续匹配下一条renaming规则. 重命名时可以定义 replaceAll或者replaceWith的方式,两者同时定义时, 仅replaceAll生效而忽略replaceWith. 以replaceAll方式重命名时,实际上是在so filename上执行String.replaceAll(regex,replaceAll). 而以replaceWith方式重命名时,则支持正则表达式的占位符($+数字表示)替换,功能更加强大,几乎可以满足所有命名需求. 具体可以参考Gradle文档中Copy的重命名.比如:
1regex = '(.*)_OEM_BLUE_(.*)' 2replaceWith = '$1$2'
prefix 表示so文件重命名后加入的前缀,一般需要lib前缀时可以配置这个.
注意
文件的重命名时,从上到下依次匹配规则,如果有一个匹配到了,则下面的规则会忽略跳过,如果最终一个规则都没有匹配到,则文件不会重命名.
以下是一个nativeso的配置示例及说明:
1nativeso { 2 3//.so filename MUST contains 'armeabi-v7a' or 'x86' to identify abi types 4 soFilters = ['armeabi-v7a'] //['armeabi-v7a','x86'] 5 6//rename .so file: textsearch-1.2.3-armeabi-v7a.so -> libtextsearch.so 7 renaming { 8 prefix = 'lib' 9 regex = 'textsearch-1.2.3-armeabi-v7a.*' 10 replaceAll = 'textsearch' //not include ext .so 11 } 12 13//rename .so file: libhello-1.4.10-armeabi-v7a.so -> libhello.so 14 renaming { 15 regex = 'libhello(.*)' 16 replaceWith = 'libhello' 17 } 18 19//rename .so file: libmysdk2-v7.0-armeabi-v7a.so -> libmysdk2.so 20 renaming { 21 regex = 'libmysdk(\\d+)-v(.*)' 22 replaceWith = 'liblocSDK$1' 23 } 24 25//默认命名规则: name-version-armeabi-v7a.so -> libname.so 26 renaming { 27 prefix = 'lib' 28 regex = '(.*)-([\\d\\.]+)-(.*)' 29 replaceWith = '$1' 30 } 31}
##注意事项 插件会把so文件拷贝到jniLibs下对应的目录下,比如jniLibs/armeabi-v7a,而且会利用Gradle提供的缓存机制,提高编译速度,但是当依赖更新而过期时,需要重新下载并拷贝,在拷贝之前,插件会清空jniLibs目录.因此如果你的主模块项目已经包含了一些native依赖,并且.so文件已经放到jniLibs下的对应目录下,那么插件会同时把这些so文件也删除.为了避免这种情况发生,需要增加一个单独 的jniLibs目录给插件使用,比如:
1android { 2 sourceSets { 3 main { 4 //... 5 jniLibs.srcDirs += 'src/main/nativeso' //一定要加在数组的最后 6 } 7 }
##使用技巧 1.插件增加了一个名为collectso的Task,并且利用了gradle的增量编译机制,如果文件是新的,Task不会重复执行.如果重命名时需要调试脚本,可以运行以下命令:
./gradlew -q --rerun-tasks collectso --info
查看插件的输出日志和重命名后的文件名,以便帮助定义重命名规则.
2.通常,如果你的APP仅支持有限的几种ABI,则其他所有不支持的ABI的so文件应该在APK打包中排除掉,否则在某些机型中无法加载 对应ABI上缺失的so,在android plugin 2.2及以上版本可以通过如下配置达到效果:
1android { 2 packagingOptions { //假设你的APP仅支持armeabi-v7a架构,则其他的所有架构的so需要排除之 3 exclude '/lib/armeabi/**' 4 exclude '/lib/arm64-v8a/**' 5 exclude '/lib/x86/**' 6 exclude '/lib/x86_64/**' 7 exclude '/lib/mips/**' 8 exclude '/lib/mips64/**' 9 } 10}