[unity3d]Unity3D与android交互----构建android插件

  1. 云栖社区>
  2. 博客>
  3. 正文

[unity3d]Unity3D与android交互----构建android插件

技术小美 2017-11-08 14:51:00 浏览727
展开阅读全文

原文地址:Building Plugins for Android


为android构建一个插件


要创建一个android插件,首先要有 Android NDK 并熟悉使用ndk构建共享库的方法。

如果用C++来实现库,必须声明成用C语言的链接方式,以避免Name Mangling问题。

  1. extern "C"   
  2. {  
  3.   float FooPluginFunction ();  
  4. }   


通过C#脚本使用插件

构建了共享库后,必须把共享库复制到unity3d工程中的Assets->Plugins->Android目录下。(没有该目录的话,自己依次创建。)

当你在unity3d中在C#脚本中定义如下的函数时,unity3d就能通过名称找到共享库

[csharp] view plaincopy
  1. [DllImport ("PluginName")]  
  2. private static extern float FooPluginFunction ();   


注意PluginName不要包含共享库文件名中的“lib”前缀和“.so”后缀。建议所有的native代码方法都用C#代码封装一层,并在C#代码中检查Application.platform变量,以保证只有app运行在正确的设备上时,才去调用native方法。当在Editor环境下运行时,可以在C#代码中返回空值。

当然也可以用平台宏定义的方法,来控制与平台相关的代码的编译。


部署

对于要部署到多个平台的项目,项目工程中必须包含各个平台所需要的插件(例如:libPlugin.so用于android平台,Plugin.bundle用于mac平台,Plugin.dll用于windows平台)。unity3d会自动为目标平台选择正确的插件。


使用java插件

android插件机制同样允许使用java来与android系统进行交互。


为android构建一个java插件

有好几种方法来构建java插件,最终结果都是生成包含.class文件的.jar包。一种方法是下载 JDK,在命令行下用javac命令编译,用jar命令打包成jar文件;另一种方法是 Eclipse+ADT


在native代码中使用java插件

构建好了java插件后,将java插件(.jar)复制到 unity3d工程中的Assets->Plugins->Android文件夹下面,unity3d会将你的.class文件和其余的java代码打包,并通过Java Native Interface (JNI)来访问这些代码。JNI既可以用于java代码调用native代码,也可用于native代码与java(java虚拟机)的交互。


要找到你的java代码,必须要能访问到java虚拟机。幸运的是,可以通过在c/c++代码中添加如下函数来很容易的实现这种访问:

  1. jint JNI_OnLoad(JavaVM* vm, void* reserved)   
  2. {  
  3.   JNIEnv* jni_env = 0;  
  4.   vm->AttachCurrentThread(&jni_env, 0);  
  5. }   


这个是从c/c++调用java所必需的。JNI超越了本文档的范畴,不做详细解释。通常情况下,先找到类的定义,然后解析类的构造方法(<init>)并创建类的实例,如下面例子所示:

  1. jobject createJavaObject(JNIEnv* jni_env)   
  2. {  
  3.   jclass cls_JavaClass = jni_env->FindClass("com/your/java/Class");          // 找到类定义  
  4.   jmethodID mid_JavaClass = jni_env->GetMethodID (cls_JavaClass, "<init>",  "()V");        // 找到构造方法  
  5.   jobject obj_JavaClass = jni_env->NewObject(cls_JavaClass, mid_JavaClass);      // 创建对象实例  
  6.   return jni_env->NewGlobalRef(obj_JavaClass);                       // return object with a global reference  
  7. }   


通过帮助类来使用java插件

使用AndroidJNIHelper 和AndroidJNI会减轻些使用原始JNI的痛苦。


AndroidJNIHelper 和AndroidJNI自动完成了很多任务(指找到类定义,构造方法等),并且使用缓存使调用java速度更快。AndroidJavaObjectAndroidJavaClass基于AndroidJNIHelper 和AndroidJNI创建,但在处理自动完成部分也有很多自己的逻辑,这些类也有静态的版本,用来访问java类的静态成员。


你可以选择任意你喜欢的方式来替代这种原始JNI的做法,可以通过 AndroidJNI类,也可以通过AndroidJNIHelperAndroidJNI 最后也可以使用 AndroidJavaObject/AndroidJavaClass,这样会有最大程度的自动完成和最大的便利性。


UnityEngine.AndroidJNI是对那些c代码可用的JNI调用的封装,该类中的所有方法都是静态的并且一一对应到JNI。

UnityEngine.AndroidJNIHelper通过public方法提供了一些不常用的辅助功能,在某些特殊情况下会比较有用处。


