Qt for Android - JNI

在使用Qt制作跨平台app时，通常目标平台都是Android和iOS。因为本身Qt所设计的平台很多，有很多功能在Android和iOS上未能提供实现，需要程序员自行制作。比如调用读取手机通讯录、使用UsbManager等。

此文章介绍JNI的基础，以便读者可以使用此技术来补全一些Qt未能做到的功能。

JNI - Java Native Interface
JNI的技术有很多年了，原先是提供让java代码直接调用c/c++代码，来做一些java代码做不到的事情，能深入做系统的功能。其原理是把c/c++代码编译成动态哭文件（dll, linux上则是so文件），此代码直接为java类中某函数的实现。那么在java代码里直接调用该函数就可以，在调用的过程中，JVM会负责动态加载该动态库到内存中，从而执行当中的c/c++代码。

Qt中所说的JNI则是方向相反，因为本身我们使用Qt所制作的android程序中，我们所编写的c/c++代码就已经是放到一个*.so的动态库文件里。android系统把apk包打开执行时，先执行Qt的QtActivity java类，从而通过JNI调用到我们的libXXX.so(此so是压缩在我们的apk中的)。而我们在此so中的代码，就要通过Qt的JNI来反过来调用java代码，所以在JNI的方向来说是反向的。

在Qt中，提供了一个Android Extras的库，首先需要在项目的pro文件中添加此库，才能使用Qt的JNI。

android {    #如果构建目标(build target)是android
    QT += androidextras  #使用此库
}

调用java代码有两种方案
方案一：直接把java代码逐行翻译为c++代码来写
方案二：把java代码写在我们的主要Activity中，然后c++那边可以以较简单的方式调用

实例：调用android中的拍照app, java代码:

String action = "android.media.action.IMAGE_CAPTURE";
Intent intent = new Intent(action);

File extDir = Environment.getExternalStorageDirectory();
String filename = "camera.jpg";
File photo = new File(extDir, filename);

Uri takePhotoSavedUri = Url.fromFile( photo );

intent.putExtra( MediaStore.EXTRA_OUTPUT, takePhotoSavedUri );

int SHOOT_PHOTO = 1;
startActivityForResult(intent, SHOOT_PHOTO);

此java代码大致含义：发出一个Intent，系统处理这个Intent就会把拍照的app调用起来。startActivity和startActivityForResult的区别就不在此博客里详说了。

方案一：直接把java代码逐行翻译为c++代码来写
要把以上的java代码翻译成Qt C++的代码，先要知道几点：

• QAndroidJniObject这个类，能包装所有java的对象。
• 用QAndroidJniObject对包装的对象调用函数或者读取属性，有几种方法
• 在读取属性或者调用函数时，需要知道如何写清楚该属性或者函数的签名（signature）

用QAndroidJniObject来做new一个对象：

java	Qt C++
File file = new File();	QAndroidJniObject file(“java/io/File”, “()V”);
File file = new File(“/tmp/a.txt”);	QAndroidJniObject str = QAndroidJniObject::fromString(“/tmp/a.txt”); QAndroidJniObject file(“java/io/File”, “(Ljava/lang/String;)V”, str.object());

用QAndroidJniObject来调用对象的方法（返回类型是对象）：

java	Qt C++
intent.putExtra(MediaStore.EXTRA_OUTPUT, takePhotoSavedUri);	intent.callObjectMethod(“putExtra”,”(Ljava/lang/String;Landroid/os/Parcelable;)Landroid/content/Intent;”, MediaStore__EXTRA_OUTPUT.object(), takePhotoSavedUri.object());

写签名的时候，类型的对应表是这样的：

java	Qt C++
boolean	Z
byte	B
char	C
short	S
int	I
long	J
float	F
double	D
完整类名	L完整类名/分隔;
类型[]	[类型
函数类型	(多个参数类型)返回类型

举个例子，要读取android.provider.MediaStore类的 EXTRA_OUTPUT 静态属性。我们先翻查api文档中（http://developer.android.com/reference/android/provider/MediaStore.html#EXTRA_OUTPUT），EXTRA_OUTPUT的类型是String(即java.lang.String)。那么我们可以这么读取：

//java: String MediaStore__EXTRA_OUTPUT = MediaStore.EXTRA_OUTPUT;

QAndroidJniObject MediaStore__EXTRA_OUTPUT = 
    QAndroidJniObject::getStaticObjectField(
        "android/provider/MediaStore", "EXTRA_OUTPUT", 
        "Ljava/lang/String;");

以上这些搞明白后，刚才的java代码转成c++：

void MyController::callExternalCamera()
{
#ifdef Q_OS_ANDROID
    //android.provider.MediaStore.EXTRA_OUTPUT
    QAndroidJniObject MediaStore__EXTRA_OUTPUT
            = QAndroidJniObject::getStaticObjectField(
                "android/provider/MediaStore", "EXTRA_OUTPUT", "Ljava/lang/String;");
    qDebug() << "MediaStore__EXTRA_OUTPUT.isValid()=" << MediaStore__EXTRA_OUTPUT.isValid();

    QAndroidJniObject action = QAndroidJniObject::fromString("android.media.action.IMAGE_CAPTURE");
    QAndroidJniObject intent=QAndroidJniObject("android/content/Intent","(Ljava/lang/String;)V",
                                               action.object<jstring>());
    qDebug() << __FUNCTION__ << "intent.isValid()=" << intent.isValid();

    QAndroidJniObject extDir = QAndroidJniObject::callStaticObjectMethod(
                "android/os/Environment", "getExternalStorageDirectory", "()Ljava/io/File;");
    qDebug() << "extDir.isValid()=" << extDir.isValid();

    QAndroidJniObject filename = QAndroidJniObject::fromString("camera.jpg");

    QAndroidJniObject photo=QAndroidJniObject("java/io/File","(Ljava/io/File;Ljava/lang/String;)V",
                                               extDir.object<jobject>(), filename.object<jstring>());
    qDebug() << __FUNCTION__ << "photo.isValid()=" << photo.isValid();

    takePhotoSavedUri = QAndroidJniObject::callStaticObjectMethod(
                "android/net/Uri", "fromFile", "(Ljava/io/File;)Landroid/net/Uri;", photo.object<jobject>());
    qDebug() << "takePhotoSavedUri.isValid()=" << takePhotoSavedUri.isValid();

    intent.callObjectMethod(
                "putExtra","(Ljava/lang/String;Landroid/os/Parcelable;)Landroid/content/Intent;",
                MediaStore__EXTRA_OUTPUT.object<jstring>(), takePhotoSavedUri.object<jobject>());
    qDebug() << __FUNCTION__ << "intent.isValid()=" << intent.isValid();

    int SHOOT_PHOTO = 1;
    QtAndroid::startActivity(intent, SHOOT_PHOTO, this);
#endif

}

因为我们希望在发出Intent之后，拍照的app把最终拍完后保存的相片路径返回给我们，所以我们用了startActivityForResult，而在C++中，我们需要给本来继承一个抽象类(即等于java中重写一个接口):

#ifdef Q_OS_ANDROID
class MyController : public QObject, QAndroidActivityResultReceiver
#else
class MyController : public QObject
#endif

.....

private:
#ifdef Q_OS_ANDROID
    QAndroidJniObject takePhotoSavedUri;
    void handleActivityResult(int receiverRequestCode, int resultCode, const QAndroidJniObject & data);
#endif

};

