暑假总结-集成ip2region实现离线IP地址定位

本周总结:本周主要对项目进行准备工作:立项、建立文档、建表、项目需求、分工等,在学习的过程中学习了一个功能,来分享一下

阅读须知

  • 本文是自己总结文档和github源码,绝无抄袭,我先打个水印哈在这里插入图片描述

  • 本文是看了Ruoyi-vue的github开源项目有所总结Ruoyi文档描述

    • 文档里的代码直接复制会报错,缺少一些他的项目里面的类
    • 下面的部分代码是复制文档的,看文档只需要找到ip2region即可
    • 下面的代码是基于文档的一些部分改动一下,可以直接复制运行
    • 记得导入StringUtils的包,一些地方会用得到

集成ip2region实现离线IP地址定位,为啥是实现离线IP地址定位,因为在线的IP定位会给网络带来资源消耗,离线的话,我们只需要访问内部的一个文件即可

  • 第一步 引入依赖
<!-- 离线IP地址定位库 -->
<dependency>
	<groupId>org.lionsoul</groupId>
	<artifactId>ip2region</artifactId>
	<version>1.7.2</version>
</dependency>
  • 第二步 添加工具类 RegionUtil.java 不用理会水印在这里插入图片描述
import java.io.File;
import java.io.InputStream;
import java.lang.reflect.Method;
import org.apache.commons.io.FileUtils;
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;

/**
 * 根据ip离线查询地址
 *
 * @author ruoyi
 */
public class RegionUtil
{
    private static final Logger log = LoggerFactory.getLogger(RegionUtil.class);

    private static final String JAVA_TEMP_DIR = "java.io.tmpdir";

    static DbConfig config = null;
    static DbSearcher searcher = null;

    /**
     * 初始化IP库
     */
    static
    {
        try
        {
            // 因为jar无法读取文件,复制创建临时文件
            String dbPath = RegionUtil.class.getResource("/ip2region/ip2region.db").getPath();
            File file = new File(dbPath);
            if (!file.exists())
            {
                String tmpDir = System.getProperties().getProperty(JAVA_TEMP_DIR);
                dbPath = tmpDir + "ip2region.db";
                file = new File(dbPath);
                ClassPathResource cpr = new ClassPathResource("ip2region" + File.separator + "ip2region.db");
                InputStream resourceAsStream = cpr.getInputStream();
                if (resourceAsStream != null)
                {
                    FileUtils.copyInputStreamToFile(resourceAsStream, file);
                }
            }
            config = new DbConfig();
            searcher = new DbSearcher(config, dbPath);
            log.info("bean [{}]", config);
            log.info("bean [{}]", searcher);
        }
        catch (Exception e)
        {
            log.error("init ip region error:{}", e);
        }
    }

    /**
     * 解析IP
     *
     * @param ip
     * @return
     */
    public static String getRegion(String ip)
    {
        try
        {
            // db
            if (searcher == null || StringUtils.isEmpty(ip))
            {
                log.error("DbSearcher is null");
                return StringUtils.EMPTY;
            }
            long startTime = System.currentTimeMillis();
            // 查询算法
            int algorithm = DbSearcher.MEMORY_ALGORITYM;
            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.warn("warning: Invalid ip address");
            }
            dataBlock = (DataBlock) method.invoke(searcher, ip);
            String result = dataBlock.getRegion();
            long endTime = System.currentTimeMillis();
            log.debug("region use time[{}] result[{}]", endTime - startTime, result);
            return result;

        }
        catch (Exception e)
        {
            log.error("error:{}", e);
        }
        return StringUtils.EMPTY;
    }

}
  • 第三步 创建AddressUtils.java,不用理会水印在这里插入图片描述

import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * 获取地址类
 *
 * @author ruoyi
 */
public class AddressUtils
{
    private static final Logger log = LoggerFactory.getLogger(AddressUtils.class);

    // 未知地址
    public static final String UNKNOWN = "XX XX";

