LayaDCC工具

介绍

LayaDCC：Laya-Dynamic Content Check，是LayaPlayer提供的一种热更新解决方案。其优点是运行时差异更新，能有效减少网络流量。他的主要数据是DCC文件，DCC文件用来描述项目中所有文件的校验值。DCC文件是通过工具 layadcc 来产生的。

layadcc会遍历所有的项目文件，生成一个包含所有文件校验值的二进制文件filetable.bin。LayaPlayer在启动的时候，会从服务器获取这个文件（如果需要的话）来确定需要更新什么文件。

layadcc 还可以用来把生成资源包，用来把资源打包到App中。

LayaPlayer资源包的类型

目前的资源打包方案有三种。

App联网包：

App本身不带任何资源，体积最小。
LayaPlayer第一次运行时，所有用到的资源都会从服务器端下载，并缓存在本地。第二次及以后运行时，会先从服务器获取dcc文件，然后在需要下载某个文件的时候，检查本地的资源是否需要更新，只有需要更新的时候才真正下载，未更新的资源则直接从本地缓存读取。
本地缓存会逐渐增大。
带资源的App联网包：

App包本身包含了部分或者全部的游戏资源，包体积较大。
数据依然能更新，即每次运行依然会从服务器取dcc文件进行校验，如果发现包中的某个文件已经老了，就会下载新的文件，缓存在本地，以后再运行的时候，只要缓存的文件没改，就依然使用缓存的。
在多次更新后，App包的文件可能大部分都无效了，每次都是取的本地缓存，这时候建议重新更新App包，用新的资源来打包。
App离线包（单机包）：

直接把所有的资源都打包到App中，完全不需要网络下载，甚至不需要联网。体积最大。
因为是单机版本，没有url，所以无法进行资源动态更新，想要更新资源的话，只能更新App。

安装和使用layadcc

layadcc基于Node.js，所以需要Node.js的环境。

1. 安装Node.js

到nodejs官网下载。
node.js不能太老，不支持 0.xx的版本，可以用命令查看node版本例如:

$ node -v
v4.2.0

这个版本就可以。

2. 安装 layadcc

npm install -g layadcc

如果顺利安装完，就可以在命令行中直接执行layadcc。

3.使用方法

layadcc 资源目录 [options]
options:
    -cache 生成资源包.
    -lwr 文件路径全部转为小写。（一般不需要）
    -url url 如果要打包资源的话，对应的url.
    -cout outpath 打包资源的输出目录，如果不设置的话，就是在资源目录下。
例如:
   layadcc d:/game/wow -cache -url www.game.com

4. 实战操作

4.1 运行环境

确保正确安装了Node.js，npm，layadcc
验证方法：

图1
只要执行layadcc没有报错就可以了。

4.2 html5项目环境

假设有一个游戏项目，放在F:/work/test/bestgame/目录下(启动页index.html在这个目录下)，他的目录结构为：
图2
这个项目发布后对应的url地址是： http://www.layabox.com/bestgame/index.html
（如果单机版不需要url地址）

4.3 打包资源

现在要把这个html5项目打包，放到App项目中。

 layadcc F:/work/test/bestgame -cache -url http://www.layabox.com/bestgame/index.html

如果是单机包的话，输入:

 layadcc F:/work/test/bestgame -cache -url http://stand.alone.version/index.html

如下图:

图3

加了-cache参数后，就会遍历所有的资源文件，输出到-cout指定的目录下，如果没有-cout参数，就在工作目录下创建一个layadccout目录（如上图），输出目录下的cache目录就是打包App的时候需要使用的资源。
然后把这个目录拷贝到构建的项目的对应的目录中，就可以编译打包生成App。
在不同的开发环境下，需要放到不同的目录中（如果使用LayaAirIDE或者layabox命令行工具，可以自动完成这一步）。

Android Eclipse:

（图4） android的资源目录是项目下的assets目录

Android Studio:

（图5）

iOS XCode:

（图6）IOS是resource目录

4.4 更新服务器

这是App发布后最常见的操作。每当更新了html5项目的内容，需要提交到服务器或者本地测试的时候，都要生成新的dcc，以便客户端能更新到最新资源。操作过程如下图：

图7

可以看到执行完layadcc后，在指定目录（现在是当前路径 . ）下面会生成一个update目录。然后把这个update目录拷贝到本地或者远程服务器的相同目录即可。
Tips:
为了方便和不出错误，建议直接在服务器所在目录下执行layadcc。

update目录介绍：

图8

allfiles.txt 所有的资源文件的相对路径。
assetsid.txt 本次dcc统计的整个资源包的校验码。
filetable.bin dcc主文件，里面是每个文件的校验值。
filetable.txt 文本格式的dcc文件，除了前三行，每一行代表一个文件和对应的校验值，与allfiles.txt正好对应起来，即第4行对应的文件是allfiles.txt的第一行。
filetable1.txt 这个文件不再使用。

注意:

如果web服务器上的目录里面没有update目录，或者update目录里面没有内容，则客户端的dcc更新机制就会关闭，这样所有的资源每次都会重新下载。在开发期间建议用这种方式。
上面的例子是在当前目录下，实际也可以指定其他路径，相对或绝对都可以，例如:
layadcc d:/game/bin/h5 或者 layadcc ../bin/h5

4.5 测试

资源打包成功的测试
先说包中没有资源的情况，这种情况下所有的资源都会从网上下载，日志如下:

图9 可以看到有很多的Download
打印信息说明：
这里面的url后面跟着的 @127.0.0.1是调试用的，表示这个文件对应的服务器地址。s=0表示这个文件没有dcc信息， l=xxx表示下载的文件的长度。

