Flutter集成Unity

Posted 2023-04-06 小尹编码中...

前言：

最近做项目时需要用到Flutter来做跨平台开发，但是项目中又用到了虚拟场景，这样一来就涉及到了Unity，那么总结下来便是用androidStudio来创建Flutter项目，将Unity项目嵌入到Flutter项目中，本篇文章就给大家分享一下Flutter集成Unity的详细过程，下一篇再给大家分享 Flutter与Unity之间的通信；

软件环境：

AndroidStudio创建Flutter项目   

Unity3D创建Unity项目

还需准备一个插件： Flutter-Unity widget

整合Flutter和Unity的关键组件：Flutter-Unity widget

Flutter在构建跨平台移动应用方面越来越受欢迎，Unity非常适用于构建增强现实（AR）和虚拟现实（VR）；

Flutter-Unity widget是整合Flutter与Unity的一个很关键的组件，它允许开发者在Flutter Widget内嵌入Unity应用；

Flutter-Unity widget插件的重要能力之一便是能够提供Flutter和Unity之间的双向通信；

一. Flutter项目

1. 准备一个Flutter项目

打开你的Android Studio，在AS中创建一个Flutter项目，取名为FlutterDemo，如下图所示：

 再点击Next，为Flutter项目取名，选择Flutter项目的存储位置，选择Android的开发语言，点击Finish便可以等待项目完成

 

2. 为Flutter项目添加ndk

3. 为Flutter项目添加依赖

4. Flutter项目中建立一个存放Unity项目的文件夹

点击New——> Directory，然后为文件夹取名

这个文件夹的作用时存放待会创建的Unity项目

到此为止，Flutter项目这边的工作告一段落了；然后，我们需要去创建一个Unity项目，创建Unity项目的存放路径就是Flutter项目刚刚建立的文件夹；

二. Unity项目

1. 准备一个Unity项目

注意一下Unity的存放路径不要搞错啊，Unity项目的名字可以随意的

2. 查看Unity的NDK

这个ndk就是上文Flutter项目中需要的ndk路径

3. 修改Unity的打包设置

切换平台，添加场景

 选择打包方式和打包设置

4. 将Flutter-Unity Widget插件包导入到Unity项目中

Flutter-Unity widget下载地址在文章前面提供了，大家可以去下载，小编这里就带大家使用第一个包吧

点击Import，等待Flutter-Unity Widget包导入即可 

选择升级过时API，等待修改完成即可

5. 修改Build脚本

打开刚刚导入的Package包中的Build脚本，并对其进行修改

在Build脚本中的DoBuildAndroid方法中进行修改

在Build脚本中的Buildios方法中修改代码 ，修改完成后，记得保存，Unity的脚本修改都不会自动保存的

6. 打包Export Android项目

点击Flutter后，再点击Export Android ，然后等待进度条加载完成即可，因为我们的Unity项目是建立在Flutter项目的一个文件夹中的，所以打包出来的unitylibrary会自动加载到Flutter项目中 ；

到此为止，Unity项目的配置就完成了

三. 将Unity项目嵌入Android项目

1. 检查刚刚Unity项目的Export Android是否成功了

2. 配置Android

将android / app / build.gradle中的minSdkVersion  ，tartgetSdkVersion 跟 android / unityLibrary / build.gradle的一致

comileSdkVersion改为33 ，这是因为Flutter-Unity Widget需要这么高的版本才能支持

3. gardle.properties 添加配置信息

4. AndroidManifest.xml中添加权限

 在android / app / src / main / AndroidManifest.xml中添加权限，如下图所示

5. 修改main.dart文件

接下来我们为Unity编写入口程序

直接给大家上代吧，把如下代码赋值到大家的main.dart文件中

import 'package:flutter/material.dart';
import 'package:flutter_unity_widget/flutter_unity_widget.dart';


void main() 
  runApp(MaterialApp(
      home: UnityDemoScreen()
  ));


