【仓颉三方库】对象存储——OBS Cangjie SDK

介绍

对象存储服务软件开发工具包（OBS SDK，Object Storage Service Software Development Kit）是对OBS服务提供的REST API进行的封装，以简化用户的开发工作。用户直接调用OBS SDK提供的接口函数即可实现使用OBS服务业务能力的目的。

特性

• 🚀 服务端加密,支持SSE-OBS,SM4服务端加密方式
• 🚀 生命周期管理
• 🚀 图片处理特性
• 🚀 并行文件系统的权限配置
• 🚀 在线解压
• 🚀 桶策略列表呈现方式优化
• 🚀 CDN自动刷新
• 🚀 支持镜像回源
• 🚀 持为对象设置WORM策略

产品架构

OBS的基本组成是桶和对象。

桶是OBS中存储对象的容器，每个桶都有自己的存储类别、访问权限、所属区域等属性，用户在互联网上通过桶的访问域名来定位桶。

对象是OBS中数据存储的基本单位，一个对象实际是一个文件的数据与其相关属性信息的集合体，包括Key、Metadata、Data三部分：

• Key：键值，即对象的名称，为经过UTF-8编码的长度大于0且不超过1024的字符序列。一个桶里的每个对象必须拥有唯一的对象键值。
• Metadata：元数据，即对象的描述信息，包括系统元数据和用户元数据，这些元数据以键值对（Key-Value）的形式被上传到OBS中。
  • 系统元数据由OBS自动产生，在处理对象数据时使用，包括Date，Content-length，Last-modify，ETag等。
  • 用户元数据由用户在上传对象时指定，是用户自定义的对象描述信息。
• Data：数据，即文件的数据内容。

华为云针对OBS提供的REST API进行了二次开发，为您提供了控制台、SDK和各类工具，方便您在不同的场景下轻松访问OBS桶以及桶中的对象。当然您也可以利用OBS提供的SDK和API，根据您业务的实际情况自行开发，以满足不同场景的海量数据存储诉求。

源码目录

├─ lib
│  ├─ crypto4cj
│  ├─ httpclient4cj
│  └─ libcrypto.dll
└─ src
   ├─ logger
   ├─ obstest
   ├─ services
   │  ├─ action
   │  ├─ client
   │  ├─ crypto
   │  ├─ exception
   │  ├─ model
   │  ├─ progress
   │  ├─ requestHandler
   │  ├─ responseHandler
   └─ util

• lib 第三方依赖
• src 源码目录
• src/log 日志记录类
• src/obstest 测试用例
• src/services/action 业务处理
• src/services/client 请求入口
• src/services/crypto 加密处理
• src/services/exception 异常处理
• src/services/model 模块类
• src/services/progress传输进度处理
• src/services/requestHandler请求前处理
• src/services/responseHandler请求后处理
• src/util 工具类

接口说明

• 主要类和函数接口说明详见 接口文档手册

使用说明

依赖分析

cnagjie:  v0.51.4
obsserver: v3.23.9

编译（win/linux）

cjpm build -V

功能示例

示例详见demo

创建 桶

main(): Int64 {

    // endpoint填写桶所在的endpoint
    var endPoint = "https://obs.cn-east-3.myhuaweicloud.com"
    // 您可以登录访问管理控制台获取访问密钥AK/SK
    var ak = "xxxxxxxxx"
    var sk = "xxxxxxxxxxxxx"
    // 创建ObsClient实例
    var obsClient = ObsClient().creatObsClient(ak, sk, endPoint)
    var createBucketRequest = CreateBucketRequest("cn-east-3", "cangjietest4")
    //设置桶访问权限
    createBucketRequest.setAcl(AccessControlList.REST_CANNED_PUBLIC_READ)
    //设置桶存储类型
    createBucketRequest.setStorageClass(StorageClassEnum.COLD)
    //创建桶
    var obsbucket = obsClient.createBucket(createBucketRequest)
}

设置对象元数据

main(): Int64 {

    // endpoint填写桶所在的endpoint
    var endPoint = "https://obs.cn-east-3.myhuaweicloud.com"
    // 您可以登录访问管理控制台获取访问密钥AK/SK
    var ak = "xxxxxxxxx"
    var sk = "xxxxxxxxxxxxx"
    // 创建ObsClient实例
    var obsClient = ObsClient().creatObsClient(ak, sk, endPoint)
    var request = SetObjectMetadataRequest("cangjie12", "testkey")
    request.setExpires("Expires")
    //设置对象自定义元数据
    request.addUserMetadata("property1", "property-value1")
    //用户头域列表
    var userHeaders = HashMap<String, String>()
    userHeaders.put("property2", "property-value2")
    userHeaders.put("x-obs-meta-property3", "property-value3")
    request.setUserHeaders(userHeaders)
    var metadata = obsClient.setObjectMetadataImpl(request)
    var  mate =  metadata.getUserMetadata("property1").getOrThrow()
    println((mate as String).getOrThrow())
}

对象上传

main(): Int64 {

    // endpoint填写桶所在的endpoint
    var endPoint = "https://obs.cn-east-3.myhuaweicloud.com"
    // 您可以登录访问管理控制台获取访问密钥AK/SK
    var ak = "xxxxxxxxx"
    var sk = "xxxxxxxxxxxxx"
    // 创建ObsClient实例
    var obsClient = ObsClient().creatObsClient(ak, sk, endPoint)
    var createBucketRequest = CreateBucketRequest("cangjie4")
    var putObjectRequest = PutObjectRequest()
    var str = "hello world"
    var byteStream = ByteArrayStream()
    byteStream.write(str.toArray())
    //流上传
    putObjectRequest.setInput(byteStream)
    putObjectRequest.setBucketName("cangjie4")
    putObjectRequest.setObjectKey("hello11")
    var obsfile = obsClient.putObject(putObjectRequest)
    println(obsfile.getObjectUrl())
}

范围下载

main(): Int64 {

    // endpoint填写桶所在的endpoint
    var endPoint = "https://obs.cn-east-3.myhuaweicloud.com"
    // 您可以登录访问管理控制台获取访问密钥AK/SK
    var ak = "xxxxxxxxx"
    var sk = "xxxxxxxxxxxxx"
    // 创建ObsClient实例
    var obsClient = ObsClient().creatObsClient(ak, sk, endPoint)
    var getObjectRequest = GetObjectRequest()
    //设置范围
    getObjectRequest.rangeStart = 0
    getObjectRequest.rangeEnd = 10
    getObjectRequest.setBucketName("cangjie12")
    getObjectRequest.setObjectKey("Obstestkey1")
    var obsobject = obsClient.getObject(getObjectRequest)
    var input = obsobject.getInputStream().getOrThrow()
    let output = ByteArrayStream()
    IOUtils.copyToStream(input, output)
    println(output.bytes().toString())
    println(String.fromUtf8(output.bytes())) 
}

欢迎给我们提交PR & Issue，欢迎参与任何形式的贡献。