基于casperjs、resemble.js实现一个像素对比服务

写在最前

本次分享一个提供设计稿与前端页面进行像素对比的node服务，旨在为测试或者前端人员本身完成一个辅助性测试。相信我，在像素级别的对比下，网页对设计稿的还原程度一会儿就会凸显出来。
欢迎关注个人博客，不按期更新中——

效果预览

前置知识

本次用到了如下两个库做为辅助工具：

• casperjs：基于PhantomJS的编写。其内部提供了一个无界面浏览器，简单来讲用它你能够以代码的形式来完成模拟人来操做浏览器的操做，其中涉及鼠标各类事件，等等很是多的功能，本次主要使用其附带的截图功能。
• resemble.js:图片像素对比工具。调用方法简单理解为，传入两张图，返回一张合成图并附带对比参数如差异度等等。基本实现思路能够理解为经过将图片转为canvas后，获取其图像像素点，以后对每一个像素点进行一次比对。

因此整个服务咱们应该已经有了大题的思路即经过casperjs来进入某个网站截取某个页面，再将其与设计图进行比对得出结果。

总体思路

经过上图咱们应该能整理出一个大概的流程：

1. 从前端页面接收设计稿图片及须要截取的网站地址与节点信息
2. 将设计稿保存到images文件夹
3. 开启子进程，启动casperjs，完成对目标网站的截取
4. 截取后请求form.html将图片地址信息填入并从新传回服务器
5. 服务端获取图片信息经过resemblejs将截取图与设计稿进行比对
6. 结果传回前端页面

这其中有一个问题可能会有人注意到就是：为何在casperjs中对目标网站截图了不能直接把信息传回服务器中，而是选择了再去打开一个表单页面经过表单的形式来提交信息？

答：首先我对casperjs和node了解都不那么深刻，我理解的是首先casperjs不是一个node模块，它是跑在操做系统中的，我尚且没有发现怎么在casperjs中创建与node服务的通讯，若是有方法必定要告诉我，由于我真的不太了解casper！其次因为没法创建通讯，我只能退而求其次，经过casper快速打开一个我写好的表单页面而且填写好图片信息传回服务器，这么作是能够完成最初的诉求。因此就有了上面from.html那段的操做。

实现细节

实现一个简易静态服务器

由于涉及到index.html与form.html页面的返回，故须要实现一个超级简易的静态服务器。代码以下：

const MIME_TYPE = {
    "css": "text/css",
    "gif": "image/gif",
    "html": "text/html",
    "ico": "image/x-icon",
    "jpeg": "image/jpeg",
    "jpg": "image/jpg",
    "js": "text/javascript",
    "json": "application/json",
    "pdf": "application/pdf",
    "png": "image/png",
    "svg": "image/svg+xml",
    "swf": "application/x-shockwave-flash",
    "tiff": "image/tiff",
    "txt": "text/plain",
    "wav": "audio/x-wav",
    "wma": "audio/x-ms-wma",
    "wmv": "video/x-ms-wmv",
    "xml": "text/xml"
}
function sendFile(filePath, res) {
    fs.open(filePath, 'r+', function(err){ //根据路径打开文件
        if(err){
            send404(res)
        }else{
            let ext = path.extname(filePath)
            ext = ext ? ext.slice(1) : 'unknown'
            let contentType = MIME_TYPE[ext] || "text/plain" //匹配文件类型
            fs.readFile(filePath,function(err,data){
                if(err){
                    send500(res)
                }else{
                 res.writeHead(200,{'content-type':contentType})
                    res.end(data)
                }
            })
        }
    })
}

解析表单并将图片存储到images文件夹

const multiparty = require('multiparty') //解析表单
let form = new multiparty.Form()
    form.parse(req, function (err, fields, files) {
        let filename = files['file'][0].originalFilename,
            targetPath = __dirname + '/images/' + filename,
        if(filename){
            fs.createReadStream(files['file'][0].path).pipe(fs.createWriteStream(targetPath))
            ...
        } 
    })

