经验首页 前端设计 程序设计 Java相关 移动开发 数据库/运维 软件/图像 大数据/云计算 其他经验
当前位置：技术经验 » 软件/图像 » unity » 查看文章
【Unity3D】Unity与Android交互
来源：cnblogs　　作者：little_fat_sheep　　时间：2024/2/21 9:23:20　　对本文有异议

1 前言

? 本文主要介绍 Unity 打包发布 Android apk 流程、基于 AndroidJavaObject（或 AndroidJavaClass）实现 Unity 调用 Java 代码、基于 UnityPlayer 实现 Java 调用 Unity 代码，官方介绍见→Android。

? Unity 项目 C# 中获取平台的代码如下，需要引入 UnityEngine 命名空间。

  1. RuntimePlatform platform = Application.platform;

? RuntimePlatform 是枚举类型，主要平台如下。

  1. public enum RuntimePlatform {
  2.     OSXEditor = 0, // editor on macOS.
  3.     OSXPlayer = 1, // player on macOS.
  4.     WindowsPlayer = 2, // player on Windows.  
  5.     OSXWebPlayer = 3, // web player on macOS.
  6.     ...
  7.     WindowsWebPlayer = 5, // web player on Windows.
  8.     WindowsEditor = 7, // editor on Windows.
  9.     IPhonePlayer = 8, // player on the iPhone.
  10.     Android = 11, // player on Android.
  11.     ...
  12.     WebGLPlayer = 17, // player on WebGL
  13.     ...
  14.     LinuxPlayer = 13, // player on Linux.
  15.     LinuxEditor = 16, // editor on Linux.
  16.     ...
  17. }

2 Unity 发布 apk

2.1 安装 Android Build Support

? 在 Unity Hub 中打开添加模块窗口，操作如下。

img

? 选择 Android Build Support 安装，如下（笔者这里已安装过）。

img

? 创建一个 Unity 项目，依次点击【File→Build Settings→Android→Switch Platform】，配置如下。

img

? 依次点击【Edit→Preferences→External Tools】打开 JDK、SDK、NDK、Gradle 配置页面，勾选默认配置，如下。

img

? Unity Editor 不同版本默认下载的 Gradle 版本如下，官方介绍见→Gradle for Android。

img

? 用户也可以选择已安装的 JDK、SDK、NDK、Gradle 路径，如下。

img

? 笔者的具体环境配置如下：

  1. Unity Editor: 2021.3.11f1c2
  2. JDK: 1.8.0_391
  3. SDK Platforms: 29
  4. SDK Build-Tools: 30.0.3
  5. SDK Command-line Tools: 11.0
  6. SDK Platform-Tools: 34.0.5
  7. NDK: 21.3.6528147
  8. Gradle: 6.1.1
  9. Gradle Plugin: 4.0.1

2.2 配置密钥

? 依次点击【Edit→Project Settings→Player→Keystore Manager】（也可以从【File→Build Settings→Player Settings→Keystore Manager】中进入），操作如下。

img

? 打开 Keystore Manager 后， 依次点击【Create New→Anywhere】，选择一个目录保存密钥库文件，笔者保存在项目目录下面的【Keystore/user.keystore】中。

img

? 接着设置密码和别名，其他选项不是必设项。

img

? Add Key 后，会弹出 “是否将创建的密钥库作为项目的密钥库” 弹窗，点击 yes 确认。

img

? 设置密钥后，回到 Project Settings 页面，显示如下。

img

? 创建密钥时，也可以通过以下命令创建。

  1. keytool -genkey -keyalg RSA -alias key_name -keystore keystore_name -validity day_time
  2. keytool -genkey -keyalg RSA -alias first -keystore user -validity 36500

img

2.3 打包 apk

? 依次点击【File→Build Settings→Player Settings】，配置公司名、项目名、版本号等信息，如下。

img

? 在 Other Settings 中配置包名、Android SDK 的最小 API 版本、目标 API 版本等信息，如下。

img

? 关闭 Player Settings，在 Build Settings 页面点击底部的 Build，构建 apk。

2.4 案例

? 新建一个 Unity 项目，修改 Game 页面的屏幕尺寸，如下。

img

? 搭建页面如下。

img

? 给 Button 按钮添加脚本，如下。

