本节介绍如何快速使用OSS C SDK完成常见操作,如创建存储空间、上传文件、下载文件等。
示例工程
- Linux示例工程
基于Linux的示例工程 aliyun-oss-c-sdk-demo.tar.gz 。
- 下载并解压示例工程。
- 安装oss-c-sdk-demo-specified-installation时需要指定安装目录**/home/your/oss/csdk**。其它示例工程基于OSS C SDK及依赖的第三方库默认安装,不需要指定安装目录。
- 将示例代码中的OSS_ENDPOINT、ACCESS_KEY_ID、ACCESS_KEY_SECRET、BUCKET_NAME更换成有效值。如果OSS C SDK及依赖库的动态库不在系统目录下,执行时请使用
LD_LIBRARY_PATH
指定。 - 进入工程目录(oss-c-sdk-demo-xxx),执行
make
,编译示例工程;执行./main
运行可执行程序;如需重新编译,请执行make clean
再进行编译。
示例工程安装详情请参见Linux下使用Aliyun OSS C SDK 。
- Windows示例工程
基于Windows示例工程 : aliyun-oss-c-sdk-sample.zip。更多示例工程下载请参见GitHub。
- 下载并解压示例工程。
- 使用Visual Studio直接打开对应的示例工程,将oss_config.c中的OSS_ENDPOINT、ACCESS_KEY_ID、ACCESS_KEY_SECRET、BUCKET_NAME、OBJECT_NAME、MULTIPART_UPLOAD_FILE_PATH和DIR_NAME更换成有效值,编译运行,也可以在示例工程基础上开发您的项目。
说明 使用Visual Studio运行示例工程的详细步骤及常见问题,请参见 Windows下编译使用Aliyun OSS C SDK。
创建存储空间
存储空间是OSS全局命名空间,相当于数据的容器,可以存储若干文件。 以下代码用于新建一个存储空间:
#include "oss_api.h" #include "aos_http_io.h" const char *endpoint = "<yourEndpoint>"; const char *access_key_id = "<yourAccessKeyId>"; const char *access_key_secret = "<yourAccessKeySecret>"; const char *bucket_name = "<yourBucketName>"; void init_options(oss_request_options_t *options) { options->config = oss_config_create(options->pool); /* 用char*类型的字符串初始化aos_string_t类型。*/ aos_str_set(&options->config->endpoint, endpoint); aos_str_set(&options->config->access_key_id, access_key_id); aos_str_set(&options->config->access_key_secret, access_key_secret); /* 是否使用了CNAME。0表示不使用。*/ options->config->is_cname = 0; /* 用于设置网络相关参数,比如超时时间等。*/ options->ctl = aos_http_controller_create(options->pool, 0); } int main(int argc, char *argv[]) { /* 在程序入口调用aos_http_io_initialize方法来初始化网络、内存等全局资源。*/ if (aos_http_io_initialize(NULL, 0) != AOSE_OK) { exit(1); } /* 用于内存管理的内存池(pool),等价于apr_pool_t。其实现代码在apr库中。*/ aos_pool_t *pool; /* 重新创建一个内存池,第二个参数是NULL,表示没有继承其它内存池。*/ aos_pool_create(&pool, NULL); /* 创建并初始化options,该参数包括endpoint、access_key_id、acces_key_secret、is_cname、curl等全局配置信息。*/ oss_request_options_t *oss_client_options; /* 在内存池中分配内存给options。*/ oss_client_options = oss_request_options_create(pool); /* 初始化Client的选项oss_client_options。*/ init_options(oss_client_options); /* 创建存储空间。*/ aos_status_t *resp_status; aos_table_t *resp_headers; oss_acl_e oss_acl = OSS_ACL_PRIVATE; aos_string_t bucket; /* 将类型为char*的数据赋值给bucket。*/ aos_str_set(&bucket, bucket_name); resp_status = oss_create_bucket(oss_client_options, &bucket, oss_acl, &resp_headers); /* 判断请求是否成功。*/ if (aos_status_is_ok(resp_status)) { printf("create bucket succeeded\n"); } else { printf("create bucket failed\n"); } /* 释放内存池,相当于释放了请求过程中各资源分配的内存。*/ aos_pool_destroy(pool); /* 释放之前分配的全局资源。*/ aos_http_io_deinitialize(); return 0; }
存储空间的命名规范,请参见基本概念中的命名规范。创建存储空间详情,请参见创建存储空间。
获取endpoint信息,请参见访问域名和数据中心文档。
上传文件
以下代码用于上传文件至OSS:
#include "oss_api.h" #include "aos_http_io.h" const char *endpoint = "<yourEndpoint>"; const char *access_key_id = "<yourAccessKeyId>"; const char *access_key_secret = "<yourAccessKeySecret>"; const char *bucket_name = "<yourBucketName>"; const char *object_name = "<yourObjectName>"; void init_options(oss_request_options_t *options) { options->config = oss_config_create(options->pool); /* 用char*类型的字符串初始化aos_string_t类型。*/ aos_str_set(&options->config->endpoint, endpoint); aos_str_set(&options->config->access_key_id, access_key_id); aos_str_set(&options->config->access_key_secret, access_key_secret); /* 是否使用了CNAME。0表示不使用。*/ options->config->is_cname = 0; /* 用于设置网络相关参数,比如超时时间等。*/ options->ctl = aos_http_controller_create(options->pool, 0); } int main(int argc, char *argv[]) { /* 在程序入口调用aos_http_io_initialize方法来初始化网络、内存等全局资源。*/ if (aos_http_io_initialize(NULL, 0) != AOSE_OK) { exit(1); } /* 用于内存管理的内存池(pool),等价于apr_pool_t。其实现代码在apr库中。*/ aos_pool_t *pool; /* 重新创建一个内存池,第二个参数是NULL,表示没有继承其它内存池。*/ aos_pool_create(&pool, NULL); /* 创建并初始化options,该参数包括endpoint、access_key_id、acces_key_secret、is_cname、curl等全局配置信息。*/ oss_request_options_t *oss_client_options; /* 在内存池中分配内存给options。*/ oss_client_options = oss_request_options_create(pool); /* 初始化Client的选项oss_client_options。*/ init_options(oss_client_options); /* 初始化参数。*/ aos_string_t bucket; aos_string_t object; aos_status_t *resp_status; aos_table_t *headers; aos_table_t *resp_headers; aos_list_t buffer; aos_buf_t *content = NULL; const char *data = "More than just cloud."; aos_str_set(&bucket, bucket_name); aos_str_set(&object, object_name); headers = aos_table_make(pool, 0); /* 将char*类型的数据转换为aos_list_t类型。*/ aos_list_init(&buffer); content = aos_buf_pack(oss_client_options->pool, data, strlen(data)); aos_list_add_tail(&content->node, &buffer); /* 上传文件。*/ resp_status = oss_put_object_from_buffer(oss_client_options, &bucket, &object, &buffer, headers, &resp_headers); /* 判断上传文件的请求是否成功。*/ if (aos_status_is_ok(resp_status)) { printf("put file succeeded\n"); } else { printf("put file failed\n"); } /* 释放内存池,相当于释放了请求过程中各资源分配的内存。*/ aos_pool_destroy(pool); /* 释放之前分配的全局资源。*/ aos_http_io_deinitialize(); return 0; }
下载文件
以下代码用于将指定的OSS文件下载到本地文件:
#include "oss_api.h" #include "aos_http_io.h" const char *endpoint = "<yourEndpoint>"; const char *access_key_id = "<yourAccessKeyId>"; const char *access_key_secret = "<yourAccessKeySecret>"; const char *bucket_name = "<yourBucketName>"; const char *object_name = "<yourObjectName>"; const char *download_filename = "<yourDownloadedFilename>"; void init_options(oss_request_options_t *options) { options->config = oss_config_create(options->pool); /* 用char*类型的字符串初始化aos_string_t类型。*/ aos_str_set(&options->config->endpoint, endpoint); aos_str_set(&options->config->access_key_id, access_key_id); aos_str_set(&options->config->access_key_secret, access_key_secret); /* 是否使用了CNAME。0表示不使用。*/ options->config->is_cname = 0; /* 用于设置网络相关参数,比如超时时间等。*/ options->ctl = aos_http_controller_create(options->pool, 0); } int main(int argc, char *argv[]) { /* 在程序入口调用aos_http_io_initialize方法来初始化网络、内存等全局资源。*/ if (aos_http_io_initialize(NULL, 0) != AOSE_OK) { exit(1); } /* 用于内存管理的内存池(pool),等价于apr_pool_t。其实现代码在apr库中。*/ aos_pool_t *pool; /* 重新创建一个内存池,第二个参数是NULL,表示没有继承其它内存池。*/ aos_pool_create(&pool, NULL); /* 创建并初始化options,该参数包括endpoint、access_key_id、acces_key_secret、is_cname、curl等全局配置信息。*/ oss_request_options_t *oss_client_options; /* 在内存池中分配内存给options。*/ oss_client_options = oss_request_options_create(pool); /* 初始化Client的选项oss_client_options。*/ init_options(oss_client_options); /* 初始化参数。*/ aos_string_t bucket; aos_string_t object; aos_string_t file; aos_status_t *resp_status; aos_table_t *headers = NULL; aos_table_t *params = NULL; aos_table_t *resp_headers = NULL; aos_str_set(&bucket, bucket_name); aos_str_set(&object, object_name); aos_str_set(&file, download_filename); headers = aos_table_make(pool, 0); /* 下载文件。*/ resp_status = oss_get_object_to_file(oss_client_options, &bucket, &object, headers, params, &file, &resp_headers); /* 判断下载文件的请求是否成功。*/ if (aos_status_is_ok(resp_status)) { printf("get object to local file succeeded\n"); } else { printf("get object to local file failed\n"); } /* 释放内存池,相当于释放了请求过程中各资源分配的内存。*/ aos_pool_destroy(pool); /* 释放之前分配的全局资源。*/ aos_http_io_deinitialize(); return 0; }
列举文件
以下代码用于列举指定存储空间的文件:
#include "oss_api.h" #include "aos_http_io.h" const char *endpoint = "<yourEndpoint>"; const char *access_key_id = "<yourAccessKeyId>"; const char *access_key_secret = "<yourAccessKeySecret>"; const char *bucket_name = "<yourBucketName>"; void init_options(oss_request_options_t *options) { options->config = oss_config_create(options->pool); /* 用char*类型的字符串初始化aos_string_t类型。*/ aos_str_set(&options->config->endpoint, endpoint); aos_str_set(&options->config->access_key_id, access_key_id); aos_str_set(&options->config->access_key_secret, access_key_secret); /* 是否使用了CNAME。0表示不使用。*/ options->config->is_cname = 0; /* 用于设置网络相关参数,比如超时时间等。*/ options->ctl = aos_http_controller_create(options->pool, 0); } int main(int argc, char *argv[]) { /* 在程序入口调用aos_http_io_initialize方法来初始化网络、内存等全局资源。*/ if (aos_http_io_initialize(NULL, 0) != AOSE_OK) { exit(1); } /* 用于内存管理的内存池(pool),等价于apr_pool_t。其实现代码在apr库中。*/ aos_pool_t *pool = NULL; /* 重新创建一个内存池,第二个参数是NULL,表示没有继承其它内存池。*/ aos_pool_create(&pool, NULL); /* 创建并初始化options,该参数包括endpoint、access_key_id、acces_key_secret、is_cname、curl等全局配置信息。*/ oss_request_options_t *oss_client_options = NULL; /* 在内存池中分配内存给options。*/ oss_client_options = oss_request_options_create(pool); /* 初始化Client的选项oss_client_options。*/ init_options(oss_client_options); /* 初始化参数。*/ aos_string_t bucket; aos_status_t *resp_status = NULL; oss_list_object_params_t *params = NULL; oss_list_object_content_t *content = NULL; int size = 0; char *line = NULL; aos_str_set(&bucket, bucket_name); params = oss_create_list_object_params(pool); /* 列举文件。*/ resp_status = oss_list_object(oss_client_options, &bucket, params, NULL); /* 判断列举文件的请求是否成功。*/ if (!aos_status_is_ok(resp_status)) { printf("list object failed\n"); } else{ /* 打印文件。*/ printf("Object\tSize\tLastModified\n"); aos_list_for_each_entry(oss_list_object_content_t, content, ¶ms->object_list, node) { ++size; line = apr_psprintf(pool, "%.*s\t%.*s\t%.*s\n", content->key.len, content->key.data, content->size.len, content->size.data, content->last_modified.len, content->last_modified.data); printf("%s", line); } printf("Total %d\n", size); } /* 释放内存池,相当于释放了请求过程中各资源分配的内存。*/ aos_pool_destroy(pool); /* 释放之前分配的全局资源。*/ aos_http_io_deinitialize(); return 0; }
删除文件
以下代码用于删除指定文件:
#include "oss_api.h" #include "aos_http_io.h" const char *endpoint = "<yourEndpoint>"; const char *access_key_id = "<yourAccessKeyId>"; const char *access_key_secret = "<yourAccessKeySecret>"; const char *bucket_name = "<yourBucketName>"; const char *object_name = "<yourObjectName>"; void init_options(oss_request_options_t *options) { options->config = oss_config_create(options->pool); /* 用char*类型的字符串初始化aos_string_t类型。*/ aos_str_set(&options->config->endpoint, endpoint); aos_str_set(&options->config->access_key_id, access_key_id); aos_str_set(&options->config->access_key_secret, access_key_secret); /* 是否使用了CNAME。0表示不使用。*/ options->config->is_cname = 0; /* 用于设置网络相关参数,比如超时时间等。*/ options->ctl = aos_http_controller_create(options->pool, 0); } int main(int argc, char *argv[]) { /* 在程序入口调用aos_http_io_initialize方法来初始化网络、内存等全局资源。*/ if (aos_http_io_initialize(NULL, 0) != AOSE_OK) { exit(1); } /* 用于内存管理的内存池(pool),等价于apr_pool_t。其实现代码在apr库中。*/ aos_pool_t *pool = NULL; /* 重新创建一个内存池,第二个参数是NULL,表示没有继承其它内存池。*/ aos_pool_create(&pool, NULL); /* 创建并初始化options,该参数包括endpoint、access_key_id、acces_key_secret、is_cname、curl等全局配置信息。*/ oss_request_options_t *oss_client_options = NULL; /* 在内存池中分配内存给options。*/ oss_client_options = oss_request_options_create(pool); /* 初始化Client的选项oss_client_options。*/ init_options(oss_client_options); /* 初始化参数。*/ aos_string_t bucket; aos_string_t object; aos_status_t *resp_status = NULL; aos_table_t *resp_headers = NULL; aos_str_set(&bucket, bucket_name); aos_str_set(&object, object_name); /* 删除文件。*/ resp_status = oss_delete_object(oss_client_options, &bucket, &object, &resp_headers); /* 判断删除文件的请求是否成功。*/ if (aos_status_is_ok(resp_status)) { printf("delete object succeeded\n"); } else { printf("delete object failed\n"); } /* 释放内存池,相当于释放了请求过程中各资源分配的内存。*/ aos_pool_destroy(pool); /* 释放之前分配的全局资源。*/ aos_http_io_deinitialize(); return 0; }