class UnityDemoScreen extends StatefulWidget 

  UnityDemoScreen() : super();

  @override
  _UnityDemoScreenState createState() => _UnityDemoScreenState();


class _UnityDemoScreenState extends State<UnityDemoScreen>
  static final GlobalKey<ScaffoldState> _scaffoldKey =
  GlobalKey<ScaffoldState>();
  late UnityWidgetController _unityWidgetController;

  Widget build(BuildContext context) 

    return Scaffold(
      key: _scaffoldKey,
      body: SafeArea(
        bottom: false,
        child: WillPopScope(
          onWillPop: () async
            // Pop the category page if Android back button is pressed.
            return true;
          ,
          child: Container(
            color: Colors.blue,
            child: UnityWidget(
              onUnityCreated: onUnityCreated,
            ),
          ),
        ),
      ),
    );
  

  // Callback that connects the created controller to the unity controller
  void onUnityCreated(controller) 
    this._unityWidgetController = controller;
  

四. 效果演示

到此为止，Flutter集成Unity便已经完成了，接下来给大家看一下效果视频

Flutter集成Unity

要是有疑问大家可以加我微信详聊 yf1553653788，下一篇再给大家分享 Flutter与Unity之间的通信；

Unity集成华为游戏服务SDK方式：Unity集成Android插件

原理介绍

该集成思路是android studio集成sdk后改为library导出，作为插件给unity使用，unity通过gradle配置集成sdk。即通过android插件 实现sdk接口的调用，但是实际sdk集成在unity实现。

Unity端

首先，unity处理场景Scene，我这里创建布局如下：

创建c#脚本文件，并编写点击事件，以初始化为例，代码如下：

定义一个交互对象：

AndroidJavaObject androidSdkObject = null;

在Start中获取对象实例，其中“”中为安卓封装sdk的包名+类名，我这里实现sdk接口调用放在MainActivity中。

void Start()
    
        androidSdkObject = new AndroidJavaObject("com.example.lianyungame.library.MainActivity");

点击unity中init按钮，实现调用android 中的sdk初始化方法，需要在脚本文件添加如下方法，包含调用init接口方法和接收sdk初始化结果方法：

public void initial()
    
        //调用android接口
        Debug.Log("initial");
        androidSdkObject.Call("init");
    

脚本中处理初始化回调方法：

public void initSuccess()
    
        Debug.Log("initSuccess");
    

    public void initFailed(string str)
    
        Debug.Log("initFailed:" + str);

脚本文件方法处理完成后将该脚本文件拖到对应的ui上添加组件：

操作后可以看到脚本文件已挂载到画布Canvas上，如图：

到这里unity的代码交互处理完成。

Android端

接下来处理android代码：

Android Studio中新建工程并参考华为官方sdk集成文档集成游戏服务sdk，并处理与unity交互逻辑。因为android java类要继承UnityPlayerActivity类，所以还需要将unity目录下的Editor\\Data\\PlaybackEngines\\AndroidPlayer\\Variations\\il2cpp\\Development\\Classes\\classes.jar拷贝到android项目launcher/libs目录下，并添加对该jar包的依赖。

Android studio集成sdk参考文档：

​​https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/integrate-as-sdk-0000001050435953​​

以实现游戏初始化接口为例，在调用接口后把结果通过UnityPlayer.UnitySendMessage回调给unity。

