S-JIS[2006-06-18/2008-02-07] 変更履歴

JNIのC言語/C++側のコーディング

• C言語とC++の違い
• コーディング例
• JNI関数の概要
  • プリミティブ型・参照型（JavaオブジェクトのC/C++での扱い）
  • String型 [/2006-11-09]
  • 配列型
  • クラスの取得・インスタンス生成 [/2008-02-02]
  • オブジェクトのメソッド呼び出し [/2008-02-07]
  • オブジェクトのフィールド操作
  • ローカル参照の終了 [2006-11-09]
  • 例外処理 [/2007-10-13]

jni.hの中でC言語/C++で使える構造体 （クラス）が定義されているが、
コンパイラーがC言語の場合とC++の場合では定義のされ方が異なり、使い方も少し異なる。

JniJikken.c： JniJikken.cpp：

#include "JniJikken.h"

JNIEXPORT jbyteArray JNICALL Java_JniJikken_copy
  (JNIEnv *env, jobject me, jstring srcj)
{
	/* ここにコーディングしていく */
}

JNIEnvという構造体に、C言語/C++に渡されたJavaのオブジェクトを扱う関数が定義されている。
その関数は、以下のような形式で呼び出す。

envの使い方が違うだけで、関数や関数独自の引数は同じ。

関数の一覧および解説は、Javadoc？にある。

コーディング例

渡された文字列の中身をバイト配列に入れて返す例。

※実行時に不用意にNULLを処理したりするとDLLやSOが落ちる（JavaのようにNullPointerExceptionになったりはしない）ので、エラーチェックはきちんとした方がよい。
（JNI関数でNULLが返ってくるような事態は、例外発生状態だと思ってよいのではないだろうか）

#include "JniJikken.h"

JNIEXPORT
jbyteArray JNICALL Java_JniJikken_copy
  (JNIEnv *env, jobject me, jstring srcj)
{
    const char *src;
    jsize len;
    jbyteArray dstj;
    jbyte *dst;
    int i;

    src = (*env)->GetStringUTFChars(env, srcj, NULL);
    if (src == NULL) return NULL;
    len = (*env)->GetStringUTFLength(env, srcj);

    dstj = (*env)->NewByteArray(env, len);
    if (dstj == NULL) {
        (*env)->ReleaseStringUTFChars(env, srcj, src);
        return NULL;
    }
    dst = (*env)->GetByteArrayElements(env, dstj, NULL);
    if (dst == NULL) {
        (*env)->ReleaseStringUTFChars(env, srcj, src);
        return NULL;
    }

    for(i = 0; i < len; i++){
        dst[i] = src[i];
    }

    (*env)->ReleaseByteArrayElements(env, dstj, dst, 0);
    (*env)->ReleaseStringUTFChars(env, srcj, src);

    return dstj;
}

#include "JniJikken.h"

JNIEXPORT
jbyteArray JNICALL Java_JniJikken_copy
  (JNIEnv *env, jobject me, jstring srcj)
{






    const char* src = env->GetStringUTFChars(srcj, NULL);
    if (src == NULL) return NULL;
    jsize len = env->GetStringUTFLength(srcj);

    jbyteArray dstj = env->NewByteArray(len);
    if (dstj == NULL) {
        env->ReleaseStringUTFChars(srcj, src);
        return NULL;
    }
    jbyte* dst = env->GetByteArrayElements(dstj, NULL);
    if (dst == NULL) {
        env->ReleaseStringUTFChars(srcj, src);
        return NULL;
    }

    for(int i = 0; i < len; i++){
        dst[i] = src[i];
    }

    env->ReleaseByteArrayElements(dstj, dst, 0);
    env->ReleaseStringUTFChars(srcj, src);

    return dstj;
}

