lionsoul2014 · RocherKong · Apr 14, 2017 · Apr 14, 2017 · Apr 19, 2017 · May 25, 2017
diff --git a/.gitignore b/.gitignore
@@ -3,13 +3,44 @@
 *.o
 *.pyc
 *~
+*.log
+*.la
+*.so
 META-INF/
+
 # Binary Files #
 *.jar
 !dbMaker-*.jar
+
 # Package Files #
 .settings/
 .classpath
 .project
+
 # vim swp file #
 *.swp
+.idea
+
+# binding
+/binding/java/classes/
+/binding/java/doc/
+/binding/java/target/
+/binding/java/*.jar
+
+/binding/c/testSearcher
+
+# rust
+Cargo.lock
+target
+
+
+# VS ignore cases
+/**/*.sln
+/binding/c#/**/.vs/
+/binding/c#/**/packages
+/binding/c#/**/bin
+/binding/c#/**/obj
+
+# Nodejs
+/binding/nodejs/tests/unitTests/__snapshots__
+/binding/nodejs/coverage
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,3 +1,26 @@
+### 1.8
+1. 数据升级至2018/12/31的版本，国外的也增加了大量的城市数据。
+2. Java的binding的Searcher类增加了如下的接口和实现：
+```java
+DbSearcher(DbConfig dbConfig, string dbBinStr);
+```
+
+maven坐标：
+```xml
+<dependency>
+    <groupId>org.lionsoul</groupId>
+    <artifactId>ip2region</artifactId>
+    <version>1.7.2</version>
+</dependency>
+```
+
+3. Javascript的pacakge上传到了npm。
+4. 增加纯lua实现的lua binding (lua 5.2版本依赖bit模块，对5.3的支持将使用lua自带的bit操作)。
+5. 增加C实现的lua_c binding (和c的性能等同，建议使用)。
+6. 优化部分binding的demo运行和使用文档。
+7. 修复python binding的benchmark的部分错误。
+
+
 ### 1.2.4
 1, 花了近两周的时间重写了数据的升级算法，再次提高准确率，升级过程如下（此处应该有掌声）：
 

diff --git a/Cargo.toml b/Cargo.toml
@@ -0,0 +1,2 @@
+[workspace]
+members = ["binding/rust", "binding/rust/example"]
diff --git a/README.md b/README.md
@@ -1,75 +1,146 @@
-ip2region - 最自由的ip地址查询库，ip到地区的映射库，提供Binary,B树和纯内存三种查询算法，妈妈再也不用担心我的ip地址定位。
+# Ip2region是什么？ 
 
-**1. 99.9%准确率，定时更新：**
+ip2region - 准确率99.9%的离线IP地址定位库，0.0x毫秒级查询，ip2region.db数据库只有数MB，提供了java,php,c,python,nodejs,golang,c#等查询绑定和Binary,B树,内存三种查询算法。
 
-数据聚合了一些知名ip到地名查询提供商的数据，这些是他们官方的的准确率，经测试着实比纯真啥的准确多了。<br />
-每次聚合一下数据需要1-2天，会不定时更新。
 
-**2. 标准化的数据格式：**
 
-每条ip数据段都固定了格式：_城市Id|国家|区域|省份|城市|ISP_
 
-只有中国的数据精确到了城市，其他国家只能定位到国家，后前的选项全部是0，已经包含了全部你能查到的大大小小的国家。
-（请忽略前面的城市Id，个人项目需求）
+# Ip2region特性
 
-**3. 体积小：**
+### 99.9%准确率
 
