Unity 編譯 Android 的原理解析和 apk 打包分析

騰訊雲加社群發表於2017-04-10
Unity編譯AndroidAPK

騰訊雲技術社群-掘金主頁持續為大家呈現雲端計算技術文章，歡迎大家關注！

最近由於想在Scene的指令碼元件中，呼叫Android的Activity的相關介面，就需要弄明白Scene和Activity的實際對應關係，並對Unity呼叫Android的部分原理進行了研究。

本文主要探討Scene和Activity之間的關係，以及Unity打包apk和Android studio打包apk的差別在什麼地方？找到這種差別之後，可以怎麼運用起來？

本文需要用到的工具：

  • Android反編譯工具——apktool
  • Android studio自帶的反編譯功能

一、將Unity的Scene編譯成apk，apk的程式入口會是什麼？

  1. 新建一個Unity專案，建立一個Scene，將Unity工程編譯打包成apk。
  2. 對編譯出來的apk，利用apktool進行反編譯：apktool d unityTest.apk
  3. 得到的AndroidManifest檔案如下：
<?xml version="1.0" encoding="utf-8" standalone="no"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android" android:installLocation="preferExternal" package="com.xfiction.p1" platformBuildVersionCode="25" platformBuildVersionName="7.1.1">
    <supports-screens android:anyDensity="true" android:largeScreens="true" android:normalScreens="true" android:smallScreens="true" android:xlargeScreens="true"/>
    <application android:banner="@drawable/app_banner" android:debuggable="false" android:icon="@drawable/app_icon" android:isGame="true" android:label="@string/app_name" android:theme="@style/UnityThemeSelector">
        <activity android:configChanges="locale|fontScale|keyboard|keyboardHidden|mcc|mnc|navigation|orientation|screenLayout|screenSize|smallestScreenSize|touchscreen|uiMode" android:label="@string/app_name" android:launchMode="singleTask" android:name="com.unity3d.player.UnityPlayerActivity" android:screenOrientation="fullSensor">
            <intent-filter>
                <action android:name="android.intent.action.MAIN"/>
                <category android:name="android.intent.category.LAUNCHER"/>
                <category android:name="android.intent.category.LEANBACK_LAUNCHER"/>
            </intent-filter>
            <meta-data android:name="unityplayer.UnityActivity" android:value="true"/>
        </activity>
    </application>
    <uses-feature android:glEsVersion="0x00020000"/>
    <uses-feature android:name="android.hardware.touchscreen" android:required="false"/>
    <uses-feature android:name="android.hardware.touchscreen.multitouch" android:required="false"/>
    <uses-feature android:name="android.hardware.touchscreen.multitouch.distinct" android:required="false"/>
</manifest>複製程式碼

由該AndroidManifest檔案可知，系統仍然存在主Activity，名字為com.unity3d.player.UnityPlayerActivity。

言下之意，編譯只包含Scene的Unity工程，打包成Android apk，會以com.unity3d.player.UnityPlayerActivity作為主程式入口，那麼問題來了，Scene如何載入顯示到這個UnityPlayerActivity呢？

二、UnityPlayerActivity如何載入Unity中的Scene？

2.1 UnityPlayerActivity

這個就要從UnityPlayerActivity原始碼入手了，Android工程中使用UnityPlayerActivity需要依賴到Unity的Android外掛classes.jar（位於Unity安裝目錄，可以用everything軟體查詢查詢得到），對其進行反編譯得到UnityPlayerActivity的部分原始碼：

public class UnityPlayerActivity extends Activity {
    protected UnityPlayer mUnityPlayer;
    protected void onCreate(Bundle var1) {
        this.requestWindowFeature(1);
        super.onCreate(var1);
        this.getWindow().setFormat(2);
        this.mUnityPlayer = new UnityPlayer(this);
        this.setContentView(this.mUnityPlayer);
        this.mUnityPlayer.requestFocus();
    }
}複製程式碼

雖然經過混淆，看起來比較費勁，但從程式碼this.setContentView(this.mUnityPlayer)可以看出，最終的介面顯示需要依賴到UnityPlayer的例項。
另外由於Google也做了一套Unity VR的SDK，與UnityPlayerActivity相對應的類，就是GoogleUnityActivity，下面也對它進行分析。

2.2 從GoogleUnityActivity.java再入手分析

GoogleUnityActivity是google推出的VR SDK中，用於實現Unity Activity的類，通過google查詢其原始碼發現：
1. GoogleUnityActivity.java實際上的佈局檔案activity_main.xml