public static
byte[] Java_JniJikken_copy
  (Object me, String srcj) throws Exception
{






    byte[] src = srcj.getBytes("UTF-8");

    int len = src.length;

    byte[] dstj = new byte[len];




    byte[] dst = new byte[dstj.length]; System.arraycopy(dstj,0,dst,0,dst.len);





    for (int i = 0; i < len; i++) {
        dst[i] = src[i];
    }

    System.arraycopy(dst,0,dstj,0,dstj.len); dst = null;
    src = null;

    return dstj;
}

呼び出す側の例。

JniJikken.java：

public class JniJikken {

	private native byte[] copy(String src);

	public static void main(String[] args) {
		String src = "ABCテスト";

		JniJikken me = new JniJikken();
		byte[] dst = me.copy(src);		//→Java_JniJikken_copy(me, src)という感じで呼ばれる
	
		System.out.println(dst.length);
		for (int i = 0; i < dst.length; i++) {
			System.out.println(i + ":" + hex(dst[i]));
		}
	}

	private static String hex(byte n) {
		StringBuffer sb = new StringBuffer(2);
		sb.append("0123456789abcdef".charAt((n >> 4) & 15));
		sb.append("0123456789abcdef".charAt(n & 15));
		return sb.toString();
	}
}

JNI関数の概要

プリミティブ型・参照型

Javaのプリミティブ型（intやbyte）に対し、（先頭に「j」を付けた）jintやjbyteといったプリミティブに該当する型が用意されている。
サイズや符号の有無も一致するように定義されている。（booleanだけは違う）

オブジェクト型は、jobjectやjclassなどが用意されている。
C言語においては全てjobjectの別名（typedef）であり、C++では派生関係になっている。
実際のところ jobject等はポインターなので、代入したりNULLと比較したりすることが出来る。

String型

Javaは文字列をUNICODEで扱っているので、JNIでも基本的にはUNICODEで操作する。
ただし名前に「UTF」と付いているJNI関数があって、これはUTF-8で操作する。
半角文字（ASCII）ならUTF-8でもSJIS（MS932）でも同じ文字コードだから、UTF付きの関数で扱うのが楽。

でもやっぱりSJISの全角文字を扱いたいなーということで、SJIS用の関数を作ってみた。[2006-06-24]

これらの関数は、例外発生中でも使える。
ただし、これらの関数内部で新たに例外が発生した場合、新しい方が有効となる。
（古い方を有効にしたいなら、これらの関数呼び出し前にExceptionOccurredを呼んで保持しておいて、事後に戻す）
また、何かエラーが発生した場合にはNULLを返す。

GetStringMS932Charsで取得した文字列は、ReleaseStringMS932Charsで解放する必要がある。
（見ての通り、引数にはReleaseStringUTFCharsと 同様にenvや元のJava文字列を渡すようにしてあるが、実際はfree()しているだけ(笑)）

/*
	SJIS文字列から、新しいStringを生成する。
	2006-11-09 ローカル参照の終了を追加
*/
jstring NewStringMS932(JNIEnv *env, const char *sjis)
{
	if (sjis==NULL) return NULL;

	jthrowable ej = env->ExceptionOccurred();
	if (ej!=NULL) env->ExceptionClear(); //発生中の例外をクリア

	int len = 0;
	jbyteArray arrj = NULL;
	jstring encj    = NULL;
	jclass clsj     = NULL;
	jmethodID mj    = NULL;
	jstring strj    = NULL;

	len = strlen(sjis);
	arrj = env->NewByteArray(len);
	if (arrj==NULL) goto END;
	env->SetByteArrayRegion(arrj, 0, len, (jbyte*)sjis);

	encj = env->NewStringUTF("MS932");
	if (encj==NULL) goto END;

	clsj = env->FindClass("Ljava/lang/String;");
	if (clsj==NULL) goto END;
	mj = env->GetMethodID(clsj, "<init>", "([BLjava/lang/String;)V");
	if (mj==NULL) goto END;

	strj = (jstring)env->NewObject(clsj, mj, arrj, encj);
	if (strj==NULL) goto END;

	if (ej!=NULL) env->Throw(ej); //発生していた例外を戻す
END:
	env->DeleteLocalRef(ej);
	env->DeleteLocalRef(encj);
	env->DeleteLocalRef(clsj);
	env->DeleteLocalRef(arrj);

	return strj;
}

