ruoyi-vue-pro 开发指南 ruoyi-vue-pro 开发指南
  • 萌新必读
  • 后端手册
  • 中间件手册
  • 工作流手册
  • 大屏手册
  • 支付手册
  • 商城手册
  • 公众号手册
  • 系统手册
  • 运维手册
  • 前端手册 Vue 2.x
  • 前端手册 Vue 3.x
  • 工作流手册
  • 大屏手册
  • 支付手册
  • 商城手册
  • 公众号手册
  • 系统手册
视频教程
  • Vue3 + element-plus (opens new window)
  • Vue3 + vben(ant-design-vue) (opens new window)
  • Vue2 + element-ui (opens new window)
微服务版 (opens new window)
作者博客 (opens new window)
GitHub (opens new window)
  • 萌新必读
  • 后端手册
  • 中间件手册
  • 工作流手册
  • 大屏手册
  • 支付手册
  • 商城手册
  • 公众号手册
  • 系统手册
  • 运维手册
  • 前端手册 Vue 2.x
  • 前端手册 Vue 3.x
  • 工作流手册
  • 大屏手册
  • 支付手册
  • 商城手册
  • 公众号手册
  • 系统手册
视频教程
  • Vue3 + element-plus (opens new window)
  • Vue3 + vben(ant-design-vue) (opens new window)
  • Vue2 + element-ui (opens new window)
微服务版 (opens new window)
作者博客 (opens new window)
GitHub (opens new window)
  • 萌新必读

    • 简介
    • 交流群
    • 视频教程
    • 功能列表
    • 快速启动(后端项目)
    • 快速启动(前端项目)
    • 接口文档
    • 技术选型
    • 项目结构
    • 代码热加载
    • 一键改包
    • 删除功能
    • 内网穿透
    • 达梦数据库专属
  • 后端手册

    • 新建模块
    • 代码生成【单表】(新增功能)
    • 代码生成【主子表】
    • 代码生成(树表)
    • 功能权限
    • 数据权限
    • 用户体系
    • 三方登录
    • OAuth 2.0(SSO 单点登录)
    • SaaS 多租户【字段隔离】
    • SaaS 多租户【数据库隔离】
    • WebSocket 实时通信
    • 异常处理(错误码)
    • 参数校验
    • 分页实现
    • 文件存储(上传下载)
    • Excel 导入导出
    • 系统日志
    • MyBatis 数据库
    • MyBatis 联表&分页查询
    • 多数据源(读写分离)
    • Redis 缓存
    • 本地缓存
    • 异步任务
    • 配置管理
    • 工具类 Util
    • 单元测试
    • 分布式锁
    • 幂等性(防重复提交)
    • 数据库文档
    • 验证码
  • 中间件手册

    • 定时任务
    • 消息队列(内存)
    • 消息队列(Redis)
    • 消息队列(RocketMQ)
    • 消息队列(RabbitMQ)
    • 消息队列(Kafka)
    • 限流熔断
  • 工作流手册

    • 工作流(Flowable)会签、或签
  • 商城手册

    • 商城演示
    • 功能开启
  • 大屏手册

    • 报表设计器
    • 大屏设计器
  • 支付手册

    • 功能开启
    • 支付宝支付接入
    • 微信公众号支付接入
    • 微信小程序支付接入
    • 支付宝、微信退款接入
  • 公众号手册

    • 功能开启
    • 公众号接入
    • 公众号粉丝
    • 公众号标签
    • 公众号消息
    • 自动回复
    • 公众号菜单
    • 公众号素材
    • 公众号图文
    • 公众号统计
  • 系统手册

    • 短信配置
    • 邮件配置
    • 站内信配置
    • 数据脱敏
    • 敏感词
    • 地区 & IP 库
      • 1. 地区
      • 2. IP
  • 运维手册

    • 开发环境
    • Linux 部署
    • Docker 部署
    • Jenkins 部署
    • HTTPS 证书
    • 服务监控
  • 前端手册 Vue 3.x

    • 开发规范
    • 菜单路由
    • Icon 图标
    • 字典数据
    • 系统组件
    • 通用方法
    • 配置读取
    • CRUD 组件
    • 国际化
    • IDE 调试
    • 代码格式化
  • 前端手册 Vue 2.x

    • 开发规范
    • 菜单路由
    • Icon 图标
    • 字典数据
    • 系统组件
    • 通用方法
    • 配置读取
  • 更新日志

    • 【v1.9.0】开发中
    • 【v1.8.3】2023-10-24
    • 【v1.8.2】2023-09-24
    • 【v1.8.1】2023-09-04
    • 【v1.8.0】2023-07-27
  • 开发指南
  • 系统手册
