N 層アプリケーションでのデータ取得および CUD 操作 (LINQ to SQL)

[アーティクル]
04/27/2011

Customers または Orders のようなエンティティオブジェクトをネットワークを介してクライアントにシリアル化すると、これらのエンティティはデータコンテキストからデタッチされます。変更内容、および他のオブジェクトとの関連付けはデータコンテキストによって追跡されなくなります。クライアントがデータを読み取るだけの場合は、これは問題にはなりません。また、クライアントが新しい行をデータベースに追加できるようにすることも、ある程度簡単です。しかし、アプリケーションでクライアントによるデータの更新または削除を可能にする必要がある場合には、DataContext.SubmitChanges を呼び出す前に、新しいデータコンテキストにエンティティをアタッチする必要があります。さらに、元の値によるオプティミスティック同時実行制御チェックを使用する場合には、何らかの方法で、元のエンティティと変更後のエンティティをデータベースに渡す必要もあります。エンティティがデタッチされた後に新しいデータコンテキストにエンティティを入れるために、Attach メソッドが用意されています。

LINQ to SQL エンティティの代わりにプロキシオブジェクトをシリアル化する場合でも、データベースにデータを送るには、データアクセス層 (DAL) 上にエンティティを構築して新しい System.Data.Linq.DataContext にそれをアタッチする必要があります。

LINQ to SQL は、エンティティがどのようにシリアル化されるかについてはまったく関与しません。 Windows Communication Foundation (WCF) を使ってシリアル化できるクラスを生成するためにオブジェクトリレーショナルデザイナーおよび SQLMetal ツールを使用する方法について、詳しくは「方法 : エンティティをシリアル化可能にする (LINQ to SQL)」を参照してください。

メモ
Attach メソッドは、新しいエンティティまたは逆シリアル化されたエンティティに対してのみ呼び出してください。エンティティを元のデータコンテキストからデタッチする唯一の方法は、シリアル化です。デタッチされていないエンティティを新しいデータコンテキストにアタッチしようとした場合、元のデータコンテキストの遅延ローダーがそのエンティティにまだ存在するならば、LINQ to SQL は例外をスローします。2 つの異なるデータコンテキストの遅延ローダーを持つエンティティに対して、挿入、更新、および削除操作を実行すると、予想外の結果が生じる可能性があります。遅延ローダーの詳細については、「遅延読み込みと即時読み込み (LINQ to SQL)」を参照してください。

Attach メソッドは、新しいエンティティまたは逆シリアル化されたエンティティに対してのみ呼び出してください。エンティティを元のデータコンテキストからデタッチする唯一の方法は、シリアル化です。デタッチされていないエンティティを新しいデータコンテキストにアタッチしようとした場合、元のデータコンテキストの遅延ローダーがそのエンティティにまだ存在するならば、LINQ to SQL は例外をスローします。2 つの異なるデータコンテキストの遅延ローダーを持つエンティティに対して、挿入、更新、および削除操作を実行すると、予想外の結果が生じる可能性があります。遅延ローダーの詳細については、「遅延読み込みと即時読み込み (LINQ to SQL)」を参照してください。

データの取得

クライアントのメソッド呼び出し

Windows フォームクライアントから DAL に対するメソッド呼び出しの例を以下に示します。この例では、DAL は Windows サービスライブラリとして実装されています。

Private Function GetProdsByCat_Click(ByVal sender As Object, ByVal e _
    As EventArgs)

    ' Create the WCF client proxy.
    Dim proxy As New NorthwindServiceReference.Service1Client

    ' Call the method on the service.
    Dim products As NorthwindServiceReference.Product() = _
        proxy.GetProductsByCategory(1)

    ' If the database uses original values for concurrency checks,
    ' the client needs to store them and pass them back to the
    ' middle tier along with the new values when updating data.

    For Each v As NorthwindClient1.NorthwindServiceReference.Product _
        In products
        ' Persist to a List(Of Product) declared at class scope.
        ' Additional change-tracking logic is the responsibility
        ' of the presentation tier and/or middle tier.
        originalProducts.Add(v)
    Next

    ' (Not shown) Bind the products list to a control
    ' and/or perform whatever processing is necessary.