在java端,UnityEngine.AndroidJavaObjectUnityEngine.AndroidJavaClass的实例分别一一对应于 java.lang.Object和java.lang.Class (或它的子类)的实例。它们提供了3种与java端交互的方法:

Call方法 Get域的值 Set域的值

Call分为两类,调用void方法和调用非void返回类型的方法,会使用一个泛型类型来表示这些非void返回类型的方法的返回类型;Get和Set也经常带一个泛型类型用以表示域的类型。


例子1:

  1. //注释表示是使用原始JNI方法必须做的工作  
  2.  AndroidJavaObject jo = new AndroidJavaObject("java.lang.String""some_string");   
  3.  // jni.FindClass("java.lang.String");   
  4.  // jni.GetMethodID(classID, "<init>", "(Ljava/lang/String;)V");   
  5.  // jni.NewStringUTF("some_string");   
  6.  // jni.NewObject(classID, methodID, javaString);   
  7.  int hash = jo.Call<int>("hashCode");   
  8.  // jni.GetMethodID(classID, "hashCode", "()I");   
  9.  // jni.CallIntMethod(objectID, methodID);  
这个例子中,我们创建了一个 java.lang.String的实例,并用我们自定义的一个字符串初始化它,最后我们得到该字符串的哈希值。


 AndroidJavaObject的构造方法至少需要一个参数----你想要实例化的类的名称。类名之后的参数会被对象的构造函数所使用,如上例种的字符串“
some_string”,随后的对hashCode方法的Call会返回一个int型值,这也是为什么我们会传一个泛型参数给Call方法。


注意:不能使用点.来初始化一个嵌套类型,内部类必须使用$分隔符,在斜线/或点.分隔的类名中都可以使用。所以当类LayoutParams嵌套在ViewGroup类中时,android.view.ViewGroup$LayoutParams或者android/view/ViewGroup$LayoutParams,这两种方式都是可行的。


例子2:

上面有个插件的例子是说获取当前程序的缓存目录的,下面这个例子直接用c#代码做同样的事情,而不需要任何插件:

[csharp] view plaincopy
  1. AndroidJavaClass jc = new AndroidJavaClass("com.unity3d.player.UnityPlayer");   
  2. // jni.FindClass("com.unity3d.player.UnityPlayer");   
  3. AndroidJavaObject jo = jc.GetStatic<AndroidJavaObject>("currentActivity");   
  4. // jni.GetStaticFieldID(classID, "Ljava/lang/Object;");   
  5. // jni.GetStaticObjectField(classID, fieldID);   
  6. // jni.FindClass("java.lang.Object");   
  7.   
  8. Debug.Log(jo.Call<AndroidJavaObject>("getCacheDir").Call<string>("getCanonicalPath"));   
  9. // jni.GetMethodID(classID, "getCacheDir", "()Ljava/io/File;"); // or any baseclass thereof!   
  10. // jni.CallObjectMethod(objectID, methodID);   
  11. // jni.FindClass("java.io.File");   
  12. // jni.GetMethodID(classID, "getCanonicalPath", "()Ljava/lang/String;");   
  13. // jni.CallObjectMethod(objectID, methodID);   
  14. // jni.GetStringUTFChars(javaString);  

这个例子中,我们没有首先使用AndroidJavaObject,而是AndroidJavaClass ,因为我们想获取类com.unity3d.player.UnityPlayer的一个静态成员,而不是去创建一个新的对象(Android UnityPlayer会自动创建一个实例)。我们访问其静态域"currentActivity" ,这个时候我们用的是AndroidJavaObject作为泛型参数,这是因为实际类型(android.app.Activity)是类java.lang.Object的子类,任意非基本类型都必须作为AndroidJavaObject来访问。有一个例外就是字符串,字符串可以直接访问,尽管它在java中并不是基本类型。


之后就是调用的Activity的getCacheDir()得到缓存目录的文件对象,再调用getCanonicalPath()方法获取缓存目录路径的字符串表示。


当然,现在已经不需要通过这种方式来获取缓存目录了,因为unity3d提供了接口用以访问程序的缓存目录和数据目录,也就是Application.temporaryCachePath and Application.persistentDataPath


例子3:

最后,是一个通过UnitySendMessage方法从java代码向脚本代码传递数据的小窍门。