<?xml version="1.0" encoding="utf-8"?>
<FrameLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="match_parent" >

    <FrameLayout
        android:id="@+id/android_view_container"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:background="@android:color/transparent" />
</FrameLayout>複製程式碼

佈局檔案中沒有具體的內容，只包含一個FrameLayout佈局。

2.重點看GoogleUnityActivity的onCreate函式：

public class GoogleUnityActivity   extends Activity
    implements ActivityCompat.OnRequestPermissionsResultCallback {
  protected void onCreate(Bundle savedInstanceState) {

        requestWindowFeature(Window.FEATURE_NO_TITLE);

        super.onCreate(savedInstanceState);

        setContentView(R.layout.activity_main);
setContentView(R.id.activity_main.xml)
        mUnityPlayer = new UnityPlayer(this);
        if (mUnityPlayer.getSettings().getBoolean("hide_status_bar", true)) {
            getWindow().setFlags(WindowManager.LayoutParams.FLAG_FULLSCREEN,
                    WindowManager.LayoutParams.FLAG_FULLSCREEN);
        }

        ((ViewGroup) findViewById(android.R.id.content)).addView(mUnityPlayer.getView(), 0);
        mUnityPlayer.requestFocus();

  }
}複製程式碼

mUnityPlayer作為FrameLayoutView加入到view集合中進行顯示，注意這裡查詢的id是android.R.id.content。根據官方對這個id的解釋：
android.R.id.content gives you the root element of a view, without having to know its actual name/type/ID. Check out Get root view from current activity

由此可見，GoogleUnityActivity的實現原理，是建立一個只包含FrameLayout的空的幀佈局，隨後通過addView將UnityPlayer中的View載入到GoogleUnityActivity中進行顯示。

看起來跟UnityPlayerActivity有異曲同工之妙，兩者牽涉的類都是UnityPlayer。

2.3.UnityPlayer究竟是一個什麼類呢？

對classes.jar包進行反編譯得到UnityPlayer的部分程式碼：

public class UnityPlayer extends FrameLayout implements com.unity3d.player.a.a {
    public static Activity currentActivity = null;
    public UnityPlayer(ContextWrapper var1) {
        super(var1);
        if(var1 instanceof Activity) {
            currentActivity = (Activity)var1;
        }
    }
    public View getView() {
           return this;
    }
    public static native void UnitySendMessage(String var0, String var1, String var2);
    private final native boolean nativeRender();

    public void onCameraFrame(final com.unity3d.player.a var1, final byte[] var2) {
        final int var3 = var1.a();
        final Size var4 = var1.b();
        this.a(new UnityPlayer.c((byte)0) {
            public final void a() {
            UnityPlayer.this.nativeVideoFrameCallback(var3, var2, var4.width, var4.height);
                var1.a(var2);
            }
        });
    }
}複製程式碼

從程式碼中可以發現：

  1. UnityPlayer實際上是繼承於FrameLayout；
  2. 並且自帶一個currentActivity的成員變數，在建構函式中，直接傳入Activity的相關引數；
  3. 在getView函式中直接返回該FrameLayout；
  4. GoogleUnityActivity通過UnityPlayer的建構函式，將其context傳遞給UnityPlayer，並賦值給其成員變數currentActivity。

由於UnityPlayer類做了混淆，關於渲染的核心功能也封裝在native程式碼中，關於Scene轉換到到UnityPlayer作為FrameLayout，只能做一個簡單的推測：通過呼叫Android的GL渲染引擎，在native層進行渲染，並同步到FrameLayout在UnityPlayerActivity上進行顯示。

三、 如何將Scene顯示在自定義的Activity當中

從以上研究的內容可知，假如要從要實現將Scene顯示在固定的Activity當中，則需要對Activity的oncreate部分的countview和unityplayer進行處理。最簡單的方法是寫一個直接繼承於UnityPlayerActivity或GoogleUnityActivity的類，並在類中寫所需要的Unity呼叫Android的方法。
這樣Scene就會載入在特定的Activity當中，Unity c#通過獲取currentActivity變數就可以獲取到該Activity，並呼叫其中的函式。