End Function

private void GetProdsByCat_Click(object sender, EventArgs e)
{
    // Create the WCF client proxy.
    NorthwindServiceReference.Service1Client proxy = 
    new NorthwindClient.NorthwindServiceReference.Service1Client();

    // Call the method on the service.
    NorthwindServiceReference.Product[] products = 
    proxy.GetProductsByCategory(1);

    // If the database uses original values for concurrency checks, 
    // the client needs to store them and pass them back to the 
    // middle tier along with the new values when updating data.
    foreach (var v in products)
    {
        // Persist to a list<Product> declared at class scope.
        // Additional change-tracking logic is the responsibility
        // of the presentation tier and/or middle tier.
        originalProducts.Add(v);
    }

    // (Not shown) Bind the products list to a control
    // and/or perform whatever processing is necessary.
    }

中間層での実装

次の例は、中間層でのインターフェイスメソッドの実装を示しています。ここでは、次の 2 つの点が重要です。

DataContext はメソッドのスコープで宣言されます。
メソッドは、実際の結果から成る IEnumerable コレクションを返します。シリアライザーは、結果をクライアント/プレゼンテーション層に戻すためのクエリを実行します。中間層でクエリ結果にローカルにアクセスするには、クエリ変数に対して ToList または ToArray を呼び出すことで、実行を強制できます。その後、そのリストまたは配列を IEnumerable として返すことができます。

Public Function GetProductsByCategory(ByVal categoryID As Integer) _
    As IEnumerable(Of Product)

    Dim db As New NorthwindClasses1DataContext(connectionString)
    Dim productQuery = _
    From prod In db.Products _
    Where prod.CategoryID = categoryID _
    Select prod

    Return productQuery.AsEnumerable()

End Function

public IEnumerable<Product> GetProductsByCategory(int categoryID)
{
    NorthwindClasses1DataContext db = 
    new NorthwindClasses1DataContext(connectionString);

    IEnumerable<Product> productQuery =
    from prod in db.Products
    where prod.CategoryID == categoryID
    select prod;

    return productQuery.AsEnumerable(); 
}

データコンテキストの 1 つのインスタンスの有効期間は、1 つの「作業単位」である必要があります。疎結合環境では、通常、作業単位は小さく、たとえば SubmitChanges の 1 つの呼び出しを含む単一のオプティミスティックトランザクションです。このため、データコンテキストはメソッドのスコープ内で作成されて破棄されます。作業単位にビジネスルールロジックの呼び出しが含まれる場合、通常は、その操作全体のために DataContext インスタンスを保持する必要が生じます。いずれにしても、DataContext インスタンスの有効期間は、多数のトランザクションにわたって長い時間になることが意図されていません。

このメソッドは Product オブジェクトを返しますが、各 Product に関連付けられた Order_Detail オブジェクトのコレクションを返しません。この既定の動作を変更するには、DataLoadOptions オブジェクトを使用します。詳細については、「方法 : 取得する関連データの量を制御する (LINQ to SQL)」を参照してください。

データの挿入

新しいオブジェクトを挿入するために、プレゼンテーション層は単に中間層インターフェイス上の関連するメソッドを呼び出して、挿入対象の新しいオブジェクトを渡します。ただし、クライアントがいくつかの値だけを渡して、オブジェクト全体の構築を中間層に任せた方が効率的である場合もあります。

中間層での実装

中間層で、新しい DataContext が作成され、InsertOnSubmit メソッドを使ってオブジェクトが DataContext にアタッチされて、SubmitChanges の呼び出し時にオブジェクトが挿入されます。他の Web サービスのシナリオとまったく同じ方法で、例外、コールバック、エラー状態を処理できます。

' No call to Attach is necessary for inserts.
Public Sub InsertOrder(ByVal o As Order)

    Dim db As New NorthwindClasses1DataContext(connectionString)
    db.Orders.InsertOnSubmit(o)

    ' Exception handling not shown.
    db.SubmitChanges()

End Sub

