CocosCreator之AssetBundle使用方案分享

前言

Creator2.4 推出了AssetBundle，使得所有平台都有了分包的能力。那么該如何使用這個強大的功能呢？下面介紹一下我個人的用法，僅供參考，水平有限，非喜勿噴。
根據官方文檔 指出，之前的cc.loader 需要用cc.resource替換

而cc.resource 本身就是一個Bundle

也就是說，2.4之前，整個引擎只有一個cc.loader 管理資源，2.4之后采用了多個Bundle來管理資源，只是cc.resource這個Bundle負責管理resource目錄下的動態資源，已經是引擎規定好的了。而自定義的Bundle其實是與cc.resource平級的。那么只要我們給資源管理器傳入不同的Bunlde，自然就是加載不同Bundle中的內容了。

概念

在介紹我的用法之前，先說明以下幾個概念

1. 分包 AssetBundle
   一個Bundle 就是一個分包，cc.resource 就是引擎默認的Bundle。
2. 模塊 Module
   將游戲按照功能划分為不同的模塊。可以多個模塊共用一個分包。也可以一個模塊使用一個分包。不使用分包的模塊默認使用cc.resource。這個模塊類跟游戲中你定義的系統，例如，設置，大廳，戰斗，背包等等並不是非要一一對應的，並不是有多少個系統就需要創建多少個Module.這個根據你的需求而定。但是我的資源清理都是根據不同的Module來做的，划分的越多，清理就越細致。

import ResLoader from "../../cfw/res/ResLoader";
import AudioManager from "../../cfw/audio/AudioManager";
import ResHelper from "../../engine/ResHelper";
import { isNull } from "../../cfw/tools/Define";
export default class Module {
    private loader: ResLoader;
    protected audio: AudioManager;
    protected moduleName: string = ''
    protected projectName: string = ''
    constructor(projectName: string, moduleName: string) {
        this.projectName = projectName;
        this.moduleName = moduleName;
        //有名稱的模塊，需要在適當的時候加載bundle 並設置。
        if (!this.moduleName) {//name != '' 的 說明是自定義的bundle。
            this.setLoader(new ResLoader(new ResHelper(cc.resources)))
        }

    }
    setAudio() {
        if (this.loader) {
            this.audio = new AudioManager(this.projectName, this.loader)
        }
    }
    hasLoader() {
        return !isNull(this.loader)
    }
    setLoader(loader: ResLoader) {
        this.loader = loader
    }
    setLoaderByBundle(bundle: cc.AssetManager.Bundle) {
        this.setLoader(new ResLoader(new ResHelper(bundle, this.moduleName)))
    }
    getName() {
        return this.moduleName;
    }
    getLoader() {
        return this.loader;
    }
    getAudio() {
        return this.audio;
    }
}

3. 模塊管理器 ModuleManager
   負責初始化模塊，獲得和設置模塊。設置模塊ID對應的Bundle名稱，不使用分包的模塊名稱設置為空字符串。

import Module from "./Module";
import XlsxDataManager from "../../cfw/xlsx/XlsxDataManager";
import { ResType } from "../../cfw/res/ResInterface";
import ResItem from "../../cfw/res/ResItem";


//模塊id
export enum ModuleID {
    PUBLIC,
    LOGIN,
    BATTLE,
    LOBBY,
    MAX
}

//有分包的模塊就有bundle的名字，沒有就是使用cc.resource 
let moduleName: string[] = ['', '', 'battle', '']

export default class ModuleManager {


    private static mgrMap: Module[] = []

    private static moduleID: ModuleID = ModuleID.PUBLIC;


    static dataManager: XlsxDataManager;

    static init(projectName: string) {
        for (let index = 0; index < moduleName.length; index++) {
            this.mgrMap[index] = new Module(projectName, moduleName[index]);
        }
        this.mgrMap[ModuleID.PUBLIC].setAudio()
        this.dataManager = new XlsxDataManager()
    }

    static getAudio(id: ModuleID = this.moduleID) {
        return this.mgrMap[id].getAudio()
    }

