Android JNI開發之Friso分詞功能
NDK是Google開發的一套開發和編譯工具集,用於Android上JNI編程。通過NDK我們可以在Android上執行C/C++代碼,進行一些CPU密集型的運算,比如遊戲引擎,信號處理,物理仿真等。本文將通過在Android上調用Friso庫實現分詞算法講解NDK開發的流程。
Friso是一個開源的使用C語言編寫的中文分詞庫,通過在Android上調用Friso庫可以實現中文分詞的功能。
通過NDK調用C代碼方式有兩種, Ndk-build 和 Cmake,其中Ndk-build方式通過Android原生工具包即可實現,Cmake需要使用外部構建工具。我們使用Ndk-build方式調用C代碼。
-
首先在工程根目錄的local.properties中配置ndk和sdk路徑:
-
在main目錄下添加jni/friso文件夾,裏面存放Friso的源文件:
-
接下來編譯Friso代碼,生成對應的So文件。首先配置app的build.gradle文件,在android模塊的defaultConfig模塊下添加ndk配置,其中moduleName是編譯模塊的名稱,在Android.mk中會用到,下面會講到。
-
接下來配置mk文件,mk文件控制着gradle中指定的nkd module如何編譯。在src/main/jni目錄下新建兩個mk文件,Application.mk和Android.mk。其中Application.mk是一些全局配置,如編譯的ABI,STL,APP_PLATFORM等。
Android.mk是編譯某個module的具體配置。APP_ABI := armeabi-v7a arm64-v8a APP_ALLOW_MISSING_DEPS=false APP_STL := gnustl_static #APP_STL := stlport_static APP_PLATFORM := android-14
在Application.mk中我們指定目標ABI包括armeabi-v7a和arm64-v8a兩個版本,可以在這裏添加更多版本。APP_STL使用gnustl_static,APP_PLATFORM指定爲手機支持的最低版本,向後兼容。
LOCAL_PATH := $(call my-dir) include $(CLEAR_VARS) LOCAL_MODULE := FrisoLib FILE_LIST := $(wildcard $(LOCAL_PATH)/*.cpp) FILE_LIST += $(wildcard $(LOCAL_PATH)/*.c) FILE_LIST += $(wildcard $(LOCAL_PATH)/friso/src/*.c) LOCAL_SRC_FILES := $(FILE_LIST:$(LOCAL_PATH)/%=%) #LOCAL_SRC_FILES := com_trio_nnpredict_Friso_FrisoWrapper.cpp LOCAL_LDLIBS := -llog -landroid LOCAL_LDLIBS += -ldl # 添加系統庫 LOCAL_LDLIBS += -latomic # fix error for armeabi: undefined reference to '__atomic_fetch_add_4' include $(BUILD_SHARED_LIBRARY)
Android.mk中通過FILE_LIST指定編譯需要的C和C++源文件,通過LOCAL_LDLIBS添加部分用到的系統庫,通過include $(BUILD_SHARED_LIBRARY)指定編譯的目標是動態庫。可以在Android.mk中指定多個需要編譯的module,通過include $(CLEAR_VARS)和include $(BUILD_SHARED_LIBRARY)配置每個module。編譯生成的so文件libFriso.so會放在src/main/libs路徑下對應的ABI目錄中。
如果項目中需要用到其他預編譯好的so文件,如xxx.so,需要把它放在src/main/jniLibs路徑下對應的ABI目錄下。只有通過mk編譯出來的so文件才放在src/main/libs下。
-
接下來添加Java和C語言通信的接口。在java目錄下新建一個FrisoWrapper.java文件,在裏面添加java調用native代碼的接口:
public class FrisoWrapper {
static {
System.loadLibrary("FrisoLib");
}
public native String[] getSegedStrings(AssetManager assetManager, String inStr);
}
通過命令行進入FrisoWrapper.java所在的目錄,執行javah FrisoWrapper,生成該文件對應的.c文件,注意,這裏要將入口函數由.c改爲.cpp,這樣會使用c++編譯器進行編譯,否則會報錯。javah自動生成了native函數對應的C接口,通過這個接口實現java對C代碼的調用。
extern "C"告訴C++編譯器按照C代碼的簽名規則去編譯。JNIEnv *是一個指向JNI運行環境的指針,通過這個指針訪問JNI函數。第一個jobject指代java中的this對象,第二個jobject代表傳入的AssetManager對象,jstring代表傳入的String對象。
com_jack_friso_FrisoWrapper.h
/* DO NOT EDIT THIS FILE - it is machine generated */
#include <jni.h>
#include <vector>
#include <string>
using namespace std;
#ifndef _Included_com_trio_nnpredict_Friso_FrisoWrapper
#define _Included_com_trio_nnpredict_Friso_FrisoWrapper
#ifdef __cplusplus
extern "C" {
#endif
#include "friso/include/friso.h"
#include "friso/include/friso_API.h"
JNIEXPORT jobjectArray JNICALL Java_com_trio_nnpredict_Friso_FrisoWrapper_getSegedStrings
(JNIEnv *, jobject, jobject, jstring);
#ifdef __cplusplus
}
#endif
#endif
com_jack_friso_FrisoWrapper.cpp
#include <android/asset_manager_jni.h>
#include "com_trio_nnpredict_Friso_FrisoWrapper.h"
using namespace std;
bool isInited = false;
friso_t friso_ = NULL;
friso_config_t config_ = NULL; // 放在最外層保證只需要初始化一次
vector<string> initAndRun(AAssetManager* mgr, fstring query);
jobjectArray make_row(JNIEnv *env, vector<string> results)
{
jclass stringClass = (*env).FindClass("java/lang/String");
jobjectArray row = (*env).NewObjectArray(results.size(), stringClass, 0);
jsize i;
for (i = 0; i < results.size(); ++i) {
const char *cstr = (results[i]).c_str();
(*env).SetObjectArrayElement(row, i, (*env).NewStringUTF(cstr));
}
return row;
}
char* jstringTostring(JNIEnv* env, jstring jstr)
{
char* rtn = NULL;
jclass clsstring = env->FindClass("java/lang/String");
jstring strencode = env->NewStringUTF("utf-8");
jmethodID mid = env->GetMethodID(clsstring, "getBytes", "(Ljava/lang/String;)[B");
jbyteArray barr= (jbyteArray)env->CallObjectMethod(jstr, mid, strencode);
jsize alen = env->GetArrayLength(barr);
jbyte* ba = env->GetByteArrayElements(barr, JNI_FALSE);
if (alen > 0)
{
rtn = (char*)malloc(alen + 1);
memcpy(rtn, ba, alen);
rtn[alen] = 0;
}
env->ReleaseByteArrayElements(barr, ba, 0);
return rtn;
}
JNIEXPORT jobjectArray JNICALL Java_com_trio_nnpredict_Friso_FrisoWrapper_getSegedStrings
(JNIEnv* env, jobject obj, jobject assetManager, jstring query) {
AAssetManager* mgr = AAssetManager_fromJava(env, assetManager );
if(mgr==NULL)
{
LOGD("AAsertManager is NULL");
}
char *nativeString = jstringTostring(env, query);
LOGD("step 00 query---> %s\n", nativeString);
/*
const char* ch = env->GetStringUTFChars(jstr, 0);
env->ReleaseStringUTFChars(jstr, ch);
*/
vector<string> results = initAndRun(mgr, (fstring)nativeString);
jobjectArray jbeatles = make_row(env, results);
return jbeatles;
}
vector<string> initAndRun(AAssetManager* mgr, fstring query) {
vector<string> terms;
if (friso_ == NULL || config_ == NULL) {
friso_ = friso_new();
LOGD("step 001");
config_ = friso_new_config();
LOGD("step 002");
string seg_conf_path = "friso/segmenter.config";
if (1 != friso_init_from_asset_file(friso_, config_, (fstring)(seg_conf_path.c_str()), mgr)) {
friso_free_config(config_);
friso_free(friso_);
LOGD("step 01");
return terms;
}
}
terms.clear();
friso_task_t task = friso_new_task();
friso_set_text(task, query);
while ((friso_next(friso_, config_, task)) != NULL) {
string word(task->hits->word);
LOGD("step 03 %s", word.c_str());
terms.push_back(word);
}
friso_free_task(task);
return terms;
}
完成這些配置工作後,到jni目錄執行ndk-build clean,ndk-build命令,如果報錯,修改相應的代碼錯誤,比如一些在Android上不支持的C類型替換成支持的類型之類的,會有很多這種錯誤,要慢慢改。一切正常的話,會在src/main/libs目錄下對應的ABI目錄中生成libFriso.so文件。
調試通過後,編譯整個工程。如果當前是一個module工程,會在moduleName/build/outputs/aar下生成aar文件,然後就可以在其他項目裏引入這個aar使用了。引入的方式很簡單,將output_aar_name.aar放到工程的app/libs下,並在build.gradle的dependencies中添加如下語句即可:
compile(name: 'output_aar_name', ext: 'aar')
至此,就可以在app中通過jni調用Friso庫實現中文分詞功能了。