モバイルアプリクラウドバックエンドでMongoDBを使用する

Azureのモバイルサービスの.NETバックエンドの利点の1つは、SQL Database（SQL Azure）だけでなく、他のデータウェアハウスの組み込みサポートも利用できることです。



ノードを使用する場合。 js、 SQLの使用を拒否し、他の可能なリポジトリを使用することもできます（たとえば、Azure Table Storageに関するChris Reisnerの記事に書かれています）が、この機能は組み込まれていないため、自分でコードを記述する必要があります。



.NETを使用する場合、非SQLリポジトリを操作するためのほとんどの機能は既に統合されているため、node.jsのようにデータリクエストを送信する機能のためだけに「ダミー」テーブルを作成する必要はありません 。



この記事では、 MongoDBのサポートと、CRUD操作がMongoDBコレクションで直接実行されるテーブルを作成する方法について説明します。

データベースのセットアップ

すでにMongoDBアカウントを持っている場合は、この手順をスキップできます（接続文字列を覚えておいてください-後で必要になります）。



この記事では、「orders」というコレクションを使用します。このようなコレクションが存在しない場合は、自分で作成する必要はありません。バックエンドが自動的に作成します。



最初から始める人のために、私は説明します：この記事では、 Microsoft Azureポータルで無料で入手できるMongo Labsデータベース （限定版）を使用します。 アカウントを作成するには、Azureポータルに移動し、[ 新規 ] -> [ストア ]をクリックしてMongoLabアドオンを選択し、アカウントを登録します。







アカウントが構成されたら、 「接続情報」ボタンをクリックして、データベースへの接続に必要なURIを取得します。 保存してください。 アカウント名は、後で使用するデータベースの名前になります。







Mongoデータベースが構成されました。 コレクションに最初にアクセスしようとしたときに作成されるため、コレクションを作成する必要はありません。

サービスのセットアップ

Visual Studioでは、Entity Framework以外のものを使用するバックエンドでプロジェクトを作成する方法がないため、空のWebプロジェクトを作成します。 最初の.NETバックエンドの作成に関する前回の記事で行ったことから始めますが、Azure Mobile Services .NETバックエンドエンティティフレームワークNuGetパッケージを追加する代わりに、 Azure Mobile Services .NETバックエンドMongoパッケージを追加します。



また、 Microsoft.Owin.Host.SystemWebパッケージを追加します。これは、デバッグプロセスを容易にするためにローカルで実行する機会を得るために必要です。



両方のパッケージ（およびそれらの依存関係）をインストールした後、デフォルトでRegisterメソッドを使用して初期化静的クラスWebApiConfigを追加します。

public static class WebApiConfig { public static void Register() { ServiceConfig.Initialize(new ConfigBuilder()); } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

グローバルクラスをアプリケーションに追加して、イニシャライザをローカルに呼び出します。

 public class Global : System.Web.HttpApplication { protected void Application_Start(object sender, EventArgs e) { WebApiConfig.Register(); } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

データベースコレクションに格納されるオブジェクトモデルを定義します。 要素のリストを含むOrderクラスを定義します。

 public class Order : DocumentData { public DateTime OrderDate { get; set; } public string Client { get; set; } public List<OrderItem> Items { get; set; } } public class OrderItem { public string Name { get; set; } public double Quantity { get; set; } public double Price { get; set; } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

データモデルは、Entity Frameworkデータモデルと同じ方法ItableData



インターフェイスItableData



実装する必要があります。このインターフェイスをEntity Frameworkに実装するには、MongoDBを使用するときにDocumentData



クラスに似たベースクラスEntityData



を使用し.



この後、モデルクラスのサブジェクト領域のプロパティのみを決定できます。

テーブル定義

MongoDBのテーブルは、実際にはEFに似ています。 サブジェクトエリアの新しいコントロールクラスを実装する必要がある状況のみを除き、操作は同じシナリオで実装できます。AzureMobile Services .NETバックエンドMongoパッケージから利用可能なMongoDomainManagerクラスを使用できます。



操作を実行するには、MongoDBドライバー （または他のMongoクライアント） から常に直接型を使用して操作を実装できますが、一般的なシナリオでは、必要な実装は基本クラスTableController < T>によって提供されます。

