iOS から BLOB ストレージを使用する方法

この記事では、Microsoft Azure Blob Storage を使用して一般的なシナリオを実行する方法について説明します。 サンプルは Objective-C で記述され、 iOS 用 Azure Storage クライアント ライブラリを使用しています。 紹介するシナリオは、BLOB のアップロード、一覧の取得、ダウンロード、および削除です。 BLOB の詳細については、「 次のステップ 」のセクションを参照してください。 また、 サンプル アプリ をダウンロードし、iOS アプリケーションでの Azure Storage の使用例をすぐに確認することもできます。

Blob Storage の詳細については、「Azure Blob Storage の概要」をご覧ください。

Azure のストレージ アカウントの作成

最初の Azure ストレージ アカウントを作成する最も簡単な方法は、Azure Portal を利用することです。 詳細については、「 ストレージ アカウントの作成」を参照してください。

Azure Storage アカウントは、Azure PowerShell、Azure CLI、または .NET 用 Azure ストレージ リソース プロバイダーを使用して作成することもできます。

現時点で Azure にストレージ アカウントを作成しない場合は、Azure ストレージ エミュレーターを使って、ローカル環境でコードの実行とテストを行うこともできます。 詳細については、ローカルでの Azure Storage の開発に Azurite エミュレーターを使用する方法に関するページを参照してください。

Azure Storage iOS ライブラリをアプリケーションにインポートする

Azure Storage CocoaPod を使用するか、または フレームワーク ファイルをインポートするかのいずれかにより、Azure Storage iOS ライブラリをアプリケーションにインポートすることができます。 既存のプロジェクトについては､フレームワーク ファイルからのインポートの方が煩わしさは少なくなりますが､ライブラリの統合が容易になるため､CocoaPod はお勧めの方法です｡

このライブラリを使用するには､以下が必要です｡

• iOS 8+
• Xcode 7+

CocoaPod

1. まだ実行していない場合は、ターミナル ウィンドウを開いて次のコマンドを実行し、コンピューターに CocoaPods をインストール します。

   sudo gem install cocoapods
   

2. 次に、プロジェクト ディレクトリ (.xcodeproj ファイルが含まれるディレクトリ) に、Podfile という新しいファイル (ファイル拡張子なし) を作成します。 Podfile に次のコードを追加して保存します。

   platform :ios, '8.0'
   
   target 'TargetName' do
     pod 'AZSClient'
   end
   

3. ターミナル ウィンドウでプロジェクト ディレクトリに移動し、次のコマンドを実行します。

   pod install
   

4. Xcode で .xcodeproj が開いている場合は閉じます。 プロジェクト ディレクトリで、拡張子が .xcworkspace の、新しく作成されたプロジェクト ファイルを開きます。 以降の作業にはこのファイルを使用します。

フレームワーク

このライブラリを利用するもう 1 つの方法は､フレームワークを手動で構築する方法です｡

1. まずは、 azure-storage-ios リポジトリをダウンロードまたは複製します。
2. azure-storage-ios - >Lib - >Azure Storage Client Library の順に移動し、AZSClient.xcodeproj を Xcode で開きます。
3. Xcode の左上部分で、アクティブ スキームを "Azure Storage Client Library" から "Framework" に変更します。
4. プロジェクトをビルド (⌘ + B キー) します。 これにより､デスクトップ上に AZSClient.framework ファイルが作成されます｡

次に、以下の手順を実行すると、フレームワーク ファイルをアプリケーションにインポートできます。

1. Xcode で新しいプロジェクトを作成するか、既存のプロジェクトを開きます。
2. AZSClient.framework を Xcode プロジェクト ナビゲーターにドラッグします｡
3. [Copy items if needed (必要に応じてアイテムをコピー)] を選択し、 [Finishu (完了)] をクリックします。
4. 左側のナビゲーションでプロジェクトをクリックし、プロジェクト エディターの上部にある [General] タブをクリックします。
5. [Linked Frameworks and Libraries] セクションの下で、追加ボタン (+) をクリックします。
6. 既に表示されているライブラリの一覧で libxml2.2.tbd を検索し、それをプロジェクトに追加します。

ライブラリをインポートする

// Include the following import statement to use blob APIs.
#import <AZSClient/AZSClient.h>

Swift を使用する場合は、ブリッジヘッダーを作成し､<AZSClient/AZSClient.h> をインポートする必要があります｡