? Test.cs

  1. using UnityEngine;
  2. using UnityEngine.UI;
  4. public class Test : MonoBehaviour {
  5.     private Button button;
  7.     private void Start() {
  8.         button = GetComponent<Button>();
  9.         button.onClick.AddListener(OnClick);
  10.     }
  12.     private void OnClick() {
  13.         Debug.Log("Test-OnClick");
  14.     }
  15. }

? 编译 apk 后，打开命令行窗口，输入以下命令，将 apk 安装到手机上。

  1. adb instll -r -t -d Test.apk

? 运行 apk 后，在命令行窗口中通过以下命令查看日志。

  1. adb logcat | findstr "Test-OnClick"

? 点击 Button 按钮，打印日志如下。

img

3 Unity 调 Android 的逻辑

3.1 Unity 项目中部署 Android 代码

? 1）拷贝 Java 源码到 Unity 项目

? 可以将 Android 项目中 Java 代码拷贝到 Unity 项目中 Assets 子目录下，如下，接着就可以通过 AndroidJavaClass 或 AndroidJavaObject 访问 Java 代码了。

img

? 2）打包 Jar 到 Unity 项目

? 可以将 Android 项目打包为 Jar，再将 Jar 拷贝到 Unity 项目中 Assets 子目录下，接着就可以通过 AndroidJavaClass 或 AndroidJavaObject 访问 Java 代码了。

? 修改 Android 项目中 Module 的 build.gradle 文件，如下，主要将 id 由 'com.android.application' 修改为 'com.android.library'，删除 android { } 模块中的 defaultConfig、buildTypes、compileOptions 等子模块。

? build.gradle

  1. apply plugin: 'com.android.library'
  3. android {
  4.     compileSdkVersion 29
  5.     buildToolsVersion '30.0.3'
  7.     compileOptions {
  8.         sourceCompatibility JavaVersion.VERSION_1_8
  9.         targetCompatibility JavaVersion.VERSION_1_8
  10.     }
  11. }
  13. dependencies {
  14.     implementation 'androidx.appcompat:appcompat:1.6.1'
  15.     implementation 'com.google.android.material:material:1.8.0'
  16.     implementation 'androidx.constraintlayout:constraintlayout:2.1.4'
  17.     testImplementation 'junit:junit:4.13.2'
  18.     androidTestImplementation 'androidx.test.ext:junit:1.1.5'
  19.     androidTestImplementation 'androidx.test.espresso:espresso-core:3.5.1'
  20. }

? 修改 build.gradle 文件后，需要点击右上角的 Sync Now 同步，接着按以下步骤编译项目。

img

? 编译结束后，在 Module 的【build\intermediates\aar_main_jar\debug】目录下生成打包的 classes.jar。

img

? 预览 classes.jar 文件如下。

img

3.2 AndroidJavaObject 和 AndroidJavaClass

? AndroidJavaObject 和 AndroidJavaClass 是 Unity 提供的调用 Java 代码的 2 个类，AndroidJavaClass 继承 AndroidJavaObject，它们只有构造方法有一点差异，没有其他的差异，因此，本节只介绍 AndroidJavaObject。

? 1）Set 和 Get 属性

? JavaTest.java

  1. package com.zhyan8.test;
  3. public class JavaTest {
  4.     public static int intVal = 0;
  5.     private String strVal = "abc";
  6. }

? 说明：对于 JavaTest 的 private 属性，AndroidJavaObject 也可以访问到。

? UnityTest.cs

  1. using UnityEngine;
  3. public class UnityTest : MonoBehaviour {
  4.     private void Start() {
  5.         AndroidJavaObject javaObject = new AndroidJavaObject("com.zhyan8.test.JavaTest");
  6.         // 静态属性Set/Get
  7.         javaObject.SetStatic<int>("intVal", 123);
  8.         int intVal = javaObject.GetStatic<int>("intVal");
  9.         Debug.Log("UnityTest, intVal=" + intVal); // 打印: UnityTest, intVal=123
  10.         // 非静态属性Set/Get
  11.         javaObject.Set<string>("strVal", "xyz");
  12.         string strVal = javaObject.Get<string>("strVal");
  13.         Debug.Log("UnityTest, strVal=" + strVal); // 打印: UnityTest, strVal=xyz
  14.     }
  15. }

? 2）调用方法

