教你开发whistle插件

whistle介绍

whistle是一款用Node实现的跨平台的Web调试代理工具,支持查看修改http(s)、Websocket连接的请求和响应内容。IMWEB团队avenwu作品。github地址:https://github.com/avwo/whistle

whistle安装启动

1、安装whistle

    npm install -g whistle

2、 启动whistle

    w2 start  // 启动whistle
    w2 restart  // 重启whsitle
    w2 run  // 调试模式启动whistle

3、 在浏览器中访问

(1)域名访问 http://local.whistlejs.com/ (2)通过ip+端口来访问,例如: http://127.0.0.1:8899

whistle插件开发

现在想做一个基于whistle的查看请求参数的插件,并将参数以表格的形式展示在页面上

插件命名规范

whistle插件本身就是一个普通的Node模块,只是名字要按照whistle.xxx的形式命名,其中xxx指插件的名称且只能包含小写字母、数字、_、-四种字符,如:whistle.tdw,而xxx就是扩展的协议,可以直接在Rules里面配置使用

插件目录结构

whistle.tdw
    |__ package.json
    |__ rules.txt
    |__ index.js
    |__ lib
          |__ ui-server.js
          |__ plugin-server.js

index.js提供whistle暴露给开发者的接口

// index.js 
var initPluginServer = require('./lib/plugin-server');
var initUIServer = require('./lib/ui-server');

exports.statsServer = function(server, options) {
    initPluginServer(server, options);
};

exports.uiServer = function(server, options) {  
    initUIServer(server, options);  
};

statsServer : 处理请求的server,可以做请求合并等,返回的数据就是请求的响应数据, 如上: options 包含一些自定义的头部字段名称及配置信息

    {

          name: // 插件的名称,
          RULE_VALUE_HEADER: // 存储配置的规则值的请求头字段,
          SSL_FLAG_HEADER: // 判断是否为HTTPS请求的请求头字段,
          FULL_URL_HEADER: // 存储请求完整url的请求头字段,
          REAL_URL_HEADER: // 存储配置映射到url的请求头字段,
          NEXT_RULE_HEADER: // 存储配置的下个规则(第一规则为插件)的请求头字段,
          REQ_ID_HEADER: // 请求的id,可以用于区分响应和请求是否同一个,
          DATA_ID_HEADER: // 数据包对应的id,不一定存在,
          STATUS_CODE_HEADER: // 配置的响应状态码,
          LOCAL_HOST_HEADER: // 配置的hosts,
          HOST_PORT_HEADER: // 配置的端口,
          METHOD_HEADER: // 请求方法,
          debugMode: // 是否是通过w2 run启动的,
          config: // 包括whistle的端口号port等一系列whistle的配置,
          storage: //提供本地存储的接口,用法参  考:https://github.com/avwo/whistle/blob/master/lib/rules/util.js
      }

server是是whistle传给插件的http.Server对象,开发者通过监听server的相关事件处理whistle转发过来的请求

uiServer: local.whistlejs.com/whistle.xxx下的请求都会直接访问该server,可用于后台管理界面

插件调试

把本地node模块link到全局目录:

npm link 开启whistle的调试模式 $ w2 run 这样whistle会自动加载改插件,如果插件有代码更新,需要触发修改package.json这个文件,比如加个空格,或者直接加个字段,每次修改下这个字段,whistle会检查package.json是否有更改,如果更改的话会自动重启。

具体实现

//  lib/plugin-server.js

module.exports = function(server, options) {
    FULL_URL_HEADER = options.FULL_URL_HEADER;
    SSL_FLAG_HEADER = options.SSL_FLAG_HEADER;
    server.on('request', app);
    initHttpServer(app);
};

function initHttpServer(app) {
    app.use(function(req, res, next) {
        dataEvent.emit('data', {query: req.headers});
        res.end('');
    });
}

打开whistle,访问https://ke.qq.com , 在network界面上能看到很多的请求

通过statsServer接口,我们能获取这些请求。这里通过事件将获取到的请求传递到uiserver中

// ui-server.js

