加载zip压缩的javascript代码以及在Egret H5实际应用

jekeyhui99 · 发表于 2018-3-28 20:07:49

随着H5游戏项目越做越大，那么随之而来的javascript也越来越来大。下面是来自实际项目使用的技术分享，从最开始的简单压缩应用到最后的Egret H5项目实战。

主要起因是策划对最快进入登录界面有硬性要求(3秒)，那么最开始加载的文件越少越小越好。对H5的游戏程序进行压缩,可以大大缩小应用程序的加载时间。

本文分两个主题，

普通的javascript代码解压使用
实际Egret游戏项目的javascript代码解压使用
对实战感兴趣的朋友可以直接看后面的Egret部分，前面只是基础原理的入门版

文章例子下载，分两个两个例子文件夹，可运行
http://download.csdn.net/detail/sujun10/9916309

js代码压缩效果

先看看压缩和没压缩之间的对比
这里写图片描述
可以看到egret引擎的文件没压缩之前有400~500k这样，压缩之后只有100kb了。
再看看实际项目的文件：

原来main.min.js文件有2.3MB，压缩之后的main.min.js.cf(zip)文件只有441.9KB了。

使用jszip进行解压

jszip的下载地址：http://stuk.github.io/jszip/
jszip的基础教程：如何使用JSZip(How to use JSZip)
JSZipUtils工具，包含了加载二进制文件的处理，很方便

字符串变script脚本的方法

eval
eval() 函数可计算某个字符串，并执行其中的的 JavaScript 代码。

eval("console.log(1000)");1

不过实际要执行项目代码，得改变运行环境，这样可以避免一些因为环境变量引起的问题。

//运行环境指定window这个顶级对象
eval.call(window,text);1
2

var script = document.createElement('script');
script.setAttribute('type', 'text/javascript');
script.text = text;
document.body.appendChild(script);1
2
3
4

JavaScrip脚本压缩

这里是简单的测试脚本，压缩后为ZipScript.zip

//声明变量
var msg = "test zip script";
//定义main函数
function main()
{
    console.log("start main");
    console.log(msg);
}
main();1
2
3
4
5
6
7
8
9

jszip3.0加载简单的javascript的zip文件

这里采用最新的jszip，所以用法可能会和老的有一点点不一样
1. XMLHttpRequest加载zip文件
主要设置XMLHttpRequest的responseType属性

var xhrZip = new XMLHttpRequest();
xhrZip.responseType = "arraybuffer";1
2

使用JSZipUtils工具

使用这个工具类更加简单

JSZipUtils.getBinaryContent('ZipScript.zip', function(err, data) {
    if(err) {
        throw err; // or handle err
    }
    console.log("JSZipUtils加载处理");
});1
2
3
4
5
6

JavaScript使用Jszip的完整测试代码

自己可以去把//xhrZip.send(null);注释去掉来跑两种不同的情况

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
    <script src="jszip.js"></script>
    <script src="jszip-utils.js"></script>
</head>
    <script>

        var xhrZip = new XMLHttpRequest();
        xhrZip.open('GET', 'ZipScript.zip?v=' + Math.random(), true);
        xhrZip.responseType = "arraybuffer";
        xhrZip.addEventListener("load", function (evt)
        {
            console.log("XMLHttpRequest加载处理");
            jszipParse(xhrZip.response);
        });
        //开启XMLHttpRequest加载二进制数据的方法
        //xhrZip.send(null);

        //使用jsziputils工具包加载zip
        JSZipUtils.getBinaryContent('ZipScript.zip', function(err, data) {
            if(err) {
                throw err; // or handle err
            }
            console.log("JSZipUtils加载处理");
            jszipParse(data);
        });
        //jszip解析zip文件，并转换为javascript脚本运行
        function jszipParse(data)
        {
            JSZip.loadAsync(data).then(function (zip) {
                return zip.file("ZipScript.js").async("string");
            }).then(function (text)
            {
                console.log("使用document.createElement");
                addScript(text);
                //使用eval
                console.log("使用eval方法");
                eval(text);
            });
        }
        //使用document创建javascript脚本
        function addScript(text)
        {
            var script = document.createElement('script');
            script.setAttribute('type', 'text/javascript');
            script.text = text;
            document.body.appendChild(script);
            document.body.removeChild(script);
        }
    </script>
</body>
</html>1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

实战Egret项目压缩JavaScript脚本

有人可能会觉得简单脚本没问题，那么这里就从实际的Egret项目做演示成果了。

jekeyhui99 · 发表于 2018-3-28 20:08:55

创建基础的Egret 项目

创建一个具备Egret UI的效果可以看到效果（比如game）
egretProperties.json配置：

