Tio Boot DocsTio Boot Docs
Home
  • java-db
  • api-table
  • Enjoy
  • Tio Boot Admin
  • ai_agent
  • translator
  • knowlege_base
  • ai-search
  • 案例
Abount
  • Github
  • Gitee
Home
  • java-db
  • api-table
  • Enjoy
  • Tio Boot Admin
  • ai_agent
  • translator
  • knowlege_base
  • ai-search
  • 案例
Abount
  • Github
  • Gitee
  • 01_tio-boot 简介

    • tio-boot:新一代高性能 Java Web 开发框架
    • tio-boot 入门示例
    • Tio-Boot 配置 : 现代化的配置方案
    • tio-boot 整合 Logback
    • tio-boot 整合 hotswap-classloader 实现热加载
    • 自行编译 tio-boot
    • 最新版本
    • 开发规范
  • 02_部署

    • 使用 Maven Profile 实现分环境打包 tio-boot 项目
    • Maven 项目配置详解:依赖与 Profiles 配置
    • tio-boot 打包成 FastJar
    • 使用 GraalVM 构建 tio-boot Native 程序
    • 使用 Docker 部署 tio-boot
    • 部署到 Fly.io
    • 部署到 AWS Lambda
    • 到阿里云云函数
    • 使用 Deploy 工具部署
    • 胖包与瘦包的打包与部署
    • 使用 Jenkins 部署 Tio-Boot 项目
    • 使用 Nginx 反向代理 Tio-Boot
    • 使用 Supervisor 管理 Java 应用
  • 03_配置

    • 配置参数
    • 服务器监听器
    • 内置缓存系统 AbsCache
    • 使用 Redis 作为内部 Cache
    • 静态文件处理器
    • 基于域名的静态资源隔离
    • DecodeExceptionHandler
  • 04_原理

    • 生命周期
    • 请求处理流程
    • 重要的类
  • 05_json

    • Json
    • 接受 JSON 和响应 JSON
    • 响应实体类
  • 06_web

    • 概述
    • 文件上传
    • 接收请求参数
    • 接收日期参数
    • 接收数组参数
    • 返回字符串
    • 返回文本数据
    • 返回网页
    • 请求和响应字节
    • 文件下载
    • 返回视频文件并支持断点续传
    • http Session
    • Cookie
    • HttpRequest
    • HttpResponse
    • Resps
    • RespBodyVo
    • /zh/06_web/19.html
    • 全局异常处理器
    • 异步
    • 动态 返回 CSS 实现
    • 返回图片
    • Transfer-Encoding: chunked 实时音频播放
    • Server-Sent Events (SSE)
    • 接口访问统计
    • 接口请求和响应数据记录
    • 自定义 Handler 转发请求
    • 使用 HttpForwardHandler 转发所有请求
    • 跨域
    • 添加 Controller
    • 常用工具类
    • HTTP Basic 认证
    • WebJars
    • JProtobuf
  • 07_validate

    • 数据紧校验规范
    • 参数校验
  • 08_websocket

    • 使用 tio-boot 搭建 WebSocket 服务
    • WebSocket 聊天室项目示例
  • 09_java-db

    • java‑db
    • 操作数据库入门示例
    • SQL 模板
    • 数据源配置与使用
    • ActiveRecord
    • Model
    • 生成器与 Model
    • Db 工具类
    • 批量操作
    • 数据库事务处理
    • Cache 缓存
    • Dialect 多数据库支持
    • 表关联操作
    • 复合主键
    • Oracle 支持
    • Enjoy SQL 模板
    • Java-DB 整合 Enjoy 模板最佳实践
    • 多数据源支持
    • 独立使用 ActiveRecord
    • 调用存储过程
    • java-db 整合 Guava 的 Striped 锁优化
    • 生成 SQL
    • 通过实体类操作数据库
    • java-db 读写分离
    • Spring Boot 整合 Java-DB
    • like 查询
    • 常用操作示例
    • Druid 监控集成指南
    • SQL 统计
  • 10_api-table

    • ApiTable 概述
    • 使用 ApiTable 连接 SQLite
    • 使用 ApiTable 连接 Mysql
    • 使用 ApiTable 连接 Postgres
    • 使用 ApiTable 连接 TDEngine
    • 使用 api-table 连接 oracle
    • 使用 api-table 连接 mysql and tdengine 多数据源
    • EasyExcel 导出
    • EasyExcel 导入
    • TQL(Table SQL)前端输入规范
    • ApiTable 实现增删改查
    • 数组类型
    • 单独使用 ApiTable
  • 11_aop

    • JFinal-aop
    • Aop 工具类
    • 配置
    • 配置
    • 独立使用 JFinal Aop
    • @AImport
    • 原理解析
  • 12_cache

    • Caffine
    • Jedis-redis
    • hutool RedisDS
    • Redisson
    • Caffeine and redis
    • CacheUtils 工具类
    • 使用 CacheUtils 整合 caffeine 和 redis 实现的两级缓存
    • 使用 java-db 整合 ehcache
    • 使用 java-db 整合 redis
    • Java DB Redis 相关 Api
    • redis 使用示例
  • 13_认证和权限

    • hutool-JWT
    • FixedTokenInterceptor
    • 使用内置 TokenManager 实现登录
    • 用户系统
    • 重置密码
    • 匿名登录
    • Google 登录
    • 权限校验注解
    • Sa-Token
    • sa-token 登录注册
    • StpUtil.isLogin() 源码解析
    • 短信登录
    • 移动端微信登录实现指南
    • 移动端重置密码
  • 14_i18n

    • i18n
  • 15_enjoy

    • tio-boot 整合 Enjoy 模版引擎文档
    • 引擎配置
    • 表达式
    • 指令
    • 注释
    • 原样输出
    • Shared Method 扩展
    • Shared Object 扩展
    • Extension Method 扩展
    • Spring boot 整合
    • 独立使用 Enjoy
    • tio-boot enjoy 自定义指令 localeDate
    • PromptEngine
    • Enjoy 入门示例-擎渲染大模型请求体
    • Enjoy 使用示例
  • 16_定时任务

    • Quartz 定时任务集成指南
    • 分布式定时任务 xxl-jb
    • cron4j 使用指南
  • 17_tests

    • TioBootTest 类
  • 18_tio

    • TioBootServer
    • tio-core
    • 内置 TCP 处理器
    • 独立启动 UDPServer
    • 使用内置 UDPServer
    • t-io 消息处理流程
    • tio-运行原理详解
    • TioConfig
    • ChannelContext
    • Tio 工具类
    • 业务数据绑定
    • 业务数据解绑
    • 发送数据
    • 关闭连接
    • Packet
    • 监控: 心跳
    • 监控: 客户端的流量数据
    • 监控: 单条 TCP 连接的流量数据
    • 监控: 端口的流量数据
    • 单条通道统计: ChannelStat
    • 所有通道统计: GroupStat
    • 资源共享
    • 成员排序
    • ssl
    • DecodeRunnable
    • 使用 AsynchronousSocketChannel 响应数据
    • 拉黑 IP
    • 深入解析 Tio 源码:构建高性能 Java 网络应用
  • 19_aio

    • ByteBuffer
    • AIO HTTP 服务器
    • 自定义和线程池和池化 ByteBuffer
    • AioHttpServer 应用示例 IP 属地查询
    • 手写 AIO Http 服务器
  • 20_netty

    • Netty TCP Server
    • Netty Web Socket Server
    • 使用 protoc 生成 Java 包文件
    • Netty WebSocket Server 二进制数据传输
    • Netty 组件详解
  • 21_netty-boot

    • Netty-Boot
    • 原理解析
    • 整合 Hot Reload
    • 整合 数据库
    • 整合 Redis
    • 整合 Elasticsearch
    • 整合 Dubbo
    • Listener
    • 文件上传
    • 拦截器
    • Spring Boot 整合 Netty-Boot
    • SSL 配置指南
    • ChannelInitializer
    • Reserve
  • 22_MQ

    • Mica-mqtt
    • EMQX
    • Disruptor
  • 23_tio-utils

    • tio-utils
    • HttpUtils
    • Notification
    • 邮箱
    • JSON
    • 读取文件
    • Base64
    • 上传和下载
    • Http
    • Telegram
    • RsaUtils
    • EnvUtils 使用文档
    • 系统监控
    • 毫秒并发 ID (MCID) 生成方案
  • 24_tio-http-server

    • 使用 Tio-Http-Server 搭建简单的 HTTP 服务
    • tio-boot 添加 HttpRequestHandler
    • 在 Android 上使用 tio-boot 运行 HTTP 服务
    • tio-http-server-native
    • handler 常用操作
  • 25_tio-websocket

    • WebSocket 服务器
    • WebSocket Client
  • 26_tio-im

    • 通讯协议文档
    • ChatPacket.proto 文档
    • java protobuf
    • 数据表设计
    • 创建工程
    • 登录
    • 历史消息
    • 发消息
  • 27_mybatis

    • Tio-Boot 整合 MyBatis
    • 使用配置类方式整合 MyBatis
    • 整合数据源
    • 使用 mybatis-plus 整合 tdengine
    • 整合 mybatis-plus
  • 28_mongodb

    • tio-boot 使用 mongo-java-driver 操作 mongodb
  • 29_elastic-search

    • Elasticsearch
    • JavaDB 整合 ElasticSearch
    • Elastic 工具类使用指南
    • Elastic-search 注意事项
    • ES 课程示例文档
  • 30_magic-script

    • tio-boot 整合 magic-script
  • 31_groovy

    • tio-boot 整合 Groovy
  • 32_firebase

    • 整合 google firebase
    • Firebase Storage
    • Firebase Authentication
    • 使用 Firebase Admin SDK 进行匿名用户管理与自定义状态标记
    • 导出用户
    • 注册回调
    • 登录注册
  • 33_文件存储

    • 文件上传数据表
    • 本地存储
    • 使用 AWS S3 存储文件并整合到 Tio-Boot 项目中
    • 存储文件到 腾讯 COS
  • 34_spider

    • jsoup
    • 爬取 z-lib.io 数据
    • 整合 WebMagic
    • WebMagic 示例:爬取学校课程数据
    • Playwright
    • Flexmark (Markdown 处理器)
    • tio-boot 整合 Playwright
    • 缓存网页数据
  • 36_integration_thirty_party

    • tio-boot 整合 okhttp
    • 整合 GrpahQL
    • 集成 Mailjet
    • 整合 ip2region
    • 整合 GeoLite 离线库
    • 整合 Lark 机器人指南
    • 集成 Lark Mail 实现邮件发送
    • Thymeleaf
    • Swagger
    • Clerk 验证
  • 37_dubbo

    • 概述
    • dubbo 2.6.0
    • dubbo 2.6.0 调用过程
    • dubbo 3.2.0
  • 38_spring

    • Spring Boot Web 整合 Tio Boot
    • spring-boot-starter-webflux 整合 tio-boot
    • Tio Boot 整合 Spring Boot Starter
    • Tio Boot 整合 Spring Boot Starter Data Redis 指南
  • 39_spring-cloud

    • tio-boot spring-cloud
  • 40_mysql

    • 使用 Docker 运行 MySQL
    • /zh/42_mysql/02.html
  • 41_postgresql

    • PostgreSQL 安装
    • PostgreSQL 主键自增
    • PostgreSQL 日期类型
    • Postgresql 金融类型
    • PostgreSQL 数组类型
    • PostgreSQL 全文检索
    • PostgreSQL 查询优化
    • 获取字段类型
    • PostgreSQL 向量
    • PostgreSQL 优化向量查询
    • PostgreSQL 其他
  • 43_oceanbase

    • 快速体验 OceanBase 社区版
    • 快速上手 OceanBase 数据库单机部署与管理
    • 诊断集群性能
    • 优化 SQL 性能指南
    • /zh/43_oceanbase/05.html
  • 50_media

    • JAVE 提取视频中的声音
    • Jave 提取视频中的图片
    • /zh/50_media/03.html
  • 51_asr

    • Whisper-JNI
  • 54_native-media

    • java-native-media
    • JNI 入门示例
    • mp3 拆分
    • mp4 转 mp3
    • 使用 libmp3lame 实现高质量 MP3 编码
    • Linux 编译
    • macOS 编译
    • 从 JAR 包中加载本地库文件
    • 支持的音频和视频格式
    • 任意格式转为 mp3
    • 通用格式转换
    • 通用格式拆分
    • 视频合并
    • VideoToHLS
    • split_video_to_hls 支持其他语言
    • 持久化 HLS 会话
  • 55_telegram4j

    • 数据库设计
    • /zh/55_telegram4j/02.html
    • 基于 MTProto 协议开发 Telegram 翻译机器人
    • 过滤旧消息
    • 保存机器人消息
    • 定时推送
    • 增加命令菜单
    • 使用 telegram-Client
    • 使用自定义 StoreLayout
    • 延迟测试
    • Reactor 错误处理
    • Telegram4J 常见错误处理指南
  • 56_telegram-bots

    • TelegramBots 入门指南
    • 使用工具库 telegram-bot-base 开发翻译机器人
  • 60_LLM

    • 简介
    • AI 问答
    • /zh/60_LLM/03.html
    • /zh/60_LLM/04.html
    • 增强检索(RAG)
    • 结构化数据检索
    • 搜索+AI
    • 集成第三方 API
    • 后置处理
    • 推荐问题生成
    • 连接代码执行器
    • 避免 GPT 混乱
    • /zh/60_LLM/13.html
  • 61_ai_agent

    • 数据库设计
    • 示例问题管理
    • 会话管理
    • 历史记录
    • 对接 Perplexity API
    • 意图识别与生成提示词
    • 智能问答模块设计与实现
    • 文件上传与解析文档
    • 翻译
    • 名人搜索功能实现
    • Ai studio gemini youbue 问答使用说明
    • 自建 YouTube 字幕问答系统
    • 自建 获取 youtube 字幕服务
    • 通用搜索
    • /zh/61_ai_agent/15.html
    • 16
    • 17
    • 18
    • 在 tio-boot 应用中整合 ai-agent
    • 16
  • 62_translator

    • 简介
  • 63_knowlege_base

    • 数据库设计
    • 用户登录实现
    • 模型管理
    • 知识库管理
    • 文档拆分
    • 片段向量
    • 命中测试
    • 文档管理
    • 片段管理
    • 问题管理
    • 应用管理
    • 向量检索
    • 推理问答
    • 问答模块
    • 统计分析
    • 用户管理
    • api 管理
    • 存储文件到 S3
    • 文档解析优化
    • 片段汇总
    • 段落分块与检索
    • 多文档解析
    • 对话日志
    • 检索性能优化
    • Milvus
    • 文档解析方案和费用对比
    • 离线运行向量模型
  • 64_ai-search

    • ai-search 项目简介
    • ai-search 数据库文档
    • ai-search SearxNG 搜索引擎
    • ai-search Jina Reader API
    • ai-search Jina Search API
    • ai-search 搜索、重排与读取内容
    • ai-search PDF 文件处理
    • ai-search 推理问答
    • Google Custom Search JSON API
    • ai-search 意图识别
    • ai-search 问题重写
    • ai-search 系统 API 接口 WebSocket 版本
    • ai-search 搜索代码实现 WebSocket 版本
    • ai-search 生成建议问
    • ai-search 生成问题标题
    • ai-search 历史记录
    • Discover API
    • 翻译
    • Tavily Search API 文档
    • 对接 Tavily Search
    • 火山引擎 DeepSeek
    • 对接 火山引擎 DeepSeek
    • ai-search 搜索代码实现 SSE 版本
    • jar 包部署
    • Docker 部署
    • 爬取一个静态网站的所有数据
    • 网页数据预处理
    • 网页数据检索与问答流程整合
  • 65_java-linux

    • Java 执行 python 代码
    • 通过大模型执行 Python 代码
    • MCP 协议
    • Cline 提示词
    • Cline 提示词-中文版本
  • 66_manim

    • 简介
    • Manim 开发环境搭建
    • 生成场景提示词
    • 生成代码
    • 完整脚本示例
    • 语音合成系统
    • Fish.audio TTS 接口说明文档与 Java 客户端封装
    • 整合 fishaudio 到 java-uni-ai-server 项目
    • 执行 Python (Manim) 代码
    • 使用 SSE 流式传输生成进度的实现文档
    • 整合全流程完整文档
    • HLS 动态推流技术文档
    • manim 分场景生成代码
    • 分场景运行代码及流式播放支持
    • 分场景业务端完整实现流程
    • Maiim布局管理器
    • 仅仅生成场景代码
    • 使用 modal 运行 manim 代码
    • Python 使用 Modal GPU 加速渲染
    • Modal 平台 GPU 环境下运行 Manim
    • Modal Manim OpenGL 安装与使用
    • 优化 GPU 加速
    • 生成视频封面流程
    • Java 调用 manim 命令 执行代码 生成封面
    • Manim 图像生成服务客户端文档
    • manim render help
    • 显示 中文公式
    • manimgl
    • EGL
    • /zh/66_manim/30.html
    • /zh/66_manim/31.html
    • 成本核算
    • /zh/66_manim/33.html
  • 70_tio-boot-admin

    • 入门指南
    • 初始化数据
    • token 存储
    • 与前端集成
    • 文件上传
    • 网络请求
    • 图片管理
    • /zh/70_tio-boot-admin/08.html
    • Word 管理
    • PDF 管理
    • 文章管理
    • 富文本编辑器
  • 71_tio-boot

    • /zh/71_tio-boot/01.html
    • Swagger 整合到 Tio-Boot 中的指南
    • HTTP/1.1 Pipelining 性能测试报告
  • 80_性能测试

    • 压力测试 - tio-http-serer
    • 压力测试 - tio-boot
    • 压力测试 - tio-boot-native
    • 压力测试 - netty-boot
    • 性能测试对比
    • TechEmpower FrameworkBenchmarks
    • 压力测试 - tio-boot 12 C 32G
  • 99_案例

    • 封装 IP 查询服务
    • tio-boot 案例 - 全局异常捕获与企业微信群通知
    • tio-boot 案例 - 文件上传和下载
    • tio-boot 案例 - 整合 ant design pro 增删改查
    • tio-boot 案例 - 流失响应
    • tio-boot 案例 - 增强检索
    • tio-boot 案例 - 整合 function call
    • tio-boot 案例 - 定时任务 监控 PostgreSQL、Redis 和 Elasticsearch
    • Tio-Boot 案例:使用 SQLite 整合到登录注册系统
    • tio-boot 案例 - 执行 shell 命令