1. ヘッダー ファイル Bridging-Header.h を作成し､上記の import ステートメントを追加します｡
2. [Build Settings] タブに移動し､[Objective-C Bridging Header] を探します｡
3. [Objective-C Bridging Header] のフィールドをダブルクリックし､ヘッダー ファイルにパスを追加します｡ ProjectName/Bridging-Header.h
4. プロジェクトをビルド (⌘+B) して､ブリッジ ヘッダーが Xcode によって取得されたことを確認します｡
5. 任意の Swift ファイルでのライブラリの直接使用を開始します｡import ステートメントは必要ありません｡

Azure Storage にアクセスするようにアプリケーションを構成する

Storage サービスにアクセスできるようにアプリケーションを認証するには、次の 2 つの方法があります。

• 共有キー:テスト目的のみに共有キーを使用します
• Shared Access Signature (SAS):運用アプリケーション用に SAS を使用します

共有キー

共有キー認証の場合、アプリケーションは Storage サービスへのアクセスにアカウント名とアカウント キーを使用します。 このライブラリを使用する方法を簡単に説明するため、ここでは共有キー認証を使用します。

共有キー認証を使用する場合は、 接続文字列を作成します。 接続文字列の構成要素は次のとおりです。

• DefaultEndpointsProtocol - HTTP または HTTPS を選択できますが、 HTTPS の使用を強くお勧めします。
• Account Name - ストレージ アカウントの名前
• Account Key - Azure Portal でお使いのストレージ アカウントに移動し、 [キー] アイコンをクリックして確認します。
• (省略可能) EndpointSuffix - Azure China、Azure Governance など、別のエンドポイント サフィックスを持つリージョンのストレージ サービスに対して使用されます。

共有キー認証を使用する接続文字列の例を次に示します。

"DefaultEndpointsProtocol=https;AccountName=your_account_name_here;AccountKey=your_account_key_here"

Shared Access Signatures (SAS)

モバイル アプリケーションの場合、Azure Storage サービスに対するクライアントからの要求を認証する際には、Shared Access Signature (SAS) を使用することをお勧めします。 SAS を使用すると、期間およびアクセス許可セットを指定して、リソースへのクライアント アクセスを許可することができます。 ストレージ アカウント所有者は、モバイル クライアントが使用する SAS を生成する必要があります。 SAS を生成するには、クライアントに配布する SAS を生成する別のサービスを記述することが必要になります。 テスト目的で、Microsoft Azure ストレージ エクスプローラーまたは Azure Portal を使用して SAS を生成できます。 SAS の作成時には、SAS の有効期間と、SAS がクライアントに付与するアクセス許可を指定できます。

次に示すのは、Microsoft Azure ストレージ エクスプローラーを使用して SAS を生成する方法の例です。

1. まだインストールしていない場合は、 Microsoft Azure ストレージ エクスプローラーをインストール

2. サブスクリプションに接続します。

3. ストレージ アカウントをクリックし、左下の [アクション] タブをクリックします。 [Get Shared Access Signature] \(Shared Access Signature の取得) をクリックすると、SAS の "接続文字列" が生成されます。

4. 次に示すのは、ストレージ アカウントの BLOB サービスに対するサービス、コンテナー、およびオブジェクト レベルの読み取りおよび書き込みのアクセス許可を付与する SAS 接続文字列の例です。

   "SharedAccessSignature=sv=2015-04-05&ss=b&srt=sco&sp=rw&se=2016-07-21T18%3A00%3A00Z&sig=3ABdLOJZosCp0o491T%2BqZGKIhafF1nlM3MzESDDD3Gg%3D;BlobEndpoint=https://youraccount.blob.core.windows.net"

ご覧のように、SAS を使用する場合、アプリケーションでアカウント キーを公開することはありません。 SAS の詳細および SAS 使用のベスト プラクティスについては、Shared Access Signature:SAS モデルの説明に関するページをご覧ください。

非同期操作

コンテナーを作成する

Azure Storage のどの BLOB もコンテナーに格納する必要があります。 次の例では、ストレージ アカウントに newcontainerというコンテナーが存在しない場合、それを作成する方法を示します。 コンテナーの名前を選択する場合は、上記の名前付け規則に注意してください。