[csharp] view plaincopy
  1. using UnityEngine;   
  2. public class NewBehaviourScript : MonoBehaviour   
  3. {   
  4.   
  5. <span style="white-space:pre">  </span>void Start ()   
  6. <span style="white-space:pre">  </span>{   
  7.     <span style="white-space:pre">  </span>JNIHelper.debug = true;   
  8.     <span style="white-space:pre">  </span>using (JavaClass jc = new JavaClass("com.unity3d.player.UnityPlayer"))   
  9. <span style="white-space:pre">      </span>{   
  10. <span style="white-space:pre">  </span>     jc.CallStatic("UnitySendMessage""Main Camera""JavaMessage""whoowhoo");   
  11.     <span style="white-space:pre">  </span>}   
  12.     }   
  13.   
  14.     void JavaMessage(string message)   
  15. <span style="white-space:pre">  </span>{   
  16.         Debug.Log("message from java: " + message);   
  17.     }  
  18. }   


com.unity3d.player.UnityPlayer现在有一个静态方法UnitySendMessage,与iOS中native端的UnitySendMessage一样,可用来在java中向脚本传递数据。


这里我们直接从脚本中调用的,但它确实是在java端发送的消息,它会调回到unity3d的native代码,传递消息到名为"Main Camera"的游戏对象上去,该对象上绑定的某个脚本中包含有名为"JavaMessage"的方法。


在unity3d中使用java插件的最佳实践
这一节主要针对那些没有足够jni,java和android经验的人。假设我们在unity3d中使用AndroidJavaObject/AndroidJavaClass来与java交互。


首先就是要注意对AndroidJavaObject/AndroidJavaClass的任何操作都是很费时的(是通过JNI来进行的)。因此为了代码性能和代码清晰性,我们强烈建议托管代码与native/java代码间的转换次数保持在最小数量。


你可以定义一个java方法完成所有的事情,然后我们通过AndroidJavaObject/AndroidJavaClass来与这个方法通信和获取结果,我们的JNI帮助类会尽可能多的缓存数据已提高性能。

[csharp] view plaincopy
  1. //第一次像这样调用java函数  
  2. AndroidJavaObject jo = new AndroidJavaObject("java.lang.String""some_string");  // 有点费时  
  3. int hash = jo.Call<int>("hashCode");  //第一次 - 费时  
  4. int hash = jo.Call<int>("hashCode");  // 第二次 - 不那么费时, 因为我们已经知道了这个java方法,可以直接调用它。  

在使用过后,Mono垃圾回收器会释放所有创建的AndroidJavaObjectAndroidJavaClass实例,但我们还是建议把它们放到using(){}块中,以保证它们能被尽快的清除掉。除此之外,你无法保证它们会被销毁掉。如果你设置了AndroidJNIHelper.debug为true,你会在log输出中看到垃圾回收器的活动记录。

[csharp] view plaincopy
  1. //获取系统语言的安全方法  
  2. void Start ()   
  3. {   
  4.     using (AndroidJavaClass cls = new AndroidJavaClass("java.util.Locale"))   
  5. <span style="white-space:pre">  </span>{   
  6.         using(AndroidJavaObject locale = cls.CallStatic<AndroidJavaObject>("getDefault"))   
  7. <span style="white-space:pre">      </span>{   
  8.             Debug.Log("current lang = " + locale.Call<string>("getDisplayLanguage"));   
  9.   
  10.         }   
  11.     }   
  12. }  


也可以直接调用.Dispose()方法确保没有java对象残留,c#对象会存活长一点,最终还是会被mono的垃圾回收器回收。

继承UnityPlayerActivity java代码


在Unity Android上,我们可以继承标准的UnityPlayerActivity类(android上Unity Player的主要java类,类似于Unity iOS上的AppController.mm)。


应用程序可以覆写android系统与Unity Android之间的任意交互方法,只要新建一个Activity继承UnityPlayerActivity就可以实现。(在mac系统上,UnityPlayerActivity.java在/Applications/Unity/Unity.app/Contents/PlaybackEngines/AndroidPlayer/src/com/unity3d/player目录下;在windows系统中,它通常在C:\Program Files\Unity\Editor\Data\PlaybackEngines\AndroidPlayer\src\com\unity3d\player目录下)


首先定位Unity Android的classes.jar文件,可以在Unity3d的安装目录(windows下通常是C:\Program Files\Unity\Editor\Data,mac下是/Applications/Unity)下的子文件夹PlaybackEngines/AndroidPlayer/bin中找到,将它添加到你编译activity的classpath中。最终编译出来的.class文件,需要打包成.jar文件,放到工程中的Assets->Plugins->Android目录下。因为android中manifest文件指明了启动哪个Activity,因此我们也需要重新写一个AndroidManifest.xml文件,也需要将它放到Assets->Plugins->Android目录下。


