Files
netdisk-fast-download/parser/README.md
q 42b721eabf feat: 新增客户端协议生成系统,支持8种主流下载工具
🚀 核心功能
- 新增完整的客户端下载链接生成器系统
- 支持ARIA2、Motrix、比特彗星、迅雷、wget、cURL、IDM、FDM、PowerShell等8种客户端
- 自动处理防盗链参数(User-Agent、Referer、Cookie等)
- 提供可扩展的生成器架构,支持自定义客户端

🔧 技术实现
- ClientLinkGeneratorFactory: 工厂模式管理生成器
- DownloadLinkMeta: 元数据存储下载信息
- ClientLinkUtils: 便捷工具类
- 线程安全的ConcurrentHashMap设计

🌐 前端集成
- 新增ClientLinks.vue界面,支持客户端链接展示
- Element Plus图标系统,混合图标显示
- 客户端检测逻辑优化,避免自动打开外部应用
- 移动端和PC端环境判断

📚 文档完善
- 完整的CLIENT_LINK_GENERATOR_GUIDE.md使用指南
- API文档和测试用例
- 输出示例和最佳实践

从单纯的网盘解析工具升级为完整的下载解决方案生态
2025-10-24 09:29:05 +08:00

107 lines
2.9 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# parser
NFD 解析器模块:聚合各类网盘/分享页解析,统一输出文件列表与下载信息,供上层下载器使用。
- 语言Java 17
- 构建Maven
- 模块版本10.1.17
## 依赖Maven Central
```xml
<dependency>
<groupId>cn.qaiu</groupId>
<artifactId>parser</artifactId>
<version>10.1.17</version>
</dependency>
```
- Gradle Groovy DSL
```groovy
dependencies {
implementation 'cn.qaiu:parser:10.1.17'
}
```
- Gradle Kotlin DSL
```kotlin
dependencies {
implementation("cn.qaiu:parser:10.1.17")
}
```
## 核心 API 速览
- WebClientVertxInit注入/获取 Vert.x 实例(内部 HTTP 客户端依赖)。
- ParserCreate从分享链接或类型构建解析器生成短链 path。
- IPanTool统一解析接口parse、parseFileList、parseById
- **CustomParserRegistry**:自定义解析器注册中心(支持扩展)。
- **CustomParserConfig**:自定义解析器配置类(支持扩展)。
## 使用示例(极简)
```java
List<FileInfo> list = ParserCreate
.fromShareUrl("https://share.feijipan.com/s/3pMsofZd")
.createTool()
.parseFileList()
.toCompletionStage().toCompletableFuture().join();
```
完整示例与调试脚本见 parser/doc/README.md。
## 快速开始
- 环境JDK >= 17Maven >= 3.9
- 构建/安装:
```
mvn -pl parser -am clean package -DskipTests
mvn -pl parser -am install
```
- 测试:
```
mvn -pl parser test
```
## 自定义解析器扩展
本模块支持用户自定义解析器扩展。通过简单的配置和注册,你可以添加自己的网盘解析实现:
```java
// 1. 继承 PanBase 抽象类(推荐)
public class MyPanTool extends PanBase {
public MyPanTool(ShareLinkInfo info) {
super(info);
}
@Override
public Future<String> parse() {
// 使用 PanBase 提供的 HTTP 客户端
client.getAbs("https://api.example.com")
.send()
.onSuccess(res -> complete(asJson(res).getString("url")))
.onFailure(handleFail("请求失败"));
return future();
}
}
// 2. 注册到系统
CustomParserConfig config = CustomParserConfig.builder()
.type("mypan")
.displayName("我的网盘")
.toolClass(MyPanTool.class)
.build();
CustomParserRegistry.register(config);
// 3. 使用自定义解析器(仅支持 fromType 方式)
IPanTool tool = ParserCreate.fromType("mypan")
.shareKey("abc123")
.createTool();
String url = tool.parseSync();
```
**详细文档:** [自定义解析器扩展指南](doc/CUSTOM_PARSER_GUIDE.md)
## 文档
- parser/doc/README.md解析约定、示例、IDEA `.http` 调试
- **parser/doc/CUSTOM_PARSER_GUIDE.md自定义解析器扩展完整指南**
## 目录
- src/main/java/cn/qaiu/entity通用实体如 FileInfo
- src/main/java/cn/qaiu/parser解析框架 & 各站点实现impl
- src/test/java单测与示例
## 许可证
MIT License