-(void)createContainer{
    NSError *accountCreationError;

    // Create a storage account object from a connection string.
    AZSCloudStorageAccount *account = [AZSCloudStorageAccount accountFromConnectionString:@"DefaultEndpointsProtocol=https;AccountName=your_account_name_here;AccountKey=your_account_key_here" error:&accountCreationError];

    if(accountCreationError){
        NSLog(@"Error in creating account.");
    }

    // Create a blob service client object.
    AZSCloudBlobClient *blobClient = [account getBlobClient];

    // Create a local container object.
    AZSCloudBlobContainer *blobContainer = [blobClient containerReferenceFromName:@"newcontainer"];

    // Create container in your Storage account if the container doesn't already exist
    [blobContainer createContainerIfNotExistsWithCompletionHandler:^(NSError *error, BOOL exists) {
        if (error){
            NSLog(@"Error in creating container.");
        }
    }];
}

このコード例が正常に機能していることを確認するには、 Microsoft Azure ストレージ エクスプローラー で、 newcontainer がストレージ アカウントのコンテナーの一覧に含まれていることを確認します。

コンテナーのアクセス許可を設定する

コンテナーのアクセス許可は、既定では、 プライベート アクセス用に構成されています。 ただし、コンテナーには、コンテナー アクセス用にいくつかの異なるオプションが用意されています。

• プライベート: コンテナーと BLOB のデータはアカウント所有者に限り読み取ることができます。
• BLOB:該当するコンテナー内の BLOB データは匿名要求で読み取り可能ですが、コンテナー データは参照できません。 クライアントはコンテナー内の BLOB を匿名要求で列挙することはできません。
• コンテナー:コンテナーと BLOB のデータを匿名要求で読み取ることができます。 クライアントは匿名要求でコンテナー内の BLOB を列挙できますが、ストレージ アカウント内のコンテナーを列挙することはできません。

次の例では、コンテナー アクセス許可を指定したコンテナーの作成方法を示します。このアクセス許可により、インターネット上のすべてのユーザーに対して読み取り専用のパブリック アクセスが許可されます。

-(void)createContainerWithPublicAccess{
    NSError *accountCreationError;

    // Create a storage account object from a connection string.
    AZSCloudStorageAccount *account = [AZSCloudStorageAccount accountFromConnectionString:@"DefaultEndpointsProtocol=https;AccountName=your_account_name_here;AccountKey=your_account_key_here" error:&accountCreationError];

    if(accountCreationError){
        NSLog(@"Error in creating account.");
    }

    // Create a blob service client object.
    AZSCloudBlobClient *blobClient = [account getBlobClient];

    // Create a local container object.
    AZSCloudBlobContainer *blobContainer = [blobClient containerReferenceFromName:@"containerpublic"];

    // Create container in your Storage account if the container doesn't already exist
    [blobContainer createContainerIfNotExistsWithAccessType:AZSContainerPublicAccessTypeContainer requestOptions:nil operationContext:nil completionHandler:^(NSError *error, BOOL exists){
        if (error){
            NSLog(@"Error in creating container.");
        }
    }];
}

コンテナーに BLOB をアップロードする

Blob service の概念に関するセクションで説明したように、Blob Storage には、ブロック BLOB、追加 BLOB、ページ BLOB という 3 種類の BLOB が用意されています。 Azure Storage iOS ライブラリは、3 つのタイプの BLOB すべてをサポートしています。 ほとんどの場合は、ブロック BLOB を使用することをお勧めします。

次の例では、NSString からブロック BLOB をアップロードする方法を示します。 同じ名前の BLOB が既にこのコンテナーに存在する場合は、この BLOB の内容が上書きされます。

-(void)uploadBlobToContainer{
    NSError *accountCreationError;

    // Create a storage account object from a connection string.
    AZSCloudStorageAccount *account = [AZSCloudStorageAccount accountFromConnectionString:@"DefaultEndpointsProtocol=https;AccountName=your_account_name_here;AccountKey=your_account_key_here" error:&accountCreationError];

    if(accountCreationError){
        NSLog(@"Error in creating account.");
    }

    // Create a blob service client object.
    AZSCloudBlobClient *blobClient = [account getBlobClient];

    // Create a local container object.
    AZSCloudBlobContainer *blobContainer = [blobClient containerReferenceFromName:@"containerpublic"];

    [blobContainer createContainerIfNotExistsWithAccessType:AZSContainerPublicAccessTypeContainer requestOptions:nil operationContext:nil completionHandler:^(NSError *error, BOOL exists)
        {
            if (error){
                NSLog(@"Error in creating container.");
            }
            else{
                // Create a local blob object
                AZSCloudBlockBlob *blockBlob = [blobContainer blockBlobReferenceFromName:@"sampleblob"];

                // Upload blob to Storage
                [blockBlob uploadFromText:@"This text will be uploaded to Blob Storage." completionHandler:^(NSError *error) {
                    if (error){
                        NSLog(@"Error in creating blob.");
                    }
                }];
            }
        }];
}