 public class OrderController : TableController<Order> { protected override void Initialize(HttpControllerContext controllerContext) { base.Initialize(controllerContext); var connStringName = "mongodb"; var dbName = "MyMongoLab"; var collectionName = "orders"; this.DomainManager = new MongoDomainManager<Order>(connStringName, dbName, collectionName, this.Request, this.Services); } public IQueryable<Order> GetAllOrders() { return base.Query(); } public Order GetOneOrder(string id) { var result = base.Lookup(id).Queryable.FirstOrDefault(); if (result == null) { throw new HttpResponseException(HttpStatusCode.NotFound); } else { return result; } } public Task<Order> PostOrder(Order order) { return base.InsertAsync(order); } public Task DeleteOrder(string id) { return base.DeleteAsync(id); } public Task<Order> PatchOrder(string id, Delta<Order> patch) { return base.UpdateAsync(id, patch); } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

MongoDomainManager



コンストラクターの最初のパラメーターは、実際のデータベース接続文字列を含む構成内の< connectionStrings>セクションの要素の名前です（実際の接続文字列をコンストラクターに渡す関数を追加できます）。



web.configファイルに適切なセクションを追加します （Azureポータルで取得した接続文字列を使用します）。

 <connectionStrings> <add name="mongodb" connectionString="mongodb://MyMongoLab:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-@dsNNNNNN.mongolab.com:PPPPP/MyMongoLab"/> </connectionStrings>
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

これでプロジェクトが開始されます。

サービステスト

サービスをテストします。 サービスにリクエストを送信するには、 Fiddlerを使用します。



まず、GETが返すものを見てみましょう。

 GET http://localhost:54524/tables/order HTTP/1.1 User-Agent: Fiddler Host: localhost:54524 =-=-=-=-=-=-=-=-=- HTTP/1.1 200 OK Cache-Control: no-cache Pragma: no-cache Content-Length: 2 Content-Type: application/json; charset=utf-8 Expires: 0 Server: Microsoft-IIS/8.0 X-Powered-By: ASP.NET Date: Mon, 14 Apr 2014 15:43:31 GMT []
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

予期しないことはありません（「注文」コレクションが既にあることを除いて）。



コレクションにいくつかの要素を追加します。

 POST http://localhost:54524/tables/order HTTP/1.1 User-Agent: Fiddler Host: localhost:54524 Content-Length: 211 Content-Type: application/json { "client":"John Doe", "orderDate":"2014-04-13T00:00:00Z", "items":[ { "name": "bread", "quantity": 1, "price": 1.99 }, { "name": "milk", "quantity": 2, "price": 2.99 } ] } =-=-=-=-=-=-=-=-=- HTTP/1.1 200 OK Content-Length: 383 Content-Type: application/json; charset=utf-8 Server: Microsoft-IIS/8.0 X-Powered-By: ASP.NET Date: Mon, 14 Apr 2014 15:53:13 GMT { "orderDate": "2014-04-13T00:00:00Z", "client": "John Doe", "items": [ { "name": "bread", "quantity": 1.0, "price": 1.99 }, { "name": "milk", "quantity": 2.0, "price": 2.99 } ], "id": "534c0469f76e1e10c4703c2b", "__createdAt": "2014-04-14T15:53:12.982Z", "__updatedAt": "2014-04-14T15:53:12.982Z" }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

そしてもう一つ：

 POST http://localhost:54524/tables/order HTTP/1.1 User-Agent: Fiddler Host: localhost:54524 Content-Length: 216 Content-Type: application/json { "client":"Jane Roe", "orderDate":"2014-02-22T00:00:00Z", "items":[ { "name": "nails", "quantity": 100, "price": 3.50 }, { "name": "hammer", "quantity": 1, "price": 12.34 } ] } =-=-=-=-=-=-=-=-=- HTTP/1.1 200 OK Content-Length: 387 Content-Type: application/json; charset=utf-8 Server: Microsoft-IIS/8.0 X-Powered-By: ASP.NET Date: Mon, 14 Apr 2014 15:53:21 GMT { "orderDate": "2014-02-22T00:00:00Z", "client": "Jane Roe", "items": [ { "name": "nails", "quantity": 100.0, "price": 3.5 }, { "name": "hammer", "quantity": 1.0, "price": 12.34 } ], "id": "534c0471f76e1e10c4703c2c", "__createdAt": "2014-04-14T15:53:21.557Z", "__updatedAt": "2014-04-14T15:53:21.557Z }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

結果を確認するために別のGETリクエストを送信します。