经过建立可读流读出文件内容，再经过pipe写入到制定路径下便可保存上传来的图片。

运行casperjs

const { spawn } = require('child_process')
spawn('casperjs', ['casper.js', filename, captureUrl, selector, id])
casperjs.stdout.on('data', (data) => {
    ...
})

经过spawn能够建立子进程来启动casperjs，一样也可使用exec等。

截图并提交数据到form.html

const system = require('system')
const host  = 'http://10.2.45.110:3033'
const casper = require('casper').create({
    // 浏览器窗口大小
    viewportSize: {
        width: 1920,
        height: 4080
    }
})
const fileName = decodeURIComponent(system.args[4])
const url = decodeURIComponent(system.args[5])
const selector = decodeURIComponent(system.args[6])
const id = decodeURIComponent(system.args[7])
const time = new Date().getTime()
casper.start(url)
casper.then(function() {
        console.log('正在截图请稍后')
        this.captureSelector('./images/casper'+ id + time +'.png', selector)
})
casper.then(function() {
    casper.start(host + '/form.html', function() {
        this.fill('form#contact-form', {
            'diff': './images/casper'+ id + time +'.png',
            'point': './images/' + fileName,
            'id': id
        }, true)
    })
})
casper.run()

代码仍是比较简单的，主要过程就是打开一个页面，而后在then中传入你的操做，最后执行run。在这个过程里我不太知道如何与node服务通讯，故选择了再开一个页面。。想深刻研究的能够去看casperjs的官网很是详尽！

经过resemble.js进行像素比对并返回数据

function complete(data) {
        let imgName = 'diff'+ new Date().getTime() +'.png',
            imgUrl,
            analysisTime = data.analysisTime,
            misMatchPercentage = data.misMatchPercentage,
            resultUrl = './images/' + imgName
        fs.writeFileSync(resultUrl, data.getBuffer())
        imgObj = {
            ...
        }
        let resEnd = resObj[id] // 找回最开始的res返回给页面数据
        resEnd.writeHead(200, {'Content-type':'application/json'})
        resEnd.end(JSON.stringify(imgObj))
    }
let result = resemble(diff).compareTo(point).ignoreColors().onComplete(complete)

这其中涉及到了一个点，即我如今所获得的结果要返回给最初的请求里，而从一开始的请求到如今我已经中转了屡次，致使我如今找不到我最初的返回体res了。想了好久只能暂时采用了设定全局对象，在接收最初的请求后将请求者的ip和时间戳设定为惟一id存为该对象的key，value为当前的res。同时整个中转流程中时刻传递id，最后经过调用resObj[id]来获得一开始的返回体，返回数据。这个方法我不认为是最优解，可是鉴于我如今想不出来好方法为了跑通整个服务不得已。。若是有新的思路请务必告知！！

部署

安装PhantomJS（osx）

官网下载： phantomjs-2.1.1-macosx.zip

解压路径：/User/xxx/phantomjs-2.1.1-macosx

添加环境变量：~/.bash_profile 文件中添加

export PATH="$PATH:/Users/xxx/phantomjs-2.1.1-macosx/bin"

terminal输入：phantomjs --version

能看到版本号即安装成功

安装casperjs

brew update && brew install casperjs

安装resemble.js

cnpm i resemblejs //已写进packjson可不用安装
brew install pkg-config cairo libpng jpeg giflib
cnpm i canvas //node内运行canvas

node服务

git clone https://github.com/Aaaaaaaty/gui-auto-test.git

cd gui-auto-test

cnpm i

cd pxdiff

nodemon server.js

打开http://localhost:3033/index.html

参考文献

• PhantomJS 安装
• casperjs 文档
• resemble.js 文档

最后

惯例po做者的博客，不定时更新中——有问题欢迎在issues下交流。