封装 IP 查询服务

在互联网应用中,获取用户的地理位置信息是一项常见且重要的功能。本文将详细介绍如何封装一个基于百度 IP 查询服务的 IP 服务,包括从申请百度 API 密钥到实现完整的业务逻辑。通过本文,您将学会如何搭建一个高效、可缓存的 IP 查询服务,减少对百度 API 的调用次数,从而降低成本。

文章目的

本文旨在为开发者提供一个完整的、可参考的案例,展示如何利用百度的 IP 查询 API,结合数据库缓存机制,构建一个高效的 IP 服务。通过本文,您将了解如何配置项目依赖、设计数据库、编写业务逻辑以及实现接口层,从而实现一个功能完善的 IP 查询服务。

前置条件

在开始之前,确保您具备以下条件:

  • 熟悉 Java 编程语言
  • 了解 Maven 项目管理工具
  • 具备基本的数据库操作知识(本文以 PostgreSQL 为例)
  • 拥有百度 API 的访问权限(需要申请 API 密钥)

步骤一:申请百度 API 密钥

首先,您需要在百度开放平台(百度开放平台)注册并申请 IP 查询服务的 API 密钥(AK)。申请过程通常包括:

  1. 注册百度开放平台账号。
  2. 创建新应用,并启用 IP 定位服务。
  3. 获取分配的 API 密钥(AK)。

