iOS项目集成UnityFramework

背景：最近公司要做关于幼儿编程的项目，在iOS项目中需要使用视频交互的功能，最后选择的方案是使用Unity实现，主要涉及到iOS原生项目和Unity界面来回切换，iOS和Unity的相互通信。

1、iOS原生项目和Unity界面来回切换

1.1 从iOS原生项目通过点击按钮进入Unity

- (void)enterUnityButtonClick {
  [self initUnity];
}

- (void)initUnity
{
    if([self unityIsInitialized]) {
        showAlert(@"Unity already initialized", @"Unload Unity first");
        return;
    }
    if([self didQuit]) {
        showAlert(@"Unity cannot be initialized after quit", @"Use unload instead");
        return;
    }
    
    [self setUfw: UnityFrameworkLoad()];
    [[self ufw] setDataBundleId: "com.unity3d.framework"];
    [[self ufw] registerFrameworkListener: self];
    [[self ufw] runEmbeddedWithArgc: gArgc argv: gArgv appLaunchOpts: appLaunchOpts];
    // set quit handler to change default behavior of exit app
    [[self ufw] appController].quitHandler = ^(){ NSLog(@"AppController.quitHandler called"); };
  }

UnityFramework* UnityFrameworkLoad()
{
    NSString* bundlePath = nil;
    bundlePath = [[NSBundle mainBundle] bundlePath];
    bundlePath = [bundlePath stringByAppendingString: @"/Frameworks/UnityFramework.framework"];
    
    NSBundle* bundle = [NSBundle bundleWithPath: bundlePath];
    if ([bundle isLoaded] == false) [bundle load];
    
    UnityFramework* ufw = [bundle.principalClass getInstance];
    if (![ufw appController])
    {
        // unity is not initialized
        [ufw setExecuteHeader: &_mh_execute_header];
    }
    return ufw;
}
//其中 [self ufw] 是所在类的一个熟悉
@property (nonatomic, strong) UnityFramework *ufw;
[[self ufw] runEmbeddedWithArgc: gArgc argv: gArgv appLaunchOpts: appLaunchOpts];
//gArgc 、 gArgv 这两个参数是程序入口main函数中的参数，可以使用NSUserDefaults保存起来
//appLaunchOpts 是- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions 函数中的launchOptions参数

1.2 从Unity界面回到iOS界面

上面的函数正确调用后，从iOS界面跳转到Unity应该是没问题了，那怎么从Unity退出回到iOS原生界面呢？

我们首先从Unity项目中导出Unity-iPhone项目中的接口文件UnityFramework看一下，接口文件如下图

UnityFramework.png

很容易我们调用- (void)pause:(bool)pause函数.

然后再调用- (void)unloadApplication或者- (void)quitApplication:(int)exitCode

结果LuaClient:Destroy()，连同iOS的程序也Crash了，那一定是调用的方法不对，或者顺序不对？那到底问题出在哪了呢？

最终找到了一个iOS集成Unity项目的工程 https://github.com/Unity-Technologies/uaal-example ，最终才理清楚调用顺序。

正确的退出顺序：

1.2.1、遵守协议注册监听

1、首先是所在的控制器要遵守协议，监听Unity状态的变化

2、注册监听 [[self ufw] registerFrameworkListener: self];

1.2.2、点击退出按钮

- (void)quitUnityButtonClick {
    if ([self unityIsInitialized]) {
        [UnityFrameworkLoad() unloadApplication];
    }
}

#pragma mark -UnityFrameworkListener
- (void)unityDidUnload:(NSNotification*)notification
{
    NSLog(@"unityDidUnload called");
    
    [[self ufw] unregisterFrameworkListener: self];
    [self setUfw: nil];
    [self.window makeKeyAndVisible];
}

2、创建一个能与iOS交互的Unity项目

2.1、引用接口文件遇到的链接错误

由于Unity-iPhone项目是另一个部门提供的，提供的接口文件在iOS项目中能编译，但是链接时报错,如下图

