快速使用

安装

编译工具和第三方依赖

本SDK使用 cmake 编译(最小 2.8 版本),为跨平台方便,代码使用 ansi c 和 posix 标准库编写,基于 libcurl 这是 SDK 惟一的外部依赖库。

请选择对应的系统下载:

Ubuntu/Debian

  • 安装 gcc && cmake
1
2
  apt-get install -y build-essential
  apt-get install cmake
  • 安装 libcurl
1
  apt-get install libcurl4-openssl-dev

RedHat/Centos

  • 安装 gcc && cmake
1
2
  yum install cmake 
  yum install -y gcc gcc-c++
  • 安装 libcurl
1
  yum install libcurl-devel.x86_64 -y

其它Linux

  • 安装CMake:从链接中下载相应的版本进行安装。常用的安装方式如下:
1
2
3
  ./configure
  make
  make install                                    

说明 执行./configure时,默认安装路径为/usr/local/,如果需要指定安装路径,请使用 ./configure –prefix选项。

  • 安装libcurl:从链接中下载相应的版本进行安装。常用的安装方式如下:
1
2
3
  ./configure
  make
  make install

SDK下载安装

1
  git clone git@github.com:ufilesdk-dev/ufile-csdk.git
  • 编译
1
  cd ufile-csdk && mkdir -p build && cd build && cmake ../ && make

使用示例

配置

本SDK使用前需配置ufile_config所需数据,用于ufile_sdk_initialize接口初始化 SDK。ufile_config数据结构如下:

1
2
3
4
5
6
struct ufile_config{
    const char *public_key;   //API公钥 或者 令牌公钥
    const char *private_key;  //API私钥 或者 令牌私钥
    const char *file_host;    //具体地域的host,例如北京的为:"cn-bj.ufileos.com"
    const char *bucket_host;  //用于创建和删除 bucket, 请填写为"api.ucloud.cn"
};

密钥可以在控制台中 API 产品 - API 密钥,点击显示 API 密钥获取。将 public_key 和 private_key 分别赋值给相关变量后,SDK即可通过此密钥完成鉴权。请妥善保管好 API 密钥,避免泄露。 token(令牌)是针对指定bucket授权的一对公私钥。可通过token进行授权bucket的权限控制和管理。可以在控制台中对象存储US3-令牌管理,点击创建令牌获取。

file_host 是文件操作请求的接收地址,可以在控制台的存储空间域名一列获取,例如test-demo.cn-bj.ufileos.com,填写cn-bj.ufileos.com即可,不需要存储空间名称。

SDK 可使用环境变量的方式加载配置,执行以下命令进行配置

1
2
3
4
export UFILE_PUBLIC_KEY=<your pubic key>
export UFILE_PRIVATE_KEY=<your pubic key>
export UFILE_BUCKET_HOST=api.ucloud.cn 
export UFILE_FILE_HOST=<your file host> 

示例代码如下

执行示例前,请将代码中的bucket_name、key_name、ul_file_path、dl_file_path和mime_type更换成有效值

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
#include "../lib/api.h"
#include <stdio.h>
#include <stdlib.h>
#include <errno.h>
#include <string.h>
#include "helper.h"

// 执行前请赋予下列变量有效值
const char* bucket_name = "";
const char* key_name = "";
const char* ul_file_path = "";
const char* dl_file_path = "";
const char* mime_type = "";

int main(int argc, char *argv[]){
    // 读取配置初始化SDK
    struct ufile_config cfg;
    cfg.public_key = getenv("UFILE_PUBLIC_KEY");
    cfg.private_key = getenv("UFILE_PRIVATE_KEY");
    cfg.bucket_host = getenv("UFILE_BUCKET_HOST");
    cfg.file_host = getenv("UFILE_FILE_HOST");
    struct ufile_error error;
    error = ufile_sdk_initialize(cfg, 0);
    if(UFILE_HAS_ERROR(error.code)){
        printf("初始化 sdk 失败,错误信息为:%s\n", error.message);
        return 1;
    }

    // 调用 ufile_put_file 上传文件
    printf("调用 ufile_put_file 上传文件 %s\n", ul_file_path);
    FILE *fp = fopen(ul_file_path, "rb");
    if (fp == NULL){
        fprintf(stderr, "打开文件失败, 错误信息为: %s\n", strerror(errno));
        ufile_sdk_cleanup();
        return 1;
    }
    error = ufile_put_file(bucket_name, key_name, mime_type, fp);
    if UFILE_HAS_ERROR(error.code) {
        printf("调用 ufile_put_file 失败,错误信息为:%s\n", error.message);
        ufile_sdk_cleanup();
        return 1;
    }
    fclose(fp);

    // 获取文件基本信息
    struct ufile_file_info file_info;
    error = ufile_head(bucket_name, key_name, &file_info);
    if UFILE_HAS_ERROR(error.code) {
        printf("调用 head 失败,错误信息为:%s\n", error.message);
        ufile_sdk_cleanup();
        return 1;
    }
    printf("文件基本信息为: size=%lld,etag=%s,mime-type=%s\n", file_info.bytes_len, file_info.etag, file_info.mime_type);
    ufile_free_file_info(file_info);  // 需释放file_info内存

    // 下载文件
    FILE *f = fopen(dl_file_path, "wb");
    if (f == NULL){
        fprintf(stderr, "打开文件失败, 错误信息为: %s\n", strerror(errno));
        return 1;
    }
    error = ufile_download(bucket_name, key_name, f, NULL);
    if UFILE_HAS_ERROR(error.code){
        printf("调用 download 失败,错误信息为:%s\n", error.message);
        ufile_sdk_cleanup();
        return 1;
    }
    fclose(f);

    // 删除文件
    error = ufile_delete(bucket_name, key_name);
    if(UFILE_HAS_ERROR(error.code)){
        printf("删除文件失败,错误信息为:%s\n", error.message);
    }
	// 释放初始化SDK时分配的内存
    ufile_sdk_cleanup();
    return 0;
}