申请完成后,将获得一个唯一的 AK,用于后续 API 调用。

步骤二:数据库设置

由于调用百度的 IP 查询服务是需要付费的,为了降低成本,我们将采用缓存机制,将查询结果存储在数据库中。以下是创建缓存表的 SQL 语句:

DROP TABLE IF EXISTS sys_baidu_ip;
CREATE TABLE sys_baidu_ip (
  ip VARCHAR PRIMARY KEY,
  address VARCHAR,
  adcode VARCHAR,
  city VARCHAR,
  city_code INT,
  district VARCHAR,
  province VARCHAR,
  street VARCHAR,
  street_number VARCHAR,
  x VARCHAR,
  y VARCHAR,
  creator VARCHAR(64) DEFAULT '',
  create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT CURRENT_TIMESTAMP,
  updater VARCHAR(64) DEFAULT '',
  update_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT CURRENT_TIMESTAMP,
  deleted SMALLINT DEFAULT 0,
  tenant_id BIGINT NOT NULL DEFAULT 0
);

表结构说明

  • ip:IP 地址,作为主键。
  • address:地理位置描述。
  • adcode:行政区划代码。
  • city、province、district等字段:详细的地理信息。
  • x、y:坐标信息。
  • 其他字段用于记录创建和更新时间,以及租户信息。

