C#と諸々レイジーロード

[ .NET ] DDD

2010/06/06 23:55

.NET Framework 4.0 から、遅延初期化を行うためのクラスが新しく追加されました。

Lazy(T) クラス (System)

遅延初期化と聞いてすぐに連想されるのはレイジーロードパターンです。
以前、仮想プロキシによるレイジーロードについての記事を書きました。
今回、VirtualList<T> クラスの実装を、Lazy<T> クラスを使用するように変更してみます。

VirtualList<T> クラス
using System;
using System.Collections;
using System.Collections.Generic;

/// <summary>
/// リストの仮想プロキシです。
/// </summary>
/// <typeparam name="T"></typeparam>
[Serializable]
public sealed class VirtualList<T> : IList<T>
{
    #region Constructors

    /// <summary>
    /// VirtualList<T> クラスの新しいインスタンスを初期化します。
    /// </summary>
    /// <param name="loader">ローダー。</param>
    /// <param name="isThreadSafeWhenLoading">
    /// このインスタンスの遅延初期化処理をスレッドセーフにする場合は true。
    /// このインスタンスの遅延初期化処理をスレッドセーフにしない場合は false。
    /// </param>
    /// <exception cref="System.ArgumentNullException">引数 loader が null です。</exception>
    public VirtualList(IListLoader<T> loader, bool isThreadSafeWhenLoading = true)
        : this(loader.Load, isThreadSafeWhenLoading)
    {
    }

    /// <summary>
    /// VirtualList<T> クラスの新しいインスタンスを初期化します。
    /// </summary>
    /// <param name="loader">ローダー。</param>
    /// <param name="isThreadSafeWhenLoading">
    /// このインスタンスの遅延初期化処理をスレッドセーフにする場合は true。
    /// このインスタンスの遅延初期化処理をスレッドセーフにしない場合は false。
    /// </param>
    /// <exception cref="System.ArgumentNullException">引数 loader が null です。</exception>
    public VirtualList(Func<IList<T>> loader, bool isThreadSafeWhenLoading = true)
    {
        if (loader == null)
        {
            throw new ArgumentNullException("loader");
        }
        this._lazyLoader = new Lazy<IList<T>>(loader, isThreadSafeWhenLoading);
    }

    #endregion

    #region Fields

    /// <summary>
    /// レイジーローダーを取得します。
    /// </summary>
    private readonly Lazy<IList<T>> _lazyLoader;

    #endregion

    #region Properties

    /// <summary>
    /// ソースリストを取得します。
    /// </summary>
    private IList<T> Items
    {
        get
        {
            return this._lazyLoader.Value;
        }
    }

    #endregion

    #region IList<T> メンバ

    /// <summary>
    /// 指定したインデックスにある要素を取得または設定します。
    /// </summary>
    /// <param name="index">取得または設定する要素の、0 から始まるインデックス番号。</param>
    /// <returns>指定したインデックスにある要素。</returns>
    /// <exception cref="System.NotSupportedException">このプロパティが設定されていますが、VirtualList<T> が読み取り専用です。</exception>
    /// <exception cref="System.ArgumentOutOfRangeException">index が VirtualList<T> の有効なインデックスではありません。</exception>
    public T this[int index]
    {
        get
        {
            return this.Items[index];
        }
        set
        {
            this.Items[index] = value;
        }
    }

    /// <summary>
    /// VirtualList<T> 内での指定した項目のインデックスを調べます。
    /// </summary>
    /// <param name="item">IList<T> 内で検索するオブジェクト。</param>
    /// <returns>リストに存在する場合は item のインデックス。それ以外の場合は -1。</returns>
    public int IndexOf(T item)
    {
        return this.Items.IndexOf(item);
    }

    /// <summary>
    /// VirtualList<T> の指定したインデックス位置に項目を挿入します。
    /// </summary>
    /// <param name="index">VirtualList<T> に挿入するオブジェクト。</param>
    /// <param name="item">item を挿入する位置の、0 から始まるインデックス番号。</param>
    /// <exception cref="System.NotSupportedException">VirtualList<T> は読み取り専用です。</exception>
    /// <exception cref="System.ArgumentOutOfRangeException">index が VirtualList<T> の有効なインデックスではありません。</exception>
    public void Insert(int index, T item)
    {
        this.Items.Insert(index, item);
    }