如果打了资源包，即cache目录下的东西拷贝到上面指定的目录了，这时候最直观的变化是包变大了。然后运行app，会有从资源包读取资源的打印，如下：
图10
打印信息说明
打印 found the file in the package: 就表示对应的资源是从包中获取的，没有去网络下载，看到这个日志就表示打包资源成功。如果打的单机版，则所有资源都应该有这个打印，不应该有任何下载。
服务是否有dcc的测试：
在浏览器里打开地址： http://www.layabox.com/bestgame/update/filetable.txt
注意要改成自己的地址，如果文件存在，表示打过dcc。如下图：

图11
更新机制起作用的测试
直观的测试就是更新了资源，App产生了对应的改变，例如修改了的图片，能在app上看到。从日志看的话，就是资源获取的时候，凡是没有改变的都是打印 found the file in the package:，而改变了的都是打印 download [ ] xxxurl。
注意
1 Download只执行一次，第二次再进入app，这个资源如果没改，就会直接从缓存取。 2 DCC的机制是运行时更新，所以只有执行到需要这个资源的时候才会下载，而不是一启动就下载所有更新。

总结

凡是有 download [ ] url就表示下载，说明没有dcc或者资源更新了
凡是有found the file in the package:，说明打包资源成功，dcc起作用了。

注意:

layadcc执行的时候会修改所有文件的修改时间，目的是为了防止cdn在回源的时候以为文件没有被修改。
上面的地址是虚构的，不存在一个 http://www.layabox.com/bestgame/index.html 的地址。

常见问题

打包资源以后，没感觉速度变快，怀疑所有的资源还是都在下载。
1. 确定是否真的都是在下载，看日志是不是有上面提到的Download和find，如果既有读缓存，也有下载，则没有问题，只是真的下载慢。
2. 如果全部都是Download，没有读缓存
  1. 是不是忘了打dcc了，通过浏览器检查服务器是否有dcc信息。
  2. 检查打包资源路径是否正确。
App发布后，修改了部分资源，但是没有被App更新到。
1. 是不是忘了打dcc了？
2. 打了dcc了，但是忘了提交到服务器上（建议在服务器打dcc）？
3. 打了dcc了，也提交到服务器了，但是由于有cdn，还没有把这个变化分发到你所在的节点。
我确认dcc流程都对了，但是某个资源每次都会重新下载，不走缓存。
1. 确认这个资源是否在打包资源中，即dcc列表中，可以在 update/allfiles.txt中搜索这个文件。
2. 如果在。确认请求这个资源的url是否有search部分，即?xxx, 如果加了的话，是无法走dcc流程的。
3. 如果也没有search，那有可能是这个文件的实际内容与校验值不匹配，dcc会以为是错误的文件，就不缓存了。可能的原因：
  1. 打完dcc以后，有人把这个文件的内容又给改了，导致dcc校验值与实际文件内容不匹配。解决方法：重新打dcc
  2. 没人改文件内容，但是dcc是在客户端打的，文件在上传到服务器以后，被上传软件修改内容了。这种情况一般发生在文本文件上，例如有的版本管理工具和ftp工具会把windows下的回车换行变成unix的回车。解决方法：用zip的方式传文件，或者在服务器上打dcc。
  3. 没有上面的问题，而且错误的是图片。可能原因是有的系统会全局截获http请求，在请求图片的时候，通过自己的服务器来缓存一个被压缩过的图片，来达到所谓的节省流量。这个压缩过的图片的校验值肯定与dcc记录的不一样。解决方法：关掉节省流量功能。
  4. 如果没有开流量节省。但是使用了cdn，则还可能是cdn的问题，例如dcc文件被刷新了，但是对应的资源文件没有刷新。确认方法：通过curl命令下载本节点上的资源文件（方法见附录），与源站的资源文件比较，如果不同，即确认。解决方法：强制刷新cdn节点，或者找cdn客服。
开发期间，每次更新都打dcc太麻烦。
不要用layadcc来打dcc，如果已经打了，把update目录删掉，然后重新安装一下app，以去掉内部的缓存，这样dcc机制就关掉了，每个文件每次请求都会重新下载。
如果某次又打了一下dcc，在服务器端生成了update目录，则缓存又会起作用，想关掉的话，再来一遍上面的操作。
为了减少包的体积，希望只是打包部分资源，正确的姿势是什么？
无论是初次安装，还是以后升级app，如果只打部分资源的话，要保证资源里的dcc信息是基于完整数据生成的。例如共有100个资源，只想打包50个到app中，需要先在完整资源状态下打dcc，保存生成的dcc信息（主要是filetable.txt），然后删掉50个资源，用layadcc生成cache文件，这时候cache目录下生成dcc信息是不完整的，所以要用上一步生成的文件来覆盖他。
如果使用了不完整的dcc会导致的问题：更新app的时候，native会优先使用app中缓存的dcc文件，导致丢失部分缓存信息，这样不在filetable.txt中的文件会被认为不需要缓存，从而一直下载，直到下次服务器dcc更新。

附录

LayaDCC的流程

图12
对应的代码在 index.js 中。
下载某个cdn节点上的文件。
```
curl -H "Host:www.layabox.com" http://182.110.238.110/bestgame/index.html >a.html
```
表示把 182.110.238.110 节点上的 http://www.layabox.com/bestgame/index.html的文件下载下来，保存到 a.html中。其中的 Host：后面的内容改成自己的域名， http://后面的ip地址改成节点服务器的地址，那怎么获得节点服务器地址呢？在LayaPlayer中，节点服务器通常不会改变，所以可以通过任意一个Download的打印来得到地址，例如:
```
Downloaded http://www.layabox.com/bestgame/bestgame.min.js@182.110.238.110 s=44216b56 l=422
```
就知道节点地址是182.110.238.110。

缓存工具-layadcc