// No call to Attach is necessary for inserts.
    public void InsertOrder(Order o)
    {
        NorthwindClasses1DataContext db = new NorthwindClasses1DataContext(connectionString);
        db.Orders.InsertOnSubmit(o);

        // Exception handling not shown.
        db.SubmitChanges();
    }

データの削除

既存のオブジェクトをデータベースから削除するために、プレゼンテーション層は中間層インターフェイス上の関連するメソッドを呼び出して、削除対象のオブジェクトの元の値を含むコピーを渡します。

削除操作ではオプティミスティック同時実行制御チェックが行われて、削除対象のオブジェクトを新しいデータコンテキストに最初にアタッチする必要があります。この例では、オブジェクトにタイムスタンプ (RowVersion) が含まれないことを示すために Boolean パラメーターが false に設定されます。各レコードのタイムスタンプがデータベーステーブルで生成される場合には、同時実行チェックは特にクライアントにとって非常に簡単です。元のオブジェクトまたは変更後のオブジェクトを渡して、Boolean パラメーターを true に設定するだけです。いずれの場合も、中間層では、通常、ChangeConflictException をキャッチする必要があります。オプティミスティック同時実行の競合を処理する方法について、詳しくは「オプティミスティック同時実行の概要 (LINQ to SQL)」を参照してください。

関連するテーブルに対する外部キー制約を含むエンティティを削除する際には、EntitySet<TEntity> コレクション内のすべてのオブジェクトを最初に削除する必要があります。

' Attach is necessary for deletes.
Public Sub DeleteOrder(ByVal order As Order)
    Dim db As New NorthwindClasses1DataContext(connectionString)

    db.Orders.Attach(order, False)
    ' This will throw an exception if the order has order details.
    db.Orders.DeleteOnSubmit(order)

    Try
        ' ConflictMode is an optional parameter.
        db.SubmitChanges(ConflictMode.ContinueOnConflict)

    Catch ex As ChangeConflictException
        ' Get conflict information, and take actions
        ' that are appropriate for your application.
        ' See MSDN Article "How to: Manage Change
        ' Conflicts (LINQ to SQL).

    End Try
End Sub

// Attach is necessary for deletes.
public void DeleteOrder(Order order)
{
    NorthwindClasses1DataContext db = new NorthwindClasses1DataContext(connectionString);

    db.Orders.Attach(order, false);
    // This will throw an exception if the order has order details.
    db.Orders.DeleteOnSubmit(order);
    try
    {
        // ConflictMode is an optional parameter.
        db.SubmitChanges(ConflictMode.ContinueOnConflict);
    }
    catch (ChangeConflictException e)
    {
       // Get conflict information, and take actions
       // that are appropriate for your application.
       // See MSDN Article How to: Manage Change Conflicts (LINQ to SQL).
    }
}

データの更新

LINQ to SQL は、オプティミスティック同時実行制御を行う次のようなシナリオでの更新をサポートします。

タイムスタンプつまり RowVersion 番号に基づくオプティミスティック同時実行制御。
エンティティプロパティのサブセットの元の値に基づくオプティミスティック同時実行制御。
元のエンティティ全体および変更後のエンティティ全体に基づくオプティミスティック同時実行制御。

また、エンティティとそのリレーションシップの両方に対して更新または削除を実行することもできます (たとえば Customer と、それに関連した Order オブジェクトのコレクション)。エンティティオブジェクトとその子 (EntitySet) コレクションから成るグラフをクライアント上で変更して、オプティミスティック同時実行制御チェックで元の値が必要とされる場合には、クライアントはそれぞれのエンティティと EntitySet<TEntity> オブジェクトの元の値を提供する必要があります。 1 つのメソッド呼び出しで互いに関連する更新、削除、挿入のセットをクライアントが実行できるようにするには、各エンティティにどんな操作を実行するかを示す方法をクライアントに提供する必要があります。その後、中間層で適切な Attach メソッドを呼び出した後、SubmitChanges を呼び出す前に、各エンティティに対して InsertOnSubmit, DeleteAllOnSubmit または InsertOnSubmit() (挿入の場合は Attach 無し) を呼び出す必要があります。更新を試行する前に元の値を入手するためにデータベースからデータを取得しないでください。