    /// <summary>
    /// 指定したインデックス位置の VirtualList<T> 項目を削除します。
    /// </summary>
    /// <param name="index">削除する項目の 0 から始まるインデックス。</param>
    /// <exception cref="System.NotSupportedException">VirtualList<T> は読み取り専用です。</exception>
    /// <exception cref="System.ArgumentOutOfRangeException">index が VirtualList<T> の有効なインデックスではありません。</exception>
    public void RemoveAt(int index)
    {
        this.Items.RemoveAt(index);
    }

    #endregion

    #region ICollection<T> メンバ

    /// <summary>
    /// VirtualList<T> に格納されている要素の数を取得します。
    /// </summary>
    public int Count
    {
        get
        {
            return this.Items.Count;
        }
    }

    /// <summary>
    /// VirtualList<T> が読み取り専用かどうかを示す値を取得します。
    /// </summary>
    public bool IsReadOnly
    {
        get
        {
            return this.Items.IsReadOnly;
        }
    }

    /// <summary>
    /// VirtualList<T> に項目を追加します。
    /// </summary>
    /// <param name="item">VirtualList<T> に追加するオブジェクト。</param>
    /// <exception cref="System.NotSupportedException">VirtualList<T> は読み取り専用です。</exception>
    public void Add(T item)
    {
        this.Items.Add(item);
    }

    /// <summary>
    /// VirtualList<T> からすべての項目を削除します。
    /// </summary>
    /// <exception cref="System.NotSupportedException">VirtualList<T> は読み取り専用です。</exception>
    public void Clear()
    {
        this.Items.Clear();
    }

    /// <summary>
    /// VirtualList<T> に特定の値が格納されているかどうかを判断します。
    /// </summary>
    /// <param name="item">VirtualList<T> 内で検索するオブジェクト。</param>
    /// <returns>item が VirtualList<T> に存在する場合は true。それ以外の場合は false。</returns>
    public bool Contains(T item)
    {
        return this.Items.Contains(item);
    }

    /// <summary>
    /// VirtualList<T> の要素を System.Array にコピーします。System.Array の特定のインデックスからコピーが開始されます。
    /// </summary>
    /// <param name="array">VirtualList<T> から要素がコピーされる 1 次元の System.Array。System.Array には、0 から始まるインデックス番号が必要です。</param>
    /// <param name="arrayIndex">コピーの開始位置となる、array の 0 から始まるインデックス番号。</param>
    /// <exception cref="System.ArgumentException">
    /// array が多次元です。
    /// またはarrayIndex が array の長さ以上です。
    /// またはコピー元の VirtualList<T> の要素数が、arrayIndex からコピー先の array の末尾までに格納できる数を超えています。
    /// または型 T をコピー先の array の型に自動的にキャストすることはできません。
    /// </exception>
    /// <exception cref="System.ArgumentNullException">array が null です。</exception>
    /// <exception cref="System.ArgumentOutOfRangeException">arrayIndex が 0 未満です。</exception>
    public void CopyTo(T[] array, int arrayIndex)
    {
        this.Items.CopyTo(array, arrayIndex);
    }

    /// <summary>
    /// VirtualList<T> 内で最初に見つかった特定のオブジェクトを削除します。
    /// </summary>
    /// <param name="item">VirtualList<T> から削除するオブジェクト。</param>
    /// <returns>
    /// item が VirtualList<T> から正常に削除された場合は true。それ以外の場合は false。
    /// このメソッドは、item が元の VirtualList<T> に見つからない場合にも false を返します。
    /// </returns>
    /// <exception cref="System.NotSupportedException">VirtualList<T> は読み取り専用です。</exception>
    public bool Remove(T item)
    {
        return this.Items.Remove(item);
    }

    #endregion

    #region IEnumerable<T> メンバ

    /// <summary>
    /// コレクションを反復処理する列挙子を返します。
    /// </summary>
    /// <returns>コレクションを反復処理するために使用できる System.Collections.Generic.IEnumerator<T>。</returns>
    public IEnumerator<T> GetEnumerator()
    {
        return this.Items.GetEnumerator();
    }

    #endregion

    #region IEnumerable メンバ

    /// <summary>
    /// コレクションを反復処理する列挙子を返します。
    /// </summary>
    /// <returns>コレクションを反復処理するために使用できる System.Collections.IEnumerator オブジェクト。</returns>
    IEnumerator IEnumerable.GetEnumerator()
    {
        return ((System.Collections.IEnumerable)this.Items).GetEnumerator();
    }

