berserkJS

基于 qt webkit,使用 JS 语法开发检测逻辑的 webkit netwrok request 检测工具。

View project on GitHub

前端自动化监测工具(BerserkJS)

演示视频

http://www.tudou.com/v/pu5xvmzVZbU/&resourceId=0_04_05_99/v.swf


工具介绍 PPT

D2 前端论坛中使用的 PPT : 【点此观看】 【在线看1(墙内)】 【在线看2(墙外)】


如何使用

Windows

直接执行源码包下 build\release\berserkJS.exe

Mac

  1. 下载并安装 Qt libraries 4.8.5 for Mac
  2. 执行源码包下 build\mac_64\berserkJS
【官网地址】 http://qt-project.org/downloads 
【立即下载】 http://download.qt-project.org/official_releases/qt/4.8/4.8.5/qt-mac-opensource-4.8.5.dmg

Linux

  1. 下载 Qt libraries 4.8.5 for Linux/X11
  2. 确定系统内存在 X11 lib,否则请使用 yum 等工具安装依赖
  3. 如果需要在纯命令行下使用,请使用yum 等工具安装 Xvfb 来模拟 X11 环境。
  4. 解压 Qt libraries 4.8.5 for Linux/X11,并进入目录
  5. 执行 ./configure
  6. 执行 make
  7. 执行 install
  8. 进入 berserkjs 源码包的 src 目录
  9. 执行 qmark berserkjs.pro
  10. 执行 mark 后可编译出 berserkJS 的可执行文件
  11. 执行 berserkJS
【官网地址】 http://qt-project.org/downloads 
【立即下载】 http://download.qt-project.org/official_releases/qt/4.8/4.8.5/qt-everywhere-opensource-src-4.8.5.tar.gz


工具说明

此工具用于尝试前端自动化分析页面网络请求数据,可以使用 JS 操作页面导向,获取所需数据。基于 QT 开发,理论上可以跨平台使用,前提是在目标平台编译并部署 QT 运行环境。

工具特性:

  1. 功能性:工具内置 webkit 浏览器内核,可响应浏览器内核事件回调、支持发送鼠标消息给浏览器、包装浏览器网络请求数据为JS数据格式、可与浏览器内JS做数据交互。
  2. 开放性:工具将主要操作均包装为JS语法与数据格式,采用JS语法包装,前端工程师可根据API组装出符合各自预期的检测功能。
  3. 接口性:工具本身支持命令行参数,可带参调用。API支持处理外部进程读取输出流、支持HTTP发送数据。可由 WEB 程序远程调用后获取测试的返回结果。


工具的适用场景

  1. 检测页面网络请求情况,包括监控页面请求时长、数据大小、文件格式、请求数量等。
  2. 用户操作模拟,利用获取页面指定元素位置,发送鼠标消息点击等手段模拟真实用户操作。
  3. 页面渲染情况检测,如页面一定时间内的paint数,页面首次渲染、首次布局时间等。
  4. 脚本插件特性模拟,如将一些检测代码在页面某个特定时刻注入页面执行,收集获取执行结果,模拟执行异常等。
  5. 远程或本地程序辅助,可执行一些本地代码讲输出流注入页面执行,远程数据亦可。
  6. 方便的网页整页截图工具,可在用户操作模拟的基础上导航到指定页面状态截图保存。


作者信息

微博:@貘吃馍香

命名介绍

那么为什么工具命名为 BERSERK 呢?它取自这个词的词源信息:

BERSERK:巴萨卡,这个词源于古代北欧语言,意思是“披着熊皮的人”后为“狂战士”的称谓。是奇幻作品中最受欢迎的职业设定之一。狂战士受主神奥丁的加护,战斗中会陷入极度兴奋的忘我状态,以超强的肉体打击敌人,没有恐惧,疼痛的感觉。严重者会陷入癫狂而死。

因此,本工具的含义中包括了“披着JS皮的”且“用起来很疯狂的”,用多了会兴奋的,忘却痛苦与恐惧的诸多含义。同时告诫所有码农注意身体健康,小心真的“爽”挂了。

ps:如果你是个动漫迷,可以看看三浦健太郎的《烙印战士》哦~~ 连载20年还没完结的狂战士故事~~ 希望作者身体健康,愿菩萨保佑他,阿门。

开发环境

基于 QtWebKit (QtWebKit-2.2 Release 基于 WebKit 主干稳定版 r85855 )开发,采用 Qt 4.8.0 (Qt SDK Version 1.2)环境编译:

  1. Qt 项目地址:http://qt.nokia.com
  2. Qt SDK 地址:http://qt.nokia.com/downloads
  3. Qt 文档地址:http://doc.qt.nokia.com/

如果你的系统是非 windows 需要重新编译源码取得当前平台的可执行文件时,才需要搭建开发环境。

windows 系统的用户仅从release 目录中copy出如下文件存放于同一目录,即可最小量级使用:

  1. berserkJS.exe
  2. libgcc_s_dw2-1.dll
  3. mingwm10.dll
  4. QtCore4.dll
  5. QtGui4.dll
  6. QtNetwork4.dll
  7. QtScript4.dll
  8. QtWebKit4.dll
  9. codecs 目录
  10. iconengines 目录
  11. imageformats 目录


获取源码

https://github.com/tapir-dream/berserkJS

工具主要文件

工具目录 
    + src 目录
    |    + 源码文件 ……
    |    
    + build 目录
         + release 发布目录
              + berserkJS (工具的可执行文件)
              + 依赖的 dll 文件们 (非必须)
              + 依赖的插件 dll 目录 (非必须)
              + codecs
              + iconengines
              + imageformats
              + js (脚本目录)
                   + conf 目录 
                   |        + config.js 模块配置文件
                   |        + init.js 全局配置初始化文件
                   + module 目录
                   |        + JS 检测模块文件 (*.js)
                   |        + JS 检测模块文件 (*.js)
                   |        + JS 检测模块文件 (*.js)
                   |        + ……
                   + action 目录
                            + helper.js 检测开始是加入的工具方法集
                            + autoscript.js 用户的自动化浏览器控制文件
                            + report.js 检测完成后执行的文件,用于生成检测报告

【说明】:

  1. module 目录中的JS检测模块 ,用户可自行编写新模块。
  2. conf 目录中的 config.js 中可以配置添加新检测模块,以及检测内容。
  3. action 目录为 用户行为脚本目录,用于存放自动化浏览器控制文件,用于依赖的工具方法以及检测模块执行完成后的动作脚本。
  4. 如果为 window 环境,工具现在采用非静态编译,需要依赖如下文件,它们均在工程的 release 目录中存在:
    1. libgcc_s_dw2-1.dll
    2. mingwm10.dll
    3. QtCore4.dll
    4. QtGui4.dll
    5. QtNetwork4.dll
    6. QtScript4.dll
    7. QtWebKit4.dll
    8. libeay32.dll
    9. ssleay32.dll
    10. codecs\qcncodecs4.dll
    11. codecs\qjpcodecs4.dll
    12. codecs\qkrcodecs4
    13. codecs\qtwcodecs4.dll
    14. iconengines\qsvgicon4.dll
    15. imageformats\qgif4.dll
    16. imageformats\qico4.dll
    17. imageformats\qjpeg4.dll
    18. imageformats\qmng4.dll
    19. imageformats\qsvg4.dll
    20. imageformats\qtga4.dll
    21. imageformats\qtiff4.dll


命令行参数

可执行文件 berserkJS 将携带一些命令行参数。如下:

  1. --version 该参数将显示工具当前版本号,并使其它参数失效。
  2. --help 该参数将在浏览器界面内显示远程 help 页,该页地址为:http://github.com/tapir-dream/berserkJS/。 启用该参数时 --command 参数自动失效。
  3. --command 该参数将隐藏工具界面使其看起来像纯命令行工具。此方法的设计目的在于非调试环境中不启用界面窗口。
  4. --start 该参数表明要自动执行 berserkJS 目录下 js/conf/init.js 文件,运行配置好的测试。
  5. --script 该参数表示要自动执行某路径下js文件。其规则是先以参数值为实际路径嗅探文件,如果存在则执行,否则执行以berserkJS路径为基准的脚本文件。此js文件将自动以 uft-8 编码格式读取并执行;此参数存在时 --start 参数自动失效。
  6. --cache 该参数表示启用页面本地缓存以及 Offline Web Application Cache、Local storage。


项目核心源文件概要

  1. berserkjs.pro --------- 工程文件
  2. customdownload.cpp --------- 收集所有网络请求
  3. monitordata.cpp ---------------- 请求数据收集对象 并扩充一些常用请求判定方法
  4. monitordatamap.cpp --------- 请求数据收集器 所有数据对象的容器
  5. selector.cpp -------------------- 请求选择器 用于定义常用的过滤方法
  6. mywebpage.cpp --------------- QtWebPage 的继承类 用于扩展原有类方法
  7. mywebview.cpp ---------------- QtWebView 的继承类 用于暴露一些浏览器方法给外部 JS
  8. scriptbinding.cpp -------------- 用于暴露绝大部分非 QtWebKit 控制方法给外部 JS
  9. pageextensioncpp ------------ 向注入页面对象方法的实现类
  10. firstscreen.cpp ---------------- 首屏渲染完毕检测实现类

