LayaDCC 2.0工具

Version >= LayaAir 3.2

LayaDCC 2.0（Laya-Dynamic Content Check）是为LayaNative提供的资源热更新方案，是LayaDCC的升级版，主要特点：

DCC2.0是完全重构的，与1.0完全不同了。

1、更新文件的时候不再使用原始目录，文件名字变成了文件内容的hash，确保不会被CDN缓存。

2、支持App打包资源。

3、支持通过zip提供差异更新。

4、支持清理缓存。

5、保证版本一致性，客户端只会使用一个版本，不会出现不同版本资源混用的情况。

6、通过扩展可以支持网页、小游戏等其他平台。

一、概念

1.1 DCC服务器

DCC服务器是一个静态文件服务器，保存了所有的DCC对象。DCC客户端在需要获得某个对象的时候，就是到这里下载相应的文件。

在使用DCC的情况下，游戏资源都是通过DCC服务器获得的，原始的游戏资源服务器很少被访问（只有不在DCC目录树下的资源才会到原始资源服务器下载）。

1.2 DCC根文件

DCC根文件又称为DCC头文件，指定了某一版的资源树，从这里可以遍历所有的这一版的资源。

在LayaAir中，使用IDE发布后的dcc目录下就有一个head.json，就是一个根文件。

1.3 映射地址

当LayaNative发起一个下载请求的时候，会被DCC拦截，DCC根据设置的映射地址过滤这个地址，如果符合映射地址，则会走DCC流程。

例如，设置的映射地址是dcc.pathMapToDCC='http://layabox.com/game', 当请求http://layabox.com/game/res/skin1.png的时候，就会走DCC流程，在DCC内部会先转成相对地址res/skin1.png，然后查找到这个相对地址对应的对象id，下载指定id的对象。

如果请求下载的地址不符合映射地址，则会直接下载原始地址的内容。

二、界面

LayaDCC在构建项目阶段工作。在构建Windows（如图2-1），iOS（如图2-2），Android（如图2-3）项目的时候，会有DCC相关选项。在勾选使用DCC后可以设置根文件的加载地址和DCC服务器的地址；勾选更新DCC后可设置版本和版本描述。

（图2-1）

（图2-2）

（图2-3）

下面是各参数的介绍：

2.1 打包资源

是否把为当前平台导出的资源（resource目录）打包到native项目中。打包的资源会放到特定的目录中，以供后续生成不同平台的App。

如果希望提供单机版，则必须选择打包资源。如果是联网包，勾选打包资源会是包体较大，但是可以减少网络下载，加快资源载入速度。

打包资源的本质是生成一个完整的DCC目录，放到项目的特定目录下。

如果发布的是原生包（VS、XCode、Android Studio项目），不同发布平台对应的路径如下：

windows: release\windows\windows_project\resource\cache\dcc2.0\

android: release\android\android_project\app\src\main\assets\cache\dcc2.0\

ios: release\ios\ios_project\resource\cache\dcc2.0\

2.2 混淆资源

如果勾选，在打包资源的时候，会随机混淆资源，主要作用是避免在上架的时候被平台扫描到某些敏感函数。

2.3 资源服务器URL

此设置决定native启动时访问的入口脚本。所以，在填写地址时，需要把入口脚本文件也写在地址内。

例如：http://192.168.31.109:9000/index.js

2.4 热更新(DCC)

2.4.1 使用DCC

根文件：设置DCC系统的根文件地址, 根文件维护一个完整的目录树，决定了一个版本的具体内容。

例如：http://192.168.31.109:8000/head.json

DCC服务器：设置DCC服务器的地址。如果为空，则使用根文件所在的地址为DCC服务器地址。

例如：http://192.168.31.109:8000/

2.4.2 更新DCC

勾选后，在构建的时候同时生成DCC资源，生成的DCC资源可以放到DCC服务器上，提供热更新内容。

这个目录在release/平台/dcc目录下，结构如图2-4所示，

（图2-4）

然后可以配置以下参数：