    public static String getRealAddressByIP(String ip)
    {
        String address = UNKNOWN;
        // 内网不查询
        if (IpUtils.internalIp(ip))
        {
            return "内网IP";
        }else {
            try
            {
                String rspStr = RegionUtil.getRegion(ip);
                if (StringUtils.isEmpty(rspStr))
                {
                    log.error("获取地理位置异常 {}", ip);
                    return UNKNOWN;
                }
                String[] obj = rspStr.split("\\|");
                String region = obj[2];
                String city = obj[3];

                return String.format("%s %s", region, city);
            }
            catch (Exception e)
            {
                log.error("获取地理位置异常 {}", e);
            }
        }
        return address;
    }
}

  • 第四步 需要创建IpUtils,这个里面方法很多,测试只用到了其中一个方法,大家可以自己探索

import org.apache.commons.lang3.StringUtils;

import javax.servlet.http.HttpServletRequest;
import java.net.InetAddress;
import java.net.UnknownHostException;

/**
 * 获取IP方法
 * 
 * @author ruoyi
 */
public class IpUtils
{
    /**
     * 获取客户端IP
     * 
     * @param request 请求对象
     * @return IP地址
     */
    public static String getIpAddr(HttpServletRequest request)
    {
        if (request == null)
        {
            return "unknown";
        }
        String ip = request.getHeader("x-forwarded-for");
        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip))
        {
            ip = request.getHeader("Proxy-Client-IP");
        }
        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip))
        {
            ip = request.getHeader("X-Forwarded-For");
        }
        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip))
        {
            ip = request.getHeader("WL-Proxy-Client-IP");
        }
        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip))
        {
            ip = request.getHeader("X-Real-IP");
        }

        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip))
        {
            ip = request.getRemoteAddr();
        }

        return "0:0:0:0:0:0:0:1".equals(ip) ? "127.0.0.1" : getMultistageReverseProxyIp(ip);
    }

    /**
     * 检查是否为内部IP地址
     * 
     * @param ip IP地址
     * @return 结果
     */
    public static boolean internalIp(String ip)
    {
        byte[] addr = textToNumericFormatV4(ip);
        return internalIp(addr) || "127.0.0.1".equals(ip);
    }

    /**
     * 检查是否为内部IP地址
     * 
     * @param addr byte地址
     * @return 结果
     */
    private static boolean internalIp(byte[] addr)
    {
        if (isNull(addr) || addr.length < 2)
        {
            return true;
        }
        final byte b0 = addr[0];
        final byte b1 = addr[1];
        // 10.x.x.x/8
        final byte SECTION_1 = 0x0A;
        // 172.16.x.x/12
        final byte SECTION_2 = (byte) 0xAC;
        final byte SECTION_3 = (byte) 0x10;
        final byte SECTION_4 = (byte) 0x1F;
        // 192.168.x.x/16
        final byte SECTION_5 = (byte) 0xC0;
        final byte SECTION_6 = (byte) 0xA8;
        switch (b0)
        {
            case SECTION_1:
                return true;
            case SECTION_2:
                if (b1 >= SECTION_3 && b1 <= SECTION_4)
                {
                    return true;
                }
            case SECTION_5:
                switch (b1)
                {
                    case SECTION_6:
                        return true;
                }
            default:
                return false;
        }
    }

    /**
     * 将IPv4地址转换成字节
     * 
     * @param text IPv4地址
     * @return byte 字节
     */
    public static byte[] textToNumericFormatV4(String text)
    {
        if (text.length() == 0)
        {
            return null;
        }

        byte[] bytes = new byte[4];
        String[] elements = text.split("\\.", -1);
        try
        {
            long l;
            int i;
            switch (elements.length)
            {
                case 1:
                    l = Long.parseLong(elements[0]);
                    if ((l < 0L) || (l > 4294967295L))
                    {
                        return null;
                    }
                    bytes[0] = (byte) (int) (l >> 24 & 0xFF);
                    bytes[1] = (byte) (int) ((l & 0xFFFFFF) >> 16 & 0xFF);
                    bytes[2] = (byte) (int) ((l & 0xFFFF) >> 8 & 0xFF);
                    bytes[3] = (byte) (int) (l & 0xFF);
                    break;
                case 2:
                    l = Integer.parseInt(elements[0]);
                    if ((l < 0L) || (l > 255L))
                    {
                        return null;
                    }
                    bytes[0] = (byte) (int) (l & 0xFF);
                    l = Integer.parseInt(elements[1]);
                    if ((l < 0L) || (l > 16777215L))
                    {
                        return null;
                    }
                    bytes[1] = (byte) (int) (l >> 16 & 0xFF);
                    bytes[2] = (byte) (int) ((l & 0xFFFF) >> 8 & 0xFF);
                    bytes[3] = (byte) (int) (l & 0xFF);
                    break;
                case 3:
                    for (i = 0; i < 2; ++i)
                    {
                        l = Integer.parseInt(elements[i]);
                        if ((l < 0L) || (l > 255L))
                        {
                            return null;
                        }
                        bytes[i] = (byte) (int) (l & 0xFF);
                    }
                    l = Integer.parseInt(elements[2]);
                    if ((l < 0L) || (l > 65535L))
                    {
                        return null;
                    }
                    bytes[2] = (byte) (int) (l >> 8 & 0xFF);
                    bytes[3] = (byte) (int) (l & 0xFF);
                    break;
                case 4:
                    for (i = 0; i < 4; ++i)
                    {
                        l = Integer.parseInt(elements[i]);
                        if ((l < 0L) || (l > 255L))
                        {
                            return null;
                        }
                        bytes[i] = (byte) (int) (l & 0xFF);
                    }
                    break;
                default:
                    return null;
            }
        }
        catch (NumberFormatException e)
        {
            return null;
        }
        return bytes;
    }

    /**
     * 获取IP地址
     * 
     * @return 本地IP地址
     */
    public static String getHostIp()
    {
        try
        {
            return InetAddress.getLocalHost().getHostAddress();
        }
        catch (UnknownHostException e)
        {
        }
        return "127.0.0.1";
    }

    /**
     * 获取主机名
     * 
     * @return 本地主机名
     */
    public static String getHostName()
    {
        try
        {
            return InetAddress.getLocalHost().getHostName();
        }
        catch (UnknownHostException e)
        {
        }
        return "未知";
    }

    /**
     * 从多级反向代理中获得第一个非unknown IP地址
     *
     * @param ip 获得的IP地址
     * @return 第一个非unknown IP地址
     */
    public static String getMultistageReverseProxyIp(String ip)
    {
        // 多级反向代理检测
        if (ip != null && ip.indexOf(",") > 0)
        {
            final String[] ips = ip.trim().split(",");
            for (String subIp : ips)
            {
                if (false == isUnknown(subIp))
                {
                    ip = subIp;
                    break;
                }
            }
        }
        return ip;
    }

    /**
     * 检测给定字符串是否为未知,多用于检测HTTP请求相关
     *
     * @param checkString 被检测的字符串
     * @return 是否未知
     */
    public static boolean isUnknown(String checkString)
    {
        return StringUtils.isBlank(checkString) || "unknown".equalsIgnoreCase(checkString);
    }


    public static boolean isNull(Object object)
    {
        return object == null;
    }
}
  • 第五步 添加离线IP地址库插件,

    • 如果失效了请去文档里面下载他的集成插件堆我只是将这个ip2region单独放了出来
    • 下载集成ip2region离线地址定位.zip
    • 链接:ip2region离线地址定位.zip 提取码:tdkp
    • 解压之后找到这个
      在这里插入图片描述
      在src/main/resources下新建ip2region复制文件ip2region.db到目录下
      在这里插入图片描述
  • 第六步 测试

    • 外网访问
      在这里插入图片描述
    • 内网访问
      在这里插入图片描述
  • 2
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 3
    评论