步骤三:Maven 项目配置(pom.xml)

在项目的pom.xml文件中,配置必要的依赖项和项目属性。以下是一个示例配置:

<properties>
  <!-- 项目属性 -->
  <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  <java.version>1.8</java.version>
  <maven.compiler.source>${java.version}</maven.compiler.source>
  <maven.compiler.target>${java.version}</maven.compiler.target>

  <!-- 版本属性 -->
  <graalvm.version>23.1.1</graalvm.version>
  <fastjson2.version>2.0.52</fastjson2.version>
  <lombok-version>1.18.30</lombok-version>
  <java-model.version>1.1.4</java-model.version>
  <tio-utils.version>3.7.3.v20241014-RELEASE</tio-utils.version>
  <tio-boot.version>1.9.5</tio-boot.version>
  <hotswap-classloader.version>1.2.6</hotswap-classloader.version>
  <jfinal-aop.version>1.3.3</jfinal-aop.version>
  <java-db.version>1.4.3</java-db.version>
  <!-- 应用程序属性 -->
  <final.name>web-hello</final.name>
  <main.class>com.litongjava.ip.baidu.BaiduAppServer</main.class>
</properties>

<dependencies>
    <!-- 日志框架 -->
    <dependency>
      <groupId>ch.qos.logback</groupId>
      <artifactId>logback-classic</artifactId>
      <version>1.2.3</version>
    </dependency>

    <!-- IP2Region 用于IP查询 -->
    <dependency>
      <groupId>org.lionsoul</groupId>
      <artifactId>ip2region</artifactId>
      <version>2.7.0</version>
    </dependency>

    <dependency>
      <groupId>com.litongjava</groupId>
      <artifactId>java-model</artifactId>
      <version>${java-model.version}</version>
    </dependency>

    <dependency>
      <groupId>com.litongjava</groupId>
      <artifactId>tio-utils</artifactId>
      <version>${tio-utils.version}</version>
    </dependency>

    <dependency>
      <groupId>com.litongjava</groupId>
      <artifactId>tio-boot</artifactId>
      <version>${tio-boot.version}</version>
    </dependency>

    <dependency>
      <groupId>com.litongjava</groupId>
      <artifactId>hotswap-classloader</artifactId>
      <version>${hotswap-classloader.version}</version>
    </dependency>


    <dependency>
      <groupId>com.litongjava</groupId>
      <artifactId>jfinal-aop</artifactId>
      <version>${jfinal-aop.version}</version>
    </dependency>

    <dependency>
      <groupId>com.litongjava</groupId>
      <artifactId>java-db</artifactId>
      <version>${java-db.version}</version>
    </dependency>


    <dependency>
      <groupId>org.postgresql</groupId>
      <artifactId>postgresql</artifactId>
      <version>42.2.24</version>
    </dependency>

    <dependency>
      <groupId>com.zaxxer</groupId>
      <artifactId>HikariCP</artifactId>
      <version>4.0.3</version>
    </dependency>


    <!-- FastJSON2 用于 JSON 解析 -->
    <dependency>
      <groupId>com.alibaba.fastjson2</groupId>
      <artifactId>fastjson2</artifactId>
      <version>${fastjson2.version}</version>
    </dependency>

    <!-- Lombok 用于简化代码 -->
    <dependency>
      <groupId>org.projectlombok</groupId>
      <artifactId>lombok</artifactId>
      <version>${lombok-version}</version>
      <optional>true</optional>
      <scope>provided</scope>
    </dependency>

    <!-- JUnit 用于测试 -->
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.12</version>
      <scope>test</scope>
    </dependency>