【注】:全小写文件名是为了避免跨平台文件名字符大小写异常问题。


内部包装出的JS方法表

工具暴露出一些 JS 方法可供调用,利用这些方法我们可以做到控制浏览页面、监听特定事件、延时处理、截图等常用操作。

整体方法树如下:


Global + [object] APP + [function] networkData <-- 返回 network 数据数组
       |              + [function] networkResources <-- 返回更详细的 network 数据数组
       |              + [function] close
       |              + [function] loadScript
       |              + [function] readFile
       |              + [function] writeFile
       |              + [function] base64FromFile
       |              + [function] dataURIFromImage
       |              + [function] netListener <-- webview.netListener 方法的引用
       |              + [function] process
       |              + [function] httpRequest
       |              + [function] download
       |              + [function] mkdir
       |              + [function] watchFile
       |              + [function] unWatcher
       |              + [function] watchedFiles
       |              + [function] watcherClose
       |              + [function] cpu
       |              + [function] memory
       |              + [function] alert
       |              + [function] about
       |              + [function] isOnline
       |              + [string] path
       |              + [string] file
       |              + [string] args
       |              + [object] selector + [function] clear
       |              |                   + [function] img
       |              |                   + [function] png
       |              |                   + [function] gif
       |              |                   + [function] ico
       |              |                   + [function] jpg
       |              |                   + [function] svg
       |              |                   + [function] doc
       |              |                   + [function] css
       |              |                   + [function] js
       |              |                   + [function] cookie;
       |              |                   + [function] nonegzip;
       |              |                   + [function] nonecache;
       |              |                   + [function] nonecdn;
       |              |                   + [function] totaltimeout
       |              |                   + [function] waittimeout
       |              |                   + [function] downloadtimeout
       |              |                   + [function] dnstimeout
       |              |                   + [function] sizeout
       |              |                   + [function] http200
       |              |                   + [function] http301
       |              |                   + [function] http302
       |              |                   + [function] http304
       |              |                   + [function] http404
       |              |                   + [function] fromcdn
       |              |                   + [function] get
       |              |
       |              + [object] webview + [function] getUrl
       |              |                  + [function] open
       |              |                  + [function] execScript <-- *这里将切换到页面JS环境,与原始JS不在同一个JS引擎(即脚本沙箱)
       |              |                  + [function] setTimeout
       |              |                  + [function] clearTimeout
       |              |                  + [function] setInterval
       |              |                  + [function] clearInterval
       |              |                  + [function] addEventListener 
       |              |                                     < - pageScriptCreated
       |              |                                     < - load
       |              |                                     < - initLayoutCompleted
       |              |                                     < - pageChanged
       |              |                                     < - contentsSizeChanged
       |              |                                     < - iconChanged
       |              |                                     < - loadStarted
       |              |                                     < - titleChanged
       |              |                                     < - urlChanged
       |              |                                     < - repaint
       |              |                                     < - pageRectChanged
       |              |                                     < - loadProgress
       |              |                                     < - message
       |              |                                     < - firstPaintFinished
       |              |                                     < - firstScreenFinished
       |              |                                     < - requestStart
       |              |                                     < - requestFinished
       |              |                                     < - consoleMessage
       |              |                                     < - alert
       |              |                                     < - confirm
       |              |                                     < - propmt
       |              |                                     < - print
       |              |                                     < - close
       |              |                                     < - scroll
       |              |                                     < - selectionChanged
       |              |                                     < - statusBarMessage
       |              |                                     < - DOMContentLoaded
       |              |                  + [function] on <- addEventListener alias
       |              |                  + [function] removeEventListener
       |              |                  + [function] off <- removeEventListener alias
       |              |                  + [function] once
       |              |                  + [function] removeAllEventListener
       |              |                  + [function] offAll <- removeAllEventListener alias
       |              |                  + [function] elementRects
       |              |                  + [function] saveImage  <-  *支持 JPG/JPEG/PNG/BMP/PPM/TIFF 格式保存;
       |              |                  + [function] savePdf
       |              |                  + [function] sendMouseEvent + click/mousedown/mouseup/mousemove
       |              |                  + [function] dataURIFromRect
       |              |                  + [function] viewport
       |              |                  + [function] setViewport
       |              |                  + [function] contentRect
       |              |                  + [function] cookiesFromUrl
       |              |                  + [function] setCookiesFromUrl
       |              |                  + [function] cookieObject
       |              |                  + [function] setCookie
       |              |                  + [function] removeCookie
       |              |                  + [function] clearCookie
       |              |                  + [function] userAgent
       |              |                  + [function] defaultUserAgent
       |              |                  + [function] setUserAgent
       |              |                  + [function] setProxy
       |              |                  + [function] clearProxy
       |              |                  + [function] useSystemProxy
       |              |                  + [function] setDetectionRects
       |              |                  + [function] clearDetectionRects
       |              |                  + [function] hasDetectionRects
       |              |                  + [function] setPageZoom
       |              |                  + [function] pageZoom
       |              |                  + [function] setPageScroll
       |              |                  + [function] pageScroll
       |              |                  + [function] pageHTML
       |              |                  + [function] setPageHTML
       |              |                  + [function] pageText
       |              |                  + [function] setUploadFile
       |              |                  + [function] setMaxPagesInCache
       |              |                  + [function] maxPagesInCache
       |              |                  + [function] clearAllPagesInCache
       |              |
       |              + [object] helper <-- 非内部包装的JS命名空间,由用户扩展
       |
       + [object] console + [function] log 
                          + [function] dir
                          + [function] time 
                          + [function] timeEnd
       + [function] alert <--- App.alert 的快捷引用
       + [function] setTimeout <-- webview.setTimeout 方法的引用
       + [function] clearTimeout <-- webview.clearTimeout 方法的引用
       + [function] setInterval <-- webview.setInterval 方法的引用
       + [function] clearInterval <-- webview.clearInterval 方法的引用                
       + [function] print     


    
 ps: 一下方法和属性由 QtWebKit 自动包装,参数以及返回值都需 Qt 类型,如无特殊需要强烈不建议使用。
     此处仅列出供参考:
 
   objectName       windowOpacity           sizeIncrement        customContextMenuRequested(QPoint)
   modal            windowModified          baseSize             setEnabled(bool)
   windowModality   toolTip                 palette              setDisabled(bool)
   enabled          statusTip               font                 setWindowModified(bool)
   geometry         whatsThis               cursor               setWindowTitle(QString)
   frameGeometry    accessibleName          mouseTracking        setStyleSheet(QString)
   normalGeometry   accessibleDescription   isActiveWindow       setFocus()
   x                layoutDirection         focusPolicy          update()
   y                autoFillBackground      focus                setVisible(bool)
   pos              styleSheet              contextMenuPolicy    setHidden(bool)
   frameSize        locale                  updatesEnabled       show()
   size             windowFilePath          visible              hide()
   width            inputMethodHints        minimized            setShown(bool)
   height           title                   maximized            showMinimized()
   rect             url                     fullScreen           showMaximized()
   childrenRect     icon                    sizeHint             showFullScreen()
   childrenRegion   selectedText            minimumSizeHint      showNormal()
   sizePolicy       modified                acceptDrops          raise()
   minimumSize      textSizeMultiplier      windowTitle          lower()
   maximumSize      zoomFactor              windowIcon           updateMicroFocus()
   minimumWidth     renderHints             windowIconText       stop()
   minimumHeight    destroyed(QObject*)                          back()
   maximumWidth     destroyed()                                  forward()
   maximumHeight    deleteLater()                                reload()
 

外部JS模块

除了工具内核包裹出的JS属性以及方法外。工具可使用外部的标准ECMAScript代码执行检测分析工作。

这些JS代码均是按照指定模块规格编写。

模块文件书写规则

它是一个简单的匿名函数表达式,可以有返回值,也可以没有返回值。

(function() {
   [JS Code]
});

【注意】:这里不需要它自动执行

配置管理文件

工具提供了一组基于JS配置管理模块,辅助用户管理自己的检测 JS 模块。

配置管理文件同样是一个JS模块,文件名为 ‘’‘config.js’‘’,会返回一个 JOSN 作为配置表,规格如下:

/**
 * 配置设置模块
 * @return {object} 返回配置对象    
 */