芋道源码
2022-12-29
目录

地区 & IP 库

yudao-spring-boot-starter-biz-ip (opens new window) 业务组件,提供地区 & IP 库的封装。

# 1. 地区

AreaUtils (opens new window) 是地区工具类,可以查询中国的省、市、区县,也可以查询国外的国家。

它的数据来自 Administrative-divisions-of-China (opens new window) 项目,最终整理到项目的 area.csv (opens new window) 文件。每一行的数据,对应 Area (opens new window) 对象。代码所示:

public class Area {

    /**
     * 编号
     */
    private Integer id;
    /**
     * 名字
     */
    private String name;
    /**
     * 类型
     *
     * 枚举 {@link AreaTypeEnum}
     * 1 - 国家
     * 2 - 省份
     * 3 - 城市
     * 4 - 地区, 例如说县、镇、区等
     */
    private Integer type;

    /**
     * 父节点
     */
    private Area parent;
    /**
     * 子节点
     */
    private List<Area> children;
    
}

AreaUtils 主要有如下两个方法:

// AreaUtils.java

/**
 * 获得指定编号对应的区域
 *
 * @param id 区域编号
 * @return 区域
 */
public static Area getArea(Integer id) {
    // ... 省略具体实现
}

/**
 * 格式化区域
 *
 * 例如说:
 *      1. id = “静安区”时:上海 上海市 静安区
 *      2. id = “上海市”时:上海 上海市
 *      3. id = “上海”时:上海
 *      4. id = “美国”时:美国
 * 当区域在中国时,默认不显示中国
 *
 * @param id 区域编号
 * @param separator 分隔符
 * @return 格式化后的区域
 */
public static String format(Integer id, String separator) {
    // ... 省略具体实现
}
  • 具体的使用,可见 AreaUtilsTest (opens new window) 测试类。

另外,管理后台提供了 [系统管理 -> 地区管理] 菜单,可以按照树形结构查看地区列表。如下图所示:

地区管理

  • 后端代码,对应 AreaController (opens new window) 的 /admin-api/system/area/tree 接口
  • 前端代码,对应 system/area/index.vue (opens new window) 界面

# 2. IP

IPUtils (opens new window) 是 IP 工具类,可以查询 IP 对应的城市信息。

它的数据来自 ip2region (opens new window) 项目,最终整理到项目的 ip2region.xdb (opens new window) 文件。

IPUtils 主要有如下两个方法:

// IPUtils.java
/**
 * 查询 IP 对应的地区编号
 *
 * @param ip IP 地址,格式为 127.0.0.1
 * @return 地区id
 */
public static Integer getAreaId(String ip) {
    // ... 省略具体实现
}

/**
 * 查询 IP 对应的地区
 *
 * @param ip IP 地址,格式为 127.0.0.1
 * @return 地区
 */
public static Area getArea(String ip) {
        // ... 省略具体实现
}
  • 具体的使用,可见 IPUtilsTest (opens new window) 测试类。

另外,管理后台提供了 [系统管理 -> 地区管理] 菜单,也提供了 IP 查询城市的示例。如下图所示:

IP 查询城市

  • 后端代码,对应 AreaController (opens new window) 的 /admin-api/system/area/get-by-ip 接口
敏感词
开发环境

← 敏感词 开发环境→

Theme by Vdoing | Copyright © 2019-2023 芋道源码 | MIT License
  • 跟随系统
  • 浅色模式
  • 深色模式
  • 阅读模式
×