UnityForiOSInteface.png

LinkerError.png

查阅了大量资料也没搞清楚原因，最后在 Unity的官方文档中看到iOS去调用Unity有两种方式

1、UnitySendMessage

2、delegates

由于我们的项目要在Unity启动前就把数据准备好，用于加载不同的内容，`UnitySendMessage`这种方式只适用于Unity已经启动好了，iOS向Unity通信，所以就要使用delegates的方式进行通信

为了调试项目，只能自己创建一个Unity项目区验证delegates这种方式是否行得通了，之前没有Unity项目基础就在腾讯课堂看到一个讲解的还不错的适合Unity入门的项目

2.2、创建一个Unity项目

https://ke.qq.com/course/3101943?taid=10573792874026231

3、iOS和Unity的相互调用：

UnityToiOS.png

iOS与Unity相互通信的文件放在Plugins/iOS/ 目录下

//UnityForiOSInterface.h 文件

#import 

typedef void (*ResultHandler) (const char * _Nonnull object);

//Unity退出时触发该通知
#define kQuitUnityNotification  @"kQuitUnityNotification"
//使用NSUserDefaults通过kCourseInfoKey保存课件信息
#define kCourseInfoKey          @"kCourseInfoKey"

NS_ASSUME_NONNULL_BEGIN

@interface UnityForiOSInterface : NSObject

#ifdef __cplusplus
extern "C" {
#endif
    
    void unitySendToiOSMessage(const char *msg); //打开Unity后，Unity回调课程的状态给iOS
    void getiOSParams(ResultHandler resultHandler); //Unity调用iOS，iOS通过函数指针参数赋值的方式向Unity赋值
    
#ifdef __cplusplus
}
#endif
@end

NS_ASSUME_NONNULL_END

//UnityForiOSInterface.m 文件
#import "UnityForiOSInterface.h"

@implementation UnityForiOSInterface

void unitySendToiOSMessage(const char *msg) {
    NSLog(@"msg:%@",[NSString stringWithUTF8String:msg]);
    [[NSNotificationCenter defaultCenter] postNotificationName:kQuitUnityNotification object:[NSString stringWithUTF8String:msg]];
}

void getiOSParams(ResultHandler resultHandler) {
    NSString *paramsStr = [[NSUserDefaults standardUserDefaults] objectForKey:kCourseInfoKey];
    resultHandler (paramsStr.UTF8String);
}
@end

这里写一个简单的Unity项目用于和iOS做交互，也可以参考腾讯课堂的Unity项目讲解，简单来说就是在场景上挂在一个脚本，通过点击场景的按钮由Unity向iOS发送消息

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.InteropServices;
using AOT;
using UnityEngine;
using UnityEngine.UI;

public class UnityCallObjc : MonoBehaviour
{
    public InputField input;  
    public Text text;

    [DllImport("__Internal")]
    static extern void UnitySendToiOSMessage(string msg);

    [DllImport("__Internal")]
    static extern void getiOSParams(IntPtr resultHandler);

    public void OnButtonClick()
    {
        //IOSLog(input.text);
        ResultHandler handler = new ResultHandler(resultHandler);
        IntPtr fp = Marshal.GetFunctionPointerForDelegate(handler);
        getiOSParams(fp);
    }

    //非托管方法
    [UnmanagedFunctionPointer(CallingConvention.Cdecl)]
    public delegate void ResultHandler(string resultString);

    [MonoPInvokeCallback(typeof(ResultHandler))]
    static void resultHandler(string resultStr)
    {
        Debug.LogFormat("result string = {0}", resultStr);
    }
}

Unity的主要语言是C#，因此可以利用C#的特性来访问C语言所定义的接口，然后再通过C接口再调用ObjC的代码，UnityCallObjc脚本为什么这么写，Unity3D与iOS的交互，讲得非常清楚了，具体可以看一下.

参考资料：

https://github.com/Unity-Technologies/uaal-example.git