/*
	SJISの文字列を返す。
	この文字列はヌルターミネートされている('\0'で終わっている)。
	使用後は、取得した文字列をReleaseStringMS932Charsで解放すること。
	2006-11-09 ローカル参照の終了を追加
*/
const char* GetStringMS932Chars(JNIEnv *env, jstring strj, int *pLen)
{
	if (strj==NULL) return NULL;

	jthrowable ej = env->ExceptionOccurred();
	if (ej!=NULL) env->ExceptionClear(); //発生中の例外をクリア

	int len = 0;
	char *sjis = NULL;
	jclass     clsj = NULL;
	jbyteArray arrj = NULL;
	jmethodID  mj   = NULL;

	jstring encj = env->NewStringUTF("MS932");
	if (encj==NULL) goto END;

	clsj = env->GetObjectClass(strj);
	if (clsj==NULL) goto END;

	mj = env->GetMethodID(clsj, "getBytes", "(Ljava/lang/String;)[B");
	if (mj==NULL) goto END;
	arrj = (jbyteArray)env->CallObjectMethod(strj, mj, encj);
	if (arrj==NULL) goto END;

	len = env->GetArrayLength(arrj);
	if (len<0) goto END;
	sjis = (char*)malloc(len + 1);
	if (sjis==NULL){
		//env->FatalError("malloc");
		goto END;
	}
	env->GetByteArrayRegion(arrj, 0, len, (jbyte*)sjis);
	sjis[len] = '\0';
	if (pLen!=NULL) *pLen = len;

	if (ej!=NULL) env->Throw(ej); //発生していた例外を戻す
END:
	env->DeleteLocalRef(ej);
	env->DeleteLocalRef(encj);
	env->DeleteLocalRef(clsj);
	env->DeleteLocalRef(arrj);

	return sjis;
}

/*
	GetStringMS932Charsによって取得した文字列を解放する。
*/
void ReleaseStringMS932Chars(JNIEnv *env, jstring strj, const char *sjis)
{
	free((void*)sjis);
}

配列型

Javaのプリミティブ型の配列は、byte[]・int[]等に応じて jbyteArray・jintArrayといった型が用意されている。
これらは、C++ではjarrayの派生クラスであり、C言語ではjarrayの別名（typedef）である。

配列を操作する関数は、関数名に型の名前が入っているものがそれぞれ用意されている。

Get〜ArrayElements関数（やGetStringUTFChars関数等）では、最後の引数isCopyに値が返ってくる。（必要ない場合はNULLを渡せばよい）

	jboolean isCopy;
	jbyte* elems = env->GetByteArrayElements(arrj, &isCopy);

プリミティブ型でないクラスの配列は、少々面倒かもしれない。

クラスの取得・インスタンス生成

オブジェクト型はJNIではjobjectしか用意されていない（当たり前と言えば当たり前だが）ので、具体的なオブジェクトに対してメソッドを呼んだり フィールドの取得/設定を行うにはJavaのリフレクションと同様の操作をする必要がある。

その際、真っ先に必要なのがクラスを取得すること。クラスはJNIではjclassとなる。

JNIの場合、クラス名をシグニチャーと呼ばれる形式で表す。
パッケージ付きのクラス名に対し、区切りの「.」（ピリオド）を「/」（スラッシュ）に置き換え、先頭に「L」、末尾に「;」（セミコロン）を付けたもの。

オブジェクトのメソッド呼び出し

メソッドを呼び出すには、リフレクションと同様の手順を踏む必要がある。
（しかしリフレクションとは違って、privateなメソッドも呼び出すことが出来る。しかもスーパークラスのprivateメソッドまで取得できる。[2008-02-07]）

