spring boot 整合 ip2region(ip地址库)

Ip2region是什么？

ip2region - 准确率99.9%的离线IP地址定位库，0.0x毫秒级查询，ip2region.db数据库只有数MB，提供了java,php,c,python,nodejs,golang,c#等查询绑定和Binary,B树,内存三种查询算法。

Ip2region特性

99.9%准确率

数据聚合了一些知名ip到地名查询提供商的数据，这些是他们官方的的准确率，经测试着实比经典的纯真IP定位准确一些。
ip2region的数据聚合自以下服务商的开放API或者数据(升级程序每秒请求次数2到4次):
01, >80%, 淘宝IP地址库, http://ip.taobao.com/
02, ≈10%, GeoIP, https://geoip.com/
03, ≈2%, 纯真IP库, http://www.cz88.net/
备注：如果上述开放API或者数据都不给开放数据时ip2region将停止数据的更新服务。

标准化的数据格式

每条ip数据段都固定了格式：

_城市Id|国家|区域|省份|城市|ISP_

只有中国的数据精确到了城市，其他国家有部分数据只能定位到国家，后前的选项全部是0，已经包含了全部你能查到的大大小小的国家（请忽略前面的城市Id，个人项目需求）。

体积小

包含了全部的IP，生成的数据库文件ip2region.db只有几MB，最小的版本只有1.5MB，随着数据的详细度增加数据库的大小也慢慢增大，目前还没超过8MB。

查询速度快

全部的查询客户端单次查询都在0.x毫秒级别，内置了三种查询算法

1. memory算法：整个数据库全部载入内存，单次查询都在0.1x毫秒内，C语言的客户端单次查询在0.00x毫秒级别。
2. binary算法：基于二分查找，基于ip2region.db文件，不需要载入内存，单次查询在0.x毫秒级别。
3. b-tree算法：基于btree算法，基于ip2region.db文件，不需要载入内存，单词查询在0.x毫秒级别，比binary算法更快。

任何客户端b-tree都比binary算法快，当然memory算法固然是最快的！

多查询客户端的支持

已经集成的客户端有：java、C#、php、c、python、nodejs、php扩展(php5和php7)、golang、rust、lua、lua_c, nginx。

binding	描述	开发状态	binary查询耗时	b-tree查询耗时	memory查询耗时
c	ANSC c binding	已完成	0.0x毫秒	0.0x毫秒	0.00x毫秒
c#	c# binding	已完成	0.x毫秒	0.x毫秒	0.1x毫秒
golang	golang binding	已完成	0.x毫秒	0.x毫秒	0.1x毫秒
java	java binding	已完成	0.x毫秒	0.x毫秒	0.1x毫秒
lua	lua实现的binding	已完成	0.x毫秒	0.x毫秒	0.x毫秒
lua_c	lua的c扩展	已完成	0.0x毫秒	0.0x毫秒	0.00x毫秒
nginx	nginx的c扩展	已完成	0.0x毫秒	0.0x毫秒	0.00x毫秒
nodejs	nodejs	已完成	0.x毫秒	0.x毫秒	0.1x毫秒
php	php实现的binding	已完成	0.x毫秒	0.1x毫秒	0.1x毫秒
php5_ext	php5的c扩展	已完成	0.0x毫秒	0.0x毫秒	0.00x毫秒
php7_ext	php7的c扩展	已完成	0.0毫秒	0.0x毫秒	0.00x毫秒
python	python bindng	已完成	0.x毫秒	0.x毫秒	0.x毫秒
rust	rust binding	已完成	0.x毫秒	0.x毫秒	0.x毫秒

Spring Boot 快速集成 ip2region

 1.  引入maven依赖，笔者使用了1.7.2版本

    org.lionsoul
    ip2region
    ${ip2region.version}

2.  代码编码

package com.healthy.ip2region;

import cn.hutool.core.io.IoUtil;
import cn.hutool.core.util.ClassLoaderUtil;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.lionsoul.ip2region.DbConfig;
import org.lionsoul.ip2region.DbMakerConfigException;
import org.lionsoul.ip2region.DbSearcher;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import java.io.InputStream;


/**
 * Ip2RegionAutoConfiguration
 *
 * @author healthy
 */
@Configuration
@EnableConfigurationProperties(Ip2RegionProperties.class)
@ConditionalOnClass(DbSearcher.class)
public class Ip2RegionAutoConfiguration {
    public static final String IP2REGION_DBSEARCHER_BEAN_NAME = "ip2regionSearcher";
    private static final Log LOGGER = LogFactory.getLog(Ip2RegionAutoConfiguration.class);

