# qingniu-cloud-starter

**Repository Path**: bodhiyg/qingniu-cloud-starter

## Basic Information

- **Project Name**: qingniu-cloud-starter
- **Description**: 访客来源分析基础包
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2024-06-06
- **Last Updated**: 2025-03-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 用户行为分析核心模块
    重要提示，项目处于早期demo阶段。不保证未来不做破坏性更新。
## 使用方式
- 引用包
```
<dependency>
    <groupId>com.qingniu.cloud</groupId>
    <artifactId>qingniu-visitor-core</artifactId>
    <version>0.0.2</version>
</dependency>		
```
- 配置说明
```
qingniu:
 ipAddressr:
    #IP解析器类型（Ip2region、Cz88、Ipwhois）
    type: Ip2region
    Ipwhois:
       #Ipwhois 接口
       ApiUrl: http://ipwhois.pro/{ip}?key=HMRUXv7OQRGTWsVB&lang=zh-CN&security=1
 filter:
    #filter类型 布隆过滤器（redis、guava）
    type: guava
```
- 调用API
```
@Autowired
AnalyzeEngine analyzeEngine;
@Autowired
InterceptContext context;
#UserVisitorRequest 需要自行获取
public InterceptResult analyze(UserVisitorRequest uvr) throws Exception {
    //解析User-Agent、Accept-Language、IP归属地等
    AnalyzeBo uvrBo = analyzeEngine.Execute(uvr);
    InterceptSource source=analyzeEngine.getSource(uvrBo);
    //获取规则
    InterceptRule rule = null;
    //执行黑白名单判断
    return context.Intercept(source, rule);
}
```

## 核心依赖说明
 - [yauaa][yauaa] 分析 useragent 字符串（以及可用的 User-Agent 客户端提示）并提取尽可能多的相关属性。
 - [ip2region][ip2region] 是一个离线IP地址定位库和IP定位数据管理框架，10微秒级别的查询效率，提供了队列主流编程语言的xdb数据生成和查询客户端实现。
 - [ipwhois][ipwhois] IP地理定位API
 - [纯真IP库][纯真IP库] IP地理定位API
 - [ja4][ja4] JA4+网络指纹
 - [fingerproxy][fingerproxy] 是一个 HTTPS 反向代理。它创建 JA3、JA4、Akamai HTTP2 指纹，并通过 HTTP 请求标头转发到后端。

## 目录结构
    qingniu-visitor-core 访客分析核心模块。

[yauaa]: https://yauaa.basjes.nl/
[ipwhois]: https://ipwhois.io/
[ja4]: https://github.com/FoxIO-LLC/ja4
[fingerproxy]: https://github.com/wi1dcard/fingerproxy
[纯真IP库]: https://www.cz88.net/
[ip2region]: https://github.com/lionsoul2014/ip2region