ReadMe for basic usage

2025-12-08 19:25:22 +00:00 · 2025-10-13 18:06:54 +08:00 · 2025-10-13 18:06:54 +08:00 · 9959117d92
commit 9959117d92
parent 3cab1bae2e
4 changed files with 214 additions and 18 deletions
--- a/binding/java/ReadMe.md
+++ b/binding/java/ReadMe.md
@ -126,14 +126,14 @@ public class SearcherTest {
        // 4、关闭资源
        searcher.close();

-        // 备注：每个线程需要单独创建一个独立的 Searcher 对象，但是都共享全局的制度 vIndex 缓存。
+        // 备注：每个线程需要单独创建一个独立的 Searcher 对象，但是都共享全局的只读 vIndex 缓存。
    }
 }
 ```

 ### 缓存整个 `xdb` 数据

-我们也可以预先加载整个 ip2region.xdb 的数据到内存，然后基于这个数据创建查询对象来实现完全基于文件的查询，类似之前的 memory search。
+我们也可以预先加载整个 xdb 文件的数据到内存，然后基于这个数据创建查询对象来实现完全基于文件的查询，类似之前的 memory search。
 ```java
 import org.lionsoul.ip2region.xdb.Searcher;
 import java.io.*;
--- a/binding/javascript/ReadMe.md
+++ b/binding/javascript/ReadMe.md
@ -0,0 +1,184 @@
+# ip2region xdb javascript 查询客户端实现
+
+# 使用方式
+
+### 关于 IPv4 和 IPv6
+该 xdb 查询客户端实现同时支持对 IPv4 和 IPv6 的查询，使用方式如下：
+```javascript
+import {IPv4, IPv6} from './index.js';
+
+// 如果是 IPv4: 设置 xdb 路径为 v4 的 xdb 文件，IP版本指定为 Version.IPv4
+let dbPath  = "../../data/ip2region_v4.xdb";  // 或者你的 ipv4 xdb 的路径
+let version = IPv4;
+
+// 如果是 IPv6: 设置 xdb 路径为 v6 的 xdb 文件，IP版本指定为 Version.IPv6
+let dbPath  = "../../data/ip2region_v6.xdb";  // 或者你的 ipv6 xdb 路径
+let version = IPv6;
+
+// dbPath 指定的 xdb 的 IP 版本必须和 version 指定的一致，不然查询执行的时候会报错
+// 备注：以下演示直接使用 dbPath 和 version 变量
+```
+
+### 文件验证
+建议您主动去验证 xdb 文件的适用性，因为后期的一些新功能可能会导致目前的 Searcher 版本无法适用你使用的 xdb 文件，验证可以避免运行过程中的一些不可预测的错误。 你不需要每次都去验证，例如在服务启动的时候，或者手动调用命令验证确认版本匹配即可，不要在每次创建的 Searcher 的时候运行验证，这样会影响查询的响应速度，尤其是高并发的使用场景。
+```javascript
+import verifyFomFile from './index.js';
+
+try {
+    verifyFromFile(dbPath);
+} catch (e) {
+    // 适用性验证失败！！！
+    // 当前查询客户端实现不适用于 dbPath 指定的 xdb 文件的查询.
+    // 应该停止启动服务，使用合适的 xdb 文件或者升级到适合 dbPath 的 Searcher 实现。
+    return;
+}
+
+// 验证通过，当前使用的 Searcher 可以安全的用于对 dbPath 指向的 xdb 的查询操作
+```
+
+### 完全基于文件的查询
+
+```javascript
+import {newWithFileOnly} from './index.js';
+
+// 1，使用上述的 version 和 dbPath 创建完全基于文件的查询对象
+let searcher;
+try {
+    searcher = newWithFileOnly(version, dbPath);
+} catch(e) {
+    console.log(`failed to newWithFileOnly: ${err.message}`);
+    return;
+}
+
+
+// 2、查询，IPv4 或者 IPv6 的地址都是同一个接口
+let ip = "1.2.3.4";
+// ip = "2001:4:112:ffff:ffff:ffff:ffff:ffff";  // IPv6
+try {
+    let region = searcher.search(ip);
+    console.log(`search(${ip}): {region: ${region}, ioCount: ${searcher.getIOCount()}}`);
+} catch(e) {
+    console.log(`${err.message}`);
+}
+
+// 3、关闭资源
+searcher.close();
+
+// 备注：每个线程需要单独创建一个独立的 Searcher 对象，但是都共享全局的制度 vIndex 缓存。
+```
+
+### 缓存 `VectorIndex` 索引
+
+我们可以提前从 `xdb` 文件中加载出来 `VectorIndex` 数据，然后全局缓存，每次创建 Searcher 对象的时候使用全局的 VectorIndex 缓存可以减少一次固定的 IO 操作，从而加速查询，减少 IO 压力。
+```javascript
+import {loadVectorIndexFromFile, newWithVectorIndex} from './index.js';
+
+// 1、从 dbPath 中预先加载 VectorIndex 缓存，并且把这个得到的数据作为全局变量，后续反复使用。
+let vIndex;
+try {
+    vIndex = loadVectorIndexFromFile(dbPath);
+} catch (e) {
+    console.log(`failed to load vector index from ${dbPath}: ${e.message}`);
+    return;
+}
+
+// 2、使用全局的 vIndex 创建带 VectorIndex 缓存的查询对象。
+let searcher;
+try {
+    searcher = newWithVectorIndex(version, vIndex, dbPath);
+} catch(e) {
+    console.log(`failed to newWithVectorIndex: ${err.message}`);
+    return;
+}
+
+
+// 3、查询，IPv4 或者 IPv6 的地址都是同一个接口
+let ip = "1.2.3.4";
+// ip = "2001:4:112:ffff:ffff:ffff:ffff:ffff";  // IPv6
+try {
+    let region = searcher.search(ip);
+    console.log(`search(${ip}): {region: ${region}, ioCount: ${searcher.getIOCount()}}`);
+} catch(e) {
+    console.log(`${err.message}`);
+}
+
+// 4、关闭资源
+searcher.close();
+
+// 备注：每个线程需要单独创建一个独立的 Searcher 对象，但是都共享全局的只读 vIndex 缓存。
+```
+
+### 缓存整个 `xdb` 数据
+
+我们也可以预先加载整个 xdb 文件的数据到内存，然后基于这个数据创建查询对象来实现完全基于文件的查询，类似之前的 memory search。
+```javascript
+import {loadContentFromFile, newWithBuffer} from './index.js';
+
+// 1、从 dbPath 加载整个 xdb 到内存。
+let cBuffer;
+try {
+    cBuffer = loadContentFromFile(dbPath);
+} catch (e) {
+    console.log(`failed to load content from ${dbPath}: ${e.message}`);
+    return;
+}
+
+// 2、使用上述的 cBuff 创建一个完全基于内存的查询对象。
+let searcher;
+try {
+    searcher = newWithBuffer(version, cBuffer);
+} catch(e) {
+    console.log(`failed to newWithBuffer: ${err.message}`);
+    return;
+}
+
+// 3、查询，IPv4 或者 IPv6 的地址都是同一个接口
+let ip = "1.2.3.4";
+// ip = "2001:4:112:ffff:ffff:ffff:ffff:ffff";  // IPv6
+try {
+    let region = searcher.search(ip);
+    console.log(`search(${ip}): {region: ${region}`);
+} catch(e) {
+    console.log(`${err.message}`);
+}
+        
+// 4、关闭资源 - 该 searcher 对象可以安全用于并发，等整个服务关闭的时候再关闭 searcher
+// searcher.close();
+
+// 备注：并发使用，用整个 xdb 数据缓存创建的查询对象可以安全的用于并发，也就是你可以把这个 searcher 对象做成全局对象去跨线程访问。
+```
+
+
+# 查询测试
+
+可以通过 `` 命令来测试查询：
+```bash
+```
+
+例如：使用默认的 data/ip2region_v4.xdb 文件进行 IPv4 的查询测试：
+```bash
+```
+
+例如：使用默认的 data/ip2region_v6.xdb 文件进行 IPv6 的查询测试：
+```bash
+```
+
+输入 ip 即可进行查询测试，也可以分别设置 `cache-policy` 为 file/vectorIndex/content 来测试三种不同缓存实现的查询效果。
+
+
+# bench 测试
+
+可以通过 `` 命令来进行 bench 测试，一方面确保 `xdb` 文件没有错误，一方面可以评估查询性能：
+```bash
+```
+
+例如：通过默认的 data/ip2region_v4.xdb 和 data/ipv4_source.txt 文件进行 IPv4 的 bench 测试：
+```bash
+```
+
+例如：通过默认的 data/ip2region_v6.xdb 和 data/ipv6_source.txt 文件进行 IPv6 的 bench 测试：
+```bash
+```
+
+可以通过分别设置 `cache-policy` 为 file/vectorIndex/content 来测试三种不同缓存实现的效果。
+@Note: 注意 bench 使用的 src 文件要是生成对应 xdb 文件相同的源文件。
--- a/binding/javascript/tests/search.test.js
+++ b/binding/javascript/tests/search.test.js
@ -32,24 +32,30 @@ test('ipv4 search test', async () => {
            console.log(`${err.message}`);
        });
    }