继承UnityPlayerActivity的一个例子,OverrideExample.java:

[java] view plaincopy
  1. package com.company.product;  
  2.   
  3. import com.unity3d.player.UnityPlayerActivity;  
  4.   
  5. import android.os.Bundle;  
  6. import android.util.Log;  
  7.   
  8. public class OverrideExample extends UnityPlayerActivity {  
  9.   
  10.   protected void onCreate(Bundle savedInstanceState) {  
  11.   
  12.     // call UnityPlayerActivity.onCreate()  
  13.     super.onCreate(savedInstanceState);  
  14.   
  15.     // print debug message to logcat  
  16.     Log.d("OverrideActivity""onCreate called!");  
  17.   }  
  18.   
  19.   public void onBackPressed()  
  20.   {  
  21.     // instead of calling UnityPlayerActivity.onBackPressed() we just ignore the back button event  
  22.     // super.onBackPressed();  
  23.   }  
  24. }   

相关的AndroidManifest.xml文件如下:

[html] view plaincopy
  1. <?xml version="1.0" encoding="utf-8"?>  
  2. <manifest xmlns:android="http://schemas.android.com/apk/res/android" package="com.company.product">  
  3.   <application android:icon="@drawable/app_icon" android:label="@string/app_name">  
  4.     <activity android:name=".OverrideExample"  
  5.               android:label="@string/app_name"  
  6.               android:configChanges="fontScale|keyboard|keyboardHidden|locale|mnc|mcc|navigation|orientation|screenLayout|screenSize|smallestScreenSize|uiMode|touchscreen">  
  7.         <intent-filter>  
  8.             <action android:name="android.intent.action.MAIN" />  
  9.             <category android:name="android.intent.category.LAUNCHER" />  
  10.         </intent-filter>  
  11.     </activity>  
  12.   </application>  
  13. </manifest>   


UnityPlayerNativeActivity

同样我们可以创建UnityPlayerNativeActivity的子类,这与创建UnityPlayerActivity的子类具有相同的效果,但是会有较小的输入延迟。但是,需要明白的是,NativeActivity是在Gingerbread中引入的(即android 2.3),老的android版本没有这个特性,因为在NativeActivity中,触摸事件都是在native代码中处理的,java视图正常情况下是无法获取这些事件的,不过在unity3d中,有允许将事件传到DalvikVM的转发机制,要应用这个转发机制,必须修改manifest文件如下:

[html] view plaincopy
  1. <?xml version="1.0" encoding="utf-8"?>  
  2. <manifest xmlns:android="http://schemas.android.com/apk/res/android" package="com.company.product">  
  3.   <application android:icon="@drawable/app_icon" android:label="@string/app_name">  
  4.     <activity android:name=".OverrideExampleNative"  
  5.               android:label="@string/app_name"  
  6.               android:configChanges="fontScale|keyboard|keyboardHidden|locale|mnc|mcc|navigation|orientation|screenLayout|screenSize|smallestScreenSize|uiMode|touchscreen">  
  7.   <meta-data android:name="android.app.lib_name" android:value="unity" />  
  8.   <meta-data android:name="unityplayer.ForwardNativeEventsToDalvik" android:value="true" />  
  9.         <intent-filter>  
  10.             <action android:name="android.intent.action.MAIN" />  
  11.             <category android:name="android.intent.category.LAUNCHER" />  
  12.         </intent-filter>  
  13.     </activity>  
  14.   </application>  
  15. </manifest>   

要注意activity元素中的.OverrideExampleNative属性,还有两条meta-data元素,第一条meta-data元素指明使用unity3d库libunity.so,第二条meta-data元素使事件能传递到你创建的UnityPlayerNativeActivity子类中。


例子


native插件例子

这里有一个简单的使用native插件的例子。

这个例子演示了如果从unity3d android程序中来调用c代码,包中包含了一个通过native插件计算出来的两个数之和的场景,要注意,你必须用Android NDK来编译这个插件。


java插件例子

这里有一个简单的使用java代码的例子。


这个例子演示了怎么用java代码与android系统进行交互,以及如何用c++来将c#和java沟通起来,包中的场景显示了一个按钮,点击该按钮,会显示出程序在android系统中的缓存目录路径。需要JDK和 Android NDK来编译这个插件。


这里有一个相似的例子,但是是基于预先编译好的JNI库,来封装native代码,供c#调用。





本文转蓬莱仙羽51CTO博客,原文链接:http://blog.51cto.com/dingxiaowei/1366208,如需转载请自行联系原作者

网友评论

登录后评论
0/500
评论
技术小美
+ 关注