云片网Java SDK使用指南

云片网Java SDK使用指南

1. 项目的目录结构及介绍

云片网的Java SDK封装在yunpian-java-sdk项目中，其基本目录结构如下：

yunpian-java-sdk/
├── bak/           # 可能包含备份文件
├── doc/            # 文档相关资料
├── src/            # 核心源代码目录
│   ├── main/       # 主要运行代码
│   │   ├── java/    # Java源代码
│   │   └── resources/  # 资源文件，包括配置文件yunpian.properties
│   └── test/       # 单元测试代码
├── gitignore       # Git忽略文件配置
├── CONTRIBUTING.md # 贡献指南
├── LICENSE         # 许可证文件，遵循MIT协议
├── README.md       # 项目读我文件，主要介绍项目和快速入门
├── pom.xml         # Maven构建配置文件

• src/main/java 存放了所有核心业务逻辑的Java类。
• src/main/resources 包含默认的配置文件yunpian.properties，用于设置云片网的相关参数。
• src/test 是单元测试目录，提供了如何调用SDK接口的示例。
• pom.xml 定义了项目依赖和其他Maven相关的构建信息。

2. 项目的启动文件介绍

本项目不是一个独立的应用程序，因此没有传统意义上的“启动文件”。使用时，您需要将其作为库依赖添加到您的Java项目中，并通过调用YunpianClient类的方法来启动相应的服务，比如发送短信等。以下是一个简单的使用示例，而非特定的启动流程：

// 初始化YunpianClient，通常在应用启动时完成一次即可
YunpianClient client = new YunpianClient("your_api_key").init();

// 发送短信的调用
Map<String, String> params = client.newParam(2);
params.put(YunpianClient.MOBILE, "18616020***");
params.put(YunpianClient.TEXT, "【云片网】您的验证码是1234");
Result<SmsSingleSend> result = client.sms().single_send(params);

3. 项目的配置文件介绍

默认配置文件（yunpian.properties）

默认情况下，配置文件位于src/main/resources/yunpian.properties。不过，在实际部署中，可以通过系统属性或构造函数指定不同的配置文件位置或覆盖默认配置项。该文件可能包含如下基础配置键值对：

# 示例yunpian.properties内容
yp.apikey=your_api_key_here
# 其他可能的配置项可根据实际需求添加

自定义配置方式

• 构造器方式：可以直接在创建YunpianClient实例时指定API Key和配置文件路径，例如 new YunpianClient(apiKey, configFile)。
• 系统属性：通过JVM启动参数设置，如 -Dyp.apikey=your_api_key -Dyp.file=config_path。

配置文件和系统的API Key设定中，接口级别的配置将优先于默认配置值，这样便于灵活管理和调整。

通过以上步骤和说明，您可以有效地集成并管理云片网的服务在您的Java应用程序中。记得根据实际应用场景调整配置和使用方法。