Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

lib-qqwry

cnwhy1.3kBSD1.3.4TypeScript support: included

Using NodeJS analytical IP Library (qqwry.dat) module.

qqwry, 纯真IP库, IP地址

readme

lib-qqwry

lib-qqwry是一个高效纯真IP库(qqwry.dat)引擎;

安装

npm i lib-qqwry

使用

cli (v1.3.0+)

从1.3版本开始支持命令模式, 你可以用把lib-qqwry安装到全局来使用; search

  • qqwry search <ip> [ips...] 查询IP/IP段
  • qqwry find <keyword> [keyword...] 反查IP段

node

var libqqwry = require('lib-qqwry');
var qqwry = libqqwry() //初始化IP库解析器
qqwry.speed(); //启用急速模式;

var ip1 = qqwry.searchIP("202.103.102.10"); //查询IP信息
var ips = qqwry.searchIPScope("0.0.0.0","1.0.0.0");  //查询IP段信息
//异步查询IP段信息
qqwry.searchIPScope("0.0.0.0","1.0.0.0",function(err,iparr){
  console.log(iparr);
});
//查询IP段信息,结果以可读流返回
var ipStream = qqwry.searchIPScopeStream('0.0.0.0','1.0.0.0',{format:'json'});
// s.pipe(fs.readFileSync(outFile))
ipStream.pipe(process.stdout)

API

libqqwry.ipToInt(IP) IP地址转数值

> libqqwry.ipToInt("255.255.255.255")
4294967295

libqqwry.intToIP(INT) 数值转IP地址

> libqqwry.intToIP(4294967295)
'255.255.255.255'

libqqwry.ipEndianChange(INT) 字节序转换

按32位转换参数的字节序
一些云平台的环境变量中IP信息可能是Little-Endian形式的数值;

> libqqwry.ipEndianChange(0x010000FF)
4278190081 //0xFF000001

new libqqwry(speed,dataPath) 实例化一个IP库解析器对像(Qqwry)

speed : 是否开启急速模式,可选; //默认false;
dataPath : IP库路径,可选; //默认路径为data文件夹中(__dirname + "/data/qqwry.dat"); // 可以简写为 libqqwry(speed,dataPath)

var libqqwry = require('lib-qqwry');
var qqwry = libqqwry(true);

libqqwry(), libqqwry.init() 功能相同

解析器对像 Qqwry

qqwry.searchIP(IP) 单个IP查询

IP : IP地址/IP数值

便捷调用: qqwry(IP) v1.2.0+

> qqwry("255.255.255.255");
{ int: 4294967295,
  ip: '255.255.255.255',
  Country: '纯真网络',
  Area: '2017年1月5日IP数据' }

qqwry.searchIPScope(beginIP,endIP,[callback]) IP段查询

beginIP : 启始IP
endIP : 结束IP
callback: function(err,arrdata){} 没有回调则使用同步查询;

便捷调用: qqwry(beginIP,endIP,callback) v1.2.0+

> qqwry("8.8.8.0","8.8.8.8");
[ { begInt: 134744064,
    endInt: 134744071,
    begIP: '8.8.8.0',
    endIP: '8.8.8.7',
    Country: '美国',
    Area: '加利福尼亚州圣克拉拉县山景市谷歌公司' },
  { begInt: 134744072,
    endInt: 134744072,
    begIP: '8.8.8.8',
    endIP: '8.8.8.8',
    Country: '美国',
    Area: '加利福尼亚州圣克拉拉县山景市谷歌公司DNS服务器' } ]

qqwry.searchIPScopeStream(beginIP,endIP,options) 流形式反回IP段结果 v1.3.0+

beginIP : <string|int> // 启始IP
endIP : <string|int> // 结束IP
options:

  • format : <string> //输出格式, 支持 'text' , 'csv', 'json', 'object'
  • outHeader: <boolean> //为true时 'csv' 会输出表头 , 'json' 会以对像数组形式输出(参考searchIPScope方法); 默认 false

流模式适合查询结果数据量较大的情况使用
format说明: 'csv' , 'json' 格式适合直接输出到文件, 'object' 将返回对像流, 适合程序二次处理数据

> qqwry.searchIPScopeStream("8.8.8.0","8.8.8.8").pipe(process.stdout);
8.8.8.0 - 8.8.8.7                   美国 加利福尼亚州圣克拉拉县山景市谷歌公司
8.8.8.8 - 8.8.8.8                   美国 加利福尼亚州圣克拉拉县山景市谷歌公司DNS服务器

> qqwry.searchIPScopeStream("8.8.8.0","8.8.8.8",{format:'csv'}).pipe(process.stdout);
134744064,134744071,8.8.8.0,8.8.8.7,美国,加利福尼亚州圣克拉拉县山景市谷歌公司
134744072,134744072,8.8.8.8,8.8.8.8,美国,加利福尼亚州圣克拉拉县山景市谷歌公司DNS服务器

> qqwry.searchIPScopeStream("8.8.8.0","8.8.8.8",{format:'json'}).pipe(process.stdout);
[[134744064,134744071,"8.8.8.0","8.8.8.7","美国","加利福尼亚州圣克拉拉县山景市谷歌公司"],[134744072,134744072,"8.8.8.8","8.8.8.8","美国","加利福尼亚州圣克拉拉县山景市谷歌公司DNS服务器"]]

qqwry.speed() 启用急速模式

急速模式实质为将IP库文件读入内存中以提升效率.

qqwry.unSpeed() 停用急速模式

changelog

1.3.0 / 2019-07-02

  • 修复 find 指令的 -c 参数
  • 优化 update 提示
  • format 代码

1.3.0 / 2019-03-12

  • 修复在普通模式下,某些情况会丢失文件描述符的问题.
  • 新增返回流API qqwry.searchIPScopeStream
  • 新增 cli 命令模式
    • qqwry search <ip> [ips...] 查询IP/IP段
    • qqwry find <keyword> [keyword...] 反查IP段
    • qqwry update [dataPath] 从纯真官网更新IP库文件

1.2.0 / 2019-02-22

  • 封装修改构建函数, 返回一个封装好的函数
    • 弱化API 支持 新的对像支持 qqwry(ip), qqwry(ipBgin,ipEnd), qqwry(ipBgin,ipEnd,callback)
    • 隐藏不必要的属性;
    • 绑定API函数上下文, 方便ES6解构赋值方式
  • 更新IP库2019年2月20日

1.1.0 / 2018-09-19

  • 修复某些情况文件描述符占用问题
  • 调整两模式切换设计,效率提高20%

1.0.2 / 2017-06-26

  • 解决.init()方法不能指定自定义IP库的bug

1.0.1 / 2017-01-09

  • 更新IP库到2017.1.5号

1.0.0 / 2015-12-23

  • 优化代码,效率提高30%
  • API修改 以类型式实现
  • 更新IP库到2015.12.20号

0.0.6 / 2015-05-30

  • 更新IP库到2015.5.30号

0.0.5 / 2014-09-28

  • 新版node(v0.10.32+)边界IP查询产生的BUG;
  • 增加一个unInfo方法;

0.0.4 / 2014-08-14

  • 修正了一些BUG;
  • 更新默认IP库到最新;
  • 调整目录结构;

0.0.3 / 2013-09-17

  • 增了一个IP数值的字节序转换方法;
  • 增加dbug模式,见说明文档;
  • 去掉了让人厌烦的控制台提示,现在只有在dbug模式下才会出现console信息;
  • 未初始化查询将抛出错误;

0.0.2 / 2013-06-19

  • 优化加载模块速度

0.0.1 / 2013-06-18

  • 最初版本