四、 Unity Android 外掛需要注意的問題

  1. Android studio工程包含多個module的依賴，則需要將對應的module編譯的外掛一起拷貝Plugins/Android/lib目錄當中。
  2. 在第一步驟下，可以直接刪除打包後的aar library目錄，尤其裡面假如帶有unity的Android外掛classesjar，否則會編譯報錯。
  3. 多個module編譯的時候，注意manifest lablel相關設定，另外就是build.gradle的minSDKVersion資訊。否則會出現manifest merger失敗的錯誤。
  4. 關於Unity的Android Manifest檔案合併：
    Unity編寫一個Scene，Android studio寫一個包含主Activity的aar包，放在Plugins/Android目錄當中。用Unity編譯apk出來之後，反編譯他的AndroidManifest檔案,兩個主Activity，預設顯示包含Scene的Activity。
    解決方法：Unity的Manifest檔案合併，把一個manifest放到Plugins/Android目錄下，就不會合並manifest了。

五、Unity打包Android apk的結構探究

由於Unity開發Android時，常常設計到Unity + Visual和Android studio的環境切換，Unity的開發往往會更快一些，更多的是Android java側的程式碼編寫和除錯。

這種情況時，有沒有一種方法，能夠將Unity編譯好的Unity Scene和c#相關檔案，放到Android studio中進行打包，從而實現直接在Android studio中進行除錯？

方法原理倒是很簡單，通過對比Unity打包的apk，與普通的Android apk的檔案差別，找出Unity檔案存放的目錄，隨後對應存放到Android studio工程目錄中，最後通過Android studio完成對Unity相關檔案的打包。

首先將apk新增zip的字尾，方便用beyond compare進行對比：

  1. 發現只是多了assert/bin目錄，在這個目錄之下，可以看到unity相關dll庫
  2. 將該檔案，拷貝到Android studio工程的src/main/assert目錄之下；
  3. 在Android studio除錯時，可以將aar library工程設定為app工程，這樣就可以編譯apk執行到手機了。
  4. 用Android studio對該工程進行編譯，發現assert/bin目錄成功被打包進去。
  5. 直接apk install 執行，可以看到跟Unity編譯打包的apk，是相同的效果。

相反，假如Android工程除錯好之後，則直接編譯成app模式修改成library模式，進行build之後，就會生成aar庫，此時將aar庫拷貝到Plugins/Android/lib目錄當中，注意要刪除aar庫中的assert/bin，因為這個目錄是我們先前從Unity拷貝過去的，假如不刪除，在unity裡面會出現重複打包導致的檔案衝突的情況。

由於當將Unity打包之後的bin目錄拷貝到Android studio工程之後，Android studio此時是一個library工程，需要轉換為app工程。
關於這其中涉及到的Android studio library和app的轉換，通過設定build.gradle檔案來實現：

  • app模式：apply plugin: 'com.android.application'
  • library模式：apply plugin: 'com.android.library'

不過在設定這兩種模式時，需要注意applicationId "com.example.yin.myapplication"的設定，假如是library模式，則需要直接註釋掉。

假如Android的java部分重新除錯好之後，重新將app模式改成library模式，進行build，將生成的aar包，拷貝到Unity Android Plugin目錄中，就可以直接在Unity看執行效果了。
不過一定要記得刪除Android studio打包的aar檔案裡面的assert/bin目錄，以防止在Unity中重複打包。

四、結論：

  1. Unity中的Scene在Android中，其實對應於Activity的FrameLayout，每個Scene的執行都有其Activity環境，通過currentActivity變數可以獲取得到。
  2. 要實現自定義的Activity能夠具備直接載入Scene的功能，則需要其繼承於UnityPlayerActivity或者GoogleUnityActivity，再或者，直接自定義實現UnityActivity類。
  3. 提升Unity+Android Plugin專案開發效率的方法：
    ● 直接將Unity打包的apk中的assert/bin目錄拷貝到Android studio工程的src/main/assert目錄當中，並且將Android工程配置成app模式，就可以直接在Android studio上面，對整個Unity+android plugin的工程進行除錯。
    ● Android studio部分除錯好之後，需要修改build.gradle檔案，重新將app模式修改為library模式，編譯出aar包檔案，刪除原來拷貝過來的unity部分，放入到unity的Plugins/Android/lib目錄下進行使用即可。

最後套句名言：log打得好，bug解得早

相關閱讀
深度瞭解Android 7.0 ，你準備好了嗎？
【騰訊雲的1001種玩法】安卓加固在騰訊雲上的使用(附反編譯結果)

此文已由作者授權騰訊雲技術社群釋出，轉載請註明文章出處；獲取更多雲端計算技術乾貨，可請前往騰訊雲技術社群

相關文章