このコード例が正常に機能していることを確認するには、Microsoft Azure ストレージ エクスプローラーで、コンテナー containerpublic に BLOB sampleblob が含まれていることを確認します。 この例では､パブリック コンテナーが使用されているため、このアプリケーションが機能することは､次の BLOB URI にアクセスすることによっても確認できます。

https://nameofyourstorageaccount.blob.core.windows.net/containerpublic/sampleblob

NSString からのブロック BLOB のアップロードばかりでなく、NSData、NSInputStream、あるいはローカル ファイルについても同様の方法が存在します。

コンテナー内の BLOB を一覧表示する

次の例では、コンテナー内のすべての BLOB を一覧表示する方法を示します。 この操作を実行する場合は、次のパラメーターに注意してください。

• continuationToken - 継続トークンは、一覧表示操作の開始位置を表します。 トークンが指定されていない場合、最初から BLOB を一覧表示します。 0 から設定された最大値まで、BLOB はいくつでも一覧表示できます。 このメソッドによって返される結果が 0 件でも、 results.continuationToken が nil でない場合は、一覧表示されていない BLOB がもっとサービス上に存在する可能性があります。
• prefix - BLOB の一覧表示に使用するプレフィックスを指定できます。 このプレフィックスで始まる名前の BLOB のみが一覧表示されます。
• useFlatBlobListing - 「コンテナーおよび BLOB の名前付けと参照」セクションで説明したように、Blob service はフラット ストレージ スキームですが、パス情報を使用して BLOB に名前を付けることで、仮想階層を作成できます。 ただし、フラットでない一覧表示は現在サポートされておらず､ まもなく公開されます｡ 現時点では、この値は YES にする必要があります。
• blobListingDetails - BLOB を一覧表示するときに含める項目を指定できます。
  • AZSBlobListingDetailsNone:コミット済みの BLOB のみを一覧表示し、BLOB メタデータは返しません。
  • AZSBlobListingDetailsSnapshots:コミット済みの BLOB と BLOB スナップショットを一覧表示します。
  • AZSBlobListingDetailsMetadata:一覧に返された BLOB ごとに BLOB メタデータを取得します。
  • AZSBlobListingDetailsUncommittedBlobs:コミット済みおよびコミット前の BLOB を一覧表示します。
  • AZSBlobListingDetailsCopy:コピー プロパティを一覧に含めます。
  • AZSBlobListingDetailsAll:使用可能なコミット済みの BLOB、コミット前の BLOB、スナップショットをすべて一覧表示し、それらの BLOB に関するすべてのメタデータとコピーの状態を返します。
• maxResults - この操作に対して返される結果の最大数。 制限を設けない場合は -1 を使用します。
• completionHandler - 一覧表示操作の結果を使用して実行するコードのブロック。

この例では、継続トークンが返されるたびに BLOB の一覧表示メソッドを再帰的に呼び出すために、ヘルパー メソッドが使用されています。

-(void)listBlobsInContainer{
    NSError *accountCreationError;

    // Create a storage account object from a connection string.
    AZSCloudStorageAccount *account = [AZSCloudStorageAccount accountFromConnectionString:@"DefaultEndpointsProtocol=https;AccountName=your_account_name_here;AccountKey=your_account_key_here" error:&accountCreationError];

    if(accountCreationError){
        NSLog(@"Error in creating account.");
    }

    // Create a blob service client object.
    AZSCloudBlobClient *blobClient = [account getBlobClient];

    // Create a local container object.
    AZSCloudBlobContainer *blobContainer = [blobClient containerReferenceFromName:@"containerpublic"];

    //List all blobs in container
    [self listBlobsInContainerHelper:blobContainer continuationToken:nil prefix:nil blobListingDetails:AZSBlobListingDetailsAll maxResults:-1 completionHandler:^(NSError *error) {
        if (error != nil){
            NSLog(@"Error in creating container.");
        }
    }];
}