</dependencies>

关键依赖说明

  • logback-classic:日志框架,用于记录日志信息。
  • ip2region:本地 IP 查询库,提高查询效率,减少对外部 API 的依赖。
  • fastjson2:用于 JSON 解析。
  • OkHttp:HTTP 客户端,用于发送 API 请求。
  • Lombok:简化 Java 代码,减少样板代码。
  • JUnit:用于编写和运行测试用例。

步骤四:配置文件

配置项目所需的属性文件,包括应用环境、数据库连接信息和 API 密钥。

app.properties

app.env=dev
server.port=8011

app-dev.properties

DATABASE_DSN=postgresql://postgres:123456@192.168.3.9/little_red_book_data
jdbc.MaximumPoolSize=2

.env

baidu.ak=YOUR_BAIDU_AK_HERE

说明:

  • app.env:指定应用运行环境(开发环境为dev)。
  • server.port:应用服务器监听的端口号。
  • DATABASE_DSN:数据库连接字符串,包含数据库类型、用户名、密码和地址。
  • baidu.ak:百度 API 的访问密钥,需要替换为实际申请到的 AK。

步骤五:客户端实现(BaiduIpClient)

实现与百度 IP 查询 API 的交互,负责发送 HTTP 请求并处理响应。

package com.litongjava.ip.baidu.client;

import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.util.LinkedHashMap;
import java.util.Map;

import com.litongjava.model.http.response.ResponseVo;
import com.litongjava.tio.utils.environment.EnvUtils;
import com.litongjava.tio.utils.http.Http;

public class BaiduIpClient {

  public static String URL = "https://api.map.baidu.com/location/ip?";
  public static String AK = EnvUtils.get("baidu.ak");

  /**
   * 查询IP信息。
   *
   * @param ip 要查询的IP地址
   * @return 响应结果
   */
  public static ResponseVo index(String ip) {
    if (AK == null) {
      throw new RuntimeException("AK为空,请检查配置文件中的baidu.ak");
    }

    Map<String, String> params = new LinkedHashMap<>();
    params.put("ip", ip);
    params.put("coor", "bd09ll");
    params.put("ak", AK);
    return requestGetAK(URL, params);
  }

  /**
   * 发送GET请求到指定URL,并附带参数。
   *
   * @param strUrl 请求URL
   * @param param  请求参数
   * @return 响应结果
   */
  public static ResponseVo requestGetAK(String strUrl, Map<String, String> param) {
    if (strUrl == null || strUrl.isEmpty() || param == null || param.isEmpty()) {
      return null;
    }

    StringBuilder targetUrl = new StringBuilder(strUrl);

    for (Map.Entry<String, String> pair : param.entrySet()) {
      targetUrl.append(pair.getKey()).append("=");
      try {
        String encodedValue = URLEncoder.encode(pair.getValue(), "UTF-8").replace("+", "%20") + "&";
        targetUrl.append(encodedValue);
      } catch (UnsupportedEncodingException e) {
        throw new RuntimeException("URL编码失败", e);
      }
    }

    // 移除最后一个'&'字符
    if (targetUrl.length() > 0) {
      targetUrl.deleteCharAt(targetUrl.length() - 1);
    }

    return Http.get(targetUrl.toString());
  }
}

关键功能说明

  • index 方法:接收 IP 地址,构建请求参数,并调用requestGetAK方法发送请求。
  • requestGetAK 方法:构建完整的请求 URL,进行 URL 编码,并发送 GET 请求。