module.exports = function(server, options) {
    FULL_URL_HEADER = options.FULL_URL_HEADER;
    server.on('request', app);
    var io = require('socket.io')(server);
    initHttpServer(app);
    initWSServer(io);
};

function initHttpServer(app) {
    app.get('/', function(req, res) {
        res.sendFile(path.join(htdocs, 'index.html'));
    });

    app.get('/js/*', function(req, res) {
        res.sendFile(path.join(htdocs, 'js/index.js'));
    });
}

function initWSServer(io) {
    io.on('connection', function (socket) {
        dataEvent.on('data', function(data) {
            socket.emit('data', getUrl(data));
        });
    });
}

在浏览器中访问http://local.whistlejs.com/whistle.tdw ,请求会直接访问uiServer ,如上, uiServer处理请求,返回给浏览器相关的资源文件,展示界面。现在想实时的在页面上展示请求的链接参数,选择socket.io来实现 。 服务端与客户端建立链接,将statsServer传输过来的数据,推给浏览器展示。

客户端js:

// js/index.js
var io = require('socket.io-client');
var socket = io({
  path: '/whistle.tdw/socket.io'
});

socket.on('data', function(data) {
      var list = self.state.list;
      list.unshift(decodeReport(data));
      self.setState({
          list: list
      });
  });

结果

访问: http://local.whistlejs.com/whistle.tdw ,页面展示

插件发布

同发布正常的node模块,模块编写完毕, 通过 npm publish 发布

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

在Docker中开发Java 8 Spring Boot应用程序

在本文中,我将向您展示如何使用Java 8开发和运行简单的Spring Web应用程序,而无需在本地计算机上安装Java 8。

1807
来自专栏bboysoul

ubuntu安装sql-server

微软在2016年宣布sqlserver支持linux,目前支持在docker,ubuntu,,centos,suse上安装,安装过程也很简单,就是添加软件源然后...

634
来自专栏黑白安全

weevely用法

Weevely是一款python编写的webshell管理工具,作为编写语言使用python的一款工具,它最大的优点就在于跨平台,可以在任何安装过python的...

813
来自专栏ytkah

wordpress无法安装这个包。: PCLZIP_ERR_MISSING_FILE (-4) : Missing archive file 'C:\WINDOWS\TEMP/wordpress-4.

朋友的wp博客好久没管理了,让ytkah帮忙打理一下,进到后台发现版本还是3.9的,那是比较早以前的版本了,早该升级了。 在升级wordpress时出现以下错误...

3008
来自专栏林德熙的博客

win10 uwp win2d 入门 看这一篇就够了

本文主要翻译,可能带有一定的主观性和局限性,说的东西可能不对或者不符合每个人的预期。如果觉得我有讲的不对的,就多多包含,或者直接关掉这篇文章,但是请勿生气或者发...

442
来自专栏nimomeng的自我进阶

基于Jenkins的CocoaPods化iOS项目构建+蒲公英/FIR系统发布

本文以本地和Git为例,结合CocoaPods,简单介绍了如何用jenkins来进行CI编译并上传蒲公英和Fir生成相应二维码的流程。

643
来自专栏Java学习123

忘记oracle的sys用户密码怎么修改

2675
来自专栏自由而无用的灵魂的碎碎念

Mac快速上手指南

上周刚入手了2017版MacBookPro,预装macOS High Sierra。第一次接触Mac系统,经过一周的使用,简单总结下与Windows相比最常用的...

993
来自专栏张戈的专栏

DX-watermark插件无法预览及上传图片报imagesx()错误的解决办法

本文重新更新编辑于:2014 年 6 月 8 日 0 时 40 分. 这篇文章还是在 2014 年 2 月 12 日发布的,旧标题为:《不明问题让我折腾了一天!...

3296
来自专栏DeveWork

WordPress 网站基于REST API 开发“微信小程序”实战

几周前,Jeff 花了两天将自己的WordPress 网站做了个微信小程序版本。这篇文章主要记录自己在开发第一版的过程,顺便为有兴趣的你剖析如何将一个WordP...

2866

扫码关注云+社区