    #endregion
}

IListLoader<T> インターフェイス
using System;
using System.Collections.Generic;

/// <summary>
/// リストのローダーです。
/// </summary>
/// <typeparam name="T"></typeparam>
public interface IListLoader<T>
{
    /// <summary>
    /// リストをロードします。
    /// </summary>
    /// <returns>リスト。</returns>
    IList<T> Load();
}

VirtualList<T> クラスに Lazy<T> クラスを導入したことで、状態管理が不要になりました。
そして、遅延初期化処理をスレッドセーフにすることができるようになりました。

以前の実装のように、Lazy<T> クラスを使わずとも遅延初期化処理を実装することは容易です。
しかし、 Lazy<T> クラスを使用すれば、遅延初期化処理のスレッドセーフも容易に保証できるようになります。

スポンサーサイト

タグ: .NET PofEAA DDD ドメインモデルレイジーロード

トラックバック(0) | コメント(0) |

[ .NET ] DDD

2007/10/13 23:00

前回の仮想プロキシによるレイジーロードで書いた仮想リストと仮想リストローダーの使用例です。

ここでは、Department ( 部署 ) クラスと Employee ( 社員 ) クラスを使った簡単な例を挙げます。
部署には ID, 名前, メンバーといったフィールドがあることにします。

public sealed class Department
{
    private readonly int _id;

    private readonly string _name;

    private readonly ReadOnlyCollection<Employee> _members;

    public int Id
    {
        get
        {
            return this._id;
        }
    }

    public string Name
    {
        get
        {
            return this._name;
        }
    }

    public ReadOnlyCollection<Employee> Members
    {
        get
        {
            return this._members;
        }
    }

    public Department(int id, string name, ReadOnlyCollection<Employee> members)
    {
        this._id = id;
        this._name = name;
        this._members = members;
    }
}

社員には ID, 名前といったフィールドがあることにします。

public sealed class Employee
{
    private readonly int _id;

    private readonly string _name;

    public int Id
    {
        get
        {
            return this._id;
        }
    }

    public string Name
    {
        get
        {
            return this._name;
        }
    }

    public Employee(int id, string name)
    {
        this._id = id;
        this._name = name;
    }
}

部署クラスの _members フィールドこそが、今回レイジーロードを行うことになるフィールドです。見ての通り、仮想プロキシによるレイジーロードでは、レイジーロードの為の特別な仕組みがドメインクラスに一切必要ありません。

DepartmentMapper は、仮想リストと仮想リストローダーを使用してレイジーロードを部署クラスに仕込みます。
IListLoader ジェネリックインターフェイスを実装した MembersLoader クラスはインナークラスとして定義してあります。この仮想リストローダーは EmployeeMapper クラス ( 今回コードは用意していませんが ) から部署メンバーを取得します。

public sealed class DepartmentMapper
{
    public Department Find(int id)
    {
        DepartmentsDataSet.DepartmentsRow row = this.FindDataRow(id);
        if (row == null)
        {
            return null;
        }

        string name = row.Name;
        MembersLoader membersLoader = new MembersLoader(id);
        VirtualList<Employee> membersVirtualList = new VirtualList<Employee>(membersLoader);
        ReadOnlyCollection<Employee> members = new ReadOnlyCollection<Employee>(membersVirtualList);

        return new Department(id, name, members);
    }

    private DepartmentsDataSet.DepartmentsRow FindDataRow(int id)
    {
        using (DepartmentsTableAdapter adapter = new DepartmentsTableAdapter())
        {
            DepartmentsDataSet.DepartmentsDataTable table = adapter.GetDataById(id);
            if (table.Count == 0)
            {
                return null;
            }
            return table[0];
        }
    }

    private sealed class MembersLoader : IListLoader<Employee>
    {
        private readonly int _id;

        public MembersLoader(int id)
        {
            this._id = id;
        }

        public IList<Employee> Load()
        {
            return EmployeeMapper.Singleton.FindByDepartment(this._id);
        }
    }
}

これで、部署クラスの Members プロパティは、実際に使用されるまでロードを行いません。

タグ: .NET C# PofEAA DDD ドメインモデルレイジーロード

トラックバック(0) | コメント(0) |

[ .NET ] DDD

2007/10/08 21:38