步骤六:常量定义

定义数据库表名等常量,便于维护和修改。

package com.litongjava.ip.baidu.consts;

public interface TableNames {
  String SYS_BAIDU_IP = "sys_baidu_ip";
}

说明:将表名定义为常量,避免在代码中硬编码,增加可读性和可维护性。

步骤七:数据层实现(BaiduIpDao)

实现数据访问对象(DAO),负责与数据库进行交互,包括查询和保存 IP 信息。

package com.litongjava.ip.baidu.dao;

import com.litongjava.db.activerecord.Db;
import com.litongjava.db.activerecord.Row;
import com.litongjava.ip.baidu.consts.TableNames;

public class BaiduIpDao {

  /**
   * 根据IP查询地址信息。
   *
   * @param ip IP地址
   * @return 地址信息
   */
  public String getAddressById(String ip) {
    String sql = "SELECT address FROM %s WHERE ip=?";
    return Db.queryStr(String.format(sql, TableNames.SYS_BAIDU_IP), ip);
  }

  /**
   * 保存IP信息到数据库。
   *
   * @param ip           IP地址
   * @param address      地址信息
   * @param adcode       行政区划代码
   * @param province     省份
   * @param city         城市
   * @param city_code    城市代码
   * @param district     区县
   * @param street       街道
   * @param street_number 街道编号
   * @param x            经度
   * @param y            纬度
   * @return 保存是否成功
   */
  public boolean save(String ip, String address, String adcode, String province, String city, Integer city_code, String district, String street, String street_number, String x, String y) {
    Row row = Row.by("ip", ip);
    row.set("address", address)
          .set("adcode", adcode)
          .set("province", province)
          .set("city", city)
          .set("city_code", city_code)
          .set("district", district)
          .set("street", street)
          .set("street_number", street_number)
          .set("x", x)
          .set("y", y);
    return Db.save(TableNames.SYS_BAIDU_IP, row);
  }
}

关键功能说明

  • getAddressById 方法:通过 IP 地址查询缓存表中的地址信息。
  • save 方法:将从百度 API 获取的 IP 信息保存到数据库中,便于下次查询时直接使用缓存。

步骤八:业务层实现(BaiduIpService 和 IpService)

业务层负责处理具体的业务逻辑,包括查询、缓存和判断 IP 归属地。

BaiduIpService

package com.litongjava.ip.baidu.service;

import com.alibaba.fastjson2.JSONObject;
import com.litongjava.ip.baidu.client.BaiduIpClient;
import com.litongjava.ip.baidu.dao.BaiduIpDao;
import com.litongjava.jfinal.aop.Aop;
import com.litongjava.model.http.response.ResponseVo;
import com.litongjava.tio.utils.json.FastJson2Utils;

public class BaiduIpService {

  /**
   * 根据IP查询地址信息,如果缓存中有则直接返回,否则调用百度API查询并缓存结果。
   *
   * @param ip IP地址
   * @return 地址信息或null
   */
  public String search(String ip) {
    // 从缓存中查询
    String address = Aop.get(BaiduIpDao.class).getAddressById(ip);
    if (address != null) {
      return address;
    }

    ResponseVo responseVo;
    try {
      // 调用百度API查询
      responseVo = BaiduIpClient.index(ip);
    } catch (Exception e) {
      throw new RuntimeException("调用百度API失败", e);
    }

    if (responseVo.isOk()) {
      JSONObject jsonObject = FastJson2Utils.parseObject(responseVo.getBodyString());
      Integer status = jsonObject.getInteger("status");
      if (status == 0) {
        // 解析响应结果
        address = jsonObject.getString("address");
        JSONObject content = jsonObject.getJSONObject("content");
        JSONObject address_detail = content.getJSONObject("address_detail");
        JSONObject point = content.getJSONObject("point");

        String adcode = address_detail.getString("adcode");
        String city = address_detail.getString("city");
        Integer city_code = address_detail.getInteger("city_code");
        String district = address_detail.getString("district");
        String province = address_detail.getString("province");
        String street = address_detail.getString("street");
        String street_number = address_detail.getString("street_number");

        String x = point.getString("x");
        String y = point.getString("y");

        // 将结果保存到缓存
        Aop.get(BaiduIpDao.class).save(ip, address, adcode, province, city, city_code, district, street, street_number, x, y);
        return address;
      } else {
        return null;
      }
    } else {
      return null;
    }
  }
}

IpService

package com.litongjava.ip.baidu.service;

import com.litongjava.ip.baidu.utils.Ip2RegionUtils;
import com.litongjava.ip.baidu.utils.IpRegionUtils;
import com.litongjava.jfinal.aop.Aop;

public class IpService {

  /**
   * 根据IP查询地理位置信息。
   *
   * @param ip IP地址
   * @return 地理位置信息
   */
  public String search(String ip) {
    // 校验IP格式
    boolean checkIp = Ip2RegionUtils.checkIp(ip);
    if (!checkIp) {
      return "不是有效的IP地址";
    }

    // 使用ip2region进行本地查询
    String searchIp = Ip2RegionUtils.searchIp(ip);
    String[] split = searchIp.split("\\|");
    String area = split[2];

    // 判断是否为中国大陆IP
    if (isChinaMainland(searchIp, area)) {
      String result = Aop.get(BaiduIpService.class).search(ip);
      if (result != null) {
        return result;
      }
    }
    return searchIp;
  }

