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的具体配置。Application.mk
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指定为手机支持的最低版本,向后兼容。
Android.mk
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库实现中文分词功能了。