android SDK开发之Native 依赖

1. 2个独立的SDK之间难免会有native依赖，例如A SDK 依赖 B SDK，我们通常的做法是手动将A中的头文件和已经编译好的lib拷贝到B中，然后在B中的Android.mk或是CMakeList.txt中声明好依赖。
2. 这个方法的缺点是：
   • A和B不止有native依赖，也有java间的依赖，将native和java依赖分开更新，很容易出现问题。
   • A的头文件和native库每次都要提交到B中的svn/git中，由于native库比较大，速度会很慢，也不利于版本匹配， 当出现问题时，很难定位到依赖A的哪个版本
3. 新方法的要求：
   • android studio IDE
   • android gradle tool 插件版本：3.0.0 - 3.3.0
4. 新方法的使用：
   • 打开SDK根目录的build.gradle，增加对nativeBundel插件的依赖，如下

buildscript {
  repositories {
      jcenter()
      google()
  }
  dependencies {
      // android gradle tool plugin
      classpath 'com.android.tools.build:gradle:3.0.0'
      //Add nativeBundle plugin dependency
      classpath 'com.ydq.android.gradle.build.tool:nativeBundle:1.0.1'
  }
}

• 对于被依赖者A来说

  1. 打开A 模块的build.gradle，引用nativeBundel的导出插件

  apply plugin: 'com.android.library'
  apply plugin: 'maven-publish'
  apply plugin: 'com.ydq.android.gradle.native-aar.export' // must below android gradle plugin
  

  2. 设置导出头文件，在build.gradle,中增加下面设置，头文件会打包进AAR包里。

  nativeBundleExport {
    headerDir = "${project.projectDir}/src/main/jni/include"
  }
  

  3. 支持flavor，如果你的工程有使用的话

  productFlavors {
    flavorDimensions "default"
    export {
        dimension "default"
        nativeBundleExport {
            headerDir = "${project.projectDir}/src/main/jni/include"
        }
    }
  }
  

  4. 支持发布静态库AAR，如果设置了bundleStatic，插件会生个bundleStaticLibDebug/Rlease任务来打包静态库，你可以依赖这个任务的输出AAR作为静态版本，这个AAR的输出目录为${project.buildDir}/output/aar/，如果是release编译，名字为${project.name}-static-release.aar

  nativeBundleExport {
      headerDir = "${project.projectDir}/src/main/jni/include"
      bundleStatic = true
      //extraStaticLibDir = "${project.projectDir}/xx"
      //excludeStaticLibs.add("**/libmylib.a")
      //excludeStaticLibs.add("**/libxx.a")
      //linkOrder = "libxx.a:libyy.a"
  }
  

  5.对于静态版本，你可以指定额外的静态库目录extraStaticLibDir，默认会收集gradle externalNativeBuild的输出静态库；其次你可以排除一些静态库，通过excludeStaticLibs来指定。由于发布多个静态库，可能会涉及到链接顺序问题在链接成动态库时，如果多个静态库间有依赖的话。你可以指定链接顺序。

• 对于使用者B来说

  1. 打开A 模块的build.gradle，引用nativeBundel的导入插件

  apply plugin: 'com.android.library'
  apply plugin: 'maven-publish'
  apply plugin: 'com.ydq.android.gradle.native-aar.import' // must below android gradle plugin
  
  

  2. 如果你是使用externalNativeBuild ndkBuild来配置native编译的话，打开Android.mk，将include ${ANDROID_GRADLE_NATIVE_BUNDLE_PLUGIN_MK} #must followed by "include $(BUILD_SHARED_LIBRARY)" or "include $(BUILD_STATIC_LIBRARY)" 放在需要依赖A库模块的 include $(BUILD_SHARED_LIBRARY)或者include $(BUILD_STATIC_LIBRARY)之前，例如

  include $(CLEAR_VARS)
  LOCAL_SRC_FILES := myapp.cpp \
  LOCAL_MODULE := myapp
  LOCAL_LDLIBS += -llog
  include ${ANDROID_GRADLE_NATIVE_BUNDLE_PLUGIN_MK} #must followed by "include $(BUILD_SHARED_LIBRARY)" or "include   $(BUILD_STATIC_LIBRARY)"
  include $(BUILD_SHARED_LIBRARY)
  
  

  3.如果你是使用externalNativeBuild cmake来配置native编译的话，将include (${ANDROID_GRADLE_NATIVE_BUNDLE_PLUGIN_MK}) 添加到CMakeList.txt，然后在需要依赖A库的target，加上target_link_libraries(<target> ${ANDROID_GRADLE_NATIVE_MODULES})；例如

  cmake_minimum_required(VERSION 3.4.1)
  project(echo LANGUAGES C CXX)
  add_library(myapp
    SHARED
    myapp.cpp)
  target_link_libraries(myapp
    log
    )
  include (${ANDROID_GRADLE_NATIVE_BUNDLE_PLUGIN_MK})
  target_link_libraries(myapp ${ANDROID_GRADLE_NATIVE_MODULES})
  target_compile_options(myapp
    PRIVATE
    -Wall -Werror)
  

  4. 如果你是用自定义task NDK-BUILD的话，将ANDROID_GRADLE_NATIVE_BUNDLE_PLUGIN_MK=${nativeBundleImport.ANDROID_GRADLE_NATIVE_BUNDLE_PLUGIN_MK}增加到你的命令中，例如

  def execmd = ["$ndkbuildcmd", "-j${coreNum}", "V=1", "NDK_PORJECT_PATH=$buildDir",
                          "APP_BUILD_SCRIPT=$androidMKfile", "NDK_APPLICATION_MK=$applicationMKfile", "ANDROID_GRADLE_NATIVE_BUNDLE_PLUGIN_MK=${nativeBundleImport.ANDROID_GRADLE_NATIVE_BUNDLE_PLUGIN_MK}"]
  

  5. 如果你想链接整个静态库的话，可以像下面声明

  nativeBundleImport {
    wholeStaticLibs = "libxx.a:libyy.a" // Library is seperated by colon
  }
  

  6. 如果你的模块有直接对so的依赖，例如下面的样子，这个插件会将so打包进这个库的aar里，而且会将它放入native构建里

  dependencies {
        implementation "com.my.group:module:1.0.0:armeabi-v7a@so"
        implementation "com.my.group:module:1.0.0:armeabi-v7a@har" // contain 'headers'
    }
  

  7. 如果你不想将某个依赖放进native构建里，例如：implementation "com.my.group:moduleA:1.0.0" 有native接口(包括了头文件和so)，你可以这样做

  nativeBundleImport {
        //wholeStaticLibs = "libxx.a:libyy.a" // Library is seperated by colon
        excludeDependencies.add("com.my.group:moduleA")
        excludeDependencies.add("com.my.group:moduleB")
    }
  

  8. 如果上面的方法都无法满足你的需求，你可以到${project.projectDir}/build/nativeLib/目录下查找头文件和native库，自己声明如何使用。

github:https://github.com/howardpang/androidNativeBundle