仮想プロキシによるレイジーロード ( PofEAA ) を実装する際に利用できる、汎用的な仮想リスト及び仮想リストローダーを C# で書いてみました。 ( 特に変わったことはしてません。単に、コードを記録する目的で記事にしました。 )

仮想リストは、実装すべきインターフェイスが多いためコード量が多くなっていますが、重要なのは Items プロパティだけです。他のプロパティやメソッドは全て、Items プロパティから取得したリストに処理を委譲しているだけです。

VirtualList<T> クラス
using System;
using System.Collections;
using System.Collections.Generic;

/// <summary>
/// リストの仮想プロキシです。
/// </summary>
/// <typeparam name="T"></typeparam>
[Serializable]
public sealed class VirtualList<T> : IList<T>
{
    #region Constructors

    /// <summary>
    /// VirtualList<T> クラスの新しいインスタンスを初期化します。
    /// </summary>
    /// <param name="loader">ローダー。</param>
    /// <exception cref="System.ArgumentNullException">引数 loader が null です。</exception>
    public VirtualList(IListLoader<T> loader)
    {
        if (loader == null)
        {
            throw new ArgumentNullException("loader");
        }
        this._items = null;
        this._loader = loader;
    }

    #endregion

    #region Fields

    /// <summary>
    /// ソースリストを取得または設定します。
    /// </summary>
    private IList<T> _items;

    /// <summary>
    /// ローダーを取得します。
    /// </summary>
    private readonly IListLoader<T> _loader;

    #endregion

    #region Properties

    /// <summary>
    /// ソースリストを取得します。
    /// </summary>
    private IList<T> Items
    {
        get
        {
            if (this._items == null)
            {
                this._items = this._loader.Load();
            }
            return this._items;
        }
    }

    #endregion

    #region IList<T> メンバ

    /// <summary>
    /// 指定したインデックスにある要素を取得または設定します。
    /// </summary>
    /// <param name="index">取得または設定する要素の、0 から始まるインデックス番号。</param>
    /// <returns>指定したインデックスにある要素。</returns>
    /// <exception cref="System.NotSupportedException">このプロパティが設定されていますが、VirtualList<T> が読み取り専用です。</exception>
    /// <exception cref="System.ArgumentOutOfRangeException">index が VirtualList<T> の有効なインデックスではありません。</exception>
    public T this[int index]
    {
        get
        {
            return this.Items[index];
        }
        set
        {
            this.Items[index] = value;
        }
    }

    /// <summary>
    /// VirtualList<T> 内での指定した項目のインデックスを調べます。
    /// </summary>
    /// <param name="item">IList<T> 内で検索するオブジェクト。</param>
    /// <returns>リストに存在する場合は item のインデックス。それ以外の場合は -1。</returns>
    public int IndexOf(T item)
    {
        return this.Items.IndexOf(item);
    }

    /// <summary>
    /// VirtualList<T> の指定したインデックス位置に項目を挿入します。
    /// </summary>
    /// <param name="index">VirtualList<T> に挿入するオブジェクト。</param>
    /// <param name="item">item を挿入する位置の、0 から始まるインデックス番号。</param>
    /// <exception cref="System.NotSupportedException">VirtualList<T> は読み取り専用です。</exception>
    /// <exception cref="System.ArgumentOutOfRangeException">index が VirtualList<T> の有効なインデックスではありません。</exception>
    public void Insert(int index, T item)
    {
        this.Items.Insert(index, item);
    }

    /// <summary>
    /// 指定したインデックス位置の VirtualList<T> 項目を削除します。
    /// </summary>
    /// <param name="index">削除する項目の 0 から始まるインデックス。</param>
    /// <exception cref="System.NotSupportedException">VirtualList<T> は読み取り専用です。</exception>
    /// <exception cref="System.ArgumentOutOfRangeException">index が VirtualList<T> の有効なインデックスではありません。</exception>
    public void RemoveAt(int index)
    {
        this.Items.RemoveAt(index);
    }

    #endregion

    #region ICollection<T> メンバ

    /// <summary>
    /// VirtualList<T> に格納されている要素の数を取得します。
    /// </summary>
    public int Count
    {
        get
        {
            return this.Items.Count;
        }
    }

    /// <summary>
    /// VirtualList<T> が読み取り専用かどうかを示す値を取得します。
    /// </summary>
    public bool IsReadOnly
    {
        get
        {
            return this.Items.IsReadOnly;
        }
    }