-生成的数据库文件ip2region.db只有1.5M（1.2版本前是3.5M）
+数据聚合了一些知名ip到地名查询提供商的数据，这些是他们官方的的准确率，经测试着实比经典的纯真IP定位准确一些。<br />
+ip2region的数据聚合自以下服务商的开放API或者数据(升级程序每秒请求次数2到4次): <br />
+01, &gt;80%, 淘宝IP地址库, [http://ip.taobao.com/](http://ip.taobao.com/) <br />
+02, ≈10%, GeoIP, [https://geoip.com/](https://geoip.com/) <br />
+03, ≈2%, 纯真IP库, [http://www.cz88.net/](http://www.cz88.net/) <br />
+<b>备注：</b>如果上述开放API或者数据都不给开放数据时ip2region将停止数据的更新服务。
 
-**4. 多查询客户端的支持，0.0x毫秒级别的查询**
 
-已经集成的客户端有：java, php, c, python，nodejs，php扩展(支持linux, php5, php7版本已支持)，golang。
+### 标准化的数据格式
 
-    提供了两种查询算法，响应时间如下：
-    客户端/binary算法/b-tree算法/Memory算法：
-    java/0.x毫秒/0.x毫秒/0.1x毫秒 (使用RandomAccessFile)
-    php/0.x毫秒/0.1x毫秒/0.1x毫秒
-    c/0.0x毫秒/0.0x毫秒/0.00x毫秒(b-tree算法基本稳定在0.02x毫秒级别)
-    python/0.x毫秒/0.1x毫秒/未知
+每条ip数据段都固定了格式：
+```
+_城市Id|国家|区域|省份|城市|ISP_
+```
+
+只有中国的数据精确到了城市，其他国家有部分数据只能定位到国家，后前的选项全部是0，已经包含了全部你能查到的大大小小的国家（请忽略前面的城市Id，个人项目需求）。
+
+
+### 体积小
+
+包含了全部的IP，生成的数据库文件ip2region.db只有几MB，最小的版本只有1.5MB，随着数据的详细度增加数据库的大小也慢慢增大，目前还没超过8MB。
 
-任何客户端b-tree都比binary算法快，当然Memory算法固然是最快的！
 
-**5. 测试程序：**
-java: 
+### 查询速度快
 
-	cd binding/java
-	ant all
-	java -jar ip2region-{version}.jar ./data/ip2region.db
+全部的查询客户端单次查询都在0.x毫秒级别，内置了三种查询算法
 
-php: 
+1. memory算法：整个数据库全部载入内存，单次查询都在0.1x毫秒内，C语言的客户端单次查询在0.00x毫秒级别。
+2. binary算法：基于二分查找，基于ip2region.db文件，不需要载入内存，单次查询在0.x毫秒级别。
+3. b-tree算法：基于btree算法，基于ip2region.db文件，不需要载入内存，单词查询在0.x毫秒级别，比binary算法更快。
 
-    php binding/php/testSearcher ./data/ip2region.db
+任何客户端b-tree都比binary算法快，当然memory算法固然是最快的！
 
-c: 
 
-    cd binding/c/
-    gcc -g -O2 testSearcher.c ip2region.c
-    ./a.out ../../data/ip2region.db
+### 多查询客户端的支持
 
-python: 
+已经集成的客户端有：java、C#、php、c、python、nodejs、php扩展(php5和php7)、golang、rust、lua、lua_c, nginx。
 
-    python binding/python/testSearcher ./data/ip2region.db
+binding | 描述 | 开发状态 | binary查询耗时 | b-tree查询耗时 | memory查询耗时
+:-: | :-: | :-: | :-: | :-: | :-:
+[c](binding/c) | ANSC c binding | 已完成 | 0.0x毫秒 | 0.0x毫秒 | 0.00x毫秒
+[c#](binding/c%23) | c# binding | 已完成 | 0.x毫秒 | 0.x毫秒 | 0.1x毫秒
+[golang](binding/golang) | golang binding | 已完成 | 0.x毫秒 | 0.x毫秒 | 0.1x毫秒
+[java](binding/java) | java binding | 已完成 | 0.x毫秒 | 0.x毫秒 | 0.1x毫秒
+[lua](binding/lua) | lua实现的binding | 已完成 | 0.x毫秒 | 0.x毫秒 | 0.x毫秒
+[lua_c](binding/lua_c) | lua的c扩展      | 已完成 | 0.0x毫秒 | 0.0x毫秒 | 0.00x毫秒
+[nginx](binding/nginx) | nginx的c扩展 | 已完成 | 0.0x毫秒 | 0.0x毫秒 | 0.00x毫秒
+[nodejs](binding/nodejs) | nodejs | 已完成 | 0.x毫秒 | 0.x毫秒 | 0.1x毫秒
+[php](binding/php) | php实现的binding | 已完成 | 0.x毫秒 | 0.1x毫秒 | 0.1x毫秒
+[php5_ext](binding/php5_ext) | php5的c扩展 | 已完成 | 0.0x毫秒 | 0.0x毫秒 | 0.00x毫秒
+[php7_ext](binding/php7_ext) | php7的c扩展 | 已完成 | 0.0毫秒 | 0.0x毫秒 | 0.00x毫秒
+[python](binding/python) | python bindng | 已完成 | 0.x毫秒 | 0.x毫秒 | 0.x毫秒
+[rust](binding/rust) | rust binding | 已完成 | 0.x毫秒 | 0.x毫秒 | 0.x毫秒
 
-均会看到如下界面：
 
-    initializing  B-tree ... 
-    +----------------------------------+
-    | ip2region test script            |
-    | Author: [email protected]  |
-    | Type 'quit' to exit program      |
-    +----------------------------------+
-    p2region>> 101.105.35.57
-    2163|中国|华南|广东省|深圳市|鹏博士 in 0.02295 millseconds
 
-输入ip地址开始测试，第一次会稍微有点慢，在运行命令后面接入binary,memory来尝试其他算法，建议使用b-tree算法，速度和并发需求的可以使用memory算法。
 
-具体集成请参考不同客户端的测试源码。
+# ip2region快速测试
+
+请参考每个binding下的README说明去运行cli测试程序，例如C语言的demo运行如下：
+```shell
+cd binding/c/
+gcc -g -O2 testSearcher.c ip2region.c
+./a.out ../../data/ip2region.db
+```
+
+会看到如下cli界面：
+```shell
+initializing  B-tree ... 
++----------------------------------+
+| ip2region test script            |
+| Author: [email protected]  |
+| Type 'quit' to exit program      |
++----------------------------------+
+p2region>> 101.105.35.57
+2163|中国|华南|广东省|深圳市|鹏博士 in 0.02295 millseconds
+```
+
+输入IP地址开始测试，第一次会稍微有点慢，在运行命令后面接入binary,memory来尝试其他算法，建议使用b-tree算法，速度和并发需求的可以使用memory算法，具体集成请参考不同binding下的测试源码。
+
+
+
+
+# ip2region安装
+
+具体请参考每个binding下的README文档和测试demo，以下是一些可用的快捷安装方式：
+
+### maven仓库地址
+```xml
+<dependency>
+    <groupId>org.lionsoul</groupId>
+    <artifactId>ip2region</artifactId>
+    <version>1.7.2</version>
+</dependency>
+```
+
+### nodejs
+```
+npm install node-ip2region --save
+```
+
+### nuget安装
+```shell
+Install-Package IP2Region
+```
+
+### php composer
+```shell
+# 插件来自：https://github.com/zoujingli/ip2region
+composer require zoujingli/ip2region
+```
+
+
+
+# ip2region 并发使用
+
+1. 全部binding的各个search接口都<b>不是</b>线程安全的实现，不同线程可以通过创建不同的查询对象来使用，并发量很大的情况下，binary和b-tree算法可能会打开文件数过多的错误，请修改内核的最大允许打开文件数(fs.file-max=一个更高的值)，或者使用持久化的memory算法。
+
+2. memorySearch接口，在发布对象前进行一次预查询(本质上是把ip2region.db文件加载到内存)，可以安全用于多线程环境。
+
+
+
+
+# ip2region.db的生成
+
+从1.8版本开始，ip2region开源了ip2region.db生成程序的java实现，提供了ant编译支持，编译后会得到以下提到的dbMaker-{version}.jar，对于需要研究生成程序的或者更改自定义生成配置的请参考${ip2region_root}/maker/java内的java源码。
 
-**6. 如何生成ip2region.db文件**
 
 从ip2region 1.2.2版本开始里面提交了一个dbMaker-{version}.jar的可以执行jar文件，用它来完成这个工作：
-* 1, 确保你安装好了java环境（不玩Java的童鞋就自己谷歌找找拉，临时用一用，几分钟的事情）
-* 2, cd到ip2region的根目录，然后运行如下命令：
+
+1. 确保你安装好了java环境（不玩Java的童鞋就自己谷歌找找拉，临时用一用，几分钟的事情）
+2. cd到${ip2region_root}/maker/java，然后运行如下命令：
 
 ```shell
 java -jar dbMaker-{version}.jar -src 文本数据文件 -region 地域csv文件 [-dst 生成的ip2region.db文件的目录]
@@ -79,14 +150,24 @@ java -jar dbMaker-{version}.jar -src 文本数据文件 -region 地域csv文件
 # ip2region.db文件的目录：是可选参数，没有指定的话会在当前目录生成一份./data/ip2region.db文件
 ```
 
-* 3, 获取生成的ip2region.db文件覆盖原来的ip2region.db文件即可
-* 4, 默认的ip2region.db文件生成命令:
+3. 获取生成的ip2region.db文件覆盖原来的ip2region.db文件即可
+4. 默认的ip2region.db文件生成命令:
 
 ```shell
-cd ip2region项目根目录
+cd ${ip2region_root}/java/
 java -jar dbMaker-1.2.2.jar -src ./data/ip.merge.txt -region ./data/global_region.csv
 
 # 会看到一大片的输出
 ```
 
-* 5, 数据库文件的结构和原理请阅读 @冬芽 的blog：[“ip2region数据库文件的结构和原理”](http://dongyado.com/tools/2016/08/18/structure-of-ip2region-database-file/)
+
+
+
+# 相关备注
+
+### 声明 
+ip2region重点在于<b>研究IP数据的存储设计和各种语言的查询实现</b>，并没有原始IP数据的支撑，数据来源请参考上面的描述，升级数据需要很多IP的支撑并且会对原始平台造成一定量的请求压力，本项目不保证及时的数据更新，没有也不会有商用版本，你可以使用自定义的数据导入ip2region进行自定义查询的实现。
+
+### 技术交流
+1. 数据库文件的结构和原理请阅读 @冬芽 的blog：[“ip2region数据库文件的结构和原理”](https://github.com/dongyado/dongyado.github.io/blob/master/_posts/2016-08-18-structure-of-ip2region-database-file.md)
+2. ip2region交流分享，微信：lionsoul2014(请备注ip2region)，QQ：1187582057(很少关注)
diff --git a/binding/LabVIEW/BinarySearch.vi b/binding/LabVIEW/BinarySearch.vi
diff --git a/binding/LabVIEW/Close.vi b/binding/LabVIEW/Close.vi
diff --git a/binding/LabVIEW/Example.vi b/binding/LabVIEW/Example.vi
diff --git a/binding/LabVIEW/Get data.vi b/binding/LabVIEW/Get data.vi
diff --git a/binding/LabVIEW/Open.vi b/binding/LabVIEW/Open.vi
diff --git a/binding/LabVIEW/ip2region.ctl b/binding/LabVIEW/ip2region.ctl
diff --git a/binding/LabVIEW/ip2region.db b/binding/LabVIEW/ip2region.db
diff --git a/binding/LabVIEW/ip2region.lvlib b/binding/LabVIEW/ip2region.lvlib
@@ -0,0 +1,13 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<Library LVVersion="19008000">
+	<Property Name="NI.Lib.Icon" Type="Bin">'1#!!!!!!!)!"1!&amp;!!!-!%!!!@````]!!!!"!!%!!!(]!!!*Q(C=\&gt;7R=2MR%!81N=?"5Q&lt;/07RB7W!,&lt;'&amp;&lt;9+K1,7Q,&lt;)%N&lt;!NMA3X)DW?-RJ(JQ"I\%%Z,(@`BA#==ZB3RN;]28_,V7@PWW`:R`&gt;HV*SU_WE@\N_XF[3:^^TX\+2YP)D7K6;G-RV3P)R`ZS%=_]J'XP/5N&lt;XH,7V\SEJ?]Z#5P?=J4HP+5JTTFWS%0?=B$DD1G(R/.1==!IT.+D)`B':\B'2Z@9XC':XC':XBUC?%:HO%:HO&amp;R7QT0]!T0]!S0I4&lt;*&lt;)?=:XA-(]X40-X40-VDSGC?"GC4N9(&lt;)"D2,L;4ZGG?ZH%;T&gt;-]T&gt;-]T?.S.%`T.%`T.)^&lt;NF8J4@-YZ$S'C?)JHO)JHO)R&gt;"20]220]230[;*YCK=ASI2F=)1I.Z5/Z5PR&amp;)^@54T&amp;5TT&amp;5TQO&lt;5_INJ6Z;"[(H#&gt;ZEC&gt;ZEC&gt;Z$"(*ETT*ETT*9^B)HO2*HO2*(F.&amp;]C20]C2)GN4UE1:,.[:/+5A?0^NOS?UJ^3&lt;*\9B9GT@7JISVW7*NIFC&lt;)^:$D`5Q9TWE7)M@;V&amp;D,6;M29DVR]6#R],%GC47T9_/=@&gt;Z5V&gt;V57&gt;V5E&gt;V5(OV?^T[FTP?\`?YX7ZRP6\D=LH%_8S/U_E5R_-R$I&gt;$\0@\W/VW&lt;[_"\Y[X&amp;],0^^+,]T_J&gt;`J@_B_]'_.T`$KO.@I"XC-_N!!!!!!</Property>
+	<Property Name="NI.Lib.SourceVersion" Type="Int">419463168</Property>
+	<Property Name="NI.Lib.Version" Type="Str">1.0.0.0</Property>
+	<Property Name="NI.LV.All.SourceOnly" Type="Bool">false</Property>
+	<Item Name="binarySearch.vi" Type="VI" URL="../binarySearch.vi"/>
+	<Item Name="Close.vi" Type="VI" URL="../Close.vi"/>
+	<Item Name="example.vi" Type="VI" URL="../example.vi"/>
+	<Item Name="Get data.vi" Type="VI" URL="../Get data.vi"/>
+	<Item Name="ip2region.ctl" Type="VI" URL="../ip2region.ctl"/>
+	<Item Name="Open.vi" Type="VI" URL="../Open.vi"/>
+</Library>
diff --git a/binding/LabVIEW/readme.md b/binding/LabVIEW/readme.md
@@ -0,0 +1,7 @@
+ip2region的LabVIEW库<br>
+使用方法：1. 将该目录下的所有文件复制到你的项目文件夹下；<br>
+         2. 导入ip2region.lvlib库文件；<br>
+         3. 查看Example.vi，了解使用方法<br>
+         <br>
+         <br>
+注意：该库依赖ni_lib_unicode-2.0.1.5.vip，请使用VIPM安装。
diff --git a/binding/c#/IP2Region.Test.Benchmark/DbSearch_Test.cs b/binding/c#/IP2Region.Test.Benchmark/DbSearch_Test.cs
@@ -0,0 +1,54 @@
+using BenchmarkDotNet.Attributes;
+using IP2Region.Models;
+using System.Threading.Tasks;
+
+namespace IP2Region.Test.Benchmark
+{
+    [RankColumn]
+    public class DbSearch_Test : TestBase
+    {
+        private string RandomIP = "";
+
+        [Benchmark]
+        public DataBlock MemorySearch()
+        {
+            RandomIP = GetRandomIP();
+            return _search.MemorySearch(RandomIP);
+        }
+
+        [Benchmark]
+        public async Task<DataBlock> MemorySearch_Async()
+        {
+            RandomIP = GetRandomIP();
+            return await _search.MemorySearchAsync(RandomIP);
+        }
+
+        [Benchmark]
+        public DataBlock BinarySearch()
+        {
+            RandomIP = GetRandomIP();
+            return _search.BinarySearch(RandomIP);
+        }
+
+        [Benchmark]
+        public async Task<DataBlock> BinarySearch_Async()
+        {
+            RandomIP = GetRandomIP();
+            return await _search.BinarySearchAsync(RandomIP);
+        }
+
+        [Benchmark]
+        public DataBlock BtreeSearch()
+        {
+            RandomIP = GetRandomIP();
+            return _search.BtreeSearch(RandomIP);
+        }
+
+        [Benchmark]
+        public async Task<DataBlock> BtreeSearch_Async()
+        {
+            RandomIP = GetRandomIP();
+            return await _search.BtreeSearchAsync(RandomIP);
+        }
+    }
+}
diff --git a/binding/c#/IP2Region.Test.Benchmark/IP2Region.Test.Benchmark.csproj b/binding/c#/IP2Region.Test.Benchmark/IP2Region.Test.Benchmark.csproj
@@ -0,0 +1,16 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>netcoreapp2.0</TargetFramework>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="BenchmarkDotNet" Version="0.11.0" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\IP2Region\IP2Region.csproj" />
+  </ItemGroup>
+
+</Project>
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		[workspace]
		members = ["binding/rust", "binding/rust/example"]