全部产品
存储与CDN 数据库 安全 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 开发者工具 解决方案 物联网
对象存储 OSS

快速入门

更新时间:2017-11-15 21:59:29

在这一章里,您将学到如何用OSS C SDK完成一些基本的操作。

Step-1.初始化OSS C SDK运行环境

OSS C SDK使用时首先需要初始化运行环境,使用结束前需要清理运行环境,下面代码演示初始化OSS C SDK运行环境:

  1. int main(int argc, char *argv[])
  2. {
  3. /* 程序入口处调用aos_http_io_initialize方法,这个方法内部会做一些全局资源的初始化,涉及网络,内存等部分 */
  4. if (aos_http_io_initialize(NULL, 0) != AOSE_OK) {
  5. exit(1);
  6. }
  7. /* 调用OSS SDK的接口上传或下载文件 */
  8. /* ... 用户逻辑代码,这里省略 */
  9. /* 程序结束前,调用aos_http_io_deinitialize方法释放之前分配的全局资源 */
  10. aos_http_io_deinitialize();
  11. return 0;
  12. }

注:

  • aos_http_io_initialize初始化OSS C SDK运行环境,第一个参数可以用于个性化设置user agent的内容,用作后续统计。
  • aos_http_io_deinitialize清理OSS C SDK运行环境。

Step-2.初始化请求选项

OSS C SDK的所有操作需要初始化请求选项,下面代码完成初始化请求选项:

  1. /* 等价于apr_pool_t,用于内存管理的内存池,实现代码在apr库中 */
  2. aos_pool_t *pool;
  3. oss_request_options_t *options;
  4. /* 重新创建一个新的内存池,第二个参数是NULL,表示没有继承自其它内存池 */
  5. aos_pool_create(&pool, NULL);
  6. /* 创建并初始化options,这个参数内部主要包括endpoint,access_key_id,acces_key_secret,is_cname, curl参数等全局配置信息
  7. * options的内存是由pool分配的,后续释放掉pool后,options的内存也相当于释放掉了,不再需要单独释放内存
  8. */
  9. options = oss_request_options_create(pool);
  10. options->config = oss_config_create(options->pool);
  11. /* aos_str_set是用char*类型的字符串初始化aos_string_t类型*/
  12. aos_str_set(&options->config->endpoint, "<您的Endpoint>");
  13. aos_str_set(&options->config->access_key_id, "<您的AccessKeyId>");
  14. aos_str_set(&options->config->access_key_secret, "<您的AccessKeySecret>");
  15. /* 是否使用了CNAME */
  16. options->config->is_cname = 0;
  17. /* 用于设置网络相关参数,比如超时时间等*/
  18. options->ctl = aos_http_controller_create(options->pool, 0);

Step-3. 新建存储空间(Bucket)

您可以按照下面的代码新建一个存储空间:

  1. aos_pool_t *p;
  2. oss_request_options_t *options;
  3. aos_status_t *s;
  4. aos_table_t *resp_headers;
  5. oss_acl_e oss_acl = OSS_ACL_PRIVATE;
  6. char *bucket_name = "<您的bucket名字>";
  7. aos_string_t bucket;
  8. aos_pool_create(&p, NULL);
  9. options = oss_request_options_create(p);
  10. init_options(options);
  11. /* 将char*类型数据赋值给aos_string_t类型的bucket */
  12. aos_str_set(&bucket, bucket_name);
  13. s = oss_create_bucket(options, &bucket, oss_acl, &resp_headers);
  14. /* 判断请求是否成功 */
  15. if (aos_status_is_ok(s)) {
  16. printf("create bucket succeeded\n");
  17. } else {
  18. printf("create bucket failed\n");
  19. }
  20. /* 执行完一个请求后,释放掉这个内存池,结果就是会释放掉这个请求过程中各个部分分配的内存 */
  21. aos_pool_destroy(p);

注:

  • Bucket的命名规范请查看OSS 基本概念
  • Bucket名字不能与OSS服务中其他用户已有的存储空间重复,所以你需要选择一个独特的存储空间名字以避免创建失败
  • oss_create_bucket的返回值是aos_status_t*类型,包括了code(http code),error_code,error_msg和req_id,req_id可以协助调查问题。其他接口,如果没有特殊说明外,也都是返回aos_status_t*类型。

Step-4. 上传文件

