https://github.com/stulzq/iptools
Querying IP address information, support longitude and latitude. 快速查询IP信息，支持国内和国外IP信息查询，支持查询经纬度。
https://github.com/stulzq/iptools
ip
Last synced: 7 months ago
JSON representation
Querying IP address information, support longitude and latitude. 快速查询IP信息，支持国内和国外IP信息查询，支持查询经纬度。
- Host: GitHub
- URL: https://github.com/stulzq/iptools
- Owner: stulzq
- License: mit
- Created: 2018-08-19T04:51:34.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-12-04T03:14:53.000Z (almost 6 years ago)
- Last Synced: 2024-10-02T07:53:20.509Z (about 1 year ago)
- Topics: ip
- Language: C#
- Homepage:
- Size: 62.1 MB
- Stars: 167
- Watchers: 13
- Forks: 41
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# IPTools | [中文文档](README_zh-CN.md)
Quickly query IP information, support domestic and foreign IP information query, support query latitude and longitude, and support geographical location to the city.
IPTools.China: [](https://www.nuget.org/packages/IPTools.China/)
IPTools.International: [](https://www.nuget.org/packages/IPTools.International/)
## 1. IPTools.China
Quickly query China IP information, country, province, city and network operators. Non China IP can only query national information.
### (1) Install
````shell
Install-Package IPTools.China
````
### (2) Download database file
```shell
https://github.com/stulzq/IPTools/raw/master/db/ip2region.db
```
After the database file is downloaded, put it in your project root directory (same level as the *.csprj file), and **set the copy to the output directory**.
> At the beginning of version 1.2.0, the database file was unembedded into the assembly, which is convenient for updating and reduces the size of the assembly.
### (3) Usage
````shell
IpTool.Search("your ip address");
````
eg.
````csharp
var ipinfo = IpTool.Search("171.210.12.163");
Console.WriteLine(ipinfo.Country); // 中国
Console.WriteLine(ipinfo.Province); // 四川省
Console.WriteLine(ipinfo.City); // 成都市
Console.WriteLine(ipinfo.NetworkOperator);// 电信
````
### (4) I18N
Not support . So you can't use `IpTool.SearchWithI18NAsync()`.
### (5) performance testing
Single thread double for loop queries 65025 IP, takes 170 ms.
### (6) Custom DB path
````csharp
IpToolSettings.ChinaDbPath="";
````
## 2. IPTools.International
Quickly query global IP information, support i18n, country, province, city, post code, longitude and latitude.
### (1) Install
```shell
Install-Package IPTools.International
```
### (2) Download database file
```shell
https://github.com/stulzq/IPTools/raw/master/db/GeoLite2-City.mmdb
```
After the database file is downloaded, put it in your project root directory (same level as the *.csprj file), and **set the copy to the output directory**.
> At the beginning of version 1.2.0, the database file was unembedded into the assembly, which is convenient for updating and reduces the size of the assembly.
### (3) Usage
````csharp
IpTool.Search("your ip address");
````
eg.
````csharp
var ipinfo = IpTool.SearchWithI18N("171.210.12.163");
Console.WriteLine(ipinfo.Country); // 中国
Console.WriteLine(ipinfo.CountryCode); // CN
Console.WriteLine(ipinfo.Province); // 四川省
Console.WriteLine(ipinfo.ProvinceCode); // SC
Console.WriteLine(ipinfo.City); // 成都
Console.WriteLine(ipinfo.Latitude); // 30.6667
Console.WriteLine(ipinfo.Longitude); // 104.6667
Console.WriteLine(ipinfo.AccuracyRadius);// 50
````
### (4) I18N
````csharp
IpTool.SearchWithI18N("your ip address");
````
eg.
````csharp
var ipinfo = IpTool.SearchWithI18N("171.210.12.163","en");//If language code is not set, Chinese will be used by default.
Console.WriteLine(ipinfo.Country); // China
Console.WriteLine(ipinfo.CountryCode); // CN
Console.WriteLine(ipinfo.Province); // Sichuan
Console.WriteLine(ipinfo.ProvinceCode); // SC
Console.WriteLine(ipinfo.City); // Chengdu
Console.WriteLine(ipinfo.Latitude); // 30.6667
Console.WriteLine(ipinfo.Longitude); // 104.6667
Console.WriteLine(ipinfo.AccuracyRadius);// 50
````
Default language is chinese(zh-CN), How to change?
````csharp
IpToolSettings.DefaultLanguage = "en";// set default language is english.
````
### (5) Increase query speed
With the following settings, will double the query speed, the principle is to fully load the database file into the memory, the price is that the memory will increase 60-70M, space for time, this should be noted.
```csharp
IpToolSettings.LoadInternationalDbToMemory = true;
```
> Version >= 1.2.0
### (6) performance testing
Single thread double for loop queries 65025 IP, takes 1500 ms(Memory).
### (7) Custom DB path
````csharp
IpToolSettings.InternationalDbPath="";
````
## 3. ASP.NET Core Support
IPTools provides an extension method for `HttpContext`.
usage:
````csharp
HttpContext.GetRemoteIpInfo();
HttpContext.GetRemoteIpInfo(headerKey); // Get ip from header if you use nginx, haproxy etc.
````
## 4. Use both IPTools.China and IPTools.International
Both IPTools.China and IPTools.International implement `IIpSearcher`. The `IpTool` class will detect the package you installed during initialization and initialize it only once. `IpTool` has three static read-only properties, namely `DefaultSearcher`, `IpChinaSearcher`, `IpAllSearcher`.
- `DefaultSearcher`. `IpTool.Search()` and `IpTool.SearchWithI18N()` will use the default Ip searcher.
- `IpChinaSearcher`. IPTools.China Implemented searcher.
- `IpAllSearcher`. IPTools.International Implemented searcher.
If you just installed IPTools.China then `DefaultSearcher` will be `IpChinaSearcher` and `IpAllSearcher` will be null.
If you just installed IPTools.International then `DefaultSearcher` will be `IpAllSearcher` and `IpChinaSearcher` will be null.
If you have both components installed at the same time, by default `DefaultSearcher` will be `IpChinaSearcher`, `IpChinaSearcher` and `IpAllSearcher` will not be null.
To change the default Searcher used by `DefaultSearcher`, please use the following code, if you have two components installed at the same time, it will take effect.
```csharp
IpToolSettings.DefalutSearcherType = IpSearcherType.China;
IpToolSettings.DefalutSearcherType = IpSearcherType.International;
```
## 5. Referencing project
[**ip2region**](https://github.com/lionsoul2014/ip2region) by [lionsoul2014](https://github.com/lionsoul2014).
[**GeoIP2-dotnet**](https://github.com/maxmind/GeoIP2-dotnet) by [maxmind](https://github.com/maxmind).