//List blobs helper method
-(void)listBlobsInContainerHelper:(AZSCloudBlobContainer *)container continuationToken:(AZSContinuationToken *)continuationToken prefix:(NSString *)prefix blobListingDetails:(AZSBlobListingDetails)blobListingDetails maxResults:(NSUInteger)maxResults completionHandler:(void (^)(NSError *))completionHandler
{
    [container listBlobsSegmentedWithContinuationToken:continuationToken prefix:prefix useFlatBlobListing:YES blobListingDetails:blobListingDetails maxResults:maxResults completionHandler:^(NSError *error, AZSBlobResultSegment *results) {
        if (error)
        {
            completionHandler(error);
        }
        else
        {
            for (int i = 0; i < results.blobs.count; i++) {
                NSLog(@"%@",[(AZSCloudBlockBlob *)results.blobs[i] blobName]);
            }
            if (results.continuationToken)
            {
                [self listBlobsInContainerHelper:container continuationToken:results.continuationToken prefix:prefix blobListingDetails:blobListingDetails maxResults:maxResults completionHandler:completionHandler];
            }
            else
            {
                completionHandler(nil);
            }
        }
    }];
}

BLOB をダウンロードする

次の例では、BLOB を NSString オブジェクトにダウンロードする方法を示します。

-(void)downloadBlobToString{
    NSError *accountCreationError;

    // Create a storage account object from a connection string.
    AZSCloudStorageAccount *account = [AZSCloudStorageAccount accountFromConnectionString:@"DefaultEndpointsProtocol=https;AccountName=your_account_name_here;AccountKey=your_account_key_here" error:&accountCreationError];

    if(accountCreationError){
        NSLog(@"Error in creating account.");
    }

    // Create a blob service client object.
    AZSCloudBlobClient *blobClient = [account getBlobClient];

    // Create a local container object.
    AZSCloudBlobContainer *blobContainer = [blobClient containerReferenceFromName:@"containerpublic"];

    // Create a local blob object
    AZSCloudBlockBlob *blockBlob = [blobContainer blockBlobReferenceFromName:@"sampleblob"];

    // Download blob
    [blockBlob downloadToTextWithCompletionHandler:^(NSError *error, NSString *text) {
        if (error) {
            NSLog(@"Error in downloading blob");
        }
        else{
            NSLog(@"%@",text);
        }
    }];
}

BLOB を削除する

次の例では、BLOB を削除する方法を示します。

-(void)deleteBlob{
    NSError *accountCreationError;

    // Create a storage account object from a connection string.
    AZSCloudStorageAccount *account = [AZSCloudStorageAccount accountFromConnectionString:@"DefaultEndpointsProtocol=https;AccountName=your_account_name_here;AccountKey=your_account_key_here" error:&accountCreationError];

    if(accountCreationError){
        NSLog(@"Error in creating account.");
    }

    // Create a blob service client object.
    AZSCloudBlobClient *blobClient = [account getBlobClient];

    // Create a local container object.
    AZSCloudBlobContainer *blobContainer = [blobClient containerReferenceFromName:@"containerpublic"];

    // Create a local blob object
    AZSCloudBlockBlob *blockBlob = [blobContainer blockBlobReferenceFromName:@"sampleblob1"];

    // Delete blob
    [blockBlob deleteWithCompletionHandler:^(NSError *error) {
        if (error) {
            NSLog(@"Error in deleting blob.");
        }
    }];
}

BLOB コンテナーを削除する

次の例では、コンテナーを削除する方法を示します。

-(void)deleteContainer{
    NSError *accountCreationError;

    // Create a storage account object from a connection string.
    AZSCloudStorageAccount *account = [AZSCloudStorageAccount accountFromConnectionString:@"DefaultEndpointsProtocol=https;AccountName=your_account_name_here;AccountKey=your_account_key_here" error:&accountCreationError];

    if(accountCreationError){
        NSLog(@"Error in creating account.");
    }

    // Create a blob service client object.
    AZSCloudBlobClient *blobClient = [account getBlobClient];

    // Create a local container object.
    AZSCloudBlobContainer *blobContainer = [blobClient containerReferenceFromName:@"containerpublic"];

    // Delete container
    [blobContainer deleteContainerIfExistsWithCompletionHandler:^(NSError *error, BOOL success) {
        if(error){
            NSLog(@"Error in deleting container");
        }
    }];
}

次のステップ

これで、iOS から BLOB ストレージを使用する方法を学習できました。 iOS ライブラリおよび Storage サービスの詳細については、次のリンク先をご覧ください。

• iOS 用 Azure Storage クライアント ライブラリ
• Azure Storage iOS リファレンス ドキュメント
• Azure Storage Services REST API (Azure Storage サービスの REST API)
• Azure のストレージ チーム ブログ

このライブラリに関してご質問がある場合は、お気軽に Microsoft Q&A 質問ページ または Stack Overflow に投稿してください。 Azure Storage の機能についてご提案がある場合は、 Azure Storage のフィードバックに投稿してください。