  /**
   * 根据IP查询所属区域代码。
   *
   * @param ip IP地址
   * @return 区域代码
   */
  public String area(String ip) {
    // 校验IP格式
    boolean checkIp = Ip2RegionUtils.checkIp(ip);
    if (!checkIp) {
      return "不是有效的IP地址";
    }

    // 使用ip2region进行本地查询
    String searchIp = Ip2RegionUtils.searchIp(ip);
    String[] split = searchIp.split("\\|");
    String area = split[2];

    // 判断是否为中国大陆IP
    if (isChinaMainland(searchIp, area)) {
      String result = Aop.get(BaiduIpService.class).search(ip);
      if (result != null) {
        return "86"; // 中国大陆区号
      }
    }

    return String.valueOf(IpRegionUtils.type(area));
  }

  /**
   * 判断IP是否属于中国大陆。
   *
   * @param searchIp 查询结果
   * @param area     区域名称
   * @return 是否为中国大陆IP
   */
  private boolean isChinaMainland(String searchIp, String area) {
    if (searchIp.startsWith("中国")) {
      if ("香港".equals(area) || "澳门".equals(area) || "台湾".equals(area)) {
        return false;
      } else {
        return true;
      }
    } else if (searchIp.startsWith("0")) {
      return true;
    }
    return false;
  }
}

关键功能说明

  • search 方法:首先校验 IP 格式,然后使用本地的 ip2region 库查询 IP 信息。如果 IP 属于中国大陆,则调用百度 API 查询详细信息并缓存结果;否则,直接返回本地查询结果。
  • area 方法:返回 IP 所属区域的代码,例如中国大陆为86,香港为852等。
  • isChinaMainland 方法:辅助判断 IP 是否属于中国大陆,排除香港、澳门和台湾。

步骤九:工具类实现(Ip2RegionUtils 和 IpRegionUtils)

工具类用于 IP 格式校验和 IP 归属地查询。

Ip2RegionUtils

package com.litongjava.ip.baidu.utils;

import java.io.IOException;
import java.net.URL;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import org.lionsoul.ip2region.xdb.Searcher;

import com.litongjava.tio.utils.hutool.FileUtil;
import com.litongjava.tio.utils.hutool.ResourceUtil;

public enum Ip2RegionUtils {
  INSTANCE;

  // IP地址正则表达式
  private static final String IP_REGEX = "([1-9]|[1-9]\\d|1\\d{2}|2[0-4]\\d|25[0-5])(\\.(\\d|[1-9]\\d|1\\d{2}|2[0-4]\\d|25[0-5])){3}";
  private static final Pattern pattern = Pattern.compile(IP_REGEX);

  private static Searcher searcher;

  static {
    // 加载ip2region数据库
    URL resource = ResourceUtil.getResource("ipdb/ip2region.xdb");
    if (resource != null) {
      byte[] bytes = FileUtil.readUrlAsBytes(resource);
      try {
        searcher = Searcher.newWithBuffer(bytes);
      } catch (IOException e) {
        e.printStackTrace();
      }
    }
  }

  /**
   * 校验IP格式是否有效。
   *
   * @param ipAddress IP地址
   * @return 是否有效
   */
  public static boolean checkIp(String ipAddress) {
    Matcher matcher = pattern.matcher(ipAddress);
    return matcher.matches();
  }

  /**
   * 根据IP地址查询归属地。
   *
   * @param ip IP地址
   * @return 归属地信息
   */
  public static String searchIp(String ip) {
    if (searcher != null) {
      try {
        return searcher.search(ip);
      } catch (Exception e) {
        throw new RuntimeException("IP查询失败", e);
      }
    }
    return null;
  }
}

IpRegionUtils

package com.litongjava.ip.baidu.utils;

public class IpRegionUtils {

  /**
   * 根据区域名称返回对应的区域代码。
   *
   * @param area 区域名称
   * @return 区域代码
   */
  public static int type(String area) {
    switch (area) {
      case "香港":
        return 852;
      case "澳门":
        return 853;
      case "台湾":
        return 886;
      default:
        return 0; // 全球
    }
  }
}

关键功能说明

  • Ip2RegionUtils:
    • checkIp 方法:使用正则表达式校验 IP 地址格式。
    • searchIp 方法:通过 ip2region 库查询 IP 归属地信息,避免频繁调用外部 API。
  • IpRegionUtils:
    • type 方法:将区域名称转换为对应的区号,例如香港为852。

步骤十:接口层实现(IpHandler)

实现 HTTP 接口,接收客户端请求并返回查询结果。

package com.litongjava.ip.baidu.handler;

import com.litongjava.ip.baidu.service.IpService;
import com.litongjava.jfinal.aop.Aop;
import com.litongjava.tio.boot.http.TioRequestContext;
import com.litongjava.tio.http.common.HttpRequest;
import com.litongjava.tio.http.common.HttpResponse;
import com.litongjava.tio.http.server.util.CORSUtils;
import com.litongjava.tio.http.server.util.Resps;

public class IpHandler {

  /**
   * 处理IP查询请求。
   *
   * @param request HTTP请求
   * @return HTTP响应
   */
  public HttpResponse search(HttpRequest request) {
    HttpResponse response = TioRequestContext.getResponse();
    // 启用CORS支持
    CORSUtils.enableCORS(response);
    // 获取请求参数中的IP地址
    String ip = request.getParam("ip");
    // 调用业务层查询IP信息
    String result = Aop.get(IpService.class).search(ip);
    // 返回文本响应
    Resps.txt(response, result);
    return response;
  }

  /**
   * 处理IP区域代码查询请求。
   *
   * @param request HTTP请求
   * @return HTTP响应
   */
  public HttpResponse area(HttpRequest request) {
    HttpResponse response = TioRequestContext.getResponse();
    // 启用CORS支持
    CORSUtils.enableCORS(response);
    // 获取请求参数中的IP地址
    String ip = request.getParam("ip");
    // 调用业务层查询IP所属区域代码
    String result = Aop.get(IpService.class).area(ip);
    // 返回文本响应
    Resps.txt(response, result);
    return response;
  }
}