オプティミスティック同時実行制御の詳細については、「オプティミスティック同時実行の概要 (LINQ to SQL)」を参照してください。オプティミスティック同時実行の変更の競合を解決する方法について、詳しくは「方法 : 変更の競合を管理する (LINQ to SQL)」を参照してください。

それぞれのシナリオの例を以下に示します。

タイムスタンプを使用したオプティミスティック同時実行

' Assume that "customer" has been sent by client.
' Attach with "true" to say this is a modified entity
' and it can be checked for optimistic concurrency
' because it has a column that is marked with the
' "RowVersion" attribute.

db.Customers.Attach(customer, True)

Try
    ' Optional: Specify a ConflictMode value
    ' in call to SubmitChanges.
    db.SubmitChanges()
Catch ex As ChangeConflictException
    ' Handle conflict based on options provided.
    ' See MSDN article "How to: Manage Change
    ' Conflicts (LINQ to SQL)".
End Try

// Assume that "customer" has been sent by client.
// Attach with "true" to say this is a modified entity
// and it can be checked for optimistic concurrency because
//  it has a column that is marked with "RowVersion" attribute
db.Customers.Attach(customer, true)
try
{
    // Optional: Specify a ConflictMode value
    // in call to SubmitChanges.
    db.SubmitChanges();
}
catch(ChangeConflictException e)
{
    // Handle conflict based on options provided
    // See MSDN article How to: Manage Change Conflicts (LINQ to SQL).
}

元の値のサブセットを使用した場合

この手法では、クライアントは変更対象の値と共に、シリアル化されたオブジェクト全体を返します。

Public Sub UpdateProductInventory(ByVal p As Product, ByVal _
    unitsInStock As Short?, ByVal unitsOnOrder As Short?)

    Using db As New NorthwindClasses1DataContext(connectionString)
        ' p is the original unmodified product
        ' that was obtained from the database.
        ' The client kept a copy and returns it now.
        db.Products.Attach(p, False)

        ' Now that the original values are in the data context,
        ' apply the changes.
        p.UnitsInStock = unitsInStock
        p.UnitsOnOrder = unitsOnOrder

        Try
            ' Optional: Specify a ConflictMode value
            ' in call to SubmitChanges.
            db.SubmitChanges()

        Catch ex As Exception
            ' Handle conflict based on options provided.
            ' See MSDN article "How to: Manage Change Conflicts
            ' (LINQ to SQL)".
        End Try
    End Using
End Sub

public void UpdateProductInventory(Product p, short? unitsInStock, short? unitsOnOrder)
{
    using (NorthwindClasses1DataContext db = new NorthwindClasses1DataContext(connectionString))
    {
        // p is the original unmodified product
        // that was obtained from the database.
        // The client kept a copy and returns it now.
        db.Products.Attach(p, false);

        // Now that the original values are in the data context, apply the changes.
        p.UnitsInStock = unitsInStock;
        p.UnitsOnOrder = unitsOnOrder;
        try
        {
             // Optional: Specify a ConflictMode value
             // in call to SubmitChanges.
             db.SubmitChanges();
        }
        catch (ChangeConflictException e)
        {
            // Handle conflict based on provided options.
            // See MSDN article How to: Manage Change Conflicts
            // (LINQ to SQL).
        }
    }
}

エンティティ全体を使用する場合

Public Sub UpdateProductInfo(ByVal newProd As Product, ByVal _
    originalProd As Product)

    Using db As New NorthwindClasses1DataContext(connectionString)
        db.Products.Attach(newProd, originalProd)

        Try
            ' Optional: Specify a ConflictMode value
            ' in call to SubmitChanges.
            db.SubmitChanges()

        Catch ex As Exception
            ' Handle potential change conflicgt in whatever way
            ' is appropriate for your application.
            ' For more information, see the MSDN article
            ' "How to: Manage Change Conflicts (LINQ to
            ' SQL)".
        End Try

    End Using
End Sub