 GET http://localhost:54524/tables/order HTTP/1.1 User-Agent: Fiddler Host: localhost:54524 =-=-=-=-=-=-=-=-=- HTTP/1.1 200 OK Cache-Control: no-cache Pragma: no-cache Content-Length: 239 Content-Type: application/json; charset=utf-8 Expires: 0 Server: Microsoft-IIS/8.0 X-Powered-By: ASP.NET Date: Mon, 14 Apr 2014 15:55:12 GMT [ { "id": "534c0469f76e1e10c4703c2b", "client": "John Doe", "orderDate": "2014-04-13T00:00:00Z" }, { "id": "534c0471f76e1e10c4703c2c", "client": "Jane Roe", "orderDate": "2014-02-22T00:00:00Z" } ]
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

先に要素を追加しましたが、オブジェクトの複雑なプロパティ （アイテムリスト）は取得しませんでした。



問題は、関数の戻り値の型（ IQueryable Order ）が複雑な型を返すのは、要求で明示的に指定されている場合のみです（ $ expand = < propertyName>パラメーターを使用）。



queryable型のオブジェクトを返すメソッドがあると便利です。これにより、さらに、フィルターと並べ替え（パラメーター$ filterと$ orderbyを使用）を使用できるようになります。



そのため、クエリ可能オブジェクトの使用を継続し、$ expandパラメータを送信して複合型を返すか、別の返された型に移動するかを決定する必要があります。



後者の場合、変更は非常に簡単です。

 public List<Order> GetAllOrders() { return base.Query().ToList(); }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

クエリを生成するためのオプションがいくつかあります。 （サーバー上で）最も簡単なのは、ヘッダーで$ expandパラメーターをクライアントに送信させることです。その後、サーバーで何も変更する必要はありません。



リクエストを送信し、ドキュメント全体を取得します。

 GET http://localhost:54524/tables/order?$expand=items HTTP/1.1 User-Agent: Fiddler Host: localhost:54524 =-=-=-=-=-=-=-=-=- HTTP/1.1 200 OK Cache-Control: no-cache Pragma: no-cache Content-Length: 663 Content-Type: application/json; charset=utf-8 Expires: 0 Server: Microsoft-IIS/8.0 X-Powered-By: ASP.NET Date: Mon, 14 Apr 2014 17:52:26 GMT [ { "id": "534c0469f76e1e10c4703c2b", "client": "John Doe", "orderDate": "2014-04-13T00:00:00Z", "items": [ { "name": "bread", "quantity": 1.0, "price": 1.99 }, { "name": "milk", "quantity": 2.0, "price": 2.99 } ] }, { "id": "534c0471f76e1e10c4703c2c", "client": "Jane Roe", "orderDate": "2014-02-22T00:00:00Z", "items": [ { "name": "nails", "quantity": 100.0, "price": 3.5 }, { "name": "hammer", "quantity": 1.0, "price": 12.34 } ] } ]
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

別のオプションは、 アクション フィルター属性を使用することです。これにより、着信リクエストが変更され、$ expandパラメーターが常にリクエストに追加されます。



以下は可能な実装の1つです。

