在Unity3D的網絡遊戲中實現資源動態加載

用Unity3D製做基於web的網絡遊戲，不可避免的會用到一個技術-資源動態加載。好比想加載一個大場景的資源，不該該在遊戲的開始讓用戶長時間等待所有資源的加載完畢。應該優先加載用戶附近的場景資源，在遊戲的過程當中，不影響操做的狀況下，後臺加載剩餘的資源，直到全部加載完畢。 

本文包含一些代碼片斷講述實現這個技術的一種方法。本方法不必定是最好的，但願能拋磚引玉。代碼是C#寫的，用到了Json，還有C#的事件機制。 

在講述代碼以前，先想象這樣一個網絡遊戲的開發流程。首先美工製做場景資源的3D建模，遊戲設計人員把3D建模導進Unity3D，託託拽拽編輯場景，完成後把每一個gameobject導出成XXX.unity3d格式的資源文件（參看BuildPipeline），而且把整個場景的信息生成一個配置文件，xml或者Json格式（本文使用Json）。最後還要把資源文件和場景配置文件上傳到服務器，最好使用CMS管理。客戶端運行遊戲時，先讀取服務器的場景配置文件，再根據玩家的位置從服務器下載相應的資源文件並加載，而後開始遊戲，注意這裏並非下載全部的場景資源。在遊戲的過程當中，後臺繼續加載資源直到全部加載完畢。 

一個簡單的場景配置文件的例子： 
MyDemoSence.txt 

{
    "AssetList" : [{
        "Name" : "Chair 1",
        "Source" : "Prefabs/Chair001.unity3d",
        "Position" : [2,0,-5],
        "Rotation" : [0.0,60.0,0.0]
    },
    {
        "Name" : "Chair 2",
        "Source" : "Prefabs/Chair001.unity3d",
        "Position" : [1,0,-5],
        "Rotation" : [0.0,0.0,0.0]
    },
    {
        "Name" : "Vanity",
        "Source" : "Prefabs/vanity001.unity3d",
        "Position" : [0,0,-4],
        "Rotation" : [0.0,0.0,0.0]
    },
    {
        "Name" : "Writing Table",
        "Source" : "Prefabs/writingTable001.unity3d",
        "Position" : [0,0,-7],
        "Rotation" : [0.0,0.0,0.0],
        "AssetList" : [{
            "Name" : "Lamp",
            "Source" : "Prefabs/lamp001.unity3d",
            "Position" : [-0.5,0.7,-7],
            "Rotation" : [0.0,0.0,0.0]
        }]
    }]
}

AssetList：場景中資源的列表，每個資源都對應一個unity3D的gameobject 
Name：gameobject的名字，一個場景中不該該重名 
Source：資源的物理路徑及文件名 
Position：gameobject的座標 
Rotation：gameobject的旋轉角度 
你會注意到Writing Table裏面包含了Lamp，這兩個對象是父子的關係。配置文件應該是由程序生成的，手工也能夠修改。另外在遊戲上線後，客戶端接收到的配置文件應該是加密並壓縮過的。 

主程序： 

。。。
public class MainMonoBehavior : MonoBehaviour {

    public delegate void MainEventHandler(GameObject dispatcher);

    public event MainEventHandler StartEvent;
    public event MainEventHandler UpdateEvent;

    public void Start() {
        ResourceManager.getInstance().LoadSence("Scenes/MyDemoSence.txt");

        if(StartEvent != null){
            StartEvent(this.gameObject);
        }
    }

    public void Update() {
        if (UpdateEvent != null) {
            UpdateEvent(this.gameObject);
        }
    }
}
。。。
}

這裏面用到了C#的事件機制，你們能夠看看我之前翻譯過的國外一個牛人的文章。C# 事件和Unity3D 
在start方法裏調用ResourceManager，先加載配置文件。每一次調用update方法，MainMonoBehavior會把update事件分發給ResourceManager，由於ResourceManager註冊了MainMonoBehavior的update事件。 

ResourceManager.cs 

。。。
private MainMonoBehavior mainMonoBehavior;
private string mResourcePath;
private Scene mScene;
private Asset mSceneAsset;

private ResourceManager() {
    mainMonoBehavior = GameObject.Find("Main Camera").GetComponent<MainMonoBehavior>();
    mResourcePath = PathUtil.getResourcePath();
}

public void LoadSence(string fileName) {
    mSceneAsset = new Asset();
    mSceneAsset.Type = Asset.TYPE_JSON;
    mSceneAsset.Source = fileName;

    mainMonoBehavior.UpdateEvent += OnUpdate;
}
。。。

在LoadSence方法裏先建立一個Asset的對象，這個對象是對應於配置文件的，設置type是Json，source是傳進來的「Scenes/MyDemoSence.txt」。而後註冊MainMonoBehavior的update事件。 

public void OnUpdate(GameObject dispatcher) {
    if (mSceneAsset != null) {
        LoadAsset(mSceneAsset);
        if (!mSceneAsset.isLoadFinished) {
            return;
        }

        //clear mScene and mSceneAsset for next LoadSence call
        mScene = null;
        mSceneAsset = null;
    }

    mainMonoBehavior.UpdateEvent -= OnUpdate;
}

OnUpdate方法裏調用LoadAsset加載配置文件對象及全部資源對象。每一幀都要判斷是否加載結束，若是結束清空mScene和mSceneAsset對象爲下一次加載作準備，而且取消update事件的註冊。 

最核心的LoadAsset方法： 