版本：生成DCC资源的版本号，这个会影响生成的DCC根文件。例如，设置为1.0.1，则DCC的输出目录会生成一个“version.1.0.1.json”的根文件，参见图2-4。

注意，在生成DCC的时候，会更新两个根文件。

一个是指定版本号的，例如，“version.1.0.1.json”。另一个是指向最新版本的 “head.json”。

所以如果选择head.json，就是指向最新的DCC。

版本描述：当前版本的描述。这个信息会保存到DCC的根文件中。

三、在LayaAir-IDE中使用

3.1 构建单机版APP

在构建发布中，勾选打包资源，并且保留资源服务器URL为空。

（图3-1）

这样构建出的纯单机版应用无法实现资源动态更新，当资源发生变化时，必须更新APP。

3.2 使用DCC更新流程

构建发布时，设置资源服务器URL后，可以打包资源，也可以不打包。

（图3-2）

如图3-2所示，设置根文件为指定的url，例如， "http://192.168.31.109:8000/head.json"。

发布后，有一个resources目录，如图3-3所示，

（图3-3）

其中，.dcc目录需要放在DCC服务器上，地址为发布前指定的url（http://192.168.31.109:8000/head.json）；其余文件是资源，需要放在资源服务器上，地址为发布前设定的"http://192.168.31.109:9000/index.js"。

这样就完成了项目的首次发布，如果发布后需要更新，

选中更新DCC，以生成DCC数据。更改更新DCC下的版本后（1.0.1），点击构建发布，发布后，resource目录下的.dcc目录如图3-4所示，

（图3-4）

把.dcc目录放到DCC服务器上，地址为发布前指定的url（http://192.168.31.109:8000/），即与上面的`根文件`一致。

这样发布的App就能根据指定根文件进行资源热更。之前发布的App，如果指定的是同一个根文件，也会在启动后触发热更。

注意：如果使用固定名称的根文件，可能会由于CDN缓存导致无法获取最新的文件内容，导致热更错误。

解决方法一般是给根文件一个非cdn地址，或者给一个动态页面地址。这时候根文件通常与DCC服务器不在一起，就不能把DCC服务器的地址设置为空了。

四、命令行工具

除了可以在构建发布中生成DCC，还可以通过命令行来更灵活的实现相同功能。

首先进行安装（管理员）：

npm install -g layadcc2

安装完以后，可以直接使用layadcc2命令。用法如下：

Usage:  [options] [command] <dir>

layadcc2命令工具

Arguments:
  dir                                         输入目录

Options:
  -V, --version                               output the version number
  -o, --output <outDir>                       指定输出目录,如果是相对目录，则是相对于当前目录 (default: "dccout")
  -m, --merge                                 是否合并小文件
  -y, --overwrite                             是否覆盖输出目录（保留历史记录需要覆盖）
  -h, --help                                  display help for command

Commands:
  genpatch [options] <inputDir1> <inputDir2>  生成补丁文件
  checkout [options] <inputDir>               把dcc目录恢复成原始结构

例如，

生成DCC资源：

layadcc2 ./resource -o ./dccout

这个会给resource目录生成DCC，输出到dccout下面。

目前没有做详细的参数，如果要保存多个版本，可以自行在dccout下面修改json文件的名字，然后把整个目录合并到之前的dccout目录下。

把DCC资源恢复成原始资源：

layadcc2 checkout ./dcc1

这个把dcc1目录下的head.json指向的版本展开成原始目录，放到checkout目录下

五、通过代码的使用方法

源码地址：https://github.com/layabox/layadcc2.git

分支：dccplugin

LayaDCCClient的接口定义：

export class LayaDCCClient{

    onlyTransUrl:boolean;
    //映射到dcc目录的地址头，如果没有，则按照http://*/算，所有的请求都裁掉主机地址
    pathMapToDCC:string;

    /**
     * 
     * @param frw 文件访问接口，不同的平台需要不同的实现。如果为null，则自动选择网页或者native两个平台
     * @param dccurl dcc的服务器地址
     */
    constructor(dccurl:string, frw:new ()=>IGitFSFileIO|null, logger:ICheckLog=null)

    enableLog(b:boolean)