public void UpdateProductInfo(Product newProd, Product originalProd)
{
     using (NorthwindClasses1DataContext db = new
        NorthwindClasses1DataContext(connectionString))
     {
         db.Products.Attach(newProd, originalProd);
         try
         {
               // Optional: Specify a ConflictMode value
               // in call to SubmitChanges.
               db.SubmitChanges();
         }
        catch (ChangeConflictException e)
        {
            // Handle potential change conflict in whatever way
            // is appropriate for your application.
            // For more information, see the MSDN article
            // How to: Manage Change Conflicts (LINQ to SQL)/
        } 
    }
}

コレクションを更新するには、Attach ではなく AttachAll を呼び出します。

必要なエンティティメンバー

既に説明したように、Attach メソッドを呼び出す前に設定する必要があるのは、エンティティオブジェクトのいくつかのメンバーだけです。設定する必要のあるエンティティメンバーは、次の条件を満たす必要があります。

エンティティの ID の一部分である。
変更される予定である。
タイムスタンプであるか、UpdateCheck 属性が Never 以外の値に設定されている。

テーブルでオプティミスティック同時実行チェック用にタイムスタンプまたはバージョン番号を使用している場合は、Attach を呼び出す前にこれらのメンバーを設定する必要があります。 Column 属性の IsVersion プロパティが true に設定されている場合、メンバーはオプティミスティック同時実行チェック専用です。要求された更新は、データベース上のバージョン番号またはタイムスタンプ値が同じ場合にのみ、送信されます。

また、UpdateCheck が Never に設定されていないメンバーもまた、オプティミスティック同時実行チェックに使用されます。他の値が指定されない場合、既定値は Always です。

これらの必要なメンバーのいずれかが欠落している場合、SubmitChanges 中に ChangeConflictException ("行が見つからないか変更されています") がスローされます。

状態

エンティティオブジェクトが DataContext インスタンスにアタッチされた後、そのオブジェクトは PossiblyModified 状態にあると見なされます。アタッチされたオブジェクトを強制的に Modified 状態にする方法は、3 つあります。

未変更としてアタッチした後、フィールドを直接変更する。
現在のオブジェクトインスタンスと元のオブジェクトインスタンスを受け入れる Attach オーバーロードを使ってアタッチする。こうすると、古い値と新しい値が変更トラッカーに提供されるため、変更されたフィールドが自動的に判別されます。
(true に設定された) 2 番目のブール値パラメーターを受け入れる Attach オーバーロードを使ってアタッチする。こうすると、元の値を提供しなくても、変更トラッカーはオブジェクトが変更済みと見なします。この手法では、オブジェクトにバージョン/タイムスタンプフィールドが含まれる必要があります。

詳細については、「オブジェクトの状態と変更の追跡 (LINQ to SQL)」を参照してください。

アタッチ対象のオブジェクトと同じ ID を持つエンティティオブジェクトが ID キャッシュ内に既に存在する場合、DuplicateKeyException がスローされます。

オブジェクトの IEnumerable セットを使ってアタッチするとき、既存のキーが含まれる場合には、DuplicateKeyException がスローされます。残りのオブジェクトはアタッチされません。

参照

概念

LINQ to SQL を使用する n 層アプリケーションとリモートアプリケーション

その他の技術情報

背景情報 (LINQ to SQL)

次の方法で共有

N 層アプリケーションでのデータ取得および CUD 操作 (LINQ to SQL)

データの取得

クライアントのメソッド呼び出し

中間層での実装

データの挿入

中間層での実装

データの削除

データの更新

タイムスタンプを使用したオプティミスティック同時実行

元の値のサブセットを使用した場合

エンティティ全体を使用する場合

必要なエンティティメンバー

状態

参照

概念

その他の技術情報

その他のリソース

次の方法で共有

N 層アプリケーションでのデータ取得および CUD 操作 (LINQ to SQL)

データの取得

クライアントのメソッド呼び出し

中間層での実装

データの挿入

中間層での実装

データの削除

データの更新

タイムスタンプを使用したオプティミスティック同時実行

元の値のサブセットを使用した場合

エンティティ全体を使用する場合

必要なエンティティ メンバー

状態

参照

概念

その他の技術情報

その他のリソース

必要なエンティティメンバー