    static publicAudio() {
        return this.mgrMap[ModuleID.PUBLIC].getAudio()
    }

    static publicLoader() {
        return this.mgrMap[ModuleID.PUBLIC].getLoader()
    }


    static loadRes(url: string, type: ResType, callback: (err: string, res: ResItem) => void) {
        this.getLoader().loadRes(url, type, callback)
    }

    static getName(id: ModuleID = this.moduleID) {
        return this.mgrMap[id].getName()
    }

    static setLoaderByBundle(id: ModuleID = this.moduleID, bundle: cc.AssetManager.Bundle) {
        this.mgrMap[id].setLoaderByBundle(bundle)
    }

    static setModuleID(id: ModuleID) {
        this.moduleID = id;
    }

    static getLoader(id: ModuleID = this.moduleID) {
        return this.mgrMap[id].getLoader()
    }

    static hasLoader(id: ModuleID = this.moduleID) {
        return this.mgrMap[id].hasLoader()
    }


    /**
     * 為某個模塊設置bundle
     * @param moduleID 
     * @param callback 
     */
    static loadBundle(moduleID: ModuleID, callback: Function) {
        this.publicLoader().loadRes(ModuleManager.getName(moduleID),
         ResType.AssetBundle, (err, item: ResItem) => {
            if (err) {
                return;
            }
            ModuleManager.setLoaderByBundle(moduleID, item.getRes())
            callback();
        })
    }

}

4. 資源管理器 ResLoader
   負責加載資源
   

5. 資源項： ResItem 負責管理資源的引用計數
   

6. ResHelper
   為了跨引擎使用ResLoader,我自定義了ResType枚舉、ResInterface 接口和這個Creator加載輔助類ResHelper，如果不涉及到跨引擎的話，可以去掉這幾個東西，然后直接把AssetBundle傳到ResLoader中使用。
   

使用

1. 將一個模塊的資源放入一個目錄中，將這個目錄設置為Bundle
   
2. 在ModuleManger中設置bundle的名字
   
3. 點擊進入時或者在loading的時候設置對應模塊的Bundle
   
4. 進入模塊之前設置為此模塊對應的模塊ID,那么此時獲得的ResLoader 自然就是battle模塊的ResLoader了,並且ResLoader使用的Bundle 是名稱為 battle 的Bunlde。
   
5. 清理資源，這里需要指定模塊ID。由於引擎做了資源引用計數的事情，所以我們不用再去管理依賴關系，省了很多事情。
   

注意事項

1. 如果是resource中的資源作為bundle之后，需要從resource中拿到外邊。
   

2. 發布小游戲時壓縮類型設置為小游戲子包，官方文檔已說明
   

資源管理的一些問題

看到論壇對於2.4的引用計數問題討論的非常激烈。
https://forum.cocos.org/t/2-4-0/95076/32
我做的資源管理器有如下規則

1. 所有資源必須通過資源項ResItem的getRes接口獲得，保證使用一次計數增加一次，不參與引擎提供的計數管理。由於引擎自己管理的依賴關系，所以2.4之后不再需要維護資源的依賴關系。只維護好自己的使用次數就好。
   
   

2. ResLoader 提供刪除某個資源的功能，應對ui清理需求。如果刪除整個模塊，調用release 接口即可。
   

3. ResLoader 支持直接緩存一個掛載到場景中的資源，比如初始場景會直接掛載一個預制體，避免黑屏。如果不想清理場景只想清理這個預制體就可以這樣使用。
   
   
   

4. 實際應用可能復雜的多，每個人的用法不同，不保證沒有問題。

結語

1. 以上各種方案僅是我個人的使用方式，並非最佳方案，可能會有bug，僅供大家參考，誰有更好的方式，也分享出來，互相學習。

2. demo 在我的框架項目中，已經更新到2.4。由於之前忽略文件的原因，請使用空文件夾重新clone。

歡迎掃碼關注公眾號《微笑游戲》，瀏覽更多內容。

歡迎掃碼關注公眾號《微笑游戲》，瀏覽更多內容。