关键功能说明

  • search 方法:接收 IP 查询请求,调用业务层获取地址信息,并返回给客户端。
  • area 方法:接收 IP 区域代码查询请求,调用业务层获取区域代码,并返回给客户端。
  • CORS 支持:允许跨域请求,确保 API 可以被不同域名的前端应用访问。

步骤十一:配置层实现(DbConfig 和 WebConfig)

配置数据库连接和 HTTP 路由,确保各个组件能够正确协同工作。

DbConfig

package com.litongjava.ip.baidu.config;

import com.jfinal.template.Engine;
import com.jfinal.template.source.ClassPathSourceFactory;
import com.litongjava.annotation.AConfiguration;
import com.litongjava.annotation.Initialization;
import com.litongjava.db.activerecord.ActiveRecordPlugin;
import com.litongjava.db.activerecord.OrderedFieldContainerFactory;
import com.litongjava.db.activerecord.dialect.PostgreSqlDialect;
import com.litongjava.db.hikaricp.HikariCpPlugin;
import com.litongjava.model.dsn.JdbcInfo;
import com.litongjava.tio.boot.server.TioBootServer;
import com.litongjava.tio.utils.dsn.DbDSNParser;
import com.litongjava.tio.utils.environment.EnvUtils;

import lombok.extern.slf4j.Slf4j;

@Slf4j
@AConfiguration
public class DbConfig {

  @Initialization
  public void config() {
    // 获取数据库连接信息
    String dsn = EnvUtils.getStr("DATABASE_DSN");
    log.info("数据库DSN: {}", dsn);
    if (dsn == null) {
      return;
    }
    JdbcInfo jdbc = new DbDSNParser().parse(dsn);

    // 初始化 HikariCP 数据库连接池
    final HikariCpPlugin hikariCpPlugin = new HikariCpPlugin(jdbc.getUrl(), jdbc.getUser(), jdbc.getPswd());
    int maximumPoolSize = EnvUtils.getInt("jdbc.MaximumPoolSize", 10);
    hikariCpPlugin.setMaximumPoolSize(maximumPoolSize);
    hikariCpPlugin.start();

    // 初始化 ActiveRecordPlugin
    final ActiveRecordPlugin arp = new ActiveRecordPlugin(hikariCpPlugin);

    // 开发环境下启用开发模式
    if (EnvUtils.isDev()) {
      arp.setDevMode(true);
    }

    // 是否展示 SQL
    boolean showSql = EnvUtils.getBoolean("jdbc.showSql", false);
    log.info("是否展示SQL: {}", showSql);
    arp.setShowSql(showSql);
    arp.setDialect(new PostgreSqlDialect());
    arp.setContainerFactory(new OrderedFieldContainerFactory());

    // 配置模板引擎
    Engine engine = arp.getEngine();
    engine.setSourceFactory(new ClassPathSourceFactory());
    engine.setCompressorOn(); // 启用压缩功能

    // 启动 ActiveRecordPlugin
    arp.start();
    // 添加销毁方法,确保应用关闭时释放资源
    HookCan.me().addDestroyMethod(() -> {
      hikariCpPlugin.stop();
      arp.stop();
    });
  }
}

WebConfig

package com.litongjava.ip.baidu.config;

import com.litongjava.annotation.AConfiguration;
import com.litongjava.annotation.Initialization;
import com.litongjava.ip.baidu.handler.IpHandler;
import com.litongjava.tio.boot.server.TioBootServer;
import com.litongjava.tio.http.server.router.HttpRequestRouter;

@AConfiguration
public class WebConfig {

  @Initialization
  public void config() {
    // 获取服务器实例和路由器
    TioBootServer server = TioBootServer.me();
    HttpRequestRouter requestRouter = server.getRequestRouter();

    // 创建IP处理器实例
    IpHandler ipHandler = new IpHandler();
    // 添加路由映射
    requestRouter.add("/ip", ipHandler::search);
    requestRouter.add("/area", ipHandler::area);
  }
}

关键功能说明

  • DbConfig:
    • 配置数据库连接池(HikariCP)和 ActiveRecord 插件,确保应用能够与数据库正常通信。
    • 根据环境变量设置开发模式和 SQL 日志输出。
  • WebConfig:
    • 配置 HTTP 路由,将特定 URL 路径映射到对应的处理器方法。
    • 例如,/ip路径映射到IpHandler的search方法,/area路径映射到area方法。

步骤十二:测试接口

配置完成后,可以通过以下 URL 进行接口测试:

  1. 查询 IP 地址信息

    GET http://127.0.0.1:8011/ip?ip=111.55.13.145
    

    预期响应:

    中国|0|香港|0|0
    
  2. 查询 IP 地址区域代码

    GET http://127.0.0.1:8011/area?ip=154.212.150.171
    

    预期响应:

    852
    

测试说明

  • /ip 接口:返回指定 IP 的地理位置信息。如果 IP 属于中国大陆,会优先从缓存中查询,否则返回本地查询结果。
  • /area 接口:返回指定 IP 所属区域的代码,例如中国大陆为86,香港为852等。

结论

通过本文的详细步骤,您已经学会了如何封装一个基于百度 IP 查询服务的 IP 服务。该服务结合了本地缓存和外部 API 查询,既提高了查询效率,又有效控制了成本。您可以根据实际需求,进一步扩展和优化该服务,例如增加更多的缓存策略、支持更多的查询参数或集成到更复杂的系统中。

希望本文对您在实际项目中实现 IP 查询功能有所帮助!

Edit this page
Last Updated:
Contributors: Tong Li
Next
tio-boot 案例 - 全局异常捕获与企业微信群通知