    @Bean(name = IP2REGION_DBSEARCHER_BEAN_NAME)
    @ConditionalOnProperty(prefix = Ip2RegionProperties.PREFIX, name = "enabled", havingValue = "true")
    public Ip2regionSearcher autoIp2regionSearcher(@Autowired Ip2RegionProperties properties) {
        try {
            InputStream inputStream = ClassLoaderUtil.getClassLoader().getResourceAsStream(properties.getDbfile());
            byte[] bytes = IoUtil.readBytes(inputStream);
            DbSearcher dbSearcher = new DbSearcher(new DbConfig(), bytes);
            Ip2regionSearcher ip2regionSearcher = new Ip2regionSearcher(dbSearcher);
            return ip2regionSearcher;
        } catch (DbMakerConfigException e) {
            //默认配置下忽略此异常
        } catch (Exception e) {
            LOGGER.error("Ip2regionSearcher can not find db file in the path [" + properties.getDbfile() + "]");
        }
        return null;
    }
}

package com.healthy.ip2region;

import org.springframework.boot.context.properties.ConfigurationProperties;

/**
 * Ip2RegionProperties
 *
 * @author healthy
 */
@ConfigurationProperties(prefix = Ip2RegionProperties.PREFIX)
public class Ip2RegionProperties {
    public static final String PREFIX = "ip2region";

    /**
     * 是否开启自动配置
     */
    private boolean enabled = false;

    /**
     * db数据文件位置
     */
    private String dbfile;

    public boolean isEnabled() {
        return enabled;
    }

    public void setEnabled(boolean enabled) {
        this.enabled = enabled;
    }

    public String getDbfile() {
        return dbfile;
    }

    public void setDbfile(String dbfile) {
        this.dbfile = dbfile;
    }
}

package com.healthy.ip2region;

import org.lionsoul.ip2region.DataBlock;
import org.lionsoul.ip2region.DbSearcher;
import org.springframework.beans.factory.DisposableBean;
import org.springframework.util.StringUtils;

import java.io.IOException;
import java.util.Arrays;
import java.util.List;

/**
 * Ip2regionSearcher
 *
 * @author healthy
 */
public class Ip2regionSearcher implements DisposableBean {

    private final ThreadLocal threadLocal = new ThreadLocal();
    private DbSearcher dbSearcher;

    public Ip2regionSearcher(DbSearcher dbSearcher) {
        this.dbSearcher = dbSearcher;
    }

    public synchronized Ip2regionSearcher search(String ip) throws IOException {
        return search(ip, ALGORITHM.BTREE_SEARCH);
    }

    public synchronized Ip2regionSearcher search(String ip, ALGORITHM algorithm) throws IOException {
        DataBlock dataBlock = null;
        switch (algorithm) {
            case BTREE_SEARCH:
                dataBlock = this.dbSearcher.btreeSearch(ip);
                break;
            case BINARY_SEARCH:
                dataBlock = this.dbSearcher.binarySearch(ip);
                break;
            case MEMORY_SEARCH:
                dataBlock = this.dbSearcher.memorySearch(ip);
                break;
        }
        if (dataBlock != null) {
            threadLocal.set(dataBlock.getRegion());
        }
        return this;
    }

    @Override
    public String toString() {
        String d = threadLocal.get();
        if (StringUtils.isEmpty(d)) {
            return "";
        }
        return d;
    }

    public String getCountry() {
        return getByIdx(0);
    }

    public String getRegion() {
        return getByIdx(1);
    }

    public String getProvince() {
        return getByIdx(2);
    }

    public String getCity() {
        return getByIdx(3);
    }

    public String getISP() {
        return getByIdx(4);
    }

    private String getByIdx(int i) {
        String d = threadLocal.get();
        if (StringUtils.isEmpty(d)) {
            return "";
        }
        List list = Arrays.asList(StringUtils.delimitedListToStringArray(d, "|"));
        return list.get(i);
    }

    @Override
    public void destroy() throws Exception {
        this.dbSearcher.close();
        this.dbSearcher = null;
    }

    public enum ALGORITHM {
        BTREE_SEARCH, BINARY_SEARCH, MEMORY_SEARCH
    }
}

3. YML配置

# ip2region
ip2region:
  enabled: true
  dbfile: data/ip2region.db

4. 如何使用

@Autowired
private Ip2regionSearcher ip2regionSearcher;

Ip2regionSearcher search = ip2regionSearcher.search(ls, Ip2regionSearcher.ALGORITHM.MEMORY_SEARCH);

5. 常见问题

// 方式1:  bytes构造
/**
 *  此方式使用ALGORITHM.BTREE_SEARCH算法有空指针异常， 请使用MEMORY_SEARCH算法调用；
 *  Ip2regionSearcher search = ip2regionSearcher.search(ls,Ip2regionSearcher.ALGORITHM.MEMORY_SEARCH);
 */ 
InputStream inputStream = ClassLoaderUtil.getClassLoader().getResourceAsStream(properties.getDbfile());
byte[] bytes = IoUtil.readBytes(inputStream);
DbSearcher dbSearcher = new DbSearcher(new DbConfig(), bytes);


// 方式1:  file文件路径构造(linux环境下启动jar运行，读取不到dbfile文件)
File file = ResourceUtils.getFile("classpath:" + properties.getDbfile());
DbSearcher dbSearcher = new DbSearcher(new DbConfig(), file.getAbsolutePath());