一、知识点学习
Unity 项目中一些需要访问安卓操作系统的功能,比如获取电量,wifi 状态等,需要 Unity 启动安卓系统的 BroadcastReceiver 监听状态,并在状态更新后通知到 Unity 界面。这就需要一种 Unity 与 Android 互相调用的机制,直观地看就是 C# 与 Java 互相调用的方法。
有 Unity 与 Android 互相调用需求的项目需要在两个开发环境中同时进行,创建两个工程,这时就涉及到如何将两个工程连接起来,有两种方式来连接:
Android 工程生成 aar/jar 文件,复制到 Unity 工程中,最终使用 Unity 的 Build 机制生成 apk。Unity 工程将所有内容和代码导出为一个 Android gradle 项目,然后使用 Android Studio 打开项目进行开发,最终使用 Android Studio 打包 apk。
对比一下两者的优缺点:
本项目使用的是第一种方法,因为这个项目中 Unity 工程特别大,导出 Unity 工程的代价太大。但也遇到了库文件依赖问题,不过由于依赖项不是很多,可以手动解决。以下是解决思路:
Unity 调用 Android
Unity官方文档说明需要通过Plugin的方式调用Java代码,但实际上不需要引入任何Plugin就可以调用Java代码。只是一般情况下需要调用的都是封装好的库,这时才需要将 jar 或者 aar 放到 Unity 项目中,然后通过 C# 来访问其中的内容。
jar 或者 aar 文件可以放在Unity任意目录下,为了方便管理,都放在了 Assets/Plugins/Android 目录下。
C# 调用 Java 方法,获取 Java 字段
C# 调用 Java 的底层原理是使用JNI调用,Unity已经提供了很方便的接口:
创建对象:C#中使用 AndroidJavaObject 类封装 Java 对象,new 一个 AndroidJavaObject 对象相当于调用对应的 Java 对象的构造函数。借助 C# 可变参数列表,可以给 Java 对象的构造函数传递任意数量的参数。
// 第一个参数是 Java 类的完整包名,剩下的其他参数会传递给构造方法。 AndroidJavaObject jo = new AndroidJavaObject("java.lang.String", "some_string");
调用对象方法:使用 AndroidJavaObject 类的 Call 方法,有泛型与非泛型的两个版本。
// 泛型版本,目的是指定返回值的类型 int hash = jo.Call<int>("hashCode"); // 非泛型版本,处理返回值是void的情况。 jo.Call("aMethodReturnVoid"); // String中没有返回void的简单方法。。。
获取类,主要用于获取静态字段或调用静态方法,常用来获取 UnityPlayer。
// 传入类的完整包名 AndroidJavaClass jc = new AndroidJavaClass("com.unity3d.player.UnityPlayer");
获取静态字段,只有泛型版本,因为不会有void类型的字段。。。
AndroidJavaObject jo = jc.GetStatic<AndroidJavaObject>("currentActivity");
二、项目实操环节:
第一步,Unity Part:
新建个 Unity 工程 ,如图实现UI:
绑定一下 按钮 的点击逻辑:
public void onClickCopy(){Debug.LogWarning("unity copy");// 注意这里的 class 路径 需要跟后面 AS 工程的 JAVA 脚本要对应上!!using (AndroidJavaClass androidClass = new AndroidJavaClass("com.example.moduleb.MainActivity")){// 这里的方法是否是static的也要注意!不是static的,用Call方法!androidClass.CallStatic("copyTextToClipboard", "test text");}}public void onClickPaste(){Debug.Log("unity paste ");// 注意这里的 class 路径 需要跟后面 AS 工程的 JAVA 脚本要对应上!!using (AndroidJavaClass androidClass = new AndroidJavaClass("com.example.moduleb.MainActivity")){// 这里的方法是否是static的也要注意!不是static的,用Call方法!string s = androidClass.CallStatic<string>("getTextFromClipboard");Debug.LogWarning("unity paste s=" + s);}}
unity 部分暂时完成。
第二步,AS Part:
新建个 AS 工程, no activity 就可以。
进去之后,我们 新建一个 module :
然后 再 src 下 新建接口java脚本:
public static void copyTextToClipboard(final String str) {Activity activity = UnityPlayer.currentActivity;activity.runOnUiThread(new Runnable() {@Overridepublic void run() {ClipboardManager clipboard = (ClipboardManager) activity.getSystemService(Activity.CLIPBOARD_SERVICE);ClipData clipData = ClipData.newPlainText("data", str);clipboard.setPrimaryClip(clipData);Log.i("speedmobile", "DoCopyText text: " + str);}});}/** 从剪贴板中获取文本*/public static String getTextFromClipboard() {Activity activity = UnityPlayer.currentActivity;ClipboardManager clipboard = (ClipboardManager)activity.getSystemService(Activity.CLIPBOARD_SERVICE);if (clipboard != null && clipboard.hasPrimaryClip()&& clipboard.getPrimaryClipDescription().hasMimeType(ClipDescription.MIMETYPE_TEXT_PLAIN)) {ClipData cdText = clipboard.getPrimaryClip();ClipData.Item item = cdText.getItemAt(0);return item.getText().toString();}return "null";}
注意到 这里 用到的UnityPlayerActivity是 Unity 的库类 。这个类需要以 Library 导入到 我们这里的 AndroidTools-module 。 导入的做法是:找到 Unity的安装路径 , 搜索 classes.jar 。
我这里的路径是 :C:\Program Files\Unity\Hub\Editor\.4.36f1\Editor\Data\PlaybackEngines\AndroidPlayer\Variations\mono\Release\Classes\classes.jar
然后拷贝到我们module - libs 文件夹内, 右键点击 classes.jar 选择Add As Library。
这时候,回头再看我们的java脚本,已经不报错误了。
接下来,需要导出我们当前模块 AndroidTools 为 jar 包 , 给Unity使用。
找到 AndroidTools module 的build.gradle脚本。添加下面task语句:
bundle.gradle 示例:
plugins {id 'com.android.library'}android {compileSdk 31defaultConfig {minSdk 21targetSdk 31versionCode 1versionName "1.0"testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"consumerProguardFiles "consumer-rules.pro"}buildTypes {release {minifyEnabled falseproguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'}}compileOptions {sourceCompatibility JavaVersion.VERSION_1_8targetCompatibility JavaVersion.VERSION_1_8}}dependencies {implementation 'androidx.appcompat:appcompat:1.3.1'implementation 'com.google.android.material:material:1.4.0'implementation files('libs\\classes.jar')testImplementation 'junit:junit:4.+'androidTestImplementation 'androidx.test.ext:junit:1.1.3'androidTestImplementation 'androidx.test.espresso:espresso-core:3.4.0'}task clearJar(type: Delete) {delete 'build/libs/androidTools.jar'这行表示如果你已经打过一次包了,再进行打包则把原来的包删掉}task makeJar(type: Copy) {from('build/intermediates/aar_main_jar/release') //这行表示要打包的文件的路径,根据下面的内容,其实是该路径下的classes.jarinto('build/bin/') //这行表示打包完毕后包的生成路径,也就是生成的包存在哪include('classes.jar') //看到这行,如果你对分包有了解的话,你就可以看出来这行它只是将一些类打包了rename ('classes.jar', 'androidTools.jar')}makeJar.dependsOn(clearJar, build)
如图:
然后点击 左边的小箭头,运行导出语句。 执行完之后,可以看到在build/bin 下生成了我们需要的jar包。
然后拷贝这个jar包 到 Unity 工程 Assets/Plugins/Android 下。
第三步,build and run!看 logcat !
success!
附上示例项目地址:
/zengzhiwei/Unity2Android4Copy.git