GeoIP-lite 技术文档

1. 安装指南

GeoIP-lite 是一个基于 NodeJS 的本地 API，用于 MaxMind 提供的 GeoLite 数据。在开始使用之前，需要按照以下步骤安装：

$ npm install geoip-lite

注意：安装后必须更新数据文件。MaxMind 的许可不允许我们随包分发最新版的数据文件。请遵循以下 更新数据文件 的说明进行操作。

2. 使用说明

GeoIP-lite 提供了一个完全用 JavaScript 实现的 MaxMind GeoIP API。以下是一个简单的使用示例：

var geoip = require('geoip-lite');

var ip = "207.97.227.239";
var geo = geoip.lookup(ip);

console.log(geo);

以上代码将输出 IP 地址 207.97.227.239 对应的地理位置信息。

3. 项目 API 使用文档

GeoIP-lite 提供了一个简单的 API 用于 IP 地址查询：

查询 IP 地址

如果你有一个点分十进制格式的 IP 地址、IPv6 冒号分隔格式，或者一个 32 位无符号整数（作为 IPv4 地址处理），可以将其传递给 lookup 方法。注意，你应该在传递给此方法之前去除 IPv6 地址周围的 [ 和 ]。

var geo = geoip.lookup(ip);

如果找到了 IP 地址，lookup 方法会返回以下结构的对象：

{
   range: [ <IP段低界>, <IP段高界> ],
   country: 'XX',                 // 2 字符 ISO-3166-1 国家代码
   region: 'RR',                  // 至多 3 个字符长度的 ISO 3166-2 代码
   eu: '0',                       // 如果国家是欧盟成员国则为 1，否则为 0
   timezone: '国家/时区',          // 来自 IANA 时区数据库的时区
   city: "城市名",                // 完整的城市名称
   ll: [<纬度>, <经度>],           // 城市的纬度和经度
   metro: <地铁代码>,             // 地铁代码
   area: <精确半径>              // 约略的精确半径（公里），围绕纬度和经度
}

如果未找到 IP 地址，lookup 返回 null。

###美化打印 IP 地址

如果你有一个 32 位无符号整数或者 lookup 方法返回的 range 数组中的数字，可以使用 pretty 方法将其转换为人类可读的字符串。

console.log("IP地址是 %s", geoip.pretty(ip));

此方法如果输入格式为 geoip-lite 可以识别的，则返回字符串，否则返回输入本身。

4. 项目安装方式

项目的安装方式已在 安装指南 中说明。简要概括，就是通过 npm 安装 geoip-lite 包。

在安装后，为了使数据生效，需要更新数据文件。更新方式请参考 更新数据文件-可选 一节。

以上就是 GeoIP-lite 的技术文档，包含了安装、使用、API 文档以及安装方式的详细说明。