public void init() 
    AccountAuthParams params = AccountAuthParams.DEFAULT_AUTH_REQUEST_PARAM_GAME;
    JosAppsClient appsClient = JosApps.getJosAppsClient(UnityPlayer.currentActivity);
    Task<Void> initTask;
    ResourceLoaderUtil.setmContext(UnityPlayer.currentActivity);
    initTask = appsClient.init(
            new AppParams(params, new AntiAddictionCallback() 
                @Override
                public void onExit() 
                    UnityPlayer.UnitySendMessage("Canvas", "exit", "");
                
            ));
    initTask.addOnSuccessListener(new OnSuccessListener<Void>() 
        @Override
        public void onSuccess(Void aVoid) 
            Toast.makeText(UnityPlayer.currentActivity, "init success", Toast.LENGTH_LONG).show();
            UnityPlayer.UnitySendMessage("Canvas", "initSuccess", "");
        
    ).addOnFailureListener(
            new OnFailureListener() 
                @Override
                public void onFailure(Exception e) 
                    Toast.makeText(UnityPlayer.currentActivity, "init failed", Toast.LENGTH_LONG).show();
                    if (e instanceof ApiException) 
                        ApiException apiException = (ApiException) e;
                        int statusCode = apiException.getStatusCode();
                        Toast.makeText(UnityPlayer.currentActivity, "init failed,statusCode is " + statusCode, Toast.LENGTH_LONG).show();
                        if (statusCode == JosStatusCodes.JOS_PRIVACY_PROTOCOL_REJECTED)  // 错误码为7401时表示用户未同意华为联运隐私协议
                            Log.i(TAG, "has reject the protocol");
                            // 此处您需禁止玩家进入游戏
                            UnityPlayer.UnitySendMessage("Canvas", "initFailed", "has reject the protocol");
                         else if (statusCode == GamesStatusCodes.GAME_STATE_NETWORK_ERROR)  // 错误码7002表示网络异常
                            Log.i(TAG, "Network error");
                            // 此处您可提示玩家检查网络，请不要重复调用init接口，否则断网情况下可能会造成手机高耗电。
                            UnityPlayer.UnitySendMessage("Canvas", "initFailed", "Network error");
                         else if (statusCode == 907135003) 
                            // 907135003表示玩家取消HMS Core升级或组件升级
                            Log.d(TAG, "init statusCode=" + statusCode);
                            init();
                         else 
                            // 在此处实现其他错误码的处理
                            UnityPlayer.UnitySendMessage("Canvas", "initFailed", "other error");
                        
                    
                
            );

可以自行编写Ui界面，编译测试接口没问题后将项目改为library导出，提取jar包。

1. 修改application为library

2. 去掉包名

3. 编译后找到编译文件，解压后把根目录下的classes.jar拷贝到unity的Assets>Plugins>Android>libs目录下

回到unity打包

Unity项目中添加sdk集成配置：

1、baseProjectTemplate.gradle 文件中添加AppGallery Connect plugin 以及 Maven repository，如下：

buildscript 
        repositories **ARTIFACTORYREPOSITORY**
            google()
            jcenter()
      maven  url https://developer.huawei.com/repo/ 
        

dependencies 
      classpath com.huawei.agconnect:agcp:1.4.2.300
        
repositories **ARTIFACTORYREPOSITORY**
            google()
          jcenter()
      maven  url https://developer.huawei.com/repo/ 
           flatDir 
                dirs "$project(:unityLibrary).projectDir/libs"
            
        

2、launcherTemplate.gradle和mainTemplate.gradle分别添加构建依赖。

dependencies 
    implementation project(:unityLibrary)
    implementation com.huawei.hms:game:6.1.0.301
    implementation com.huawei.hms:hwid:6.4.0.300
    implementation com.huawei.hms:iap:6.1.0.300
    

3、Json文件需要在manifest文件中配置appid，否则调用接口异常：

<meta-data   
     android:name="com.huawei.hms.client.appid"    
     android:value="appid=xxx">   
</meta-data>

然后检查包名与华为后台包名一致，签名编译运行并打包测试。

1、打开unity File>Build Settings...目录：

2、切换到Android平台，点击Play Settings…：

3、左边选中Player，打开Other Settings，勾选Override Default Package Name并重写包名，Minimun API Level选中19（sdk要求最低为19）。

4、选中Player，打开Publishing Settings，设置签名。

5、返回上一个页面，选中场景，点击Build打包即可。其他接口类似，可自行集成并调测。