? JavaTest.java

  1. package com.zhyan8.test;
  3. import android.util.Log;
  5. public class JavaTest {
  6.     public static void fun1() {
  7.         Log.d("JavaTest", "fun1"); // 打印: JavaTest: fun1
  8.     }
  10.     private int fun2() {
  11.         Log.d("JavaTest", "fun2"); // 打印: JavaTest: fun2
  12.         return 123;
  13.     }
  15.     public String fun3(int value) {
  16.         Log.d("JavaTest", "fun3, value=" + value); // 打印: JavaTest: fun3, value=235
  17.         return "Call fun3";
  18.     }
  20.     public String fun4(String value1, int value2) {
  21.         Log.d("JavaTest", "fun4, value1=" + value1 + ", value2=" + value2); // 打印: JavaTest: fun4, value1=abc, value2=123
  22.         return value1 + value2;
  23.     }
  24. }

? 说明：对于 JavaTest 的 private 方法，AndroidJavaObject 也可以访问到。

? UnityTest.cs

  1. using UnityEngine;
  3. public class UnityTest : MonoBehaviour {
  4.     private void Start() {
  5.         AndroidJavaObject javaObject = new AndroidJavaObject("com.zhyan8.test.JavaTest");
  6.         // 静态方法
  7.         javaObject.CallStatic("fun1");
  8.         // 非静态无参方法
  9.         int val2 = javaObject.Call<int>("fun2");
  10.         Debug.Log("UnityTest, val2=" + val2); // 打印: UnityTest, val2=123
  11.         // 非静单参方法
  12.         string val3 = javaObject.Call<string>("fun3", 235);
  13.         Debug.Log("UnityTest, val3=" + val3); // 打印: UnityTest, val3=Call fun3
  14.         // 非静双参方法
  15.         string val4 = javaObject.Call<string>("fun4", "abc", 123);
  16.         Debug.Log("UnityTest, val4=" + val4); // 打印: UnityTest, val4=abc123
  17.     }
  18. }

? 运行程序后，打印日志如下。

img

3.3 Unity 调用 Android 的 Toast

? UnityTest.cs

  1. using UnityEngine;
  2. using UnityEngine.UI;
  4. public class UnityTest : MonoBehaviour {
  5.     private void Start() {
  6.         GetComponent<Button>().onClick.AddListener(() => {
  7.             Toast("Clicked", 1);
  8.         });
  9.     }
  11.     // 调用Android的代码: Toast.makeText(context, msg, durationFlag).show();
  12.     private void Toast(string msg, int durationFlag) { // durationFlag: Toast.LENGTH_SHORT=0, Toast.LENGTH_LONG=1
  13.         AndroidJavaClass toastClass = new AndroidJavaClass("android.widget.Toast");
  14.         AndroidJavaClass unityPlayerClass = new AndroidJavaClass("com.unity3d.player.UnityPlayer");
  15.         AndroidJavaObject currentActivity = unityPlayerClass.GetStatic<AndroidJavaObject>("currentActivity");
  16.         AndroidJavaObject toast = toastClass.CallStatic<AndroidJavaObject>("makeText", currentActivity, msg, durationFlag);
  17.         toast.Call("show");
  18.     }
  19. }

? UnityPlayer 是 Unity 引擎提供的 Java 类，在 Unity Editor 目录下的【Data\PlaybackEngines\AndroidPlayer\Variations\mono\Release\Classes\classes.jar】 中。

? 运行效果如下。

img

4 Android 调 Unity 的逻辑

4.1 Unity 打包为 Android 项目

? 在 Build Settings 页面勾选 Export Project 后，点击 Export 按钮，如下。

img

? 构建成功后，Unity 项目将会被打包成一个 Android 项目，我们可以使用 Android Studio 打开生成的 Android 项目，如下。

img

? 其中，UnityPlayerActivity 是启动的 Main Activity，unity-classes.jar 是 Unity Editor 中的 Jar 包，位置见【Unity Hub\Unity\Editor\2021.3.11f1c2\Editor\Data\PlaybackEngines\AndroidPlayer\Variations\mono\Release\Classes\classes.jar】，我们常用的 UnityPlayer 类就在该 Jar 文件中。

? 如果用户想将 Android 项目打包到 Unity 项目中，但是 Android 项目中又要引用 Unity 的接口，用户可以将 Unity Editor 中的 classes.jar 拷贝到 Android 项目中，如下。

img

? 右键 classes.jar，在弹出菜单中选择 Add As Library。