(function() {

  var path = App.path + 'js/';
  
  var namespace = function(name) {
    return path + name.replace(/\./g, '/') + '.js';
  };
  
  return {
    // 全局依赖模块表
    // 表内模块被最先被执行
    // 依赖关系由上至下
    global: [
      namespace('action.helper')
    ], 
    
    // 自动化脚本位置,如果为null则直接执行module部分
    // 如果有内容则会在自动化脚本内确切时间点执行module代码
    automation: namespace('action.autoscript'),

    // 运行模块配置表
    // 依赖关系由上至下
    // args 为模块依赖参数。
    // 如果参数是运行时动态指定的,
    // 可以写为function,return array
    // 它将在模块被调用时执行
    module: [
      { 
        path: namespace('module.none_expires'),
        args: function () {
          return [App.networkData()];
        }
      },
      { 
        path: namespace('module.none_gzip_doc'),
        args: []
      },
      ...
    ],
    
    // 完成时操作列表
    // 将在所有模块运行完成后执行
    completed: [
      namespace('action.report')
    ]
  };
});
  1. log 配置项:用户可以指定检测报告输出目录。
  2. global 配置项: 此数组配置项用于在检测模块执行运执行依赖代码,如用来做初始化全局工具包函数等。
  3. automation 配置项:此项非缺省需要,如有存在,它将接收一个 JS 模块路径。这个JS模块用于将页面导航到某一时刻后才执行所有的检测模块内容。
  4. module 配置项:此数组项中每个配置项都是一个 JSON,存在两个属性:
    1. path:用于指定JS的检测模块路径
    2. args:用于指定模块执行时所需的用户参数,它是个数组可返回数组的函数
      1. ‘’‘数组值使用环境’‘’:如检测加载时间的模块需要一个加载时间极限值,超过这个极限值将输出问题URL,这个极限值可以在此配置中写入。
      2. ‘’‘可返回数组的函数环境’‘’:通常检测代码需要依赖某种事件后执行 App.networkData() 方法得到所有请求监控数据的数组。这是个异步操作,在配置文件被执行时,App.networkData() 中还没有任何数据可返回。所以,此项中使用函数配置将可以在模块执行期再得到实际所需参数。

初始化配置以及开始运行

同配置文件一样,init.js 文件也是个模块文件,它负责初始化配置,并且执行具体检测模块代码。

init.js 文件需要使用 loadScript 方法被执行,方式如下:

App.loadScript(App.path + 'js/conf/init.js', function(err, func){func(App,App.webview)});

这行代码可以在工具启动后敲入工具的 JS 执行框内运行。

也可以使用命令参数 --start=true 使工具在开始运行后自动执行。


API 文档

App 命名空间下函数与属性

App.netListener(enabled <Boolean>)

参数: enabled <Boolean> 是否开始数据收集

返回值:

说明:

当 netListener(true) 时表示开始收集网络数据,当 netListener(false) 时停止收集。再次 netListener(true) 时将清空上次的数据开始新数据采集


App.networkData()

参数:

返回值: [<Object>,<Object>,<Object>……]

Object 明细:

  1. "StatusCode": <string> [readonly]
  2. "ReasonPhrase": <string> [readonly] 人类可读的 HTTP 状态字符串
  3. "FromCache": <boolean> [readonly] 是否来自浏览器缓存
  4. "url": <string> [readonly] 当前请 URL
  5. "ResponseSize": <number> [readonly] 请求大小
  6. "RequestStartTime": <number> [readonly] 建立请求的时间点
  7. "RequestEndTime": [readonly] 请求结束的时间点
  8. "ResponseDuration": <number> [readonly] 总应答时间
  9. "ResponseDNSLookupDuration": <number> [readonly] dns 查找时间
  10. "ResponseWaitingDuration": <number> [readonly] waiting 时间
  11. "ResponseDownloadDuration": <number> [readonly] download 时间
  12. "ResponseMethod": <string> [readonly]
  13. "UserAgent": <string> [readonly]
  14. "Accept": <string> [readonly]
  15. "Referer": <string> [readonly]
  16. "AcceptRanges": <string> [readonly]
  17. "Age": <string> [readonly]
  18. "AccessControlAllowrigin": <string> [readonly]
  19. "CacheControl": <string> [readonly]
  20. "Connection": <string> [readonly]
  21. "ContentType": <string> [readonly]
  22. "ContentLength": <string> [readonly]
  23. "ContentEncoding": <string> [readonly]
  24. "ContentLanguage": <string> [readonly]
  25. "Cookie": <string> [readonly]
  26. "Date": <string> [readonly]
  27. "ETag": <string> [readonly]
  28. "Expires": <string> [readonly]
  29. "IfModifiedSince": <string> [readonly]
  30. "LastModified": <string> [readonly]
  31. "Location": <string> [readonly]
  32. "Server": <string> [readonly]
  33. "SetCookie": <string> [readonly]
  34. "P3P": <string> [readonly]
  35. "Vary": <string> [readonly]
  36. "TransferEncoding": <string> [readonly]
  37. "Via": <string> [readonly]
  38. "XVia": <string> [readonly]
  39. "XDEBUGIDC": <string> [readonly]
  40. "XPoweredBy": <string> [readonly]
  41. "XCache": <string> [readonly]
  42. "XCacheLookup": <string> [readonly]
  43. "XCacheVarnish": <string> [readonly]
  44. "PoweredByChinaCache": <string> [readonly]
  45. "SINALB": <string> [readonly]
  46. "width": [readonly] 如果过是图片类型,则存在非负宽度值,否则默认宽度值为 -1
  47. "height": [readonly] 如果过是图片类型,则存在非负高度值,否则默认高度值为 -1
  48. "hasKeepAlive": <boolean>
  49. "hasGZip": <boolean>
  50. "hasCookie": <boolean>
  51. "hasCache": <boolean>
  52. "hasExpires": <boolean>
  53. "isFromCDN": <boolean>
  54. "isImgFile": <boolean>
  55. "isPng": <boolean>
  56. "isJpg": <boolean>
  57. "isGif": <boolean>
  58. "isIco": <boolean>
  59. "isSvg": <boolean>
  60. "isCssFile": <boolean>
  61. "isJsFile": <boolean>
  62. "isDocFile": <boolean>
  63. "isAudioFile": <boolean>
  64. "isVideoFile": <boolean>
  65. "isFontFile": <boolean>
  66. "isOtherFile": <boolean>
  67. "isHttp200": <boolean>
  68. "isHttp301": <boolean>
  69. "isHttp302": <boolean>
  70. "isHttp304": <boolean>
  71. "isHttp404": <boolean>

以上值对应同名的HTTP头数据,不再一一特殊说明。

其中标注 [readonly] 的值项为只读。

考虑到内核提供的 Boolean 数据可能会由于特殊情况而不准确。用户可以根据 HTTP头数据来复写他们,修正问题。

【注意】:如果有非常规头数据或者未被收录在此规定数据中的头内容,同样会被收集,采用 头名 + 值 形式存放。因此实际每条请求所获取的数据并非仅有以上罗列内容。

【注意】:每次 App.netListener(true) 方法被执行后,工具将会收集数据,直到 App.netListener(false) 被执行 时停止,停止后 App.networkData() 方法才可以获取到数据内容。


App.loadScript(path <string>, callback <function>)

参数:

path <string> js模块文件路径(支持本地文件路径或 HTTP 、HTTPS 协议的远程文件路径)

callback <function> load完毕后执行的回调函数

返回值: 依赖 callback 函数返回值

说明:

如果可载人的 js 文件是一个js模块文件。callback 函数内有会传入 err 和 module 两个参数。

  1. err 为 true 表示被 load 的 JS 模块有误,执行错误。
  2. module 模块函数本身,可以直接调用执行。

这个操作是同步的 callback 函数的返回值就是loadScript函数的返回值。


例子:

var args = [1,2,3];
var module = App.loadScript(App.path + 'module/xxx.js',  function(err, module) {
   if (err)
      return false;
   return module.apply(null, args);
});
if (!module) {
  ....
}

反之被加载的 js 文件为非模块写法,则直接在全局上下文环境中运行 JS 文件代码。

//远程 JS 文件, URL 为 http://www.berserkJS.org/test.js
// test.js 文件内容
var a =  1;

App.loadScript('http://www.berserkJS.org/test.js');
alert(a);
// 显示 1

【注意】:远程JS文件的实际编码取决于 content-type 内 charset 值,默认为 utf-8。


App.readFile(path <string>[, charset <string>] )

参数:

path <string> 读取的文本文件路径

charset <string> 读取文件的编码,可选参数,默认 ”UTF-8“。

值范围: "UTF-8"、 "UTF-16"、 "GBK"、 "GB18030-0"、 "ISO 8859-1"、 "BIG5"、 "BIG5-HKSCS"

返回值: <string> 返回文件内容。


App.writeFile(path <string>, content <string>[, charset <string>, appendMode<boolean>] )

参数:

path <string> 写入的文本文件路径

content <string> 写入内容。

charset <string> 指定写入的文件编码,可选参数,默认 ”UTF-8“。