    /**
     * 初始化，下载必须信息 
     * @param headfile dcc根文件，这个文件作为入口，用来同步本地缓存。如果为null则仅仅使用本地缓存
     * @param cachePath 这个暂时设置为null即可 
     * @returns 
     */
    async init(headfile:string|null,cachePath:string):Promise<boolean>;

    /**
     * 当前缓存中是否缓存了某个文件
     *
     */
    async hasFile(url: string):Promise<boolean>;

    /**
     *  读取缓存中的一个文件，url是相对地址
     * @param url 用户认识的地址。如果是绝对地址，并且设置是映射地址，则计算一个相对地址。如果是相对地址，则直接使用
     * @returns 
     */
    async readFile(url:string):Promise<ArrayBuffer|null>

    /**
     * 把一个原始地址转换成cache服务器对象地址
     * @param url 原始资源地址
     * @returns 
     */
    async transUrl(url:string)

    /**
     * 与DCC服务器同步本版本的所有文件。
     * 可以用这个函数来实现集中下载。
     * 
     * @param progress 进度回调，从0到1
     * 注意：在开始同步之前可能会有一定的延迟，这期间会进行目录节点的下载。不过目前的实现这一步在init的时候就完成了
     * 
     */
    async updateAll(progress:(p:number)=>void);

    /**
     * 根据指定的zip文件更新本地缓存。
     * 这个zip文件可以通过DCC插件的补丁生成工具来生成。
     * 
     * 这个会修改本地保存的root
     * @param zipfile 打补丁的zip文件，注意这里必须是本地目录，所以需要自己实现下载zip到本地之后才能调用这个函数。
     * @param progress 进度提示，暂时没有实现。
     */
    async updateByZip(zipfile:string,zipClass:new()=>IZip, progress:(p:number)=>void);

    /**
     * 利用一个pack文件更新，这个pack包含idx,文件内容。
     * @param pack :一个url或者buffer
     * @param unpacker :解包类。把包文件内容解开成一个列表
     */
    async updateByPack(pack: string | ArrayBuffer, unpacker?: new () => IDCCPackR);

    /**
     * 遍历所有的节点。
     * 包括没有下载的
     */
    async visitAll(treecb: (cnode: TreeNode,entry:TreeEntry) => Promise<void>, blobcb: (entry: TreeEntry) => Promise<void>)；

    /**
     * 清理缓存。
     * 根据根文件遍历所有本版本依赖的文件，删除不属于本版本的缓存文件
     */
     async clean()

    //插入到laya引擎的下载流程，实现下载的接管
    injectToLaya();
    //取消对laya下载引擎的插入
    removeFromLaya();
}

常见用法如下：

5.1 生成DCC

    let srcPath = '资源的绝对路径'
    let dcc = new LayaDCC();
    //配置参数
    let param = new Params();
    param.version = '1.0.0';
    param.dccout = '输出的绝对路径'
    dcc.params = param;
    //开始生成dcc数据
    await dcc.genDCC(srcPath);

5.2 使用dcc

对于使用dcc，基本流程是根据根文件初始化，然后插入laya引擎的downloader，之后下载就会被dcc接管

//创建DCC客户端，参数是DCC服务器地址
let dcc = new DCCClient('http://localhost:7788/' );
//设置这个地址下的资源加载走DCC模式
dcc.pathMapToDCC= 'http://localhost:8899/';
//通过DCC的根文件初始化dcc客户端
let initok = await dcc.init('http://localhost:7788/version.3.0.0.json',null);
//把dcc功能插入laya引擎
dcc.injectToLaya();

5.3 native端使用dcc

var appUrl = "http://stand.alone.version/index.js";
var dccHead = "http://10.10.20.26:6666/head.json";
var dccUrl = null;
var mapToDCC = null;
let layadcc = require('layadcc.js').layadcc;
let dcc = new layadcc.LayaDCCClient(dccUrl || getBaseUrl(dccHead));
dcc.pathMapToDCC = mapToDCC || getBaseUrl(appUrl);
dcc.init(dccHead, null).then((ok) => {
    if (ok) {
        //如果初始化成功，接管native的下载流程
        dcc.injectToNative3();
    }
    window.layadcc = layadcc;
    window.dcc = dcc;
    loadApp(conch.presetUrl || appUrl);
});

