aar包介紹
在介紹aar之前,先來看看jar。現在在android開發過程中經常需要引用jar等第三方庫。你可以很容易把Android Library Project項目打包成jar包給其他項目引用。但是如果你打包的庫需要引用到drawable文件、xml文件等資源文件,jar就無法滿足要求。與jar不同,aar包是把整個module都打包進去,aar包包含以下文件:
/AndroidManifest.xml (mandatory)
/classes.jar (mandatory)
/res/ (mandatory)
/R.txt (mandatory)
/assets/ (optional)
/libs/*.jar (optional)
/jni/<abi>/*.so (optional)
/proguard.txt (optional)
/lint.jar (optional)
如果我們要引用一個帶有資源文件的庫,就可以很方便的引用aar包。
對于jni開發,我們可以把c/c++文件編譯成so文件,然后應用到其他工程中,但是引用so文件的工程就需要創建一個package一個與so文件的包名一致,這樣才能調用到so文件的方法。有了aar,就可以把so文件和調用so文件的java代碼都封裝起來,打包成aar給其他工程調用,這樣就可以讓主工程與庫完全獨立,不需要受到包名或路徑的限制。
本文的源碼請前往Github https://github.com/dragonjiang/JniPackagingToAar
環境配置
如果已經配置好可以跳過這個步驟。
下載ndk,墻內官網訪問不了,可以度娘,現在最新的是
android-ndk-r10e-windows-x86_64.exe解壓,一般是解壓到與SDK同級的目錄下:
- 設置Windows環境變量
然后在Path里面添加%Android_NDK_HOME%
新建工程
1. 打開android studio,新建工程
選擇新建一個Empty Actity
2. 新建一個module
選擇File->New->New Module 新建一個module,選擇Android Library
取名JniModule
3. 在JniModule下新建NativeHelper類,聲明一個native方法:
聲明代碼如下:
public class NativeHelper {
public native String getStringFromJni();
}
4. 執行Build->Make Project,目的是生成class文件###
打開工程目錄PackagingToAar\jnimodule\build\intermediates\classes\debug\com\dj\jni\jnimodule\NativeHelper.class 可以看到生成了NativeHelper.class文件:
5. 根據class文件生成對應的c語言頭文件
打開android stuido 的 terminal,執行命令cd jnimodule/src/main
進入JniModule的mian目錄,目的是在mian目錄下生成jni文件夾。
然后用javah生成c頭文件:
javah -d jni -classpath D:\ANDROID_DEVELOP_ENVIRNMONT\SDK\platforms\android-21\android.jar;..\..\build\intermediates\classes\debug com.dj.jni.jnimodule.NativeHelper
命令格式是:
javah -d (jni文件夾名) -classpath (sdk路徑);(class路徑) (class完整的文件名,包括包名)
然后再看JniModule的mian目錄下會多出jni文件夾,里面已經自動生成了一個頭文件com_dj_jni_jnimodule_NativeHelper.h
文件內容如下:
/* DO NOT EDIT THIS FILE - it is machine generated */
#include <jni.h>
/* Header for class com_dj_jni_jnimodule_NativeHelper */
#ifndef _Included_com_dj_jni_jnimodule_NativeHelper
#define _Included_com_dj_jni_jnimodule_NativeHelper
#ifdef __cplusplus
extern "C" {
#endif
/*
* Class: com_dj_jni_jnimodule_NativeHelper
* Method: getStringFromJni
* Signature: ()Ljava/lang/String;
*/
JNIEXPORT jstring JNICALL Java_com_dj_jni_jnimodule_NativeHelper_getStringFromJni
(JNIEnv *, jobject);
#ifdef __cplusplus
}
#endif
#endif
6. 新建.c文件
在jni文件下新建.c文件,當然新建.cpp文件也是可以的啦,就看大家習慣使用c還是c++
添加內容如下:
//
// Created by dragonjiang on 2016/2/26.
//
#include <jni.h>
#include<android/log.h>
#ifndef LOG_TAG
#define LOG_TAG "JNI"
#define LOGD(...) __android_log_print(ANDROID_LOG_DEBUG,LOG_TAG ,__VA_ARGS__) // 定義LOGD類型
#define LOGI(...) __android_log_print(ANDROID_LOG_INFO,LOG_TAG ,__VA_ARGS__) // 定義LOGI類型
#define LOGW(...) __android_log_print(ANDROID_LOG_WARN,LOG_TAG ,__VA_ARGS__) // 定義LOGW類型
#define LOGE(...) __android_log_print(ANDROID_LOG_ERROR,LOG_TAG ,__VA_ARGS__) // 定義LOGE類型
#define LOGF(...) __android_log_print(ANDROID_LOG_FATAL,LOG_TAG ,__VA_ARGS__) // 定義LOGF類型
#endif
/*
* Class: com_dj_jni_jnimodule_NativeHelper
* Method: getStringFromJni
* Signature: ()Ljava/lang/String;
*/
JNIEXPORT jstring JNICALL Java_com_dj_jni_jnimodule_NativeHelper_getStringFromJni
(JNIEnv *env, jobject obj){
LOGD("LOG from JNI");
return (*env)->NewStringUTF(env,"Hello from JNI !");
}
7. 配置ndk
執行Build->Clean Project, 再執行Build->Make Project,期間可能會提示錯誤:
我們根據提示在gradle.properties文件中添加以下內容:
android.useDeprecatedNdk=true
打開File->Project Structure,選擇ndk的路徑
在jnimodule目錄下的build.gradle中設置要生成的so庫文件名,注意是在jnimodule目錄下,因為我們的jni工程在這個module下。
在defaultConfig這項里面添加:
ndk {
moduleName "JniPackageTest" //編譯后會生成JniPackageTest.so
ldLibs "log", "z", "m"
}
在NativeHelper類中添加對so庫的加載:
static {
System.loadLibrary("HelloJni");
}
android動態加載庫文件有兩個方法,System.load 和 System.loadLibrary
System.load 參數必須為庫文件的絕對路徑
System.loadLibrary 參數為庫文件名,不包含庫文件的擴展名。
注意加載的庫名字要與build.gradle中配置的庫名字一致。
NativeHelper類的完整代碼如下:
package com.dj.jni.jnimodule;
/**
* @author DragonJiang
* @Date 2016/2/26
* @Time 9:49
* @description
*/
public class NativeHelper {
public native String getStringFromJni();
static {
System.loadLibrary("JniPackageTest");
}
}
8. 編譯jni, 在app中調用native方法
再執行Build->Clean Project,
執行Build->Make Project。
打開工程目錄PackagingToAar\jnimodule\build\intermediates\ndk\debug\lib 可以看到生成了各個平臺的so文件:
打開工程目錄PackagingToAar\jnimodule\build\outputs\aar 可以看到生成了aar包。
注意: 每次修改jni文件夾下的.c文件或者.h文件都要重新執行Build->Make Project,重新生成so文件和aar包。
把aar文件copy出來,后綴名改為.zip,然后解壓,看到aar包里面包含了jni、res、lib等文件夾:
其中jni文件夾下面已經放入各個平臺的so文件:
打開app module下的build.gradle文件,配置引用jnimodule, 在dependecies下添加
compile project(':jnimodule')
然后更新一下gradle,打開app module下的MainActivity,直接引用JniModule下的NativeHelper類。
public class MainActivity extends AppCompatActivity {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
NativeHelper nativeHelper = new NativeHelper();
TextView textView = (TextView) findViewById(R.id.text_view);
textView.setText(nativeHelper.getStringFromJni());
}
}
運行結果:
9. 導出aar包
執行上面的步驟8后,再來打開工程目錄下PackagingToAar\jnimodule\build\outputs\aar 可以看到分別生成了debug和release版的aar包。
把jnimodule-release copy出來就可以使用了。
引用aar包
引用aar包有兩種方式,一種是添加新module,選擇Import .JAR/.AAR Package的方式導入。
一種是配置依賴的方式導入。
完整源碼請前往Github https://github.com/dragonjiang/ImportAarTest
1. 新建module的方式導入
在需要導入aar的工程中,打開File->New->New Module,選擇Import .JAR/.AAR Package:
然后下一步選擇需要導入的aar包,導入成功后就可以看到新的module:
最后在app下的build.gralde中添加依賴
compile project(':jnimodule-release')
到此就可以在app中引用aar包中的類了。
但是這種方式有個缺點,就是被依賴的aar包無法看到資源文件等內容
2. 配置依賴的方式導入
先將aar包放入需要引用的Module的libs目錄下,這里我們在app中引用aar包,所以放到aap下的libs目錄下:
然后在app下的build.gralde中把libs目錄加入依賴:
repositories {
flatDir {
dirs 'libs'
}
}
接著在build.gralde的依賴配置中加入compile (name:'jnimodule-release',ext:'aar')
格式是compile(name: 'xxx', ext: 'aar')
,表示依賴aar文件。
至此依賴的配置完畢。
然后構建一下工程,在aap的build/intermediates/exploded-aar目錄下看到jnimodule-release里面的文件。
在MainActivity中直接引用aar包里面類:
這種方式可以很方便的看到aar里面的jni、res、libs等文件