# bc-aliyun-sdk

**Repository Path**: buddycoder/bc-aliyun-sdk

## Basic Information

- **Project Name**: bc-aliyun-sdk
- **Description**: rust 开发的对应阿里云的API 的 SDK
目前已经实现的SMS，OSS
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-06-24
- **Last Updated**: 2026-06-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

bc-aliyun-sdk
==============

阿里云服务 Rust SDK

  面向 BuddyCoder 项目的轻量阿里云 SDK，支持按需编译——
  只编译你需要的功能，不引入多余的代码和依赖。

----------------------------------------------------------------------
快速开始
----------------------------------------------------------------------

1. 在 Cargo.toml 中添加依赖：

   [dependencies]
   bc-aliyun-sdk = { features = ["oss"] }

2. 使用 OSS 上传/下载文件（需要 tokio runtime）：

   use bc_aliyun_sdk::oss::OssClient;

   #[tokio::main]
   async fn main() -> Result<(), Box<dyn std::error::Error>> {
       let client = OssClient::new(
           "oss-cn-hangzhou.aliyuncs.com",
           "my-bucket",
           "your-access-key-id",
           "your-access-key-secret",
       );

       // 上传
       client.put_object("hello.txt", b"Hello OSS", "text/plain").await?;

       // 下载
       let data = client.get_object("hello.txt").await?;

       // 生成预签名下载 URL（有效期 1 小时）
       let url = client.sign_url("hello.txt", 3600);

       Ok(())
   }

----------------------------------------------------------------------
可用的 Feature
----------------------------------------------------------------------

  基础功能：
    oss-core       核心（client/error/sign），其他 OSS feature 的基础
    oss-object     对象操作：上传/下载/删除
    oss-multipart  分片上传（依赖 oss-object）
    oss-bucket     Bucket 管理：ACL、跨域、生命周期等

  高级功能：
    oss-service    列出所有 Bucket
    oss-region     查询可用地域

  低频功能：
    oss-livechannel  直播频道
    oss-vector       向量存储与检索
    oss-qos          资源池流控

  快捷组合：
    oss-standard = oss-core + oss-object + oss-multipart（日常推荐）
    oss-admin    = oss-standard + oss-bucket + oss-service + oss-region
    oss-full     = oss-admin + oss-livechannel + oss-vector + oss-qos
    oss          = oss-standard（向后兼容）

  按需选择示例：

    # 只需上传下载
    bc-aliyun-sdk = { features = ["oss-object"] }

    # 需要大文件分片上传
    bc-aliyun-sdk = { features = ["oss-multipart"] }

    # 运维管理场景
    bc-aliyun-sdk = { features = ["oss-admin"] }

----------------------------------------------------------------------
当前状态
----------------------------------------------------------------------

  [已实现]
    - OSS：异步客户端，全部 95 API（上传/下载/删除 + 分片上传 + Bucket 管理 + 直播/向量/QoS）
    - SMS：异步客户端，28 API（发送/查询 + 新版签名/模板管理 + 资质 + 短链）

  [计划中]
    - SMS 扩展：授权委托书、卡片短信、数字短信等 ~30 API（按需）
    - 其他阿里云服务（VOD / ...）

----------------------------------------------------------------------
项目结构
----------------------------------------------------------------------

  bc-aliyun-sdk/
  ├── AGENT.md            AI 助手的项目速览
  ├── README.txt          ← 你正在看的文件
  ├── Cargo.toml
  ├── docs/
  │   ├── CONVENTIONS.md  开发总则（设计规范、新增服务步骤）
  │   └── oss-design.md   OSS 模块 Feature 拆分方案
  └── src/
      ├── lib.rs          库根模块
      └── oss/
          ├── mod.rs       OSS 模块入口
          ├── client.rs    OssClient 客户端
          ├── error.rs     错误类型
          └── sign.rs      HMAC-SHA1 签名

----------------------------------------------------------------------
构建与测试
----------------------------------------------------------------------

  # 编译
  cargo build --features oss

  # 测试
  cargo test --features oss

  # 生成并查看文档
  cargo doc --features oss --open

----------------------------------------------------------------------
参考链接
----------------------------------------------------------------------

  OSS API 文档
  https://help.aliyun.com/zh/oss/developer-reference/

  设计文档
  docs/CONVENTIONS.md    开发总则
  docs/oss-design.md     OSS 模块方案

----------------------------------------------------------------------
许可证
----------------------------------------------------------------------

  MIT