Aliyun OSS SDK for C#
GitHub version
Build Status
關于
- 此C# SDK基于阿里云對象存儲服務 API構建。
- 阿里云對象存儲（Object Storage Service，簡稱OSS），是阿里云對外提供的海量，安全，低成本，高可靠的云存儲服務。
- OSS適合存放任意文件類型，適合各種網站、開發企業及開發者使用。
- 使用此SDK，用戶可以方便地在任何應用、任何時間、任何地點上傳，下載和管理數據。
版本
- 當前版本：2.3.0
運行環境
Windows
- 適用于
.NET 2.0及以上版本 - 適用于
Visual Studio 2010及以上版本
Linux/Mac
- 適用于
Mono 3.12及以上版本
安裝方法
Windows環境安裝
NuGet安裝
- 如果您的Visual Studio沒有安裝NuGet，請先安裝 NuGet.
- 安裝好NuGet后，先在
Visual Studio中新建或者打開已有的項目，然后選擇<工具>－<NuGet程序包管理器>－<管理解決方案的NuGet程序包>， - 搜索
aliyun.oss.sdk，在結果中找到Aliyun.OSS.SDK，選擇最新版本，點擊安裝，成功后添加到項目應用中。
GitHub安裝
- 如果沒有安裝git，請先安裝 git
- git clone https://github.com/aliyun/aliyun-oss-csharp-sdk.git
- 下載好源碼后，按照
項目引入方式安裝即可
DLL引用方式安裝
- 從阿里云OSS官網下載SDK包，解壓后bin目錄包括了Aliyun.OSS.dll文件。
- 在Visual Studio的
<解決方案資源管理器>中選擇您的項目，然后右鍵<項目名稱>-<引用>，在彈出的菜單中選擇<添加引用>，
在彈出<添加引用>對話框后，選擇<瀏覽>，找到SDK包解壓的目錄，在bin目錄下選中<Aliyun.OSS.dll>文件,點擊確定即可
項目引入方式安裝
- 如果是下載了SDK包或者從GitHub上下載了源碼，希望源碼安裝，可以右鍵
<解決方案>，在彈出的菜單中點擊<添加>-><現有項目>。 - 在彈出的對話框中選擇
aliyun-oss-sdk.csproj文件，點擊打開。 - 接下來右鍵
<您的項目>－<引用>，選擇<添加引用>，在彈出的對話框選擇<項目>選項卡后選中aliyun-oss-sdk項目，點擊確定即可。
Unix/Mac環境安裝
NuGet安裝
- 先在
Xamarin中新建或者打開已有的項目，然后選擇<工具>－<Add NuGet Packages>。 - 搜索
aliyun.oss.sdk，在結果中找到Aliyun.OSS.SDK，選擇最新版本，點擊<Add Package>，成功后添加到項目應用中。
GitHub安裝
- 如果沒有安裝git，請先安裝 git
- git clone https://github.com/aliyun/aliyun-oss-csharp-sdk.git
- 下載好源碼后，使用Xamarin打開，在Release模式下編譯aliyun-oss-sdk項目，生成Aliyun.OSS.dll，然后通過DLL引用方式安裝
DLL引用方式安裝
- 從阿里云OSS官網下載SDK包，解壓后bin目錄包括了Aliyun.OSS.dll文件。
- 在Xamarin的
<解決方案>中選擇您的項目，然后右鍵<項目名稱>-<引用>，在彈出的菜單中選擇<Edit References>，
在彈出<Edit References>對話框后，選擇<.Net Assembly>-<瀏覽>，找到SDK包解壓的目錄，在bin目錄下選中<Aliyun.OSS.dll>文件,點擊<Open>即可
快速使用
獲取存儲空間列表（List Bucket）
OssClient client = new OssClient(endpoint, accessKeyId, accessKeySecret);
var buckets = client.ListBuckets();
foreach (var bucket in buckets)
{
Console.WriteLine(bucket.Name + ", " + bucket.Location + ", " + bucket.Owner);
}
創建存儲空間（Create Bucket）
OssClient client = new OssClient(endpoint, accessKeyId, accessKeySecret);
client.CreateBucket(bucketName);
刪除存儲空間（Delete Bucket）
OssClient client = new OssClient(endpoint, accessKeyId, accessKeySecret);
client.DeleteBucket(bucketName);
上傳文件（Put Object）
OssClient client = new OssClient(endpoint, accessKeyId, accessKeySecret);
client.PutObject(bucketName, key, filePathToUpload);
下載文件 (Get Object)
OssClient client = new OssClient(endpoint, accessKeyId, accessKeySecret);
var object = ossClient.GetObject(bucketName, key);
獲取文件列表（List Objects）
OssClient client = new OssClient(endpoint, accessKeyId, accessKeySecret);
var listResult = client.ListObjects(bucketName);
foreach (var summary in listResult.ObjectSummaries)
{
Console.WriteLine(summary.Key);
}
刪除文件(Delete Object)
OssClient client = new OssClient(endpoint, accessKeyId, accessKeySecret);
client.DeleteObject(bucketName, key)
其他
上面的例子中，如果沒有拋出異常則說明執行成功，否則失敗，更詳細的例子可以在aliyun-oss-sample項目中查看并運行。
注意事項
- 如果要運行sample，需要將aliyun-oss-sdk-sample項目設為
啟動項目，并添加您自己的AccessKeyId，AccessKeySecret，bucket，key等后即可運行。
聯系我們
- 阿里云OSS官方網站
- 阿里云OSS官方論壇
- 阿里云OSS官方文檔中心
- 阿里云官方技術支持：提交工單