    /// <summary>
    /// VirtualList<T> に項目を追加します。
    /// </summary>
    /// <param name="item">VirtualList<T> に追加するオブジェクト。</param>
    /// <exception cref="System.NotSupportedException">VirtualList<T> は読み取り専用です。</exception>
    public void Add(T item)
    {
        this.Items.Add(item);
    }

    /// <summary>
    /// VirtualList<T> からすべての項目を削除します。
    /// </summary>
    /// <exception cref="System.NotSupportedException">VirtualList<T> は読み取り専用です。</exception>
    public void Clear()
    {
        this.Items.Clear();
    }

    /// <summary>
    /// VirtualList<T> に特定の値が格納されているかどうかを判断します。
    /// </summary>
    /// <param name="item">VirtualList<T> 内で検索するオブジェクト。</param>
    /// <returns>item が VirtualList<T> に存在する場合は true。それ以外の場合は false。</returns>
    public bool Contains(T item)
    {
        return this.Items.Contains(item);
    }

    /// <summary>
    /// VirtualList<T> の要素を System.Array にコピーします。System.Array の特定のインデックスからコピーが開始されます。
    /// </summary>
    /// <param name="array">VirtualList<T> から要素がコピーされる 1 次元の System.Array。System.Array には、0 から始まるインデックス番号が必要です。</param>
    /// <param name="arrayIndex">コピーの開始位置となる、array の 0 から始まるインデックス番号。</param>
    /// <exception cref="System.ArgumentException">
    /// array が多次元です。
    /// またはarrayIndex が array の長さ以上です。
    /// またはコピー元の VirtualList<T> の要素数が、arrayIndex からコピー先の array の末尾までに格納できる数を超えています。
    /// または型 T をコピー先の array の型に自動的にキャストすることはできません。
    /// </exception>
    /// <exception cref="System.ArgumentNullException">array が null です。</exception>
    /// <exception cref="System.ArgumentOutOfRangeException">arrayIndex が 0 未満です。</exception>
    public void CopyTo(T[] array, int arrayIndex)
    {
        this.Items.CopyTo(array, arrayIndex);
    }

    /// <summary>
    /// VirtualList<T> 内で最初に見つかった特定のオブジェクトを削除します。
    /// </summary>
    /// <param name="item">VirtualList<T> から削除するオブジェクト。</param>
    /// <returns>
    /// item が VirtualList<T> から正常に削除された場合は true。それ以外の場合は false。
    /// このメソッドは、item が元の VirtualList<T> に見つからない場合にも false を返します。
    /// </returns>
    /// <exception cref="System.NotSupportedException">VirtualList<T> は読み取り専用です。</exception>
    public bool Remove(T item)
    {
        return this.Items.Remove(item);
    }

    #endregion

    #region IEnumerable<T> メンバ

    /// <summary>
    /// コレクションを反復処理する列挙子を返します。
    /// </summary>
    /// <returns>コレクションを反復処理するために使用できる System.Collections.Generic.IEnumerator<T>。</returns>
    public IEnumerator<T> GetEnumerator()
    {
        return this.Items.GetEnumerator();
    }

    #endregion

    #region IEnumerable メンバ

    /// <summary>
    /// コレクションを反復処理する列挙子を返します。
    /// </summary>
    /// <returns>コレクションを反復処理するために使用できる System.Collections.IEnumerator オブジェクト。</returns>
    IEnumerator IEnumerable.GetEnumerator()
    {
        return ((System.Collections.IEnumerable)this.Items).GetEnumerator();
    }

    #endregion
}

IListLoader<T> インターフェイス
using System;
using System.Collections.Generic;

/// <summary>
/// リストのローダーです。
/// </summary>
/// <typeparam name="T"></typeparam>
public interface IListLoader<T>
{
    /// <summary>
    /// リストをロードします。
    /// </summary>
    /// <returns>リスト。</returns>
    IList<T> Load();
}

この仮想リスト及びローダーは、そのまま使用できます。
仮想リストはシールクラスにしてあります。これは、仮想リストを継承したクラスを定義する必要がないはずだからです。null を許可しないとか重複を許可しないといった制約は、仮想リストには実装しません。

この仮想リスト及びローダーを使用したレイジーロードの実装例は次回にでも。

// 追記 (2010/06/06)
Lazy クラスを使用した仮想プロキシを実装してみました。

タグ: .NET PofEAA DDD ドメインモデルレイジーロード

トラックバック(0) | コメント(3) |