appendMode<boolean> 采用追加模式写文件,可选参数。默认是值为 flase,当设置为 true 时,如文件存在,新写入内容不会将老文件内容盖,而是在文件尾追加写入新数据。

值范围: "UTF-8"、 "UTF-16"、 "GBK"、 "GB18030-0"、 "ISO 8859-1"、 "BIG5"、 "BIG5-HKSCS"

返回值: <Boolean> true 为写成功,false 为写失败。


App.base64FromFile(file <string>)

参数: file <string> 一个合法的可打开的目标文件路径。

返回值: <string> 正常情况返回文件内容的base64编码字符串。错误返回 false。

说明: 此方法用来读取一个文件二进制内容,base64编码后返回字符串。它可以配合 httpRequest 方法将指定文件内容上传到服务器,服务器可解码base64后还原文件二进制内容。


App.dataURIFromImage(image <string>)

参数: image <string> 一个合法的可打开的目标图片路径。图片格式支持: jpg/jpeg/png/bmp/gi/ico,根据文件扩展名确定文件格式

返回值: <string> 正常情况返回浏览器可识别的标准Data URI 字符串。错误返回 false。

说明: 此方法用来读取图片内容,将其 Data URI 化后返回。此内容可被传入到浏览器环境中用 img 标签还原图片显示。


App.httpRequest(method <string>, url <string> [, data <string>, charset <string>])

参数:

method <string> 请求方式字符串,值可以为 "GET" 或 "POST" (不区分大小写),如不在此范围则默认为 "GET"。

url <string> 一个合法的 HTTP 协议 URL,注意此字符串会被检查开头字符是否为 http://,不支持其他协议

data<string> 请求数据字符串,可选参数,需要符URL参数编码规范。

charset <string> 设置请求返回结果字符串编码,可选参数。

返回值: 被转为 string 的 responseText。

说明: 用来发起一个HTTP请求,用于获取数据或者提交数据操作。其返回值编码根据 HTTP Header 的 content-type 识别,如无此 head 则将使用默认的 UTF-8 编码数据返回。当用户同时设置了 charset 时,以用户设置为优先。

注意: 此方法是同步的,并且不能用以二进制方式上传。因为工具没有开放 enctype 设置项用来设置 multipart/form-data,同时也没有开放以流形式读取文件的功能。但是你可以配合 base64FromFile 方法,将指定文件二进制内容的 base64 字符串上传至服务器,再由服务器解码后还原文件。


App.process(program <string>, [args <Array>, timeout <number>, debug <function>])

参数:

program <string> 目标程序路径字符串(window 下请注意转义 \ 字符),均会被执行 ToString 操作后显示出来。

args <Array> 可选,进程执行所需参数列表数组。注意:参数列表将解析到数组内任意值不为 string 或 number 时止 ,参数默认值为 null。

timeout <number> 可选,进程最长存活时间。如果处理进程执行时间过长超过此阈值,将被强行终止并返回终止前存在的标准输出。 参数默认值是 30000,参数单位为 ms (毫秒)

debug <function> 可选,debug 回调函数。如果进程处理事件过长或无响应时,使用此参数可每 300ms 获取一次进程运行状态以及标准输出。回调函数存在两个参数 state (当前状态 string)与 output (当前累积的标准输出)。 建议回调中使用 console.log 方法来输出它们辅助调试。

返回值: 被转为 string 的所有进程标准输出。

说明: 用来执行一个外部命令行程序。使用者可以将工具中某些数据传入给外部处理程序处理,再从标准输出中得到处理结果,继续在工具环境中处理。

注意: 此方法是同步的,不建议用来执行运行时间很长的外部进程或是无返回值的后台运行进程。此外,需注意此方法的安全性!!不要用来执行 rm -rf 之类的操作。


App.watchFile(flie <string>, callback <function>)

参数:

file <string> 指定需要监听的文件。

callbackHandle <function> 文件改时执行的回调函数。

说明: 此方法用来指定监听文件或目录改变,一旦文件内容发生变化 则触发回调函数。 此方法可以传入目录,但需要注意的是,仅在指定目录内发生目录级变化时 (如创建、删除子目录),将触发回调函数。

注意:

  1. 此方法针对文件监控时,仅对文件内容变更有效。如果文件名被修改,对该文件的监控将自动移除。
  2. 此方法针对目录监控时,仅对指定目录下创建修改一级子目录有效。如果目录名被修改,对该目录的监控将自动移除。
  3. 原则上不建议用来监控目录。


App.unWatcher(file <string> | callbackHandle <function>)

参数:

file <string> 如果传入 string 则为从监听列表内去除文件监听。

callbackHandle <function> 如果传入 function 则为从监听回调函数列表内去除指定的回调函数。

说明: 移除指定监听文件、目录或指定的监听回调函数。


App.watchedFiles()

参数:

返回值: <Array> 返回所有监听文件列表数组。

'说明: 查看所有监听文件和目录列表。


App.watcherClose()

参数:

说明: 关闭文件监听,调用后监听文件列表以及回调函数将全部被清除。


App.cpu()

参数:

说明: 获取当前进程的CPU占用率,百分比单位。如:返回1.2 则为当前工具进程 CPU占用率 1.2%。


App.memory()

参数:

说明: 获取当前进程的内存使用值,返回 number,单位为KB。

注意: 此方法在 win 系统下,返回值通常会比在任务管理器中看到的值要大。这是因为它是返回程序使用内存的工作总集,而任务管理器中仅显示专用内存集,其区别在于后者不包括可共享的内存(如加载的DLL)。


App.setTimeout(callback <function>, timeout <number>)

说明:与 App.webview 内同名函数的使用方法一致。

注意: 此方法被引用到 Global 中,可以用 setTimeout直接调用。


App.clearTimeout(timeId <number>)

说明:与 App.webview 内同名函数的使用方法一致。

注意: 此方法被引用到 Global 中,可以用 clearTimeout直接调用。


App.setInterval(callback <function>, interval <number>)

说明:与 App.webview 内同名函数的使用方法一致。

注意: 此方法被引用到 Global 中,可以用 setInterval直接调用。


App.clearInterval(timeId <number>)

说明:与 App.webview 内同名函数的使用方法一致。

注意: 此方法被引用到 Global 中,可以用 clearInterval 直接调用。


App.alert(message <number>|<string>|<boolean>|<function>|<Array>|<Object>)

参数: message 参数类型不限,均会被执行 ToString 操作后显示出来。message 参数支持简易的HTML标签字符串,提示窗口将渲染以HTML方式渲染他们。

返回值:

说明: 此方法是工具提供的内置方法(非浏览器提供的alert方法),其所有传入值都将在JS引擎层面做 ToString 操作。这个方法预期用来辅助做简单的 JS 编码调试

注意: 此方法被引用到 Global 中,可以用 alert 直接调用。


App.hide()

参数:

返回值:

说明: 隐藏工具窗口。


App.show()

参数:

返回值:

说明: 显示工具窗口。


App.about()

参数:

返回值 无

说明: 关于信息提示框。


App.close()

参数:

返回值:

说明:该方法用来关闭工具自身进程。


App.isOnline()

参数:

返回值: true 或 false

说明: 在线为 true 否则为 false, 不要过于信任此方法


App.path [readonly]

说明:该属性为只读,返回工具所处路径。


App.file [readonly]

说明:该属性为只读,返回工具文件名。


App.args [readonly]

说明:该属性为只读,返回启动工具时的运行参数数组。如无启动参数,则返回 undefined。


App.download(url <string>, dir <string>[, filename <string>])

参数:

url <string> 一个合法的 HTTP 协议 URL

url <string> 一个合法的 HTTP 协议 URL

filenmae <string> 指定文件名,如果没有传入此参数,则按照URL结构递归创建出对应目录,并使用原始文件名保存

说明: 用来下载指定文件,如:App.downloadhttp://img.t.sinajs.cn/t5/skin/skin048/images/body_bg.png?id=1376628763520', '/data') 则会自动创建目录 /data/img.t.sinajs.cn/t5/skin/skin048/images/ 并在images 目录下保存 body_bg.png 文件。 而 App.download('http://img.t.sinajs.cn/t5/skin/skin048/images/body_bg.png?id=1376628763520', '/data', '1.png') 则不自动构造url 目录,仅将body_bg.png 下载并保存为 /data/1.png 。

注意: 此方法是同步的


App.mkdir(dir <string>)

参数:

dir <string> 一个合法的目录名

说明: 用来递归创建目录

App.networkResources()

说明: 同 networkData 使用方式,但返回更详细的 network 数据,但无法使用selector系列方法筛选数据。

格式为:

[
  {
    "request": {
      "headers": {
        "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8",
        "User-Agent": "Mozilla/5.0 (Windows NT 6.1) AppleWebKit/534.34 (KHTML, like Gecko) Qt/4.8.0 Safari/534.34 berserkJS",
        ....
      },
      "base": {
        "url": "http://xxxx.com/",
        "FromCache": false,
        "method": "GET",
        "bodySize": 0,
        "postData": "",
        "queryString": "",
        "headersSize": 179
      }
    },
    "response": {
      "headers": {
        "Accept-Ranges": "bytes",
        "Cache-Control": "max-age=86400",
        "Connection": "Keep-Alive",
        "Content-Length": "81",
        "Content-Type": "text/html",
        "Date": "Mon, 14 Jul 2014 07:18:18 GMT",
        "ETag": "\"51-4b4c7d90\"",
        "Expires": "Tue, 15 Jul 2014 07:18:18 GMT",
        "Last-Modified": "Tue, 12 Jan 2010 13:48:00 GMT",
        "Server": "Apache",
        ....
      },
      "base": {
        "status": 200,
        "statusText": "OK",
        "headersSize": 241,
        "bodySize": 81
      }
    },
    "timings": {
      "blocked": 0, // 该值此工具无法获取
      "connect": 0,// 该值此工具无法获取
      "dns": 5,// 该值为此工具推算值
      "endTime": 867992646,
      "receive": 25,
      "send": 0,
      "ssl": -1,
      "startTime": 867987982,
      "wait": 115
    }
  },
  // 第二个请求数据
  .....
]


App.selector 命名空间下函数

selector 是一组特定数据选择器,可以从 network 数据中累积选择出所要的数据子集。其返回数据结构与 App.networkData 函数返回值一致。

如下例:

// 清空选择器
App.selecotr.clear();

// 选择所有 http 304 的url
App.selecotr.http304();

// 继续选择是 img 的文件
App.selecotr.img();

// 获取数据
seletedNetworkData = App.selecotr.get();

上例中使用 selecotr 功能从所有数据集中选择出 产生 304 请求的 img 文件。

【注意】:选择器所做的是累积操作,先选择出所有 304 请求集,然后从 304 请求集中再选择出图片类型文件。而不是选择所有 304 请求和所有图片请求的合集并且,此方法附带 App.selector.clear() 效果,执行后将会自动清理累积选择数据。


App.selector.img()

参数:

返回值:

说明: 用来在当前筛选数据集合内,筛选出所有图片请求。


App.selector.png()

参数:

返回值:

说明: 用来在当前筛选数据集合内,筛选出所有 png 类型图片请求。


App.selector.gif()

参数:

返回值:

说明: 用来在当前筛选数据集合内,筛选出所有 gif 图片请求。


App.selector.ico()

参数:

返回值:

说明: 用来在当前筛选数据集合内,筛选出所有 ico 请求。


App.selector.jpg()

参数:

返回值:

说明: 用来在当前筛选数据集合内,筛选出所有 jpg 请求。


App.selector.svg()

参数:

返回值:

说明: 用来在当前筛选数据集合内,筛选出所有 svg 请求。


App.selector.doc()

参数:

返回值:

说明: 用来在当前筛选数据集合内,筛选出所有文档类型文件(HTML/XHTML)。


App.selector.css()

参数:

返回值:

说明: 用来在当前筛选数据集合内,筛选出所有 css 请求。


App.selector.js()

参数:

返回值:

说明: 用来在当前筛选数据集合内,筛选出所有 js 请求。


App.selector.cookie()

参数:

返回值:

说明: 用来在当前筛选数据集合内,筛选出携带 cookie 头的请求。


App.selector.nonegzip()

参数:

返回值:

说明: 用来在当前筛选数据集合内,筛选出没有启动 gzip 的请求。

App.selector.nonecache()

参数:

返回值:

说明: 用来在当前筛选数据集合内,筛选出没有从浏览器缓存内取出的请求。


App.selector.nonecdn()

参数:

返回值:

说明: 用来在当前筛选数据集合内,筛选出无 CDN 的请求。


App.selector.totaltimeout(duration <number>)

参数: duration <number> 用来指定最大请求时间,超过此值的请求将被选择。 时间单位 ms

返回值:

说明: 用来在当前筛选数据集合内筛选出超出指定请求时间的请求。


App.selector.waittimeout(duration <number>)

参数: duration <number> 用来指定请求的最大等待时间,超过此值的请求将被选择。 时间单位 ms

返回值:

说明: 用来在当前筛选数据集合内,筛选出超出指定请求等待时间的请求。


App.selector.downloadtimeout(duration <number>)

参数: duration <number> 用来指定请求的最大数据下载时间,超过此值的请求将被选择。 时间单位 ms

返回值:

说明: 用来在当前筛选数据集合内,筛选出超出指定请求数据下载时间的请求。


App.selector.dnstimeout(duration <number>)

参数: duration <number> 用来指定请求的最大 DNS 查找时间,超过此值的请求将被选择。 时间单位 ms

返回值:

说明: 用来在当前筛选数据集合内,筛选出超出指定DNS查找时间的请求。


App.selector.sizeout(size <number>)

参数: duration <number> 用来指定最大文件,超过此值的请求将被选择。 尺寸单位 byte

返回值:

说明: 用来在当前筛选数据集合内,筛选出超出指定文件大小的请求。


App.selector.http200()

参数:

返回值:

说明: 用来在当前筛选数据集合内,筛选出 HTTP 200 的请求。


App.selector.http301()

参数:

返回值:

说明: 用来在当前筛选数据集合内,筛选出 HTTP 301的请求。


App.selector.http302()

参数:

返回值:

说明: 用来在当前筛选数据集合内,筛选出 HTTP 302 的请求。


App.selector.http304()

参数:

返回值:

说明: 用来在当前筛选数据集合内,筛选出 HTTP 304 的请求。


App.selector.http404()

参数:

返回值:

说明: 用来在当前筛选数据集合内,筛选出 HTTP 404 的请求。


App.selector.fromcdn()

参数:

返回值:

说明: 用来在当前筛选数据集合内,筛选出来自浏览器缓存的请求。


App.selector.get()

参数:

返回值: <Array> 返回选择集内数据。

说明: 用来得到累积选择的内容。


App.selector.clear()

参数:

返回值:

说明: 用来清除累积选择的内容,如果没有执行过 App.selector.get() 方法获取累积选择记录,则在需要选择新数据内容前执行此函数保证数据集纯净。


App.webview命名空间下函数

App.webview命名空间主要封装了 webview 组件控制相关方法。

如果你需要浏览器的当前页面做某些工作,将会大量的使用到此命名空间下函数。

需要注意的是,该空间下的 execScript 方法将产生 JS 沙箱效果,你不能期望把页面 JS 或者页面的 DOM 对象放置到此沙箱外调用


App.webview.setUserAgent(userAgent <string>)

参数: userAgent <string>,将工具原始的 UA 值设置为自己的个性化值。

返回值: <string> 设置的 UA 值。

说明: 当前工具使用的 User Agent 字符串。


App.webview.userAgent()

参数:

返回值: <string> 当前工具使用的 User Agent 字符串。

说明: 当前工具使用的 User Agent 字符串。


App.webview.defaultUserAgent()

参数:

返回值: <string> 工具原始的 User Agent 字符串。

说明: 用来获取工具原始的不可被变更 User Agent 字符串,它不是 setUserAgent 之后使用的当前 UA 值。


App.webview.getUrl()

参数:

返回值: <string>

说明: 当前浏览页面的 URL 。


App.webview.open(url <string>)

参数: url <string> 目标 URL

返回值:

说明: 指定浏览页面,webview 将访问此 URL 并渲染页面。