### 回答1: 首先,你需要将 IP2Region 的 jar 包添加到你的项目中。然后,你需要在 application.properties 文件中配置 IP2Region 的数据库文件路径。 接下来,你需要在你的 Spring Boot 应用程序中创建一个 Bean 来初始化 IP2Region。 示例代码如下: ``` @Bean public IP2Region getIp2Region() throws Exception { return new IP2Region("/path/to/ip2region.db"); } ``` 之后,你就可以在你的应用程序中使用 IP2Region 类来查询 IP 地址的信息了。 示例代码如下: ``` @Autowired private IP2Region ip2Region; public void queryIp(String ip) throws Exception { RegionInfo info = ip2Region.memorySearch(ip); System.out.println(info.getRegion()); } ``` 这样就可以在 Spring Boot 应用程序中集成 IP2Region 了。 ### 回答2: Springboot是一个开源的Java框架,可以方便地搭建和开发Java应用程序。而ip2region则是一个高性能的IP地理位置查询库,可以根据IP地址快速查找对应的地理位置信息。 要在Springboot项目中集成ip2region,我们首先需要导入对应的依赖包。可以通过Maven或Gradle来管理项目的依赖。 接下来,我们需要创建一个地理位置查询的服务类。可以使用ip2region提供的查询函数,将IP地址作为参数传入,在函数中调用ip2region的方法进行查询,然后返回查询结果。可以根据实际需要,将查询结果转换成自定义的对象或者直接返回字符串。 在Springboot中,我们可以将查询服务类注册为一个Bean,以便在其他地方使用。可以使用@Component或@Service注解将其标记为一个组件或服务类,然后在需要使用的地方通过@Autowired注解进行注入。 在集成ip2region的过程中,我们还可以进行一些优化和配置。ip2region提供了一些配置选项,例如可以设置查询数据的文件路径、缓存配置等。我们可以根据实际情况调整这些配置,以提高查询效率和灵活性。 最后,在项目中使用该地理位置查询服务即可。可以在Controller中接收客户端传来的IP地址,在调用查询服务进行查询后返回结果给客户端。 以上就是使用Springboot集成ip2region的基本步骤和流程。通过这种方式,我们可以方便地在Springboot项目中使用ip2region库来进行IP地理位置查询,从而更好地实现一些与地理位置相关的功能。 ### 回答3: Spring Boot是一种用于开发Java应用程序的框架,它使得构建和部署应用程序变得简单且高效。而ip2region是一个使用Java编写的IP地理位置查询库,它可以根据IP地址获取其所属的地理位置信息。 要在Spring Boot中集成ip2region,我们可以按照以下步骤进行操作: 1. 导入依赖:在项目的pom.xml文件中添加ip2region的Maven依赖。可以通过搜索ip2region Maven依赖来找到最新版本的依赖配置。 2. 创建IP查询服务:在Spring Boot应用程序中创建一个IP查询服务类,该类将使用ip2region库来查询IP的地理位置。可以使用注解@Service来标记该类为一个服务类,并在类中使用@Autowired注解注入ip2region库的相关对象。 3. 实现IP查询方法:在IP查询服务类中实现一个方法,该方法接收一个IP地址作为参数,并返回该IP地址所属的地理位置信息。在该方法中使用ip2region库提供的API来查询IP地址的地理位置信息。 4. 配置Spring Boot应用程序:在Spring Boot应用程序的配置文件中添加相关配置,以连接到ip2region的数据库文件。可以使用application.properties或application.yaml文件来添加配置。 5. 使用IP查询服务:在Spring Boot应用程序的其他组件中使用IP查询服务来获取IP地址的地理位置信息。可以通过在需要使用地理位置信息的地方注入IP查询服务,并调用其查询IP方法来获取地理位置信息。 总结起来,要将ip2region集成到Spring Boot应用程序中,我们需要导入ip2region的Maven依赖,创建一个IP查询服务并实现查询方法,配置Spring Boot应用程序以连接到ip2region的数据库文件,并在其他组件中使用IP查询服务来获取IP地址的地理位置信息。这样就可以在Spring Boot应用程序中方便地使用ip2region进行IP地理位置查询了。
评论 3
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值