这样实现这个回调函数：

#ifdef Q_OS_ANDROID
void MyController::handleActivityResult(int receiverRequestCode, int resultCode, const QAndroidJniObject & data)
{
    int SHOOT_PHOTO = 1;
    jint Activity__RESULT_OK = QAndroidJniObject::getStaticField<jint>(
                "android.app.Activity", "RESULT_OK");

    if ( receiverRequestCode == SHOOT_PHOTO && resultCode == Activity__RESULT_OK )
    {
        qDebug() << "takePhotoSavedUri:" << takePhotoSavedUri.toString();

        QAndroidJniObject absPath = takePhotoSavedUri.callObjectMethod("getPath","()Ljava/lang/String;");
        qDebug() << __FUNCTION__ << "absPath.isValid()=" << absPath.isValid();

        m_imagePath = absPath.toString();
        emit this->imagePathChanged();
    }
}
#endif

代码参考：https://github.com/minixxie/examples/tree/master/qt-for-mobile/TestExternalAndroidCamera1

方案二：把java代码写在我们的主要Activity中，然后c++那边可以以较简单的方式调用

使用Qt Creator中的”Create Template”来创建AndroidManifest.xml，就可以编辑：

Create Template之后，pro文件中会自动添加了这几行，qmake在构建时就自动会去android目录找我们编辑好的AndroidManifest.xml来打apk包：

DISTFILES += \
    android/gradle/wrapper/gradle-wrapper.jar \
    android/AndroidManifest.xml \
    android/res/values/libs.xml \
    android/build.gradle \
    android/gradle/wrapper/gradle-wrapper.properties \
    android/gradlew \
    android/gradlew.bat

ANDROID_PACKAGE_SOURCE_DIR = $$PWD/android

在android目录下，建一个src目录，在添加一个我们自定义的Activity类（如 src/com/simon/MyActivity.java），包名和目录名要匹配：

package com.simon;

class MyActivity extends org.qtproject.qt5.android.bindings.QtActivity
{
}

然后修改AndroidManifest.xml里的主Activity类为com.simon.MyActivity：

        <activity android:configChanges="orientation|uiMode|screenLayout|screenSize|smallestScreenSize|locale|fontScale|keyboard|keyboardHidden|navigation"
                  android:name="org.qtproject.qt5.android.bindings.QtActivity"

改为：

        <activity android:configChanges="orientation|uiMode|screenLayout|screenSize|smallestScreenSize|locale|fontScale|keyboard|keyboardHidden|navigation"
                  android:name="com.simon.MyActivity"

把主要的java代码，添加到我们的主要Activity类里，定一个有意义的函数名。并且把需要用到的类，都用import导入：

class MyActivity extends org.qtproject.qt5.android.bindings.QtActivity
{
    public void callExternalCamera()
    {
        String action = "android.media.action.IMAGE_CAPTURE";
        Intent intent = new Intent(action);

        File extDir = Environment.getExternalStorageDirectory();
        String filename = "camera.jpg";
        File photo = new File(extDir, filename);

        Uri takePhotoSavedUri = Uri.fromFile( photo );

        intent.putExtra( MediaStore.EXTRA_OUTPUT, takePhotoSavedUri );

        int SHOOT_PHOTO = 1;
        startActivityForResult(intent, SHOOT_PHOTO);
    }
}

此次c++这边的代码就简单很多，因为只需要调用当前Activity的上面这个函数：

void MyController::callExternalCamera()
{
#ifdef Q_OS_ANDROID
    QAndroidJniObject activity = QtAndroid::androidActivity();

    activity.callMethod<void>("callExternalCamera","()V");
#endif

}

代码参考：https://github.com/minixxie/examples/tree/master/qt-for-mobile/TestExternalAndroidCamera2