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

简介:

原文地址:Building Plugins for Android


为android构建一个插件


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

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

[cpp]  view plain copy
  1. extern "C"   
  2. {  
  3.   float FooPluginFunction ();  
  4. }   


通过C#脚本使用插件

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

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

[csharp]  view plain copy
  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++代码中添加如下函数来很容易的实现这种访问:

[cpp]  view plain copy
  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>)并创建类的实例,如下面例子所示:

[cpp]  view plain copy
  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:

[cpp]  view plain copy
  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 plain copy
  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 plain copy
  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 plain copy
  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垃圾回收器会释放所有创建的 AndroidJavaObject AndroidJavaClass实例,但我们还是建议把它们放到using(){}块中,以保证它们能被尽快的清除掉。除此之外,你无法保证它们会被销毁掉。如果你设置了 AndroidJNIHelper.debug为true,你会在log输出中看到垃圾回收器的活动记录。

[csharp]  view plain copy
  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 plain copy
  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 plain copy
  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 plain copy
  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,如需转载请自行联系原作者

相关文章
|
1月前
|
Java Linux Android开发
移动应用开发与操作系统的交互:深入理解Android和iOS
在数字时代,移动应用成为我们日常生活的一部分。本文将深入探讨移动应用开发的核心概念、移动操作系统的工作原理以及它们如何相互作用。我们将通过实际代码示例,展示如何在Android和iOS平台上创建一个简单的“Hello World”应用,并解释其背后的技术原理。无论你是初学者还是有经验的开发者,这篇文章都将为你提供有价值的见解和知识。
|
15天前
|
Android开发
我是一位Android工程师,用通义灵码的AS插件做开发工作助手,对比之前没有灵码,现在提效了60%
我是一位Android工程师,用通义灵码的AS插件做开发工作助手,对比之前没有灵码,现在提效了60%
30 0
|
2月前
|
前端开发 图形学 开发者
【独家揭秘】那些让你的游戏瞬间鲜活起来的Unity UI动画技巧:从零开始打造动态按钮,提升玩家交互体验的绝招大公开!
【9月更文挑战第1天】在游戏开发领域,Unity 是最受欢迎的游戏引擎之一,其强大的跨平台发布能力和丰富的功能集让开发者能够迅速打造出高质量的游戏。优秀的 UI 设计对于游戏至关重要,尤其是在手游市场,出色的 UI 能给玩家留下深刻的第一印象。Unity 的 UGUI 系统提供了一整套解决方案,包括 Canvas、Image 和 Button 等组件,支持添加各种动画效果。
124 3
|
3月前
|
图形学 Android开发 iOS开发
穿越数字洪流,揭秘Unity3d中的视频魔法!Windows、Android和iOS如何征服RTSP与RTMP的终极指南!
【8月更文挑战第15天】在数字媒体的海洋中,实时视频流是连接世界的桥梁。对于那些渴望在Unity3d中搭建这座桥梁的开发者来说,本文将揭示如何在Windows、Android和iOS平台上征服RTSP与RTMP的秘密。我们将深入探讨这两种协议的特性,以及在不同平台上实现流畅播放的技巧。无论你是追求稳定性的RTSP拥趸,还是低延迟的RTMP忠实粉丝,这里都有你需要的答案。让我们一起穿越数字洪流,探索Unity3d中视频魔法的世界吧!
61 2
|
3月前
|
传感器 开发工具 vr&ar
ManoMotion⭐二、Unity手势识别插件简介,及效果录屏
ManoMotion⭐二、Unity手势识别插件简介,及效果录屏
|
3月前
|
Java 网络安全 开发工具
UNITY与安卓⭐一、Android Studio初始设置
UNITY与安卓⭐一、Android Studio初始设置
|
3月前
|
图形学 Android开发
小功能⭐️Unity调用Android常用事件
小功能⭐️Unity调用Android常用事件
|
2月前
|
图形学 C++ C#
Unity插件开发全攻略:从零起步教你用C++扩展游戏功能,解锁Unity新玩法的详细步骤与实战技巧大公开
【8月更文挑战第31天】Unity 是一款功能强大的游戏开发引擎,支持多平台发布并拥有丰富的插件生态系统。本文介绍 Unity 插件开发基础,帮助读者从零开始编写自定义插件以扩展其功能。插件通常用 C++ 编写,通过 Mono C# 运行时调用,需在不同平台上编译。文中详细讲解了开发环境搭建、简单插件编写及在 Unity 中调用的方法,包括创建 C# 封装脚本和处理跨平台问题,助力开发者提升游戏开发效率。
174 0
|
2月前
|
vr&ar 图形学 API
Unity与VR控制器交互全解:从基础配置到力反馈应用,多角度提升虚拟现实游戏的真实感与沉浸体验大揭秘
【8月更文挑战第31天】虚拟现实(VR)技术迅猛发展,Unity作为主流游戏开发引擎,支持多种VR硬件并提供丰富的API,尤其在VR控制器交互设计上具备高度灵活性。本文详细介绍了如何在Unity中配置VR支持、设置控制器、实现按钮交互及力反馈,结合碰撞检测和物理引擎提升真实感,助力开发者创造沉浸式体验。
141 0
|
2月前
|
图形学 iOS开发 Android开发
从Unity开发到移动平台制胜攻略:全面解析iOS与Android应用发布流程,助你轻松掌握跨平台发布技巧,打造爆款手游不是梦——性能优化、广告集成与内购设置全包含
【8月更文挑战第31天】本书详细介绍了如何在Unity中设置项目以适应移动设备,涵盖性能优化、集成广告及内购功能等关键步骤。通过具体示例和代码片段,指导读者完成iOS和Android应用的打包与发布,确保应用顺利上线并获得成功。无论是性能调整还是平台特定的操作,本书均提供了全面的解决方案。
149 0
下一篇
无影云桌面