+
+    // close searcher
+    searcher.close();
 });

 test('ipv6 search test', async () => {
-        let searcher = newWithFileOnly(IPv6, dbPath.v6);
-        let ip_list  = [
-            '2a02:26f7:c409:4001::',
-            parseIP('2a11:8080:200::a:a05c'),
-            '240e:3b7::',
-            '120.229.45.92'
-        ];
+    let searcher = newWithFileOnly(IPv6, dbPath.v6);
+    let ip_list  = [
+        '2a02:26f7:c409:4001::',
+        parseIP('2a11:8080:200::a:a05c'),
+        '240e:3b7::',
+        '120.229.45.92'
+    ];

-        for (var i = 0; i < ip_list.length; i++) {
-            let ip = ip_list[i];
-            searcher.search(ip).then((region)=>{
-                let ipStr = Buffer.isBuffer(ip) ? ipToString(ip) : ip;
-                console.log(`search(${ipStr}): {region: ${region}, ioCount: ${searcher.getIOCount()}}`);
-            }).catch((err) => {
-                console.log(`${err.message}`);
-            });
-        }
+    for (var i = 0; i < ip_list.length; i++) {
+        let ip = ip_list[i];
+        searcher.search(ip).then((region)=>{
+            let ipStr = Buffer.isBuffer(ip) ? ipToString(ip) : ip;
+            console.log(`search(${ipStr}): {region: ${region}, ioCount: ${searcher.getIOCount()}}`);
+        }).catch((err) => {
+            console.log(`${err.message}`);
+        });
+    }
+
+    // close searcher
+    searcher.close();
 });
--- a/binding/javascript/tests/searcher.test.js
+++ b/binding/javascript/tests/searcher.test.js
@ -45,6 +45,9 @@ test('ipv4 searcher test', async () => {
            }
            bRegion = region;
            console.log(`${meta[0]}.search(${ip_Str}): ${region}`);
+
+            // searcher close
+            meta[1].close();
        }
    } catch (e) {
        console.error(`${e.message}`);
@ -64,6 +67,9 @@ test('ipv6 searcher test', async () => {
            }
            bRegion = region;
            console.log(`${meta[0]}.search(${ip_Str}): ${region}`);
+
+            // searcher close
+            meta[1].close();
        }
    } catch (e) {
        console.error(`${e.message}`);