4.2 UnityPlayer

? UnityPlayer 继承 FrameLayout，主要用于 Java 调用 Unity 代码，其主要属性和方法如下。

  1. // 在UnityPlayer的构造方法中初始化, currentActivity = this.mActivity
  2. public static Activity currentActivity = null;
  4. // java调用Unity中的方法, gameObject: 游戏对象名, method: 游戏对象上挂载脚本中的方法名, params: 方法参数
  5. public static void UnitySendMessage(String gameObject, String method, String params)

? 说明：UnitySendMessage 可以调用 private 方法，只能调用无参和单参数方法，不能调用 static 方法，无法获取方法返回值。

4.3 案例

? UseUnity.cs

  1. using UnityEngine;
  3. public class UseUnity : MonoBehaviour {
  5.     private void Start() {
  6.         AndroidJavaObject javaObject = new AndroidJavaObject("com.zhyan8.test.JavaTest");
  7.         javaObject.Call("start");
  8.     }
  10.     public void Fun1() {
  11.         Debug.Log("UseUnity-Fun1"); // 打印: UseUnity-Fun1
  12.     }
  14.     private void Fun2(string value) {
  15.         Debug.Log("UseUnity-Fun2, value=" + value); // 打印: UseUnity-Fun2, value=xyz
  16.     }
  17. }

? 说明：UseUnity 脚本组件挂在 TestObj 对象上。

? JavaTest.java

  1. package com.zhyan8.test;
  3. import android.util.Log;
  5. import com.unity3d.player.UnityPlayer;
  7. public class JavaTest {
  9.     public void start() {
  10.         fun1();
  11.         fun2();
  12.     }
  14.     private void fun1() {
  15.         Log.d("JavaTest", "fun1"); // 打印: JavaTest: fun1
  16.         UnityPlayer.UnitySendMessage("TestObj", "Fun1", "");
  17.     }
  19.     private void fun2() {
  20.         Log.d("JavaTest", "fun2"); // 打印: JavaTest: fun2
  21.         UnityPlayer.UnitySendMessage("TestObj", "Fun2", "xyz");
  22.     }
  23. }

? 打印日志如下：

img

? 声明：本文转自【Unity3D】Unity与Android交互。

原文链接：https://www.cnblogs.com/zhyan8/p/18024329

 友情链接：直通硅谷 　点职佳 　北美留学生论坛

unity热门文章

  • Unity3D 计时器的实现代码(三种写法总结)
  • unity AudioSource播放完声音后要执行的函数或条件操作
  • Unity 实现给物体替换材质球
  • unity中camera摄像头控制详解
  • 欧拉角的万向节死锁问题
  • 原生实现C#与Lua相互调用方法(Unity3D可用)
  • unity 实现摄像机绕某点旋转一周
  • Unity Shader实现模糊效果
  • 基于Unity实现2D边缘检测
  • C#使用Unity实现IOC

    • unity推荐文章

  • [Unity] Dreamteck Splines实现沿路径移动功能
  • [Unity] 实现AssetBundle资源加载管理器
  • 扩展实现Unity协程的完整栈跟踪
  • iOS使用Unity容器动态加载3D模型
  • 【Unity3D】Unity与Android交互
  • Unity学习笔记--数据持久化之PlayerPrefs的使用
  • 循序渐进介绍基于CommunityToolkit.Mvvm 和HandyControl的WPF应用端开发(12) -- 使用代码生成工具Database2Sharp生成WPF界面代码
  • 循序渐进介绍基于CommunityToolkit.Mvvm 和HandyControl的WPF应用端开发(11) -- 下拉列表的数据绑定以及自定义系统字典列表控件
  • 【Unity3D】UI Toolkit样式选择器
  • 【Unity3D】UI Toolkit容器

    • 本站QQ群：前端 618073944 | Java 606181507 | Python 626812652 | C/C++ 612253063 | 微信 634508462 | 苹果 692586424 | C#/.net 182808419 | PHP 305140648 | 运维 608723728

    W3xue 的所有内容仅供测试，对任何法律问题及风险不承担任何责任。通过使用本站内容随之而来的风险与本站无关。
    关于我们  |  意见建议  |  捐助我们  |  报错有奖  |  广告合作、友情链接（目前9元/月）请联系QQ：27243702 沸活量
    皖ICP备17017327号-2　皖公网安备34020702000426号