Android/iOS內嵌Unity開發示例
阿新 • • 發佈:2020-07-09
Unity 與 Android/iOS 交叉開發主要有兩種方式,以 Android 為例,一是 Android 生成 jar 或者 aar 包,匯入到 unity3d plugin/bin/ 目錄下;**二是 Unity 匯出 Android 工程,在 Android Studio 中作為庫繼續開發**。網上的教程幾乎全是第一種方式,而本文主要分析第二種方式。
這種方式可以在移動端的 NativeApp 中以,庫的形式整合已經寫好的 Unity 工程,利用 Unity 遊戲引擎便捷的開發手段進行跨平臺開發。
Unity官方文件 [Unity as a Library integration example to iOS and Android](https://github.com/Unity-Technologies/uaal-example)
以下以安卓平臺作為示例。
## 環境
- Android Studio `3.5.3`
- Unity version `2019.3.7f1`
## 新建工程
- Android Studio 新建專案:
![](https://img2020.cnblogs.com/blog/1536438/202005/1536438-20200511193628285-297005542.png)
- Unity 新建專案:![](https://img2020.cnblogs.com/blog/1536438/202005/1536438-20200511193939816-1606248075.png)
- 最終工程結構如下:
![](https://img2020.cnblogs.com/blog/1536438/202005/1536438-20200511193911156-612425801.png)
## Unity匯出
- 通過 Unity 開啟 UnityProject
- 選擇 `File -> Build Settings -> Switch Android Platform -> Export Project`
![](https://img2020.cnblogs.com/blog/1536438/202007/1536438-20200709111006361-1090391301.png)
- 這時候選擇Export可能會提示JDK路徑配置出錯,沒關係我們到 `Preference -> Externl Tools` 設定路徑
![](https://img2020.cnblogs.com/blog/1536438/202007/1536438-20200709110902738-1889266000.png)
- 現在就可以點選 Export 了,路徑選擇可以自由選擇,這裡建議按照官方來
![](https://img2020.cnblogs.com/blog/1536438/202005/1536438-20200511200219564-1834859668.png)
## Android接入
- 通過 Android Studio 開啟 NativeAndroidApp
- 選擇 **setting.gradle** 檔案新增 unityLibrary module
```C++
include ':unityLibrary'
project(':unityLibrary').projectDir = new File('..\\UnityProject\\androidBuild\\unityLibrary')
```
- 選擇 **build.gradle**(Module:app)新增 dependencies
```C++
dependencies {
implementation project(':unityLibrary')
implementation fileTree(dir: project(':unityLibrary').getProjectDir().toString() + ('\\libs'), include: ['*.jar'])
// 自己專案的配置
}
```
- 選擇 **build.gradle**(Module:NativeAndroidApp)
```C++
allprojects {
repositories {
google()
jcenter()
// Add Code
flatDir {
dirs "${project(':unityLibrary').projectDir}/libs"
}
// End
}
}
```
- 選擇 NativeAndroidApp 的 **strings.xml** 新增
```C++
NativeAndroidApp
Settings
// Add Code
Game view
// End
```
- 點選 AS 的 sync project,可以看到已經多了一個 module:
![](https://img2020.cnblogs.com/blog/1536438/202007/1536438-20200709110558037-1047107989.png)
現在我們可以直接使用這個 module 裡的 java class 了。
## 如何使用
### 作為Activity
現在我們的工程包含了兩個 module ,一個是新建工程自帶的 app,一個是剛才匯入的 unityLibrary。點開 unityLibrary 的目錄可以看到兩個主要的 class :
![](https://img2020.cnblogs.com/blog/1536438/202007/1536438-20200709112436152-950991399.png)
其中 UnityPlayerActivity 是最重要的 class ,我們可以通過這個類在安卓 app 中顯示 Unity 的場景。至於怎麼使用—— OverrideUnityActivity 則是對 UnityPlayerActivity 用法的一個官方示例,裡面的程式碼也很簡單
```java
import com.unity3d.player.UnityPlayerActivity;
public abstract class OverrideUnityActivity extends UnityPlayerActivity
{
public static OverrideUnityActivity instance = null;
abstract protected void showMainActivity(String setToColor);
@Override
protected void onCreate(Bundle savedInstanceState)
{
super.onCreate(savedInstanceState);
instance = this;
}
@Override
protected void onDestroy() {
super.onDestroy();
instance = null;
}
}
```
顯然官方是希望我們在安卓內用一個 Activity 去顯示 Unity 渲染的場景,至於這個 Activity ,直接繼承 UnityPlayerActivity 就基本完事了,非常簡單。
那麼我們新建一個 Activity,這裡我起名為 MainUnityActivity:
```java
public class MainUnityActivity extends UnityPlayerActivity {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
}
}
```
你大可什麼都不寫,只要繼承 UnityPlayerActivity 就行了。現在構建 app,進入 MainUnityActivity 的時候就會顯示 Unity 的場景了。
![](https://img2020.cnblogs.com/blog/1536438/202007/1536438-20200709114955916-1055660417.png)
### 作為subView
當然你可能需要將 Unity 的場景作為子檢視顯示,而不是讓 Unity 佔據你的整個螢幕,這套簡單方法就不適合了,不過仍然有解決方案,參考 [Display Unity Scene as Sub View in android studio](https://stackoverflow.com/questions/43918417/display-unity-scene-as-sub-view-in-android-studio) 。
我們先來觀察 UnityPlayerActivity 裡面到底寫了什麼:
```java
public class UnityPlayerActivity extends Activity implements IUnityPlayerLifecycleEvents
{
protected UnityPlayer mUnityPlayer; // don't change the name of this variable; referenced from native code
// Override this in your custom UnityPlayerActivity to tweak the command line arguments passed to the Unity Android Player
// The command line arguments are passed as a string, separated by spaces
// UnityPlayerActivity calls this from 'onCreate'
// Supported: -force-gles20, -force-gles30, -force-gles31, -force-gles31aep, -force-gles32, -force-gles, -force-vulkan
// See https://docs.unity3d.com/Manual/CommandLineArguments.html
// @param cmdLine the current command line arguments, may be null
// @return the modified command line string or null
protected String updateUnityCommandLineArguments(String cmdLine)
{
return cmdLine;
}
// Setup activity layout
@Override protected void onCreate(Bundle savedInstanceState)
{
requestWindowFeature(Window.FEATURE_NO_TITLE);
super.onCreate(savedInstanceState);
String cmdLine = updateUnityCommandLineArguments(getIntent().getStringExtra("unity"));
getIntent().putExtra("unity", cmdLine);
mUnityPlayer = new UnityPlayer(this, this);
setContentView(mUnityPlayer);
mUnityPlayer.requestFocus();
}
......
}
```
其實關鍵就在於這幾行
```java
protected UnityPlayer mUnityPlayer;
......
mUnityPlayer = new UnityPlayer(this, this);
setContentView(mUnityPlayer);//←
```
我們只要照貓畫虎的把 UnityPlayer 寫進一個 FrameLayout 裡就行了:
```java
private UnityPlayer mUnityPlayer;
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
// Create the UnityPlayer
mUnityPlayer = new UnityPlayer(this);
setContentView(R.layout.activity_sub);
FrameLayout layout = (FrameLayout) findViewById(R.id.FrameLayout);
LayoutParams layoutParams = new LayoutParams(LayoutParams.MATCH_PARENT, LayoutParams.MATCH_PARENT);
layout.addView(mUnityPlayer.getView(), 0, layoutParams);
}
```
這樣下來 UnityActivity 就能顯示在一個 FrameLayot 裡了。
## 簡單通訊
互調函式的通訊方法和安卓打包進 Unity 工程是一樣的。
### Android呼叫Unity
```java
//向unity發訊息
UnityPlayer.UnitySendMessage("Main Camera", //gameobject的名字
"ChangeColor", //呼叫方法的名字
""); //引數智慧傳字串,沒有引數則傳空字串
```
### Unity呼叫Android
```c#
//通過該API來例項化java程式碼中對應的類
AndroidJavaObject jc = new AndroidJavaObject("com.xxx.xxx.UnityPlayer");
jo.Call("Test");//呼叫void Test()方法
jo.Call("Text1", msg);//呼叫string Test1(string str)方法
jo.Call("Text2", 1, 2);//呼叫int Test1(int x, int y)方法
```
## 進階用法
舉個例子,Unity中有很多內建外掛可以自動操控攝像頭,編譯到移動平臺時,使用這些外掛可以滿足大部分場景,不需要額外程式設計,直接在 Unity 做好後打包就可以了。但是當你需要以下應用場景:
- 檢測攝像頭視訊資料中的人臉
- 自定義美顏(CPU美顏演算法)
的時候,使用Unity內建或擴充套件外掛就難以完成這個任務了。這時候,就需要 Unity 和移動平臺交叉開發,比如以下這套流程
> Android/iOS native app 操作攝像頭 -> 獲取視訊流資料 -> 人臉檢測或美顏 -> 傳輸給 Unity 渲染 -> Unity做出更多的效果(濾鏡/粒子)
但是由於 UnitySendMessage 只能把字串傳入 Unity,用這個API傳入視訊流到 Unity 是不可能的,效率太差。比較好的解決方案就是 Render to texture。
之後會發一篇安卓和 Unity 執行緒共享 eglcontext 的部落格,視訊流資料傳輸就會用到 Render to texture 的方法,先佔個坑位。
## 參考資料:
- [AAR plug-ins and Android Libraries](https://docs.unity3d.com/Manual/AndroidAARPlugins.html)
- [JAR plug-ins](https://docs.unity3d.com/Manual/AndroidJARPlugins.html)
- [Extending the UnityPlayerActivity Code](https://docs.unity3d.com/Manual/AndroidUnityPlayerActivity.html)
- [Native (C++) plug-ins](https://docs.unity3d.com/Manual/AndroidNativePlugins.html)
- [Using Java and Kotlin source files as plug-ins](https://docs.unity3d.com/Manual/AndroidJavaSourcePlugin)
- [Unity as a Library](https://docs.unity3d.com/2019.3/Documentation/Manual/UnityasaLibrary.html?_ga=2.1265265.1523025253.1584945162-961748705.1582291110)
- [Unity into Android API](https://docs.unity3d.com/2019.3/Documentation/Manual/UnityasaLibrary-Android.html)
- [Unity into Android Step Details](https://forum.unity.com/threads/integration-unity-as-a-library-in-native-android-app.685240/)
- [Display Unity Scene as Sub View in android studio](https://stackoverflow.com/questions/43918417/display-unity-scene-as-sub-view-in-android