ip2region 使用总结

Posted 2021-10-29 在奋斗的大道

ip2region 简介：

根据它获取一个具体ip的信息，通过IP解析出国家、具体地址、网络服务商等相关信息。

ip2region 实际应用：

在开发中，我们需要记录登陆的日志信息，关于登陆者的ip和位置信息，可以通过ip2region来实现。

Spring Boot集成ip2region

第一步：pom.xml引入

	<properties>
		<ip2region.version>1.7.2</ip2region.version>
	</properties>

   <dependency>
		<groupId>org.lionsoul</groupId>
		<artifactId>ip2region</artifactId>
		<version>${ip2region.version}</version>
	</dependency>

第二步：下载ip2region.db

 $ git clone https://gitee.com/lionsoul/ip2region.git

 下载这个项目之后到data/文件夹下面找到ip2region.db复制到项目resources下

第三步：ip2region 工具类

功能:主要基于IP获取当前位置信息。

import org.apache.commons.io.IOUtils;
import org.lionsoul.ip2region.DataBlock;
import org.lionsoul.ip2region.DbConfig;
import org.lionsoul.ip2region.DbSearcher;
import org.lionsoul.ip2region.Util;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.core.io.ClassPathResource;

import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.lang.reflect.Method;

/**
 * @author zhouzhiwengang
 */
public class AddressUtil {

    private static Logger log = LoggerFactory.getLogger(AddressUtil.class);

    @SuppressWarnings("all")
    public static String getCityInfo(String ip) {
        //db
        String dbPath = AddressUtil.class.getResource("/ip2region/ip2region.db").getPath();
        File file = new File(dbPath);

        if (!file.exists()) {
            log.info("地址库文件不存在,进行其他处理");
            String tmpDir = System.getProperties().getProperty("java.io.tmpdir");
            dbPath = tmpDir + File.separator + "ip2region.db";
            log.info("临时文件路径:{}", dbPath);
            file = new File(dbPath);
            if (!file.exists() || (System.currentTimeMillis() - file.lastModified() > 86400000L)) {
                log.info("文件不存在或者文件存在时间超过1天进入...");
                try {
                    InputStream inputStream = new ClassPathResource("ip2region/ip2region.db").getInputStream();
                    IOUtils.copy(inputStream, new FileOutputStream(file));
                } catch (IOException exception) {
                    exception.printStackTrace();
                }
            }
        }

        //查询算法
        int algorithm = DbSearcher.BTREE_ALGORITHM; //B-tree
        try {
            DbConfig config = new DbConfig();
            DbSearcher searcher = new DbSearcher(config, dbPath);
            //define the method
            Method method = null;
            switch (algorithm) {
                case DbSearcher.BTREE_ALGORITHM:
                    method = searcher.getClass().getMethod("btreeSearch", String.class);
                    break;
                case DbSearcher.BINARY_ALGORITHM:
                    method = searcher.getClass().getMethod("binarySearch", String.class);
                    break;
                case DbSearcher.MEMORY_ALGORITYM:
                    method = searcher.getClass().getMethod("memorySearch", String.class);
                    break;
            }
            DataBlock dataBlock = null;
            if (Util.isIpAddress(ip) == false) {
                log.error("Error: Invalid ip address");
            }
            dataBlock = (DataBlock) method.invoke(searcher, ip);
            return dataBlock.getRegion();
        } catch (Exception e) {
            e.printStackTrace();
        }
        return null;
    }


}

知识拓展：

遇到的问题：由于AddressUtil.java 工具类是处于项目common(基础通用模块)，但部署到tomcat 容器中，提示无法加载ip2region.db 数据库资源文件。

产生上述问题的原因是:项目common(基础通用模块)没有把resources 资源文件夹下的相关资源打包，仅需要将ip2region.db 打包之项目common(基础通用模块).jar 中即可。

解决办法:改造项目common(基础通用模块)的pom.xml 文件，添加如下代码片段：

<build>
		<resources>
			<resource>
				<directory>src/main/java</directory>
				<includes>
					<include>**/*.xml</include>
				</includes>
			</resource>
			<resource>
				<directory>src/main/resources</directory>
				<includes>
					<include>**.*</include>
					<include>**/*.*</include><!-- i18n能读取到 -->
					<include>**/*/*.*</include>
				</includes>
			</resource>
		</resources>
	</build>