遅延コンテンツの読み込み (WCF Data Services)

[アーティクル]
02/24/2011

WCF Data Services の既定では、クエリが返すデータの量が制限されます。その一方で、関連エンティティ、ページングされた応答データ、およびバイナリデータストリームを含む追加データをデータサービスから必要に応じて明示的に読み込むことが可能です。このトピックでは、このような遅延コンテンツをアプリケーションに読み込む方法について説明します。

ページングされたコンテンツ

データサービスでページングが有効化されている場合、データサービスが返すフィード内のエントリの数はデータサービスの構成によって制限されます。ページ制限は、各エンティティセットに対して個別に設定できます。詳細については、「データサービスの構成 (WCF Data Services)」を参照してください。ページングが有効である場合、フィードの最終的なエントリには、データの次のページへのリンクが含まれます。このリンクは、DataServiceQueryContinuation オブジェクトに含まれます。データの次のページへの URI は、DataServiceQuery が実行されたときに返される QueryOperationResponse で GetContinuation メソッドを呼び出すことによって取得します。返された DataServiceQueryContinuation オブジェクトが使用されて、結果の次のページが読み込まれます。クエリ結果は、GetContinuation メソッドを呼び出す前に列挙する必要があります。最初に do…while ループを使用してクエリ結果を列挙した後に、次の non-null リンク値をチェックすることをお勧めします。 GetContinuation メソッドが null (Visual Basic の場合は Nothing) を返す場合、元のクエリに追加の結果ページはありません。次の例は、Northwind サンプルデータサービスからページングされた顧客データを読み込む docwhile ループを示します。

' With a paged response from the service, use a do...while loop 
' to enumerate the results before getting the next link.
Do
    ' Write the page number.
    Console.WriteLine("Page {0}:", pageCount + 1)

    ' If nextLink is not null, then there is a new page to load.
    If token IsNot Nothing Then
        ' Load the new page from the next link URI.
        response = CType(context.Execute(Of Customer)(token),  _
        QueryOperationResponse(Of Customer))
    End If

    ' Enumerate the customers in the response.
    For Each customer As Customer In response
        Console.WriteLine("\tCustomer Name: {0}", customer.CompanyName)
    Next

    ' Get the next link, and continue while there is a next link.
    token = response.GetContinuation()
Loop While token IsNot Nothing

// With a paged response from the service, use a do...while loop 
// to enumerate the results before getting the next link.
do
{
    // Write the page number.
    Console.WriteLine("Page {0}:", pageCount++);

    // If nextLink is not null, then there is a new page to load.
    if (token != null)
    {
        // Load the new page from the next link URI.
        response = context.Execute<Customer>(token)
            as QueryOperationResponse<Customer>;
    }

    // Enumerate the customers in the response.
    foreach (Customer customer in response)
    {
        Console.WriteLine("\tCustomer Name: {0}", customer.CompanyName);
    }
}

// Get the next link, and continue while there is a next link.
while ((token = response.GetContinuation()) != null);

要求されたエンティティセットと一緒に関連エンティティを 1 つの応答で返すようクエリが要求すると、ページング制限は、応答と共にインラインで含まれるネストされたフィードに影響することがあります。たとえば、Northwind サンプルデータサービスで Customers エンティティセットに対してページング制限が設定されている場合、次の Northwind サンプルデータサービスを定義する Northwind.svc.cs ファイルの例に示すように、独立したページング制限を関連 Orders エンティティセットに設定することもできます。

' Set page size defaults for the data service.
config.SetEntitySetPageSize("Orders", 20)
config.SetEntitySetPageSize("Order_Details", 50)
config.SetEntitySetPageSize("Products", 50)

' Paging requires v2 of the OData protocol.
config.DataServiceBehavior.MaxProtocolVersion = _
    System.Data.Services.Common.DataServiceProtocolVersion.V2

// Set page size defaults for the data service.
config.SetEntitySetPageSize("Orders", 20);
config.SetEntitySetPageSize("Order_Details", 50);
config.SetEntitySetPageSize("Products", 50);

// Paging requires v2 of the OData protocol.
config.DataServiceBehavior.MaxProtocolVersion =
    System.Data.Services.Common.DataServiceProtocolVersion.V2;

この場合、最上位レベルの Customers エンティティフィードとネストされた Orders エンティティフィードの両方にページングを実装する必要があります。次の例は、選択した Customers エンティティに関連する Orders エンティティのページを読み込むために使用する while ループを示します。

While nextOrdersLink IsNot Nothing
    For Each o As Order In c.Orders
        ' Print out the orders.
        Console.WriteLine("\t\tOrderID: {0} - Freight: ${1}", _
                o.OrderID, o.Freight)
    Next
    ' Load the next page of Orders.
    Dim ordersResponse = _
    context.LoadProperty(c, "Orders", nextOrdersLink)
    nextOrdersLink = ordersResponse.GetContinuation()
End While

while (nextOrdersLink != null)
{
    foreach (Order o in c.Orders)
    {
        // Print out the orders.
        Console.WriteLine("\t\tOrderID: {0} - Freight: ${1}",
            o.OrderID, o.Freight);
    }

    // Load the next page of Orders.
    var ordersResponse = context.LoadProperty(c, "Orders", nextOrdersLink);
    nextOrdersLink = ordersResponse.GetContinuation();
}

詳細については、「方法: ページングされた結果を読み込む (WCF Data Services)」を参照してください。

バイナリデータストリーム

WCF Data Services では、バイナリラージオブジェクト (BLOB) データにデータストリームとしてアクセスできます。ストリーミングは必要になるまでバイナリデータの読み込みを待機し、クライアントは、このデータを効率的に処理できます。この機能を活用するには、データサービスは IDataServiceStreamProvider プロバイダーを実装する必要があります。詳細については、「ストリーミングプロバイダー (WCF Data Services)」を参照してください。ストリーミングが有効である場合、エンティティ型は関連バイナリデータなしで返されます。この場合、サービスのバイナリデータのデータストリームにアクセスするには、DataServiceContext クラスの GetReadStream メソッドを使用する必要があります。同様に、SetSaveStream メソッドを使用して、エンティティのバイナリデータをストリームとして追加または変更します。詳細については、「バイナリデータの操作 (WCF Data Services)」を参照してください。

遅延コンテンツの読み込み (WCF Data Services)

関連エンティティ

ページングされたコンテンツ

バイナリデータストリーム

参照

概念

その他のリソース

その他のリソース

遅延コンテンツの読み込み (WCF Data Services)

関連エンティティ

ページングされたコンテンツ

バイナリ データ ストリーム

参照

概念

その他のリソース

その他のリソース

バイナリデータストリーム