 [AttributeUsage(AttributeTargets.Method, AllowMultiple = true)] class ExpandPropertyAttribute : ActionFilterAttribute { string propertyName; public ExpandPropertyAttribute(string propertyName) { this.propertyName = propertyName; } public override void OnActionExecuting(HttpActionContext actionContext) { base.OnActionExecuting(actionContext); var uriBuilder = new UriBuilder(actionContext.Request.RequestUri); var queryParams = uriBuilder.Query.TrimStart('?').Split(new[] { '&' }, StringSplitOptions.RemoveEmptyEntries).ToList(); int expandIndex = -1; for (var i = 0; i < queryParams.Count; i++) { if (queryParams[i].StartsWith("$expand", StringComparison.Ordinal)) { expandIndex = i; break; } } if (expandIndex < 0) { queryParams.Add("$expand=" + this.propertyName); } else { queryParams[expandIndex] = queryParams[expandIndex] + "," + propertyName; } uriBuilder.Query = string.Join("&", queryParams); actionContext.Request.RequestUri = uriBuilder.Uri; } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

そして、この属性でメソッドをマークした後：

 [ExpandProperty("Items")] public IQueryable<Order> GetAllOrders() { return base.Query(); }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

他のクエリ可能な属性を使用するクエリを送信できますが、同時にオブジェクトのすべての要素を返します。

 GET http://localhost:54524/tables/order?$orderby=client HTTP/1.1 User-Agent: Fiddler Host: localhost:54524 =-=-=-=-=-=-=-=-=- HTTP/1.1 200 OK Cache-Control: no-cache Pragma: no-cache Content-Length: 663 Content-Type: application/json; charset=utf-8 Expires: 0 Server: Microsoft-IIS/8.0 X-Powered-By: ASP.NET Date: Mon, 14 Apr 2014 18:37:27 GMT [ { "id": "534c0471f76e1e10c4703c2c", "client": "Jane Roe", "orderDate": "2014-02-22T00:00:00Z", "items": [ { "name": "nails", "quantity": 100.0, "price": 3.5 }, { "name": "hammer", "quantity": 1.0, "price": 12.34 } ] }, { "id": "534c0469f76e1e10c4703c2b", "client": "John Doe", "orderDate": "2014-04-13T00:00:00Z", "items": [ { "name": "bread", "quantity": 1.0, "price": 1.99 }, { "name": "milk", "quantity": 2.0, "price": 2.99 } ] } ]
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

展開

サービスがローカルで開始されたので、 Azureですべてを公開する準備ができました。



ポータルから公開プロファイルをダウンロードした後、VSでプロジェクトを右クリックして[ 公開]を選択します-サービスが公開されます。



また、Fiddlerを再度使用する場合、Azureから2つの「順序」要素を直接取得する必要があります。

 GET http://blog20140413.azure-mobile.net/tables/order HTTP/1.1 User-Agent: Fiddler Host: blog20140413.azure-mobile.net =-=-=-=-=-=-=-=-=- HTTP/1.1 500 Internal Server Error Cache-Control: no-cache Pragma: no-cache Content-Length: 43 Content-Type: application/json; charset=utf-8 Expires: 0 Server: Microsoft-IIS/8.0 X-Powered-By: ASP.NET Date: Mon, 14 Apr 2014 18:50:22 GMT { "message": "An error has occurred." }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

何かがおかしかった。 デフォルトでは、ランタイムは（セキュリティ上の理由から）エラーの詳細を返しません。そのため、ポータルのログファイルをチェックして、何が起こったのかを確認できます。 エラーは次のとおりです。

 Exception=System.ArgumentException: No connection string named 'mongodb' could be found in the service configuration. at Microsoft.WindowsAzure.Mobile.Service.MongoDomainManager`1.GetMongoContext(String connectionStringName) at System.Collections.Concurrent.ConcurrentDictionary`2.GetOrAdd(TKey key, Func`2 valueFactory) at Microsoft.WindowsAzure.Mobile.Service.MongoDomainManager`1..ctor(String connectionStringName, String databaseName, String collectionName, HttpRequestMessage request, ApiServices services) at MongoDbOnNetBackend.OrderController.Initialize(HttpControllerContext controllerContext) at System.Web.Http.ApiController.ExecuteAsync(HttpControllerContext controllerContext, CancellationToken cancellationToken) at System.Web.Http.Dispatcher.HttpControllerDispatcher.SendAsyncCore(HttpRequestMessage request, CancellationToken cancellationToken) at System.Web.Http.Dispatcher.HttpControllerDispatcher.d__0.MoveNext(), Id=6133b3eb-9851-4
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

問題は、サービスを開始するときにローカルで使用されるローカルweb.configファイルが、クラウドでサービスを開始するときに適切でないことです。 別の方法で接続文字列を定義する必要があります。



残念ながら、このエラーのため、接続文字列を決定する簡単な方法がありません（ポータルによって簡単になりますが、これまでのところこの機能はありません）。そのため、 回避策を使用します。



これを行うには、モバイルサービスセクションのポータルに移動し、[ 構成 ]タブに新しいアプリ設定を追加します。この値は、web.configファイルで定義した接続文字列です。







テーブルコントローラーを初期化した後、アプリケーション設定から受け取った値に基づいて、サービス設定の接続文字列を変更します。

 static bool connectionStringInitialized = false; private void InitializeConnectionString(string connStringName, string appSettingName) { if (!connectionStringInitialized) { connectionStringInitialized = true; if (!this.Services.Settings.Connections.ContainsKey(connStringName)) { var connFromAppSetting = this.Services.Settings[appSettingName]; var connSetting = new ConnectionSettings(connStringName, connFromAppSetting); this.Services.Settings.Connections.Add(connStringName, connSetting); } } } protected override void Initialize(HttpControllerContext controllerContext) { var connStringName = "mongodb"; var dbName = "MyMongoLab"; var collectionName = "orders"; // Workaround for lack of connection strings in the portal InitializeConnectionString(connStringName, "mongoConnectionString"); base.Initialize(controllerContext); this.DomainManager = new MongoDomainManager<Order>(connStringName, dbName, collectionName, this.Request, this.Services); }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

これで、サービスを再度デプロイすると、Azureからテーブルデータを取得できるはずです。

 GET http://blog20140413.azure-mobile.net/tables/order HTTP/1.1 User-Agent: Fiddler Host: blog20140413.azure-mobile.net x-zumo-application: cOFQkbaAmffuVRBJRpYDKHbNHbtDYG97 =-=-=-=-=-=-=-=-=- HTTP/1.1 200 OK Cache-Control: no-cache Pragma: no-cache Content-Length: 663 Content-Type: application/json; charset=utf-8 Expires: 0 Server: Microsoft-IIS/8.0 X-Powered-By: ASP.NET Date: Mon, 14 Apr 2014 19:21:11 GMT [ { "id": "534c0469f76e1e10c4703c2b", "client": "John Doe", "orderDate": "2014-04-13T00:00:00Z", "items": [ { "name": "bread", "quantity": 1.0, "price": 1.99 }, { "name": "milk", "quantity": 2.0, "price": 2.99 } ] }, { "id": "534c0471f76e1e10c4703c2c", "client": "Jane Roe", "orderDate": "2014-02-22T00:00:00Z", "items": [ { "name": "nails", "quantity": 100.0, "price": 3.5 }, { "name": "hammer", "quantity": 1.0, "price": 12.34 } ] } ]
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

最後に、サービスがローカルで起動されると、デフォルトでは認証が実行されないため、リクエストがキーを送信しない場合があります。 Azureのサーバーにリクエストを送信する場合、「x-zumo-application」ヘッダーでアプリケーションキー （デフォルトの認証レベル）を指定する必要があります。

おわりに

。 モバイルサービス用の Azure NETバックエンドは、テーブルデータを抽象化するストレージプロバイダーのセットを提供します。



既存の例のほとんどはEntity Framework（SQLサーバー）での作業について説明しているため、この投稿でMongoDBプロバイダーを使用してデータを保存する方法を学べることを願っています。



そして、いつものように、ブログ、MSDNフォーラム、またはtwitter @AzureMobileでコメントやアドバイスを歓迎します。

便利なリンク

Microsoft Azureの30日間無料試用。

スタートアップ 、 パートナー 、教師、 MSDNサブスクライバー向けのMicrosoft Azureリソースへの無料アクセス

Microsoft Azure Development Center（azurehub.ru）-Microsoft Azureでのサービスと開発の選択に関するスクリプト、ガイド、例、推奨事項。

最新のMicrosoft Azureニュース-Twitter.com/windowsazure

FacebookのMicrosoft Azureコミュニティ 。 ここでは、専門家、写真、多くのニュースをご覧いただけます。

Microsoft Virtual Academy（MVA）トレーニングコース

無料または試用版のVisual Studio 2013をダウンロードする