リフレクションと異なり、メソッド呼び出しには戻り値の型に応じてJNI関数が用意されている。
オブジェクト型が返る場合はCallObjectMethod()、何も返さない場合はCallVoidMethod()、など。
staticなメソッドを呼び出す場合はCallStaticObjectMethod()、そうでない場合はCallObjectMethod()。

jmethodIDは JavaのMethodクラス相当のポインターではあるが、jobjectの派生ではない。

メソッドを表すシグニチャーは、慣れないとややこしい。
「(引数のシグニチャー)返り型のシグニチャー」 （引数の型を表すシグニチャーを丸括弧でくくり、直後に返り値の型のシグニチャーを付ける）という構造をしているが、単純なものはともかく、引数が複数になったりクラスが入ってきたりするとすぐ複雑になって 面倒。

こういうときは、javapというコマンドがシグニチャーを表示してくれるので便利。

>cd クラスが在るディレクトリ
>javap -s クラス名			…指定したクラス内のメソッド・フィールドのシグニチャーを表示する

オブジェクトのフィールド操作

フィールド（プロパティ）を操作するにもメソッド呼び出しと同様の手順が必要となる。

リフレクションではフィールド名だけでフィールドを取得できるが、JNIの場合はフィールドのシグニチャーが必要。
フィールドのシグニチャーは単純で、intの場合は「I」。

値の取得・設定には型名が入ったJNI関数があるので、フィールドの型に応じた関数を呼ぶ。

jfieldIDは JavaのFieldクラス相当のポインターではあるが、jobjectの派生ではない。

ローカル参照の終了

通常のJavaソースの場合、ローカル変数にnullを代入することで、その変数（に入っていたインスタンス）への参照を終了させることが出来る。
あるいはメソッドが終了すれば、そのメソッド内部のローカル変数の参照は全て終了される。

JNIはC/C++のソースなので、同じようにNULLを代入したり関数を終了したりするだけでは、Java（JNI）としては参照が終了したのかどうか判断できない。

この為に、DeleteLocalRef()というJNI関数がある。この関数を呼ぶと、ローカル参照が終了したとみなされる。

	env->DeleteLocalRef(obj);
	obj = NULL;

ローカル参照は、「ローカル参照領域」というような場所に保持されているらしい。
当然このエリアには限りがあるので、オブジェクトを使わなくなったら積極的にDeleteLocalRef()を呼び出すのがいいと思う。
もっとも、JNIの呼び出しが終了すればローカル参照は全て解放されるので、すぐ終了する関数ならそんなに気にすることはないだろうけど。

• SunのJNI拡張機能のローカル参照の管理

→グローバル参照

例外処理

JNIでの実行中は 例外が発生したかどうかの状態を保持しているが、例外が発生した時点で関数を抜けるようなことは無い。
（C++ならともかくCでは無理だろう…？ でもlongjmpとか使えば出来なくはないのではないかと。
でも取得したメモリのReleaseとかをしないといけないから無理かなー。
それより、途中でcatchして処理したり出来ないから、絶対無理か）
try〜catchに当たる部分は 自分でコーディングする必要がある。
例外が発生したままJava側に制御が戻ると、普通に例外が発生したかのように扱われる。

static void throw_test(JNIEnv *env, jobject argj)
{
	if (argj == NULL) {
		jclass clsj = env->FindClass("Ljava/lang/RuntimeException;");
		if (clsj==NULL) return;
		env->ThrowNew(clsj, "argj is null");
		printf("throw exception\n");
		env->DeleteLocalRef(clsj);
		return;		//明示的にreturnしないと、後続がそのまま実行されてしまう
	}
	printf("throw_test end\n");
}

JNIEXPORT void JNICALL Java_JniJikken_throwTest
  (JNIEnv *env, jobject me)
{
	throw_test(env, NULL);
	if (env->ExceptionCheck()) {		//例外が発生したかどうかチェック（catchに相当）
		printf("exception occured\n");
		return;
	}
	printf("throwTest end");
}

