Unity 与原生交互:Android(Java/Kotlin)与 iOS(Objective-C)的双向调用
一、什么时候需要原生交互
Unity 的 C# 代码运行在引擎中,很多平台相关的功能需要调用系统或第三方的原生代码:
- 接入 SDK:登录、支付、广告、统计、推送、分享;
- 设备功能:震动、剪贴板、权限申请、获取电量和网络类型、打开应用商店评分;
- 系统界面:原生弹窗、分享面板、网页视图;
- 性能:用 C/C++ 实现的计算密集的库。
二、Android
C# 调用 Java
#if UNITY_ANDROID && !UNITY_EDITOR// 调用静态方法using var cls = new AndroidJavaClass("com.mygame.NativeBridge");string version = cls.CallStatic<string>("getAppVersion");
// 获取当前的 Activity(很多 Android API 都需要它)using var unityPlayer = new AndroidJavaClass("com.unity3d.player.UnityPlayer");using var activity = unityPlayer.GetStatic<AndroidJavaObject>("currentActivity");
// 调用实例方法cls.CallStatic("vibrate", activity, 100L);#endif| API | 作用 |
|---|---|
AndroidJavaClass | 代表一个 Java 类,用于调用静态方法、读写静态字段 |
AndroidJavaObject | 代表一个 Java 对象,用于调用实例方法 |
Call / CallStatic<T> | 调用方法,泛型参数是返回值类型 |
Get / GetStatic<T> | 读取字段 |
底层通过 JNI(Java Native Interface)实现:按类名、方法名和签名查找方法,把参数转换成 Java 的类型。每次调用都有一定开销,频繁调用时要缓存 AndroidJavaClass 和 AndroidJavaObject,而不是每次都新建。它们持有 Java 对象的引用,用完要 Dispose(或者用 using)。
对应的 Java 代码放在 Assets/Plugins/Android 下,可以是 .java 源文件,也可以是打包好的 .aar / .jar:
package com.mygame;
public class NativeBridge { public static String getAppVersion() { ... } public static void vibrate(Activity activity, long ms) { ... }}Java 回调 C#
方式一:UnitySendMessage
UnityPlayer.UnitySendMessage("NativeCallback", "OnLoginResult", "{\"uid\":\"123\",\"ok\":true}");按物体名字和方法名字调用场景中某个 GameObject 上脚本的方法,只能传一个字符串。简单通用,复杂数据用 JSON 编码。缺点是依赖场景中有这个名字的物体,靠字符串匹配,拼错了只会静默失败。
方式二:AndroidJavaProxy
让 C# 类实现一个 Java 接口,把它的实例传给 Java,Java 像调用普通的 Java 对象一样回调它:
public interface LoginListener { void onSuccess(String uid); void onFailed(int code);}class LoginCallback : AndroidJavaProxy{ public LoginCallback() : base("com.mygame.LoginListener") { } void onSuccess(string uid) { MainThread.Post(() => Login.OnSuccess(uid)); } void onFailed(int code) { MainThread.Post(() => Login.OnFailed(code)); }}
sdk.CallStatic("login", activity, new LoginCallback());类型更明确,可以传多个参数,不依赖场景中的物体。
线程问题
Java 的回调常常发生在其他线程上(SDK 的网络线程、Android 的 UI 线程),而 Unity 的大部分 API 只能在主线程调用。回调中不要直接操作 Unity 对象,而是把任务投递到主线程的队列中,在 Update 中执行(上面代码中的 MainThread.Post,原理见 网络消息交给主线程)。
反过来,有些 Android 的界面操作必须在 Android 的 UI 线程上执行,需要在 Java 中用 activity.runOnUiThread(...)。
三、iOS
C# 调用 Objective-C
iOS 的插件代码会被静态链接进应用,C# 通过 DllImport("__Internal") 声明外部函数:
using System.Runtime.InteropServices;
public static class IOSBridge{#if UNITY_IOS && !UNITY_EDITOR [DllImport("__Internal")] static extern void _ShowRating(); [DllImport("__Internal")] static extern string _GetDeviceName();#endif
public static void ShowRating() {#if UNITY_IOS && !UNITY_EDITOR _ShowRating();#endif }}对应的 Objective-C 代码放在 Assets/Plugins/iOS 下(.mm 文件),用 extern "C" 导出 C 风格的函数:
#import <StoreKit/StoreKit.h>
extern "C" { void _ShowRating() { [SKStoreReviewController requestReview]; }
const char* _GetDeviceName() { NSString *name = [[UIDevice currentDevice] name]; return strdup([name UTF8String]); // 返回的字符串必须是新分配的内存 }}字符串的内存:C# 端会把返回的 char* 转换成 C# 字符串,并释放这块内存。所以返回的必须是用 malloc / strdup 新分配的内存,不能返回指向局部变量或常量字符串的指针,否则会崩溃。
Objective-C 回调 C#
方式一:UnitySendMessage,用法与 Android 相同:
UnitySendMessage("NativeCallback", "OnPurchaseResult", "{\"ok\":true}");方式二:函数指针
C# 把一个静态方法作为回调传给原生代码:
delegate void ResultCallback(int code, string message);
[DllImport("__Internal")] static extern void _Purchase(string productId, ResultCallback callback);
[AOT.MonoPInvokeCallback(typeof(ResultCallback))]static void OnPurchaseResult(int code, string message){ MainThread.Post(() => Shop.OnResult(code, message));}
_Purchase("gem_100", OnPurchaseResult);typedef void (*ResultCallback)(int code, const char* message);
extern "C" void _Purchase(const char* productId, ResultCallback callback) { NSString *pid = [NSString stringWithUTF8String:productId]; // 立即复制,参数的内存在调用后可能失效 // ……完成后: callback(0, "success");}- 回调方法必须是静态的,并且标记
MonoPInvokeCallback。IL2CPP 需要据此为它生成一个可以被原生代码调用的入口; - C# 传入的字符串参数在调用期间有效,原生代码需要保存时要立即复制;
- 同样要注意回调所在的线程。
四、平台条件编译
#if UNITY_ANDROID && !UNITY_EDITOR // 只在 Android 真机上编译#elif UNITY_IOS && !UNITY_EDITOR // 只在 iOS 真机上编译#else // 编辑器和其他平台:提供模拟实现#endif一定要加上 !UNITY_EDITOR:在编辑器中切换到 Android 平台时,UNITY_ANDROID 也为真,但编辑器中并没有 Java 环境,调用会报错。编辑器中应该提供一个模拟的实现,比如登录直接返回一个测试账号,方便开发调试。
五、SDK 封装的实践
- 统一的接口层:业务代码只调用自己定义的接口,比如
ILoginService.Login(),每个平台各有一个实现,编辑器中是模拟实现。更换 SDK 或者接入多个渠道时,业务代码不需要改动(见 外观模式)。 - 异步接口:原生调用的结果几乎都是异步返回的,封装成回调或
UniTask,统一处理超时和失败。 - 数据格式:复杂的数据在两边之间用 JSON 字符串传递,接口简单、不容易出错。
- Unity 生命周期:处理好应用切到后台、回到前台时 SDK 需要的回调(支付中途切出去再回来)。
- 构建配置:Android 的依赖库、权限、Gradle 配置,iOS 的系统框架、Info.plist 中的权限描述,可以在打包后处理的脚本中自动完成,避免每次手动修改(见 自动化打包)。
常见追问
Unity 怎么调用 Android 的 Java 代码? 用 AndroidJavaClass 调用静态方法,用 AndroidJavaObject 调用实例方法,底层通过 JNI 实现。频繁调用时缓存对象,用完 Dispose。
Java 怎么回调 C#? UnitySendMessage,按物体名和方法名传一个字符串;或者 C# 继承 AndroidJavaProxy 实现 Java 接口,Java 直接调用它的方法。
Unity 怎么调用 iOS 的代码?
在 Objective-C 中用 extern “C” 导出 C 函数,C# 中用 DllImport("__Internal") 声明后调用。
iOS 原生函数返回字符串要注意什么? 必须返回新分配的内存(如 strdup),C# 端转换后会释放它。
原生代码怎么回调 C# 的方法? UnitySendMessage;或者传入函数指针,C# 的回调方法必须是静态的并标记 MonoPInvokeCallback。
原生回调中能直接调用 Unity API 吗? 不一定。回调可能在其他线程上,应该把任务投递到主线程执行。
平台判断为什么要加 !UNITY_EDITOR? 编辑器切换到对应平台时宏也会生效,但编辑器中没有原生环境,需要提供模拟实现。
文章分享
如果这篇文章对你有帮助,欢迎分享给更多人!