"modules": [
    {
      "name": "egret"
    },
    {
      "name": "res"
    },
    {
      "name": "tween"
    },
    {
      "name": "promise",
      "path": "./promise"
    }1
2
3
4
5
6
7
8
9
10
11
12
13
14

egret代码变成zip(后缀该为cfg)步骤

发布egret项目代码生成,main.min.js文件
压缩egret引擎代码和main.min.js

egret.min.js、egret.web.min.js、res.min.js、tween.min.js、main.min.js1

压缩egret.zip文件。main.min.js压缩为main.min.js.zip

注意，实际项目中，egret引擎和项目的main的js文件应该分开压成zip，因为引擎代码几乎步变，项目代码经常变动，以后可以只热更项目代码，不动引擎代码zip。

使用的是老版的jszip，因为比较小(70多KB，api会稍微有点不同)
例子是分别使用IntelliJ IDEA和Egret Wing这两个IDE跑的(Egret5.01)
压缩文件zip的后缀修改为cfg，主要是zip可能会被下载软件给拦截了。

部署加载zip文件的indexZip.html

修改项目的index.html为的indexZip.html文件(也可以直接用index.html修改)，这里做了简化，直接加载egret.zip和main.min.js.zip。
实际项目中尽量少加载文件，则采用XMLHttpRequest，加载zip文件这里和前面的解压js的代码一样。这里重点介绍解压egret的代码，后面会给出完整的代码以及代码工程。
加载和解压egret以及main压缩文件的代码

<!DOCTYPE HTML>
<html>
<head>
    <meta charset="utf-8">
    <title>Egret</title>
    <meta name="viewport" content="width=device-width,initial-scale=1, minimum-scale=1, maximum-scale=1, user-scalable=no" />
    <meta name="apple-mobile-web-app-capable" content="yes" />
    <meta name="full-screen" content="true" />
    <meta name="screen-orientation" content="portrait" />
    <meta name="x5-fullscreen" content="true" />
    <meta name="360-fullscreen" content="true" />
    <style>
        html, body {
            -ms-touch-action: none;
            background: #888888;
            padding: 0;
            border: 0;
            margin: 0;
            height: 100%;
        }
    </style>
    <script egret="libs" src="libs/jszip/jszip.min.js"></script>
</head>

<body>
<div style="margin: auto;width: 100%;height: 100%;" class="egret-player"
     data-entry-class="Main"
     data-orientation="auto"
     data-scale-mode="showAll"
     data-frame-rate="30"
     data-content-width="640"
     data-content-height="1136"
     data-show-paint-rect="false"
     data-multi-fingered="2"
     data-show-fps="false" data-show-log="false"
     data-show-fps-style="x:0,y:0,size:12,textColor:0xffffff,bgAlpha:0.9">
</div>
<script>
    //加载egret的引擎库
    try
    {
        loadZip("egret.cfg",function(zip)
        {
            //压缩进的egret引擎的各个代码文件
            var files = ["egret.min.js", "egret.web.min.js", "res.min.js", "tween.min.js", "promise.min.js"];
            for (var i = 0; i < files.length; i++)
            {
                createScript(zip,files);
            }
            //加载游戏代码
            loadZip("main.min.js.cfg" + "?v=" + Math.random(),function(zip)
            {
                createScript(zip,"main.min.js");
                //全部加载完成，启动egret游戏
                egret.runEgret({ renderMode: "webgl", audioType: 0,retina:true});
            });
        });
    }
    catch (e)
    {
        //压缩失败，实际项目这里需要改为加载没压缩的js文件。
        console.error("jszip解压文件报错，进行普通文件加载");
    }
    //加载单个zip文件，成功后进行回调
    function loadZip(url,callBack)
    {
        var xhrZip = new XMLHttpRequest();
        xhrZip.open("GET", url, true);
        xhrZip.responseType = "arraybuffer";
        xhrZip.addEventListener("load", function (oEvent)
        {
            var arrayBuffer = xhrZip.response; // 注意:不是oReq.responseText
            if (!arrayBuffer)
            {
                console.log(url + "解析异常:" + xhrZip);
                throw new Error("zip异常");
            }
            callBack(new JSZip(arrayBuffer));
        });
        xhrZip.send(null);
    }
    function createScript(zip,file)
    {
        //解压出来变成script脚本
        var text = zip.file(file).asText();
        var script = document.createElement("script");
        script.setAttribute("type", "text/javascript");
        script.text = text;
        document.body.appendChild(script);
        document.body.removeChild(script);
    }
</script>
</body>

</html>1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

最终的运行效果，和没有压缩egret代码的效果是一样的。

		自动登录	找回密码
密码			立即注册