private Asset LoadAsset(Asset asset) {

    string fullFileName = mResourcePath + "/" + asset.Source;

    //if www resource is new, set into www cache
    if (!wwwCacheMap.ContainsKey(fullFileName)) {
        if (asset.www == null) {
            asset.www = new WWW(fullFileName);
            return null;
        }

        if (!asset.www.isDone) {
            return null;
        }
        wwwCacheMap.Add(fullFileName, asset.www);
    }
。。。

傳進來的是要加載的資源對象，先獲得它的物理地址，mResourcePath是個全局變量保存資源服務器的網址，獲得fullFileName相似http://www.mydemogame.com/asset/Prefabs/xxx.unity3d。而後經過wwwCacheMap判斷資源是否已經加載完畢，若是加載完畢把加載好的www對象放到Map裏緩存起來。看看前面Json配置文件，Chair 1和Chair 2用到了同一個資源Chair001.unity3d，加載Chair 2的時候就不須要下載了。若是當前幀沒有加載完畢，返回null等到下一幀再作判斷。這就是WWW類的特色，剛開始用WWW下載資源的時候是不能立刻使用的，要等待諾幹幀下載完成之後纔可使用。能夠用yield返回www，這樣代碼簡單，可是C#要求調用yield的方法返回IEnumerator類型，這樣限制太多不靈活。 

繼續LoadAsset方法： 

。。。
    if (asset.Type == Asset.TYPE_JSON) { //Json
        if (mScene == null) {
            string jsonTxt = mSceneAsset.www.text;
            mScene = JsonMapper.ToObject<Scene>(jsonTxt);
        }

        //load scene
        foreach (Asset sceneAsset in mScene.AssetList) {
            if (sceneAsset.isLoadFinished) {
                continue;
            } else {
                LoadAsset(sceneAsset);
                if (!sceneAsset.isLoadFinished) {
                    return null;
                }
            }
        }
    }
。。。

代碼可以運行到這裏，說明資源都已經下載完畢了。如今開始加載處理資源了。第一次確定是先加載配置文件，由於是Json格式，用JsonMapper類把它轉換成C#對象，我用的是LitJson開源類庫。而後循環遞歸處理場景中的每個資源。若是沒有完成，返回null，等待下一幀處理。 

繼續LoadAsset方法： 

。。。
    else if (asset.Type == Asset.TYPE_GAMEOBJECT) { //Gameobject
        if (asset.gameObject == null) {
            wwwCacheMap[fullFileName].assetBundle.LoadAll();
            GameObject go = (GameObject)GameObject.Instantiate(wwwCacheMap[fullFileName].assetBundle.mainAsset);
            UpdateGameObject(go, asset);
            asset.gameObject = go;
        }

        if (asset.AssetList != null) {
            foreach (Asset assetChild in asset.AssetList) {
                if (assetChild.isLoadFinished) {
                    continue;
                } else {
                    Asset assetRet = LoadAsset(assetChild);
                    if (assetRet != null) {
                        assetRet.gameObject.transform.parent = asset.gameObject.transform;
                    } else {
                        return null;
                    }
                }
            }
        }
    }

    asset.isLoadFinished = true;
    return asset;
}

終於開始處理真正的資源了，從緩存中找到www對象，調用Instantiate方法實例化成Unity3D的gameobject。UpdateGameObject方法設置gameobject各個屬性，如位置和旋轉角度。而後又是一個循環遞歸爲了加載子對象，處理gameobject的父子關係。注意若是LoadAsset返回null，說明www沒有下載完畢，等到下一幀處理。最後設置加載完成標誌返回asset對象。 

UpdateGameObject方法： 

private void UpdateGameObject(GameObject go, Asset asset) {
    //name
    go.name = asset.Name;

    //position
    Vector3 vector3 = new Vector3((float)asset.Position[0], (float)asset.Position[1], (float)asset.Position[2]);
    go.transform.position = vector3;

    //rotation
    vector3 = new Vector3((float)asset.Rotation[0], (float)asset.Rotation[1], (float)asset.Rotation[2]);
    go.transform.eulerAngles = vector3;
}

這裏只設置了gameobject的3個屬性，眼力好的同窗必定會發現這些對象都是「死的」，由於少了腳本屬性，它們不會和玩家交互。設置腳本屬性要複雜的多，編譯好的腳本隨着主程序下載到本地，它們也應該經過配置文件加載，再經過C#的反射建立腳本對象，賦給相應的gameobject。 

最後是Scene和asset代碼： 

public class Scene {
    public List<Asset> AssetList {
        get;
        set;
    }
}

public class Asset {

    public const byte TYPE_JSON = 1;
    public const byte TYPE_GAMEOBJECT = 2;

    public Asset() {
        //default type is gameobject for json load
        Type = TYPE_GAMEOBJECT;
    }

    public byte Type {
        get;
        set;
    }

    public string Name {
        get;
        set;
    }

    public string Source {
        get;
        set;
    }

    public double[] Bounds {
        get;
        set;
    }

    public double[] Position {
        get;
        set;
    }

    public double[] Rotation {
        get;
        set;
    }

    public List<Asset> AssetList {
        get;
        set;
    }

    public bool isLoadFinished {
        get;
        set;
    }

    public WWW www {
        get;
        set;
    }

    public GameObject gameObject {
        get;
        set;
    }
}

代碼就講完了，在我實際測試中，會看到gameobject一個個加載並顯示在屏幕中，並不會影響到遊戲操做。代碼還須要進一步完善適合更多的資源類型，如動畫資源，文本，字體，圖片和聲音資源。 

動態加載資源除了網絡遊戲必需，對於大公司的遊戲開發也是必須的。它可讓遊戲策劃（負責場景設計），美工和程序3個角色獨立出來，極大提升開發效率。試想若是策劃改變了什麼NPC的位置，美工改變了某個動畫，或者改變了某個程序，你們都要從新倒入一遍資源是多麼低效和麻煩的一件事。