文件是OSS中最基本的数据单元,用下面代码可以实现一个文件的上传:

  1. aos_pool_t *p;
  2. oss_request_options_t *options;
  3. aos_status_t *s;
  4. aos_table_t *headers;
  5. aos_table_t *resp_headers;
  6. char *bucket_name = "<您的bucket名字>";
  7. char *object_name = "<您的object名字>";
  8. aos_string_t bucket;
  9. aos_string_t object;
  10. char *data = "object content";
  11. aos_list_t buffer;
  12. aos_buf_t *content;
  13. aos_pool_create(&p, NULL);
  14. /* 创建并初始化options */
  15. options = oss_request_options_create(p);
  16. init_options(options);
  17. /* 初始化参数 */
  18. aos_str_set(&object, object_name);
  19. aos_str_set(&bucket, bucket_name);
  20. headers = aos_table_make(p, 0);
  21. /* 将char*类型的数据转换为oss_put_object_from_buffer接口需要的aos_list_t类型的 */
  22. aos_list_init(&buffer);
  23. content = aos_buf_pack(options->pool, data, strlen(data));
  24. aos_list_add_tail(&content->node, &buffer);
  25. /* 上传文件 */
  26. s = oss_put_object_from_buffer(options, &bucket, &object, &buffer, headers, &resp_headers);
  27. /* 判断请求是否成功 */
  28. if (aos_status_is_ok(s)) {
  29. printf("put file succeeded\n");
  30. } else {
  31. printf("put file failed\n");
  32. }
  33. /* 释放资源 */
  34. aos_pool_destroy(p);

注:

  • 关于上传文件更详细的信息,参见上传文件

Step-5. 列出存储空间中的所有文件

当您完成一系列上传后,可能需要查看某个存储空间中有哪些文件,可以通过下面的程序实现:

  1. aos_pool_t *p;
  2. oss_request_options_t *options;
  3. aos_status_t *s;
  4. aos_table_t *resp_headers;
  5. char *bucket_name = "<您的bucket名字>";
  6. aos_string_t bucket;
  7. oss_list_object_params_t *params;
  8. oss_list_object_content_t *content;
  9. int max_ret = 1000;
  10. char *key;
  11. aos_pool_create(&p, NULL);
  12. /* 创建并初始化options */
  13. options = oss_request_options_create(p);
  14. init_options(options);
  15. /* 初始化参数 */
  16. aos_str_set(&bucket, bucket_name);
  17. params = oss_create_list_object_params(p);
  18. params->max_ret = max_ret;
  19. aos_str_set(&params->prefix, "<prefix>");
  20. aos_str_set(&params->delimiter, "<delimiter>");
  21. aos_str_set(&params->marker, "<marker>");
  22. s = oss_list_object(options, &bucket, params, &resp_headers);
  23. /* 判断请求是否成功 */
  24. if (aos_status_is_ok(s)) {
  25. printf("list file succeeded\n");
  26. } else {
  27. printf("list file failed\n");
  28. }
  29. /* 获取每个文件的名称 */
  30. aos_list_for_each_entry(content, &params->object_list, node) {
  31. key = apr_psprintf(p, "%.*s", content->key.len, content->key.data);
  32. }
  33. /* 释放资源 */
  34. aos_pool_destroy(p);

注:

Step-6. 下载指定文件

您可以参考下面的代码简单地实现下载指定文件:

  1. aos_pool_t *p;
  2. oss_request_options_t *options;
  3. aos_status_t *s;
  4. aos_table_t *headers;
  5. aos_table_t *resp_headers;
  6. char *bucket_name = "<您的bucket名字>";
  7. char *object_name = "<您的object名字>";
  8. aos_string_t bucket;
  9. aos_string_t object;
  10. aos_list_t buffer;
  11. aos_buf_t *content;
  12. char *buf;
  13. int64_t len = 0;
  14. int64_t size = 0;
  15. int64_t pos = 0;
  16. aos_pool_create(&p, NULL);
  17. /* 创建并初始化options */
  18. options = oss_request_options_create(p);
  19. init_options(options);
  20. /* 初始化参数 */
  21. aos_str_set(&object, object_name);
  22. aos_str_set(&bucket, bucket_name);
  23. headers = aos_table_make(p, 1);
  24. /* 下载文件到buffer中 */
  25. aos_list_init(&buffer);
  26. s = oss_get_object_to_buffer(options, &bucket, &object, headers, &buffer, &resp_headers);
  27. /* 判断请求是否成功 */
  28. if (aos_status_is_ok(s)) {
  29. printf("get file succeeded\n");
  30. } else {
  31. printf("get file failed\n");
  32. }
  33. /* 从buffer中将aos_list_t类型的数据转为char*类型的,并计算读到的文件总长度 */
  34. len = aos_buf_list_len(&buffer);
  35. buf = aos_pcalloc(p, len + 1);
  36. buf[len] = '\0';
  37. aos_list_for_each_entry(content, &buffer, node) {
  38. size = aos_buf_size(content);
  39. memcpy(buf + pos, content->pos, size);
  40. pos += size;
  41. }
  42. /* 释放资源 */
  43. aos_pool_destroy(p);

注:

本文导读目录