现在native中已经包含这段代码（index.js中），可以通过layadcc访问dcc库导出的对象，通过dcc访问native创建的LayaDCCClient

5.4 集中更新所有资源，避免边运行边下载

let dcc = new DCCClient('http://localhost:7788/' );
dcc.pathMapToDCC= 'http://localhost:8899/';
let initok = await dcc.init('http://localhost:7788/version.3.0.0.json',null);
await dcc.updateAll((p)=>{/*进度提示*/})

5.5 使用zip更新

    async function downloadBigZip(url:string):Promise<string|null>{
        let cachePath = conch.getCachePath();
        let localfile =  cachePath+url.substring(url.lastIndexOf('/'));

        return new Promise((resolve,reject)=>{
                downloadBigFile(url, localfile, (total, now, speed) => {
                    console.log(`downloading:${Math.floor((now / total) * 100)}`)
                    return false;0
                }, (curlret, httpret) => {
                    if (curlret != 0 || httpret < 200 || httpret >= 300) {
                        resolve(null);
                    }
                    else {
                        resolve(localfile);
                    }
                }, 10, 100000000);        
            }
        );
    }

    let zipfile = await downloadBigZip('http://10.10.20.26:8899/update/dccout1.zip')
    let client = new DCCClient('http://101.10.20.26:6677/dccout2');
    let iniok = await client.init(dccurl+'/head.json', null);

    await client.updateByZip(zipfile, Zip_Native,null);

注意，zip是通过dcc插件生成的zip文件，有特定的文件组织形式。

详细参考zip更新。

5.6 清理本地缓存

let dcc = new DCCClient(null);
await dcc.clean();

5.7 生成版本之间的差异zip

    let zipfile = await LayaDCCTools.genZipByComparePath(老的dcc目录, 新的dcc目录, 输出目录);
    //zipfile是返回的输出的zip文件路径

zip中包含根root，可以通过updateByZip更新。具体的LayaDCCTools的接口见源码。

5.8 根据文件列表生成pack包

import {layadcctools} from './dist/layadcctools.js'
const {LayaDCCTools,LayaDCC,Params,PackRaw} = layadcctools;

layadcctools.LayaDCCTools.genPackByFileList( [
    'D:/work/ideproj/DCCPlugin/release/web/internal/sky.jpg',
    ],
    'd:/temp/ddd1.pack', layadcctools.PackRaw)

这里的PackRaw是一个默认打包器，具体见源码。

更新可以通过：

    dcc.updateByPack(buffer, DCCPackR);

这里的DCCPackR是PackRaw对应的解码器。

5.9 其他功能

enableLog:boolean ：是否打印日志，设置为true之后，会有更多打印信息，有助于调试。

onlyTransUrl:boolean：只做地址转换功能，即把一个url请求转换成对缓存对象的请求，不会在本地存储这个对象。例如，在网页端，只是希望保证文件资源是正确的，可以设置为这个true。

适配其他平台：用户可以自己实现一个IGitFSFileIO接口，并传给DCCClient的构造函数，就可以支持新的平台，主要是提供本地文件的读写功能。

七、常见问题

DCC是否能读取apk中打包的资源，需要特殊设置吗？

能读取，不需要特殊设置，直接可用。

网页端可以使用layadcc2吗？

可以把layadcc项目包含到自己的项目中，或者加载layadcc.js，然后在网页中使用。

网页使用会通过indexdb来缓存资源。缺点是只能接管laya的downloader，所以无法接管系统的xhr，且必须在laya初始化完成之后才能起作用。

是否支持微信小游戏？

这个可以通过自己扩展来实现。

是否可以在以前版本的native中使用dcc2？

不可以，layadcc2依赖native的新的接口。

在网页端是否可以接管开始的js的下载？

目前还不能，在网页端的dcc目前依赖laya引擎。native端可以不依赖。

缓存工具-layadcc