引数がString以外のコンストラクターの例外を投げる例。（C言語（C99））[2006-06-23]

/*
	throw new ArgIntException((int)value); …デフォルトパッケージ
*/
static void throwArgIntException(int value, JNIEnv *env)
{
	jclass cls = (*env)->FindClass(env, "LArgIntException;");
	if (cls == NULL) return;
	jmethodID cns = (*env)->GetMethodID(env, cls, "<init>", "(I)V");
	if (cns == NULL) {
		env->DeleteLocalRef(cls);
		return;
	}
	jobject e = (*env)->NewObject(env, cls, cns, value);
	env->DeleteLocalRef(cls);
	if (e == NULL) return;
	(*env)->Throw(env, (jthrowable)e);
}

ちなみに、この関数では、JNIEnvが引数の並びの先頭ではない。
これは何故かというと、上記のC言語のソースをC++に変換するのがやりやすいから。

C++に変換する場合、「(*env)->」を「env->」に置換し、「(env, 」を「(」に置換するとC++のソースになる。
この際、自分で作った関数の先頭をJNIEnvにしてしまうと、その関数の呼び出し部分も置換されてしまってコンパイルエラーになる。だから先頭以外に置いておけば置換対象外となって楽というわけ。
（ちなみに引数なしのJNI関数だと「(*env)->関数(env)」という形式だから、上記の置換だけでは足りない。自分の関数もenv以外の引数が無い場合はJNI関数と区別できないから、これに関してだけは単純な置換は無理）

なお、伝統的な古いC言語では変数宣言を関数の途中で行うことはできないし、C++形式コメント「//」を使うこともできないが、C99規格なら問題ない。（そしてVC++.NETでのC言語モードは、古い…。C言語のソースをそのまま使うことを考えるより、C++に変換しちゃった方が楽なときがあるかもしれない）

一旦例外が起きると、それをクリアするまで、ExceptionOccurred・ExceptionDescribe・ExceptionClear以外のJNI関数は呼び出せなくなる（呼び出してもエラーになる（戻り値がNULLになる））。

試してみるとIsInstanceOfは使えるようだったが、仕様に「安全」と書かれていない以上、使うべきではないだろう。[2006-06-23]
したがって単純なcatchの羅列は、以下のようになる。

try{
	〜
}








catch(RuntimeException e){
	throw e;


}



catch(Exception e){









	throw new RuntimeException(e);

}

static void rethrow(JNIEnv *env)
{
	jthrowable e = env->ExceptionOccurred();
	if (e==NULL) return; //例外が発生していない場合は抜ける

	env->ExceptionClear(); //例外をクリアーしておかないと、FindClassもGetMethodIDも駄目

	jclass clsR = env->FindClass("Ljava/lang/RuntimeException;");
	if (clsR==NULL) return;
	if (env->IsInstanceOf(e, clsR)) {
		env->Throw(e);
		env->DeleteLocalRef(clsR);
		return;
	}

	jclass clsE = env->FindClass("Ljava/lang/Exception;");
	if (clsE==NULL) return;
	if (env->IsInstanceOf(e, clsE)) {
		env->DeleteLocalRef(clsE);
		jmethodID cns = env->GetMethodID(clsR, "<init>", "(Ljava/lang/Throwable;)V");
		if (cns==NULL) {
			env->DeleteLocalRef(clsR);
			return;
		}
		e = (jthrowable)env->NewObject(clsR, cns, e);
		env->DeleteLocalRef(clsR);
		if (e==NULL) return;
		env->Throw(e);
		return;
	}
	env->DeleteLocalRef(clsE);

	env->Throw(e); //例外をクリアしたので、その他の例外を再スローする必要あり
}

例外発生時に使ってもよい関数 [2007-10-13]

• JNI1.4
• JNI5.0（1.5）
• JNI6.0（1.6） …使っていい関数が増えている

参考

• matsuさんのフィールド取得・メソッドを呼び出す
• SunのJava Native Interface 仕様