App.webview.setProxy(host <string>[, type <string>, userName <string>, password <string>)

参数:

host <string> 代理服务器地址字符串,如果有端口请用 “:” 字符分割,如 "127.0.0.1:8888"

type <string> 可选参数,代理类型字符串,可选值范围 “HTTP. SOCKS5” (不区分大小写),默认值为 "HTTP"。

userName <string> 可选参数,设置代理所需的用户名,默认值为空。

password <string> 可选参数,设置代理所需的密码,默认值为空。

返回值: <boolean> 如果成功返回 true, 否则 false。

说明: 为 webview 设置指定代理。


App.webview.clearProxy()

参数:

返回值: <boolean> 如果成功返回 true。

说明: 清除 webview 所有代理设置(也将不使用系统代理)。


App.webview.useSystemProxy([index <number>])

参数: index <number> 可选参数,系统设置的代理索引值,从 0 开始,默认值为 0。

返回值: <boolean> 如果成功返回 true。

说明: 为 webview 设置系统代理。

注意: 工具默认已经启用了系统代理,如没有使用过 clearProxy 方法,将不用手动调用此方法。


App.webview.viewport()

参数:

返回值: <Object> {widht, height}

说明: 返回 webview 的视口大小(同浏览器的浏览窗口大小)。


App.webview.setViewport(size <Object>)

参数: size <Object> {widht, height}

返回值: <Boolean>

说明: 设置 webview 的视口大小,设置成功返回 true。


App.webview.contentRect()

参数:

返回值: <Object> {x:<number>,y:<number>, widht,<number>, height:<number>}

说明: 返回当前页面正文的整体宽高。


App.webview.saveImage(path <string>[, imgType <string>, quality <number>, rect <Object>])

参数:

path <string> 指定保存图片的文件绝对路径和文件名

imgType <string> 可选参数。用于指定图片格式,默认值为 "PNG"。可选值 JPG/JPEG/PNG/BMP/PPM/TIFF。

quality <number> 可选参数。用于指定图片压缩率,默认值为 100。 可选值范围 1-100。

rect <Object> 可选参数。用于指定保存区域,默认为全页面范围。该参数格式: {x:<number>,y:<number>,width:<number>,height:<number>}

返回值: <Boolean> 成功 true ,失败 false。

说明: 保存当前页面截图到指定位置,保存区域如果超出整体图片范围,则该指定区域会被调整,超出部分被忽略


App.webview.dataURIFromRect([rect <Object>, imgType <string>, quality <number>])

rect <Object> 可选参数。用于截取当前webview渲染区域内图形。默认值为整个渲染区域。值格式:{x:<number>, y:<number>, width:<number>, height:<number>}

imgType <string> 可选参数。用于指定图片格式,默认值为 "PNG"。可选值 JPG/JPEG/PNG/BMP/PPM/TIFF

quality <number> 可选参数。用于指定图片压缩率,默认值为 100。 可选值范围 1-100

说明: 此方法用将当前渲染区域内指定位置范围的渲染结果,进行 Data URI 编码后返回其字符串。一般可用将此值放置在页面的中的 img 中显示,或配合 httpRequest 方法将内容提交到远程服务器。指定位置范围如果超出整体渲染区域,则该范围会被调整,超出部分被忽略。


App.webview.savePdf(path <string>)

参数:

path <string> 指定保存PDF的文件绝对路径和文件名

说明: 此方法将当前页面全部内容保存为 PDF 文件。

App.webview.setTimeout(callback <function>, timeout <number>)

说明:与浏览器内同名函数的使用方法一致,且此方法被引用到 App 命名空间以及 Globla 全局对象中,可直接调用。


App.webview.clearTimeout(timeId <number>)

说明:与浏览器内同名函数的使用方法一致,且此方法被引用到 App 命名空间以及 Globla 全局对象中,可直接调用。


App.webview.setInterval(callback <function>, interval <number>)

说明:与浏览器内同名函数的使用方法一致,且此方法被引用到 App 命名空间以及 Globla 全局对象中,可直接调用。


App.webview.clearInterval(timeId <number>)

说明:与浏览器内同名函数的使用方法一致,且此方法被引用到 App 命名空间以及 Globla 全局对象中,可直接调用。


App.webview.netListener(enabled <boolean>)

说明:此方法被引用到 App 命名空间下,见 App 命名空间下的同名 API 说明。


App.webview.cookiesFromUrl([url <string>])

参数: url <string> 可选参数, 一个合法的 URL 字符串,必须以 http:// 开头。如果没有或不合法,则为从当前工具访问的 URL 中获取 cookies。

返回值: <string> 指定 URL 的 cookies 字符串。

说明: 此方法用来获取指定URL下的Cookies内容,前提是此URL已被工具访问过。用户可将获取的 Cookies 内容使用 writeFile API 保存到特特定文件中待用。


App.webview.setCookiesFromUrl(cookies <string>[, url <string>])

参数:

cookies <string> 一个合法的 cookies 字符串,如使用 cookiesFromUrl API 获取的内容。

url <string> 可选参数,一个合法的 URL 字符串,必须以 http:// 开头默认值为当前工具正在访问的URL

返回值: <boolean> 成功返回 true ,否则返回 false。

说明: 此方法用来将 cookie 内容设置到指定 URL 下。一般配合 cookiesFromUrl 、writeFile 、readFile 等 API 将某 URL 中的 cookie 恢复。预期用来解决依赖cookies(cookies 中的 sessionid 或其他)的自动登录验证问题。


App.webview.cookieObject([url <string>])

参数: url <string> 可选参数,一个合法的 URL 字符串,必须以 http:// 或 https:// 开头默认值为当前工具正在访问的URL

返回值: <Array> 返回一个数组,其每一项均为一个 包含 name、value、domain 三个 key 的 JS Object。

说明: 此方法用来返回一个容易处理的 cookie 值数组。


App.webview.setCookie(cookieObject <Object>)

参数: cookieObject <Object> 一个 cooke 对象,其格式为 {name: your_cookie_name, value:your_cookie_value, domain: your_domain}

返回值: <boolean> 成功返回 true 反之为 false。

说明: 此方法用来为指定的域设置 cookie 内容,如果 cookie 存在则改写其值,否则为新建 cookie 内容。

【注意】: 其中的 domain 的值需为 .domain ,如为 weibo.com 域设置值,其 domain 应写为 .weibo.com (注意前面的点字符), 如此 key 没有赋值,则默认为当前访问的 url 值。


App.webview.removeCookie(name <string>[, domain <string>])

参数:

name <string> cookie 字符串

domain <string> 非必选参数,默认为当前访问页面的 url。

返回值: <boolean> 找到指定名字与 domian 的 cookie 并删除成功则返回 true,反之为 false。

【注意】: 其中的 domain 的值需为 .domain ,如为 weibo.com 域设置值,其 domain 应写为 .weibo.com (注意前面的点字符)


App.webview.clearCookie()

返回值: 清理成功返回 true,反之 false。

说明: 此方法用于清除所有 domain 下的 cookie。 请慎用


App.webview.elementRects(cssSelectorString <string>)

参数: cssSelectorString <string> 一个符合 CSS 规范的选择器字符串 (同浏览器的 querySelectorAll 参数值)

返回值: <Array> [<Object>, <Object>, <Object>, ……] 返回包含指定节点的渲染区域,如没有找到节点则返回 undefined。

<Object> 格式 {x, y, left, right, top, bottom, width,height}

说明: 用来返回一组元素的渲染区域信息。


App.webview.sendMouseEvent(argPoint <Object>[, argEvt <string>, argKey <string>])

参数:

argPoint <Object> {x, y} 鼠标事件发生的点

argEvt <string> 可选值。鼠标事件名,默认值为 "click",值范围 mousedown/mouseup/mousemove。

argKey <string> 可选值。鼠标事件发生时,同时按下的按键。 默认值为空。值范围 shift/ctrl/alt。

说明: 此方法用来向 webview 渲染页面的指定区域发送鼠标事件。通常配合 App.webview.elementRects 方法来向选定的 DOM 元素发送合法的 click 事件,用来做模拟用户点击操作。

【注意】: 由于 App.webview.elementRects 方法仅返回元素布局信息,如果需要更为精确的点击到元素上,你应该将 App.webview.elementRects 方法返回的 x 与 y 值均多加几像素值。


App.webview.addEventListener(eventName <string>, callback <function>)

参数:

eventName <string> 所需监听的事件名。值范围(不区分大小写):

  • "load" --页面载入完成后触发
  • "DOMContentLoaded" --页面 DOM 构造完成时触发
  • "initLayoutCompleted"--页面首次布局完成后触发
  • "pageChanged"--页面跳转完成时触发
  • "contentsSizeChanged"--文档总渲染大小发生变化后触发
  • "iconChanged"--站点的 ICO 图标文件发生变化后触发
  • "loadStarted"--页面已经开始载入时触发
  • "titleChanged"--页面 title 变化后触发(一般发生在浏览器 HTML 文档读到 title 时产生)
  • "urlChanged"--页面 url 发生变化时触发
  • "repaint"--页面重绘时触发
  • "pageRectChanged" --视口位置和大小发生改变时触发
  • "loadProgress"--页面加载进度
  • "pageScriptCreated"--页面当前JS环境准备就绪时触发(一般利用此事件在页面JS环境仅构建出Window时,注入页面级别的全局JS 对象)
  • "consoleMessage" --页面控制台输出内容时触发
  • "alert" --页面使用alert方法时触发 【注意】工具中页面调用alert方法将无法显示出对话框,它的输出被事件化。
  • "confirm" --页面使用confirm方法时触发 【注意】工具中页面调用confirm方法将无法显示出对话框,它的输出被事件化。
  • "propmt" --页面使用propmt方法时触发 【注意】工具中页面调用propmt方法将无法显示出对话框,它的输出被事件化。
  • "message"--页面使用特定扩展方法__pageExtension.postMessage时触发的回调
  • "firstPaintFinished"--页面首次渲染后触发
  • "firstScreenFinished" ---首屏渲染完成后触发
  • "requestStart"--网络请求监听被开启情况下,一旦页面某资源试图发起网络请求,此事件将被触发。
  • "requestFinished" --网络请求监听被开启情况下,页面某资源的网络请求完成时,此事件将被触发。
  • "print" --当页面使用 window.print 方法时触发
  • "close" --当页面使用 window.close 方法时触发 【注意】工具中页面调用alert方法无法关闭页面,它的输出被事件化。
  • "scroll" --当页面滚动条位置被修改后触发
  • "selectionChanged" --当页面内容被框选时触发
  • "statusBarMessage" --当页面状态栏内容变更时触发


说明:用来监听页面事件,触发回调函数执行。


callback <function> 事件触发时的回调函数。

根据事件不同回调函的参数值也不同,其中具有参数的事件如下:

  • load([timeout<number>, url <string>])
    • 参数 timeout 返回从 loadStarted 事件开始到 load 事件的间隔值,单位毫秒。
    • 参数 url 返回当前 url 字符串。
  • load([timeout<number>, url <string>])
    • 参数 timeout 返回从 loadStarted 事件开始到 load 事件的间隔值,单位毫秒。
    • 参数 url 返回当前 url 字符串。
  • DOMContentLoaded([timeout<number>, url <string>])
    • 参数 timeout 返回从 loadStarted 事件开始到 DOMContentLoaded 事件的间隔值,单位毫秒。
    • 参数 url 返回当前 url 字符串。
  • initLayoutCompleted([timeout<number>, url <string>])
    • 参数 timeout 返回从 loadStarted 事件开始到 initLayoutCompleted 事件的间隔值,单位毫秒。
    • 参数 url 返回当前 url 字符串。
  • contentsSizeChanged([size <Object>])
    • 参数 size 返回当前内容大小, 数据格式 {width, height}
  • titleChanged([title <string>])
    • 参数 title 返回当前 title 字符串。
  • urlChanged([url <string>])
    • 参数 url 返回当前 url 字符串。
  • loadProgress([progress <number>])
    • 参数 progress 返回当前加载进度值,范围 1-100。
  • repaint([rect <Object>])
    • 参数 rect 返回当前重绘区域, 数据格式 {x, y, left, right, top, bottom, width,height} 。
  • pageRectChanged([rect <Object>])
    • 参数 rect 返回当前视口区域, 数据格式 {x, y, left, right, top, bottom, width,height} 。
  • consoleMessage([msg<string>, lineNumber<number>, sourceID<string>])
    • 参数 msg: 控制台输出内容
    • 参数 lineNumber: 行号
    • 参数 sourceID: 如果是脚本执行错误,则 sourceID 会指出是那个脚本触发。
  • prompt([msg<string>, defaultValue<number>])
    • 参数 msg: prompt方法的首参数
    • 参数 defaultValue: prompt方法的次参数
  • confirm([msg<string>])
    • 参数 msg: confirm中的提示文字
  • alert([msg<string>])
    • 参数 msg: alert中的提示文字
  • message([wparam <string>, lparam<string>])
    • 参数返回页面中执行 __pageExtension.postMessage 方法时的两个字符串参数。
  • firstPaintFinished([timeout <int>, url<string>])
    • 参数 timeout 返回当前从 loadStarted 事件开始到首次渲染时间的间隔值,单位毫秒。
    • 参数 url 返回当前 url 字符串。
    • 注意:此事件可以通过其他事件组合,由JS实现,此处仅给出内置的组合方案。
  • firstScreenFinished([timeout <int>, url<string>])
    • 参数 timeout 返回当前从 loadStarted 事件开始到首屏渲染完毕的间隔值,单位毫秒。
    • 参数 url 返回当前 url 字符串。
    • 事件说明(非常重要): 此方法为模拟实现!其中,首屏区域为当前 webview 视口区域,它可以使用 setViewport 方法设置,或使用 viewport 方法获取大小。
    • 首屏渲染时间计算方法有两种(非常重要):
      • 默认检测方法:
        • loadStarted 事件触发开始计时
        • 从 firstPaintFinished 事件触发后,按照当前视口区域平均分布 14400 个像素监控点
        • 每 250 ms 检测一次所有监控点 RGB 值变化
        • 如果连续 12 次大于 12000 个像素点无变化,则结束计时,减去 12*250 ms 后返回耗时。
        • 如果连续 12 次内出现像素变化,则计数清空,重新循环检测直至达到上一步条件为止。
      • 自定义监控点检测方法:
        • loadStarted 事件触发开始计时
        • 从 firstPaintFinished 事件触发后,按照 setDetectionRects 方法设置的重点检测区块内分布像素级检测点
        • 每 250 ms 检测一次所有监控点 RGB 值变化
        • 如果连续 12 次大于检测区块总像素*设置相同率(见 setDetectionRects 方法说明)个像素点无变化,则结束计时,减去 12*250 ms 后返回耗时。
        • 如果连续 12 次内出现像素变化,则计数清空,重新循环检测直至达到上一步条件为止。
    • 此事件缺陷(非常重要):
      • 默认检测方法不适合用于长时间有大规模像素变化的页面。
      • 由于检测分布点色值取自 webkit 渲染内核,如果存在 wmode 属性值为 window 的 Flash (它由系统接管渲染,而非浏览器),那么检测点将无法获得它的色值变化。此类页面的首屏时间可能会不准确。
  • requestStart([url <string>])
    • 参数: url 返回正在发送请求的 url。
    • 说明: 当页面资源开始试图发起请求时,此事件被触发。
    • 注意: 此事件只能在 App.netListener(true) 设置后被响应
  • requestFinished([url <string>])
    • 参数: url 返回请求已经结束的 url。
    • 说明: 当页面资源的网络请求已经完成时,此事件被触发。
    • 注意: 此事件只能在 App.netListener(true) 设置后被响应
  • print([url <string>])
    • 参数 url 返回当前 url 字符串。
  • close([title <string>])
    • 参数 url 返回当前 url 字符串。
  • scroll([top<number>, left<number>, diffTop<number>, diffLeft<number>])
    • 参数 top 返回垂直滚动条当前位置距离页面顶部距离。
    • 参数 left 返回水平滚动条当前位置距离页面左部距离。
    • 参数 diffTop 返回垂直滚动条当前移动增量。
    • 参数 diffLeft 返回水平滚动条当前移动增量。
  • selectionChanged([html <string>])
    • 参数 html 返回被框选的 html 字符串。
  • statusBarMessage([text <string>])
    • 参数 text 返回当前状态条内容。


App.webview.on(eventName <string>, callback <function>)

说明: addEventListener 方法的别名方法。


App.webview.removeEventListener(eventName <string>, callbackHandle <function>)

参数:

eventName <string> 所需监听的事件名。值范围同 addEventListener 方法 eventName 值。

callbackHandle <function> 要取消的事件触发回调函数。

返回值: 成功移除事件返回值 true 否则 flase。

说明: 此函数用来移除指定事件的某条执行回调。


App.webview.un(eventName <string>, callback <function>)

说明: removeEventListener 方法的别名方法。


App.webview.once(eventName <string>, callback <function>)

说明: 单次事件触发绑定函数。使用方法同 addEventListener ,差异仅为事件触发一次后,立即移除 callback 监听函数。


App.webview.removeAllEventListener([eventName <string>])

参数:

eventName <string> 所需监听的事件名,非必选参数,值范围同 addEventListener 方法 eventName 值。

返回值: 成功移除事件返回值 true 否则 flase。

说明: 此函数用来移除指定事件的全部执行回调。如果 eventName 值为空字符串或者未传值,则会移除所有事件的全部执行回调。


App.webview.unAll([eventName <string>])

说明: removeAllEventListener 方法的别名方法。


App.webview.setDetectionRects(rects <Array>[, sameRate <number>])

参数:

rects <Array <Object>> 一组区块对象列表。每个区块对象需为 {x:<number>, y:<number>, width:<number>, height: <number>} 的 Object 格式。

sameRate <number> 可选参数,表示全部像素一段时间内的趋同率。该值取值范围为 0-1, 默认值为 0.95。

返回值:

说明: 此函数用来指定页面首屏渲染事件实现所需的自定义检测区块位置以及全部区块像素的趋同率。如果使用此方法,那么 firstScreenFinished 事件将由全部区块内像素一定时间内不再变化后触发。

注意: 过多的像素检测可能会带来执行效率问题,因此强烈建议每个区块大小不要超过 30*30,并且最多不要超过 9 个监控区块


App.webview.clearDetectionRects()

说明: 清除 setDetectionRects 方法设置的监控区块与趋同率。


App.webview.hasDetectionRects()

返回值: <boolean> 如果存在自定义检测区块,返回 true,否则 false。

说明: 用来检测是否设置过自定义检测区块。


App.webview.execScript(sandbox <function> [, argObject <Object>|<Array>|<string>|<number>])

参数:

sandbox <function> 在页面全局脚本环境内下执行的匿名函数沙箱,它与其他 API 调用环境是隔离的,不能使用此环境作用域中的任何变量。如果存在 argObject 参数设置,那么该函数的首参数是 argObject 参数值。

argObject <Object>|<Array>|<string>|<number> 可选参数。用于向页面的 sandbox 环境中传入简单数据值。它可以是朴素 的对象、数组或字符串与数字。【注意】不能传入function,数组与对象内也不能存在 function 引用

返回值: 依赖沙箱函数回调值。沙箱函数可以将页面数据包装为 朴素 的对象、数组或字符串与数字返回给当前执行环境。同样需需要注意,不能将页面的 DOM 、function 等复杂对象从沙箱内传出

说明:此函数用来将某段脚本注入到当前页面执行。注入的代码运行在页面脚本环境中,与当前环境隔离。

例子:

    // 执行当前页面中的console.log方法打印在控制台中打印 'hello'
    App.webview.execScript(function(msg) {
      console.log(msg);
    }, 'hello');
    // 执行当前页面中的console.log方法在控制台中打印 'width: 100, height:100''
    App.webview.execScript(function(size) {
      console.log('width: ' + size.width + ", " + "height: " +  size.height);
    }, {width:100, height:300});


   // 将参数传入页面沙箱计算并出沙箱接受
  var msg = App.webview.execScript(function(size) {
      return 'width: ' + size.width + ", " + "height: " +  size.height;
    }, {width:100, height:300});
  if (msg)
    ......

特别注意: 页面沙箱内所实现的 JS 内置对象会超出 ECMAScript 5th 规范设定范围。请避免在传出沙箱时使用:ArrayBuffer Uint8Array DataView Float32Array Int8Array Int16Array Int32Array Uint8Array Uint16Array Uint32Array 等扩展的内置对象。他们在页面沙箱内存在而APP 脚本沙箱中没有被实现。


App.webview.setPageZoom(zoom <number>)

参数: zoom <number> 页面缩放级别数字,支持浮点数。

返回值: <boolean> 成功设置返回 true,反之返回 false。

说明: 此函数用于指定页面缩放界别。


App.webview.pageZoom()

返回值: <number> 当前页面缩放级别数字,默认为 1。

说明: 检测当前页面缩放级别。


App.webview.setPageScroll(point <Object>)

参数: point 数据格式必须为 {top: <number>, left: <number>},top 或 left 未设置时默认值为 0。

返回值: <boolean> 成功设置返回 true,反之返回 false。

说明: 此函数用于设置页面滚动条位置,如 setPageScroll({top: 100, left: 0}),将会使页面滚动条定位到距离顶部 100 px 位置。


App.webview.pageScroll()

返回值: <Object> 格式为 {top: <number>, left: <number>},表示页面滚动条距离页面顶部和左部的距离。

说明: 此函数用于检测页面滚动条位置。


App.webview.setPageHTML(html <string>)

参数: html <string> html格式的字符串。

返回值: <boolean> 成功设置返回 true,反之返回 false。

说明: 此函数用于设置全页的html内容。


App.webview.pageHTML()

返回值: <string> 页面的全部 HTML 字符串。

说明: 返回整页的 HTML 字符串。


App.webview.pageText()

返回值: <string> 页面的全部文本字符串(不含HTML标记)。

说明: 返回整页的文本字符串内容,如同 DOM 的 textContent 属性。


App.webview.setUploadFile(cssSelectorString <string>, path <string>[, index <number>])

参数:

cssSelectorString <string> 一个可用的 Selector 选择器字符串,用它来选择指定的 <input type="file"> 节点。如果该 Selector 将返回多个 node ,那么具体使用列表中哪个 node 将由第三个参数 index 值来决定。

path <string> 一个可用的待上传本地文件路径。

index <number>非必须参数,默认值为 0,它用于指定 Selector 选择的 nodeList 中具体索引项值。该值小于0时会为0,大于 Selector 返回 nodeList 长度值是会为最大长度值。


返回值: <boolean> 成功设置返回 true,反之返回 false。

说明: 此函数用于为指定文件域 (<input type="file">) 设置上传文件内容。

【注意】:为了实现此功能,GUI 模式下页面的文件域将无法通过手动点击打开文件选择对话框。


App.webview.setMaxPagesInCache(num <number>)

参数: num <number> 设置缓存页数值。

返回值: <boolean> 成功设置返回 true,反之返回 false。

说明: 此函数用于设置 webview 可在内存缓存的页面数。


App.webview.maxPagesInCache()

返回值: <number> webview 已被设置的内存缓存页面数

说明: 此函数用于查看 webview 被设置在内存的缓存页面数。


App.webview.clearAllPagesInCache()

返回值: <boolean> 成功返回 true,反之返回 false。

说明: 此函数用于清除 webview 所有内存缓存的页面数据(同浏览器清除缓存的页面数据功能)。


console 命名空间下函数与属性

为保留基于浏览器开的前端开发者习惯,在 Globla 中创建的控制台相关方法。


console .log(arg1, [arg2, arg3, arg4, ...])

参数: arg1, [arg2, arg3, arg4, ...] 参数类型不限,所有参数将被 ToString 后返回

返回值:

说明: 此方法是 App 的 console.log 方法,并非 App.helper.log 包装的浏览器内 console.log 方法。 该方法将预期用来做 JS 代码调试输出。


console .dir(arg)

参数: arg 参数类型不限,为需要打印说有方法和属性的数据内容。

返回值:

说明: 将一个对象的所有方法和属性通过 console.log 功能打印出来,如果对象多层嵌套仅递归 5 层

console .time(flag <string>)

参数: flag <string>,时间戳标识。

返回值:

说明: 此方法与 console .timeEnd 方法配对使用,用于检测同一时间标识中 console .time 与 console .timeEnd 执行之间所差间隔。


console .timeEnd(flag <string>)

参数: flag <string>,时间戳标识。

返回值: 时间间隔毫秒数。

说明: 此方法与 console .time 方法配对使用,用于检测同一时间标识中 console .time 与 console .timeEnd 执行之间所差间隔。

例如:

console.time('flag');
setTimeout(function() {
  console.timeEnd('flag');
}, 2000);

// 输出 flag: 2003ms

__pageExtension 页面扩展对象

该对象在页面被创建初始被扩展到页面中 (pageScriptCreated事件触发时)。在此命名空间下,存放页面与 App 交互用特殊处理函数。


__pageExtension.postMessage([wparam <Object|string|number>, lparam <Object|string|number>])

参数:

wparam <Object|string|number> 可选参数。用来附加特定消息,通常用于发送消息内容。

lparam<Object|string|number> 可选参数。用来附加特定消息,通常用来发送消息辨别数据。

返回值:

说明:此方法在页面中被使用,该方法触发时,如果App中存在 message 事件监听,则会触发监听回调函数。通常 wparam 和 lparam 参数通常用来标示消息字符串和消息辅助辨别信息,它们具体使用方式由用户确定。 wparam 和 lparam 参数还可以私用 JSON 数据,它们会被序列化后发送给 message 事件监听函数,监听函数获取消息后会自动反序列化数据。

例如:

App.webview.addEventListener('message', function(w, l) {
  if ('page' == l.b) {
    App.webview.execScript(function(msg) {
      // 显示 "this is a message" 信息。
      console.log(msg.a);
    }, w);
  }
});

App.webview.execScript(function(s) {
  __pageExtension.postMessage({a:"hello world"}, {b:"page"});
});

__pageExtension.cpu()

参数:

返回值: number 类型,表示当前工具中运行的页面 CPU 占用率。

说明: 此方法会在页面脚本沙箱中跨沙箱调用 App.cpu 获取当前进程的 CPU 占用率。

__pageExtension.memory()

参数:

返回值: number 类型,表示当前工具占用的内存值,单位 KB。

说明: 此方法会在页面脚本沙箱中跨沙箱调用 App.memory 方法获取当前进程的内存占用量。

App.helper 命名空间下函数

App.helper 命名空间是转配在 config.js 配置文件的 global 项中,它将在配置初始化时候被装配到 App 命名空间下供使用者调用。此空间中工具函数可由使用者不断添加。


App.helper.supplant(template<string>, data <Object>)

参数:

template<string> 一个字符串模板 使用 ${key} 字符作为占位符,其中 key 对应 data 参数对象的同名 key 值。

data <Object> 模板所要提供的数据,是个一维的简单对象。

返回值: <string> 组装后的字符串

说明: 最为简单的字符串替换模板函数。如模板 "${hello},我是${name}" 配合数据对象 {hello:"吃了么您", name:"小明"},将会输出字符串 "吃了么您,,我是小明"。


App.helper.require(moduleName<string>[, args <Array>])

参数:

moduleName<string> 模块名,指定为 App 的 module 目录下 js 模块文件名 (不需要 ".js" 扩展名)。

args <Array> 可选参数。模块所需的执行参数。

返回值: 模块执行的返回值

说明: 此方法是对 App.loadScript 方法的包装,使其实用简单化。


App.helper.log(msg <string>|<number>)

参数: msg <string>|<number> log 内容

返回值:

说明: 此方法是对 App.webview.execScript 方法的包装,简易调用页面中的 console.log 方法,在页面控制台中输出内容。


END