1、新增ip服务查询接口,对接阿里云第三方服务,服务封装、ip模块旧引用清理、新增ip服务开关和配置;2、新增组织地理信息字段;3、新增登录对地理信息的校验;

This commit is contained in:
gaoqr
2024-11-05 14:38:34 +08:00
parent eadb7f7633
commit 90eb6b8d6d
32 changed files with 463 additions and 4228 deletions
@@ -66,4 +66,17 @@ public class StrUtils {
.collect(Collectors.joining("\n"));
}
/**
* a字符串是否包含b
*
* @param a
* @param b
* @return
*/
public static boolean contains(String a, String b) {
if (CharSequenceUtil.isEmpty(a) || CharSequenceUtil.isEmpty(b)) {
return false;
}
return a.contains(b);
}
}
@@ -25,12 +25,6 @@
<artifactId>cf-common</artifactId>
</dependency>
<!-- IP地址检索 -->
<dependency>
<groupId>org.lionsoul</groupId>
<artifactId>ip2region</artifactId>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
@@ -48,6 +42,16 @@
<artifactId>cf-spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<scope>provided</scope>
</dependency>
</dependencies>
</project>
@@ -0,0 +1,23 @@
package com.cf.imes.framework.ip.config;
import com.cf.imes.framework.ip.core.property.IPQueryProperties;
import com.cf.imes.framework.ip.core.service.IPQueryService;
import com.cf.imes.framework.ip.core.service.imp.IPQueryServiceImpl;
import org.springframework.boot.autoconfigure.AutoConfiguration;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
/**
* ip自动注册配置
*
* @author 晨丰科技
*/
@AutoConfiguration
@EnableConfigurationProperties(IPQueryProperties.class)
public class ChenfengIPAutoConfiguration {
@Bean
public IPQueryService ipQueryService() {
return new IPQueryServiceImpl();
}
}
@@ -1,55 +0,0 @@
package com.cf.imes.framework.ip.core;
import com.cf.imes.framework.ip.core.enums.AreaTypeEnum;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import java.util.List;
/**
* 区域节点,包括国家、省份、城市、地区等信息
*
* 数据可见 resources/area.csv 文件
*
* @author 晨丰科技
*/
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Area {
/**
* 编号 - 全球,即根目录
*/
public static final Integer ID_GLOBAL = 0;
/**
* 编号 - 中国
*/
public static final Integer ID_CHINA = 1;
/**
* 编号
*/
private Integer id;
/**
* 名字
*/
private String name;
/**
* 类型
*
* 枚举 {@link AreaTypeEnum}
*/
private Integer type;
/**
* 父节点
*/
private Area parent;
/**
* 子节点
*/
private List<Area> children;
}
@@ -0,0 +1,13 @@
package com.cf.imes.framework.ip.core.enums;
import com.cf.imes.framework.common.exception.ErrorCode;
/**
* ip查询 错误码枚举类
*
* 使用 1-008-000-000 段
*/
public class ErrorCodeConstants {
public static final ErrorCode IP_QUERY_ERROR = new ErrorCode(1_008_000_000, "IP归属地查询异常,请联系客服处理");
}
@@ -0,0 +1,51 @@
package com.cf.imes.framework.ip.core.property;
import com.cf.imes.framework.common.util.encrypt.AesUtils;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.NoArgsConstructor;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.properties.ConfigurationProperties;
/**
* ip查询服务配置
* @author Gqr
* @since 2024/10/30 9:59
*/
@ConfigurationProperties(prefix = "chenfeng.ipquery")
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class IPQueryProperties {
@Value("${chenfeng.encrypt.publicKey:}")
private String publicKey;
/**
* 接口地址
*/
private String apiUrl;
/**
* 接口认证编码
*/
private String appCode;
public String getAppCode() {
return appCode;
}
public IPQueryProperties setAppCode(String appCode) {
this.appCode = AesUtils.decrypt(appCode, publicKey);
return this;
}
public String getApiUrl() {
return apiUrl;
}
public void setApiUrl(String apiUrl) {
this.apiUrl = apiUrl;
}
}
@@ -0,0 +1,19 @@
package com.cf.imes.framework.ip.core.service;
import com.cf.imes.framework.ip.core.service.dto.IPQueryDataRespDTO;
/**
* ip查询服务
*
* @author Gqr
* @since 2024/10/30 10:54
*/
public interface IPQueryService {
/**
* 查询ip归属地
*
* @param ip
* @return
*/
IPQueryDataRespDTO querySource(String ip);
}
@@ -0,0 +1,83 @@
package com.cf.imes.framework.ip.core.service.dto;
import lombok.Data;
import java.io.Serializable;
/**
* ip来源查询明细
*
* @author Gqr
* @since 2024/10/30 11:00
*/
@Data
public class IPQueryDataRespDTO implements Serializable {
private static final long serialVersionUID = 3403763102169461000L;
/**
* 国家
*/
private String country;
/**
* 国家编号
*/
private String countryCode;
/**
* 省份
*/
private String prov;
/**
* 城市
*/
private String city;
/**
* 城市编号
*/
private String cityCode;
/**
* 城市编号缩写
*/
private String cityShortCode;
/**
* 区域
*/
private String area;
/**
* 邮编
*/
private String postCode;
/**
* 区域编码
*/
private String areaCode;
/**
* 运营商
*/
private String isp;
/**
* 经度
*/
private String lng;
/**
* 纬度
*/
private String lat;
/**
* 大区
*/
private String bigArea;
}
@@ -0,0 +1,26 @@
package com.cf.imes.framework.ip.core.service.dto;
import lombok.Data;
import java.io.Serializable;
/**
* ip来源查询结果
*
* @author Gqr
* @since 2024/10/30 10:59
*/
@Data
public class IPQueryRespDTO implements Serializable {
private static final long serialVersionUID = -5526001196829386416L;
/**
* 响应码,200:正常、400:ip参数不正确
*/
private int ret;
/**
* ip来源信息
*/
private IPQueryDataRespDTO data;
}
@@ -0,0 +1,64 @@
package com.cf.imes.framework.ip.core.service.imp;
import cn.hutool.core.text.CharSequenceUtil;
import cn.hutool.http.HttpRequest;
import cn.hutool.http.HttpResponse;
import cn.hutool.http.HttpStatus;
import com.alibaba.fastjson.JSON;
import com.cf.imes.framework.common.exception.ErrorCode;
import com.cf.imes.framework.common.exception.ServiceException;
import com.cf.imes.framework.common.exception.util.ServiceExceptionUtil;
import com.cf.imes.framework.ip.core.enums.ErrorCodeConstants;
import com.cf.imes.framework.ip.core.property.IPQueryProperties;
import com.cf.imes.framework.ip.core.service.IPQueryService;
import com.cf.imes.framework.ip.core.service.dto.IPQueryDataRespDTO;
import com.cf.imes.framework.ip.core.service.dto.IPQueryRespDTO;
import lombok.extern.slf4j.Slf4j;
import javax.annotation.Resource;
/**
* @author Gqr
* @since 2024/10/30 11:02
*/
@Slf4j
public class IPQueryServiceImpl implements IPQueryService {
@Resource
private IPQueryProperties ipQueryProperties;
@Override
public IPQueryDataRespDTO querySource(String ip) {
ErrorCode queryError = ErrorCodeConstants.IP_QUERY_ERROR;
try {
String apiUrl = ipQueryProperties.getApiUrl();
String appCode = ipQueryProperties.getAppCode();
if (CharSequenceUtil.isEmpty(apiUrl)) {
log.error("[IPQueryService][querySource]request apiUrl为空");
throw ServiceExceptionUtil.exception(queryError);
}
if (CharSequenceUtil.isEmpty(appCode)) {
log.error("[IPQueryService][querySource]request appCode为空");
throw ServiceExceptionUtil.exception(queryError);
}
log.info("[IPQueryService][querySource]request url{}", apiUrl);
log.info("[IPQueryService][querySource]request param, appCode: {}, ip: {}", appCode, ip);
HttpResponse execute = HttpRequest.get(apiUrl).header("Authorization", "APPCODE " + appCode).form("ip", ip).execute();
log.info("[IPQueryService][querySource]request status{}, response: {}", execute.getStatus(), execute.body());
String respBody = execute.body();
IPQueryRespDTO ipQueryRespDTO = JSON.parseObject(execute.body(), IPQueryRespDTO.class);
if (HttpStatus.HTTP_OK == ipQueryRespDTO.getRet()) {
return ipQueryRespDTO.getData();
} else {
ServiceException serviceException = ServiceExceptionUtil.exception(queryError);
log.error(serviceException.getMessage() + ",状态【{}】,异常:{}", ipQueryRespDTO.getRet(), respBody);
throw serviceException;
}
} catch (ServiceException se) {
throw se;
} catch (Exception e) {
log.error(queryError.getMsg(), e);
throw new ServiceException(queryError);
}
}
}
@@ -1,162 +0,0 @@
package com.cf.imes.framework.ip.core.utils;
import cn.hutool.core.io.resource.ResourceUtil;
import cn.hutool.core.lang.Assert;
import cn.hutool.core.text.csv.CsvRow;
import cn.hutool.core.text.csv.CsvUtil;
import com.cf.imes.framework.common.util.object.ObjectUtils;
import com.cf.imes.framework.ip.core.Area;
import com.cf.imes.framework.ip.core.enums.AreaTypeEnum;
import lombok.NonNull;
import lombok.extern.slf4j.Slf4j;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.function.Function;
import static com.cf.imes.framework.common.util.collection.CollectionUtils.convertList;
/**
* 区域工具类
*
* @author 晨丰科技
*/
@Slf4j
public class AreaUtils {
/**
* 初始化 SEARCHER
*/
@SuppressWarnings("InstantiationOfUtilityClass")
private final static AreaUtils INSTANCE = new AreaUtils();
/**
* Area 内存缓存,提升访问速度
*/
private static Map<Integer, Area> areas;
private AreaUtils() {
long now = System.currentTimeMillis();
areas = new HashMap<>();
areas.put(Area.ID_GLOBAL, new Area(Area.ID_GLOBAL, "全球", 0,
null, new ArrayList<>()));
// 从 csv 中加载数据
List<CsvRow> rows = CsvUtil.getReader().read(ResourceUtil.getUtf8Reader("area.csv")).getRows();
rows.remove(0); // 删除 header
for (CsvRow row : rows) {
// 创建 Area 对象
Area area = new Area(Integer.valueOf(row.get(0)), row.get(1), Integer.valueOf(row.get(2)),
null, new ArrayList<>());
// 添加到 areas 中
areas.put(area.getId(), area);
}
// 构建父子关系:因为 Area 中没有 parentId 字段,所以需要重复读取
for (CsvRow row : rows) {
Area area = areas.get(Integer.valueOf(row.get(0))); // 自己
Area parent = areas.get(Integer.valueOf(row.get(3))); // 父
Assert.isTrue(area != parent, "{}:父子节点相同", area.getName());
area.setParent(parent);
parent.getChildren().add(area);
}
log.info("启动加载 AreaUtils 成功,耗时 ({}) 毫秒", System.currentTimeMillis() - now);
}
/**
* 获得指定编号对应的区域
*
* @param id 区域编号
* @return 区域
*/
public static Area getArea(Integer id) {
return areas.get(id);
}
/**
* 格式化区域
*
* @param id 区域编号
* @return 格式化后的区域
*/
public static String format(Integer id) {
return format(id, " ");
}
/**
* 格式化区域
*
* 例如说:
* 1. id = “静安区”时:上海 上海市 静安区
* 2. id = “上海市”时:上海 上海市
* 3. id = “上海”时:上海
* 4. id = “美国”时:美国
* 当区域在中国时,默认不显示中国
*
* @param id 区域编号
* @param separator 分隔符
* @return 格式化后的区域
*/
public static String format(Integer id, String separator) {
// 获得区域
Area area = areas.get(id);
if (area == null) {
return null;
}
// 格式化
StringBuilder sb = new StringBuilder();
for (int i = 0; i < AreaTypeEnum.values().length; i++) { // 避免死循环
sb.insert(0, area.getName());
// “递归”父节点
area = area.getParent();
if (area == null
|| ObjectUtils.equalsAny(area.getId(), Area.ID_GLOBAL, Area.ID_CHINA)) { // 跳过父节点为中国的情况
break;
}
sb.insert(0, separator);
}
return sb.toString();
}
/**
* 获取指定类型的区域列表
*
* @param type 区域类型
* @param func 转换函数
* @param <T> 结果类型
* @return 区域列表
*/
public static <T> List<T> getByType(AreaTypeEnum type, Function<Area, T> func) {
return convertList(areas.values(), func, area -> type.getType().equals(area.getType()));
}
/**
* 根据区域编号、上级区域类型,获取上级区域编号
*
* @param id 区域编号
* @param type 区域类型
* @return 上级区域编号
*/
public static Integer getParentIdByType(Integer id, @NonNull AreaTypeEnum type) {
for (int i = 0; i < Byte.MAX_VALUE; i++) {
Area area = AreaUtils.getArea(id);
if (area == null) {
return null;
}
// 情况一:匹配到,返回它
if (type.getType().equals(area.getType())) {
return area.getId();
}
// 情况二:找到根节点,返回空
if (area.getParent() == null || area.getParent().getId() == null) {
return null;
}
// 其它:继续向上查找
id = area.getParent().getId();
}
return null;
}
}
@@ -1,87 +0,0 @@
package com.cf.imes.framework.ip.core.utils;
import cn.hutool.core.io.resource.ResourceUtil;
import com.cf.imes.framework.ip.core.Area;
import lombok.SneakyThrows;
import lombok.extern.slf4j.Slf4j;
import org.lionsoul.ip2region.xdb.Searcher;
import java.io.IOException;
/**
* IP 工具类
*
* IP 数据源来自 ip2region.xdb 精简版,基于 <a href="https://gitee.com/zhijiantianya/ip2region"/> 项目
*
* @author wanglhup
*/
@Slf4j
public class IPUtils {
/**
* 初始化 SEARCHER
*/
@SuppressWarnings("InstantiationOfUtilityClass")
private final static IPUtils INSTANCE = new IPUtils();
/**
* IP 查询器,启动加载到内存中
*/
private static Searcher SEARCHER;
/**
* 私有化构造
*/
private IPUtils() {
try {
long now = System.currentTimeMillis();
byte[] bytes = ResourceUtil.readBytes("ip2region.xdb");
SEARCHER = Searcher.newWithBuffer(bytes);
log.info("启动加载 IPUtils 成功,耗时 ({}) 毫秒", System.currentTimeMillis() - now);
} catch (IOException e) {
log.error("启动加载 IPUtils 失败", e);
}
}
/**
* 查询 IP 对应的地区编号
*
* @param ip IP 地址,格式为 127.0.0.1
* @return 地区id
*/
@SneakyThrows
public static Integer getAreaId(String ip) {
return Integer.parseInt(SEARCHER.search(ip.trim()));
}
/**
* 查询 IP 对应的地区编号
*
* @param ip IP 地址的时间戳,格式参考{@link Searcher#checkIP(String)} 的返回
* @return 地区编号
*/
@SneakyThrows
public static Integer getAreaId(long ip) {
return Integer.parseInt(SEARCHER.search(ip));
}
/**
* 查询 IP 对应的地区
*
* @param ip IP 地址,格式为 127.0.0.1
* @return 地区
*/
public static Area getArea(String ip) {
return AreaUtils.getArea(getAreaId(ip));
}
/**
* 查询 IP 对应的地区
*
* @param ip IP 地址的时间戳,格式参考{@link Searcher#checkIP(String)} 的返回
* @return 地区
*/
public static Area getArea(long ip) {
return AreaUtils.getArea(getAreaId(ip));
}
}
@@ -0,0 +1 @@
com.cf.imes.framework.ip.config.ChenfengIPAutoConfiguration
File diff suppressed because it is too large Load Diff
@@ -1,36 +0,0 @@
package com.cf.imes.framework.ip.core.utils;
import com.cf.imes.framework.ip.core.Area;
import com.cf.imes.framework.ip.core.enums.AreaTypeEnum;
import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.assertEquals;
/**
* {@link AreaUtils} 的单元测试
*
* @author 晨丰科技
*/
public class AreaUtilsTest {
@Test
public void testGetArea() {
// 调用:北京
Area area = AreaUtils.getArea(110100);
// 断言
assertEquals(area.getId(), 110100);
assertEquals(area.getName(), "北京市");
assertEquals(area.getType(), AreaTypeEnum.CITY.getType());
assertEquals(area.getParent().getId(), 110000);
assertEquals(area.getChildren().size(), 16);
}
@Test
public void testFormat() {
assertEquals(AreaUtils.format(110105), "北京 北京市 朝阳区");
assertEquals(AreaUtils.format(1), "中国");
assertEquals(AreaUtils.format(2), "蒙古");
}
}
@@ -1,47 +0,0 @@
package com.cf.imes.framework.ip.core.utils;
import com.cf.imes.framework.ip.core.Area;
import org.junit.jupiter.api.Test;
import org.lionsoul.ip2region.xdb.Searcher;
import static org.junit.jupiter.api.Assertions.assertEquals;
/**
* {@link IPUtils} 的单元测试
*
* @author wanglhup
*/
public class IPUtilsTest {
@Test
public void testGetAreaId_string() {
// 120.202.4.0|120.202.4.255|420600
Integer areaId = IPUtils.getAreaId("120.202.4.50");
assertEquals(420600, areaId);
}
@Test
public void testGetAreaId_long() throws Exception {
// 120.203.123.0|120.203.133.255|360900
long ip = Searcher.checkIP("120.203.123.250");
Integer areaId = IPUtils.getAreaId(ip);
assertEquals(360900, areaId);
}
@Test
public void testGetArea_string() {
// 120.202.4.0|120.202.4.255|420600
Area area = IPUtils.getArea("120.202.4.50");
assertEquals("襄阳市", area.getName());
}
@Test
public void testGetArea_long() throws Exception {
// 120.203.123.0|120.203.133.255|360900
long ip = Searcher.checkIP("120.203.123.252");
Area area = IPUtils.getArea(ip);
assertEquals("宜春市", area.getName());
}
}
@@ -0,0 +1,42 @@
package com.cf.imes.framework.ip.service;
import com.cf.imes.framework.common.exception.ServiceException;
import com.cf.imes.framework.ip.config.ChenfengIPAutoConfiguration;
import com.cf.imes.framework.ip.core.service.IPQueryService;
import com.cf.imes.framework.ip.core.service.dto.IPQueryDataRespDTO;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.ActiveProfiles;
import javax.annotation.Resource;
import static com.cf.imes.framework.test.core.util.RandomUtils.randomString;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertThrows;
/**
* {@link IPQueryService} 的单元测试
*
* @author gaoqr
*/
@SpringBootTest(classes = {ChenfengIPAutoConfiguration.class}, webEnvironment = SpringBootTest.WebEnvironment.NONE)
@ActiveProfiles("unit-test") // 设置使用 application-unit-test 配置文件
public class IPQueryServiceTest {
@Resource
private IPQueryService ipQueryService;
@Test
public void testQuerySourceFail() {
assertThrows(ServiceException.class, () -> ipQueryService.querySource(randomString()));
}
@Test
public void testQuerySourceSuccess() {
IPQueryDataRespDTO ipQueryDataRespDTO = ipQueryService.querySource("220.250.48.74");
assertNotNull(ipQueryDataRespDTO);
assertEquals(ipQueryDataRespDTO.getProv(), "福建");
assertEquals(ipQueryDataRespDTO.getCity(), "福州");
}
}
@@ -0,0 +1,7 @@
# 晨丰配置项,设置当前项目所有自定义的配置
chenfeng:
encrypt:
publicKey: cfimes
ipquery:
apiUrl: https://ipquery.market.alicloudapi.com/query
appCode: zAE0h8wOBZbwIwDob1tXJfJsdxpQ2QYzIgie7oSozCLHXsdD8hhkot6UBs55Vhm35KYrqGj+t0W4IOSr