VB

デザインパターンを学ぶ～その１8：Singletonパターン(1)～

まさる — Sun, 08 Jun 2008 01:24:00 GMT

Singleton　（シングルトン）
　一人っ子、単一のこと・もの

Singletonパターンは、インスタンスがひとつしかない唯一のオブジェクトを生成し、そのインスタンスを取得する方法を公開します。

例えば、アプリケーション実行時のログを出力するような場合を考えます。ログのファイル名をシステム日付＋時刻でつけるとしましょう。ログ出力を初回に行う際に、ログファイル名を決定し、以後はそのログファイルにログを出力します。

この場合、ログファイル名はアプリケーション実行時に1つだけでなくてはなりません。このような場合、Singletonが使えます。

以下に、コード例を示します。

C#

/// <summary>
/// ログ出力クラス
/// </summary>
public class SingletonLogger
{
  /// <summary>
  /// ログ出力パス
  /// </summary>
  private string _logPath;

  /// <summary>
  /// プロパティ ログ出力パス
  /// </summary>
  public string LogPath
  {
    get
    {
      return _logPath;
    }
  }

  /// <summary>
  /// コンストラクタ
  /// </summary>
  /// <remarks>new でインスタンス化できないよう、privateでコンストラクタを定義</remarks>
  private SingletonLogger()
  {
    _logPath = DateTime.Now.ToString("yyyyMMddhhmmssfff") + ".log";
  }

  /// <summary>
  /// 自身の唯一のインスタンス
  /// </summary>
  private static SingletonLogger _uniqueLogger;

  /// <summary>
  /// プロパティ インスタンス
  /// </summary>
  /// <remarks>自身の唯一のインスタンスを返す</remarks>
  public static SingletonLogger Instance
  {
    get
    {
      if ( _uniqueLogger == null )
      {
        _uniqueLogger = new SingletonLogger();
      }
      return _uniqueLogger;
    }
  }

  /// <summary>
  /// ログ出力
  /// </summary>
  /// <param name="message"></param>
  public void WriteLog(string message)
  {
    // ログ出力処理
    // ・・・
  }
}

VB

''' <summary>
''' ログ出力クラス
''' </summary>
''' <remarks></remarks>
Public Class SingletonLogger

  ''' <summary>
  ''' ログ出力パス
  ''' </summary>
  ''' <remarks></remarks>
  Private _logPath As String

  ''' <summary>
  ''' プロパティ ログ出力パス
  ''' </summary>
  ''' <value></value>
  ''' <returns></returns>
  ''' <remarks></remarks>
  Public ReadOnly Property LogPath() As String
    Get
      Return _logPath
    End Get
  End Property

  ''' <summary>
  ''' コンストラクタ
  ''' </summary>
  ''' <remarks>new でインスタンス化できないよう、privateでコンストラクタを定義</remarks>
  Private Sub New()
    _logPath = DateTime.Now.ToString("yyyyMMddhhmmssfff") & ".log"
  End Sub

  ''' <summary>
  ''' 自身の唯一のインスタンス
  ''' </summary>
  ''' <remarks></remarks>
  Private Shared _uniqueLogger As SingletonLogger

  ''' <summary>
  ''' プロパティ インスタンス
  ''' </summary>
  ''' <value></value>
  ''' <returns></returns>
  ''' <remarks>自身の唯一のインスタンスを返す</remarks>
  Public Shared ReadOnly Property Instance() As SingletonLogger
    Get
      If _uniqueLogger Is Nothing Then
        _uniqueLogger = New SingletonLogger
      End If
      Return _uniqueLogger
    End Get
  End Property

  ''' <summary>
  ''' ログ出力
  ''' </summary>
  ''' <param name="message"></param>
  Public Sub WriteLog(ByVal message As String)
    ' ログ出力処理
    ' ・・・
  End Sub

End Class

このコードのポイントは以下の3点です。

コンストラクタをprivateとして、外からはインスタンス化できないようにする。
privateな静的フィールドとして、自身の型のフィールドを用意し、クライアントにはそれを提供するようにする。
Instanceプロパティ内で、上記静的フィールドがnullの場合のみ、新たにインスタンス化するようにし、唯一のオブジェクトを保障する。

以上のコードを使って見ましょう。

C#

public class Program
{
  static void Main(string[] args)
  {
    {
      var logger = SingletonLogger.Instance;
      Console.WriteLine(logger.LogPath);
    }

    System.Threading.Thread.Sleep(1000);

    {
      var logger = SingletonLogger.Instance;
      Console.WriteLine(logger.LogPath);
    }

    Console.ReadKey();
  }
}

VB

Public Class Program

  Public Shared Sub Main()

    With Nothing
      Dim logger = SingletonLogger.Instance
      Console.WriteLine(logger.LogPath)
    End With

    System.Threading.Thread.Sleep(1000)

    With Nothing
      Dim logger = SingletonLogger.Instance
      Console.WriteLine(logger.LogPath)
    End With

    Console.ReadKey()

  End Sub

End Class

実行結果

20080608125533068.log
20080608125533068.log

実行結果を見るとわかるように、1つのインスタンスが使いまわされていることがわかります。

さて、以上のコードは、通常の使用方法では問題がないのですが、以下のようにマルチスレッドで動かす場合、1つだけであるはずのインスタンスが、複数生成されてしまうことがあります。

C#

/// ログ出力クラス
/// </summary>
public class SingletonLogger
{
  ・・・

  /// <summary>
  /// コンストラクタ
  /// </summary>
  /// <remarks>new でインスタンス化できないよう、privateでコンストラクタを定義</remarks>
  private SingletonLogger()
  {
    // 重い初期化処理
    for ( var i = 0; i < 100000000; i++ )
    {
    }

    _logPath = DateTime.Now.ToString("yyyyMMddhhmmssfff") + ".log";
  }

  ・・・
}

public class Program
{
  static void Main(string[] args)
  {
    SingletonLogger logger1 = null;
    var thread1 = new Thread(
      () =>
      {
        logger1 = SingletonLogger.Instance;
      }
    );
    SingletonLogger logger2 = null;
    var thread2 = new Thread(
      () =>
      {
        logger2 = SingletonLogger.Instance;
      }
    );

    thread1.Start();
    thread2.Start();

    while ( logger1 == null || logger2 == null)
    {
      Thread.Sleep(10);
    }

    Console.WriteLine(logger1.LogPath);
    Console.WriteLine(logger2.LogPath);

    Console.ReadKey();
  }
}

VB

''' <summary>
''' ログ出力クラス
''' </summary>
''' <remarks></remarks>
Public Class SingletonLogger

  ・・・

  ''' <summary>
  ''' コンストラクタ
  ''' </summary>
  ''' <remarks>new でインスタンス化できないよう、privateでコンストラクタを定義</remarks>
  Private Sub New()
    ' 重い初期化処理
    For i As Integer = 0 To 100000000
    Next i

    _logPath = DateTime.Now.ToString("yyyyMMddhhmmssfff") & ".log"
  End Sub

  ・・・

End Class

Public Class Program

  Public Shared Sub Main()

    Dim logger1 As SingletonLogger = Nothing
    Dim loggerHelper1 As New LoggerHelper(logger1)
    Dim thread1 = New Thread(AddressOf loggerHelper1.SetLogger)

    Dim logger2 As SingletonLogger = Nothing
    Dim loggerHelper2 As New LoggerHelper(logger2)
    Dim thread2 = New Thread(AddressOf loggerHelper2.SetLogger)

    thread1.Start()
    thread2.Start()

    While (logger1 Is Nothing OrElse logger2 Is Nothing)
      Thread.Sleep(10)
    End While

    Console.WriteLine(logger1.LogPath)
    Console.WriteLine(logger2.LogPath)

    Console.ReadKey()

  End Sub

  Public Class LoggerHelper

    Private _logger As SingletonLogger

    Public Sub New(ByRef logger As SingletonLogger)
      _logger = logger
    End Sub

    Public Sub SetLogger()
      _logger = SingletonLogger.Instance
    End Sub
  End Class

End Class

実行結果

20080608011949432.log
20080608011949613.log

ごらんのように、インスタンスが２つ生成された結果、ログ出力パスが変わってしまいます。

この問題を解消する方法はないのでしょうか？

実はあります。このあたり、次回のエントリで取り上げようと思います。

＃今回から、.NET Framework 3.5 のコードにしています。

デザインパターンを学ぶ～その１６：Factoryパターン(3)～

まさる — Wed, 27 Feb 2008 23:58:00 GMT

記念すべき100エントリ目となりました。いい加減にシリーズ再開せねばということで、前回から間が空きましたが、今回はAbstract Factoryパターンを取り上げます。

Abstract Factoryパターンは、具象クラスに依存することなく、一連の関連するオブジェクトを生成するためのインタフェイスを提供します。

具体的には、例えばGUIインタフェイスでスキンを指定したら、それに紐付くボタン、枠、スクロールバーなどを生成する、といった用途で使われているようですね。

では、コード例です。今回はお弁当の種類に応じたごはんとおかずを作るFactoryをコードにしてみます。

生成される製品の抽象クラスを定義します。

C# Code

public abstract class Abstractごはん
{
  public abstract string 名前
  {
    get;
  }
}

public abstract class Abstractおかず
{
  public abstract string 名前
  {
    get;
  }
}

VB Code

Public MustInherit Class Abstractごはん

  Public MustOverride ReadOnly Property 名前() As String

End Class

Public MustInherit Class Abstractおかず

  Public MustOverride ReadOnly Property 名前() As String

End Class

1.で作成した抽象製品クラスを継承し、具象製品クラスを定義します。

C# Code

public class ごはん : Abstractごはん
{
  public override string 名前
  {
    get { return "ごはん"; }
  }
}

public class ふりかけごはん : Abstractごはん
{
  public override string 名前
  {
    get { return "ふりかけごはん"; }
  }
}

public class ごま塩ごはん : Abstractごはん
{
  public override string 名前
  {
    get { return "ごま塩ごはん"; }
  }
}

public class 梅干し : Abstractおかず
{
  public override string 名前
  {
    get { return "梅干し"; }
  }
}

public class から揚げ : Abstractおかず
{
  public override string 名前
  {
    get { return "から揚げ"; }
  }
}

public class 玉子焼き : Abstractおかず
{
  public override string 名前
  {
    get { return "玉子焼き"; }
  }
}

public class 焼き鮭 : Abstractおかず
{
  public override string 名前
  {
    get { return "焼き鮭"; }
  }
}

public class 煮物 : Abstractおかず
{
  public override string 名前
  {
    get { return "煮物"; }
  }
}

public class ウインナ : Abstractおかず
{
  public override string 名前
  {
    get { return "ウインナ"; }
  }
}

VB Code

Public Class ごはん
  Inherits Abstractごはん

  Public Overrides ReadOnly Property 名前() As String
    Get
      Return "ごはん"
    End Get
  End Property

End Class

Public Class ふりかけごはん
  Inherits Abstractごはん

  Public Overrides ReadOnly Property 名前() As String
    Get
      Return "ふりかけごはん"
    End Get
  End Property

End Class

Public Class ごま塩ごはん
  Inherits Abstractごはん

  Public Overrides ReadOnly Property 名前() As String
    Get
      Return "ごま塩ごはん"
    End Get
  End Property

End Class

Public Class 梅干し
  Inherits Abstractおかず

  Public Overrides ReadOnly Property 名前() As String
    Get
      Return "梅干し"
    End Get
  End Property

End Class

Public Class から揚げ
  Inherits Abstractおかず

  Public Overrides ReadOnly Property 名前() As String
    Get
      Return "から揚げ"
    End Get
  End Property

End Class

Public Class 玉子焼き
  Inherits Abstractおかず

  Public Overrides ReadOnly Property 名前() As String
    Get
      Return "玉子焼き"
    End Get
  End Property

End Class

Public Class 焼き鮭
  Inherits Abstractおかず

  Public Overrides ReadOnly Property 名前() As String
    Get
      Return "焼き鮭"
    End Get
  End Property

End Class

Public Class 煮物
  Inherits Abstractおかず

  Public Overrides ReadOnly Property 名前() As String
    Get
      Return "煮物"
    End Get
  End Property

End Class

Public Class ウインナ
  Inherits Abstractおかず

  Public Overrides ReadOnly Property 名前() As String
    Get
      Return "煮物"
    End Get
  End Property

End Class

1.で作成した抽象クラスそれぞれを生成するメソッド（Factory Method）を持つ、抽象Factoryクラスを定義します。

C# Code

public abstract class Abstractお弁当Factory
{
  public abstract Abstractごはん Createごはん();
  public abstract Abstractおかず[] Createおかず();
}

VB Code

Public MustInherit Class Abstractお弁当Factory

  Public MustOverride Function Createご飯() As Abstractごはん
  Public MustOverride Function Createおかず() As Abstractおかず()

End Class

3.で作成した抽象クラスを継承し、具象Factoryクラスを定義します。

C# Code

public class 日の丸弁当Factory : Abstractお弁当Factory
{
  public override Abstractごはん Createごはん()
  {
    return new ごはん();
  }

  public override Abstractおかず[] Createおかず()
  {
    return new Abstractおかず[] { new 梅干し() };
  }
}

public class 和風弁当Factory : Abstractお弁当Factory
{
  public override Abstractごはん Createごはん()
  {
    return new ごま塩ごはん();
  }

  public override Abstractおかず[] Createおかず()
  {
    return new Abstractおかず[] {
      new 梅干し()
      , new 焼き鮭()
      , new 煮物()
    };
  }
}

public class こども弁当Factory : Abstractお弁当Factory
{
  public override Abstractごはん Createごはん()
  {
    return new ふりかけごはん();
  }

  public override Abstractおかず[] Createおかず()
  {
    return new Abstractおかず[] {
      new ウインナ()
      , new 玉子焼き()
      , new から揚げ()
    };
  }
}

VB Code

Public Class 日の丸弁当Factory
  Inherits Abstractお弁当Factory

  Public Overrides Function Createご飯() As Abstractごはん

    Return New ごはん()

  End Function

  Public Overrides Function Createおかず() As Abstractおかず()

    Return New Abstractおかず() {New 梅干し()}

  End Function

End Class

Public Class 和風弁当Factory
  Inherits Abstractお弁当Factory

  Public Overrides Function Createご飯() As Abstractごはん

    Return New ごま塩ごはん()

  End Function

  Public Overrides Function Createおかず() As Abstractおかず()

    Return New Abstractおかず() { _
     New 梅干し() _
     , New 焼き鮭() _
     , New 煮物() _
     }

  End Function

End Class

Public Class こども弁当Factory
  Inherits Abstractお弁当Factory

  Public Overrides Function Createご飯() As Abstractごはん

    Return New ふりかけごはん()

  End Function

  Public Overrides Function Createおかず() As Abstractおかず()

    Return New Abstractおかず() { _
     New ウインナ() _
     , New 玉子焼き() _
     , New から揚げ() _
     }

  End Function

End Class

1～4.で作成したクラス群を使用する、Clientクラスを定義します。

C# Code

public class お弁当Client
{
  private Abstractごはん ごはん;
  private Abstractおかず[] おかず;
  private Abstractお弁当Factory お弁当Factory;

  public お弁当Client(string 種類)
  {
    if ( 種類 == "日の丸" )
    {
      this.お弁当Factory = new 日の丸弁当Factory();
    }
    else if ( 種類 == "和風" )
    {
      this.お弁当Factory = new 和風弁当Factory();
    }
    else if ( 種類 == "こども" )
    {
      this.お弁当Factory = new こども弁当Factory();
    }
  }

  public void お弁当作成()
  {
    this.ごはん = お弁当Factory.Createごはん();
    this.おかず = お弁当Factory.Createおかず();
  }

  public override string ToString()
  {
    List<string> おかず名List = new List<string>();
    foreach ( Abstractおかず おかず単品 in おかず )
    {
      おかず名List.Add(おかず単品.名前);
    }
    return String.Format(
        "{0}におかずとして、{1}が付いています。"
      , ごはん.名前
      , String.Join("、", おかず名List.ToArray())
      );
  }
}

VB Code

Public Class お弁当Client

  Private ごはん As Abstractごはん
  Private おかず As Abstractおかず()
  Private お弁当Factory As Abstractお弁当Factory

  Sub New(ByVal 種類 As String)

    If 種類 = "日の丸" Then

      Me.お弁当Factory = New 日の丸弁当Factory()

    ElseIf 種類 = "和風" Then

      Me.お弁当Factory = New 和風弁当Factory()

    ElseIf 種類 = "こども" Then

      Me.お弁当Factory = New こども弁当Factory()

    End If

  End Sub

  Public Sub お弁当作成()

    Me.ごはん = Me.お弁当Factory.Createご飯()
    Me.おかず = Me.お弁当Factory.Createおかず()

  End Sub

  Public Overrides Function ToString() As String

    Dim おかず名List As New List(Of String)()

    For Each おかず単品 As Abstractおかず In Me.おかず

      おかず名List.Add(おかず単品.名前)

    Next

    Return String.Format( _
     "{0}におかずとして、{1}が付いています。" _
     , ごはん.名前 _
     , String.Join("、", おかず名List.ToArray()) _
     )

  End Function

End Class

上記コードを実行してみます。

実行コード

C# Code

public class Program
{
  static void Main(string[] args)
  {
    お弁当Client client;

    Console.WriteLine("日の丸弁当：");
    client = new お弁当Client("日の丸");
    client.お弁当作成();
    Console.WriteLine(client.ToString());

    Console.WriteLine("和風弁当：");
    client = new お弁当Client("和風");
    client.お弁当作成();
    Console.WriteLine(client.ToString());

    Console.WriteLine("こども弁当：");
    client = new お弁当Client("こども");
    client.お弁当作成();
    Console.WriteLine(client.ToString());

    Console.ReadKey();
  }
}

VB Code

Public Class Program

  Public Shared Sub Main(ByVal args As String())

    Dim client As お弁当Client

    Console.WriteLine("日の丸弁当：")
    client = New お弁当Client("日の丸")
    client.お弁当作成()
    Console.WriteLine(client.ToString())

    Console.WriteLine("和風弁当：")
    client = New お弁当Client("和風")
    client.お弁当作成()
    Console.WriteLine(client.ToString())

    Console.WriteLine("こども弁当：")
    client = New お弁当Client("こども")
    client.お弁当作成()
    Console.WriteLine(client.ToString())

    Console.ReadKey()

  End Sub

End Class

実行結果

日の丸弁当：
ごはんにおかずとして、梅干しが付いています。
和風弁当：
ごま塩ごはんにおかずとして、梅干し、焼き鮭、煮物が付いています。
こども弁当：
ふりかけごはんにおかずとして、ウインナ、玉子焼き、から揚げが付いています。

さて、上記のコードをよく見てみると、気付くことがあります。

まずは、3.で定義した抽象Factoryですが、そのメンバである製品を生成するメソッドは、前回紹介したFactory Methodパターンとなっています。

また、Clientクラスの中で、抽象Factoryクラスの変数に、具象Factoryのインスタンスを切り替えて設定し、Factoryメソッドを実行している箇所は、Strategyパターンになっていますね。（この辺の話は以前凪瀬さんがまとめていらっしゃいますのでご一読をオススメします。）

このように、あるパターンの中に他のパターンが紛れている、ということもGoFパターンにはちょくちょくあるようですので、その意味、役割を考えなければいけませんね。わたしももう少し勉強します(^^;

さて、次回はFactoryパターンについてのまとめをお送りする予定です。

re: re: オブジェクト指向におけるFizzBuzz問題

まさる — Fri, 09 Nov 2007 12:30:00 GMT

＃問題→オブジェクト指向におけるFizzBuzz問題

＃前回→re: オブジェクト指向におけるFizzBuzz問題

ひろえむさんのコメントにより、さらに修正。

C#

public abstract class Animal
{
    private int soundsCount = 1;

    public void SetCount(int count)
    {
        this.soundsCount = count;
    }

    protected abstract string SoundsString
    {
        get;
    }

    public void Sound()
    {
        StringBuilder sounds = new StringBuilder();
        for ( int i = 0; i < this.soundsCount; i++ )
        {
            sounds.Append(this.SoundsString);
        }
        Console.WriteLine(sounds.ToString());
    }
}

public class Cat : Animal
{
    protected override string SoundsString
    {
        get
        {
            return "にゃー";
        }
    }
}

public class Dog : Animal
{
    protected override string SoundsString
    {
        get
        {
            return "わん";
        }
    }
}

class Program
{
    static void Main(string[] args)
    {
        Animal animal;
        animal = new Dog();
        animal.Sound();
        animal.SetCount(3);
        animal.Sound();
        animal = new Cat();
        animal.Sound();

        Console.Read();
    }
}

せっかくなのでVB版も。

VB

Imports System.Text

Public MustInherit Class Animal

    Private soundsCount As Integer = 1

    Protected MustOverride ReadOnly Property SoundsString() As String

    Public Sub SetCount(ByVal count As Integer)
        Me.soundsCount = count
    End Sub

    Public Sub Sound()
        Dim sounds As New StringBuilder()
        For i As Integer = 1 To Me.soundsCount
            sounds.Append(Me.SoundsString())
        Next i
        Console.WriteLine(sounds.ToString())
    End Sub

End Class

Public Class Cat
    Inherits Animal

    Protected Overrides ReadOnly Property SoundsString() As String
        Get
            Return "にゃー"
        End Get
    End Property

End Class

Public Class Dog
    Inherits Animal

    Protected Overrides ReadOnly Property SoundsString() As String
        Get
            Return "わん"
        End Get
    End Property

End Class

Public Class Program

    Public Shared Sub Main(ByVal args As String())

        Dim animal As Animal
        animal = New Dog()
        animal.Sound()
        animal.SetCount(3)
        animal.Sound()
        animal = New Cat()
        animal.Sound()

        Console.Read()

    End Sub

End Class

デザインパターンを学ぶ～その１５：Factoryパターン(2)～

まさる — Wed, 07 Nov 2007 00:57:00 GMT

＃色々あって間が空きましたが、ようやくこのシリーズを再開します。

さて、前回はFactoryの基本ということで、Simple Factoryを取り上げました。今回はFactory Methodパターンを取り上げます。

Factory Methodパターンはインスタンス化するクラスをサブクラスに決定させるため、インスタンス化をサブクラスに先送りできます。これにより、実際にオブジェクトを使用するクラスから具象クラスへの依存がなくなります。

といってもよくわからないので、コードを書いてみましょう。

まず、生成されるオブジェクトのインタフェイスとなる抽象クラスAbstractMemberを定義します。ここで、インタフェイスとは広義の意味であり、interface（VBならInterface）で定義するインタフェイスのことではありません。
C# Code
```
public abstract class AbstractMember
{
    protected string name;

    public abstract void Speak();
}
```
VB Code
```
Public MustInherit Class AbstractMember

    Protected name As String

    Public MustOverride Sub Speak()

End Class
```

AbstractMemberを継承した具象クラスMasaru, Epistemeを定義します。

C# Code

public class Masaru : AbstractMember
{
    public Masaru()
    {
        this.name = "まさる";
    }

    public override void Speak()
    {
        Console.WriteLine("名前は{0}です。", this.name);
        Console.WriteLine("越後のとあるSIerで働いています。");
    }
}

public class Episteme : AbstractMember
{
    public Episteme()
    {
        this.name = "επιστημη";
    }

    public override void Speak()
    {
        Console.WriteLine("名前は{0}です。", this.name);
        Console.WriteLine("わんくま茶藝部顧問です。");
    }
}

VB Code

Public Class Masaru
    Inherits AbstractMember

    Sub New()

        Me.name = "まさる"

    End Sub

    Public Overrides Sub Speak()

        Console.WriteLine("名前は{0}です。", Me.name)
        Console.WriteLine("越後のとあるSIerで働いています。")

    End Sub

End Class

Public Class Episteme
    Inherits AbstractMember

    Sub New()

        Me.name = "επιστημη"

    End Sub

    Public Overrides Sub Speak()

        Console.WriteLine("名前は{0}です。", Me.name)
        Console.WriteLine("わんくま茶藝部顧問です。")

    End Sub

End Class

AbstractMemberを生成するための抽象クラスAbstractCreatorを定義します。

C# Code

public abstract class AbstractCreator
{
    public abstract AbstractMember CreateMember();
}

VB Code

Public MustInherit Class AbstractCreator

    Public MustOverride Function CreateMember() As AbstractMember

End Class

AbstractCreatorを継承したインスタン生成のための具象クラスNormalMemberCreator、SuperMemberCreatorを定義します。

C# Code

public class NormalMemberCreator : AbstractCreator
{
    public override AbstractMember CreateMember()
    {
        return new Masaru();
    }
}

public class SuperMemberCreator : AbstractCreator
{
    public override AbstractMember CreateMember()
    {
        return new Episteme();
    }
}

VB Code

Public Class NormalMemberCreator
    Inherits AbstractCreator

    Public Overrides Function CreateMember() As AbstractMember

        Return New Masaru()

    End Function

End Class

Public Class SuperMemberCreator
    Inherits AbstractCreator

    Public Overrides Function CreateMember() As AbstractMember

        Return New Episteme()

    End Function

End Class

以上のコードを実行してみましょう。

実行コード

C# Code

public static class Program
{
    public static void Main(string[] args)
    {
        {
            NormalMemberCreator memberCreator = new NormalMemberCreator();
            AbstractMember member = memberCreator.CreateMember();
            member.Speak();
        }

        Console.WriteLine("");

        {
            SuperMemberCreator memberCreator = new SuperMemberCreator();
            AbstractMember member = memberCreator.CreateMember();
            member.Speak();
        }

        Console.Read();
    }
}

VB Code

Public Class Program

    Private Shared Block As Object = Nothing

    Public Shared Sub Main(ByVal args As String())

        With Block

            Dim memberCreator As New NormalMemberCreator()
            Dim member As AbstractMember = memberCreator.CreateMember()
            member.Speak()

        End With

        Console.WriteLine("")

        With Block

            Dim memberCreator As New SuperMemberCreator()
            Dim member As AbstractMember = memberCreator.CreateMember()
            member.Speak()

        End With

        Console.ReadLine()

    End Sub

End Class

実行結果

名前はまさるです。
越後のとあるSIerで働いています。

名前はεπιστημηです。
わんくま茶藝部顧問です。

上記の実行コードはSpeakメソッドを実装している具象クラスのことを知りません。これが依存性をなくしたということです。

これによって何が良いのかというと、例えばMasaruクラスでなく、Torikobitoクラスに変更したい場合、実行コードに変更が必要ありません。あくまでTorikobitoクラスの追加と、NormalMemberCreatorの変更だけで済みます。

変更点

C# Code

public class Torikobito : AbstractMember
{
    public Torikobito()
    {
        this.name = "とりこびと";
    }

    public override void Speak()
    {
        Console.WriteLine("名前は{0}です。", this.name);
        Console.WriteLine("Memo(Of T)管理人です。");
    }
}

public class NormalMemberCreator : AbstractCreator
{
    public override AbstractMember CreateMember()
    {
        //return new Masaru();
        return new Torikobito();
    }
}

VB Code

Public Class Torikobito
    Inherits AbstractMember

    Sub New()

        Me.name = "とりこびと"

    End Sub

    Public Overrides Sub Speak()

        Console.WriteLine("名前は{0}です。", Me.name)
        Console.WriteLine("Memo(Of T)管理人です。")

    End Sub
End Class

Public Class NormalMemberCreator
    Inherits AbstractCreator

    Public Overrides Function CreateMember() As AbstractMember

        'Return New Masaru()
        Return New Torikobito()

    End Function

End Class

実行結果

名前はとりこびとです。
Memo(Of T)管理人です。

名前はεπιστημηです。
わんくま茶藝部顧問です。

ということで、今回はFactory Methodパターンをお送りしましたが、私自身まだこのパターンの有用性が理解し切れていません。実際に「こんなときに使ったよ」などありましたらコメントで教えてください。

デザインパターンを学ぶ～その１４：Factoryパターン(1)～

まさる — Tue, 28 Aug 2007 22:35:00 GMT

Factory　（ファクトリー）
　工場

Factoryパターンは、「工場」という名の通り、インスタンスを作り出すクラスを定義するパターンです。

このパターンを適用することにより、インスタンスの生成方法を気にすることなく使用することができるようになり、オブジェクト間の結合が"疎"になります。

まずはSimple Factoryからやっていきます。Simple Factoryは実際はデザインパターンではないそうですが、Factoryの簡単なイメージが得られると思います。

では、コードを示します。

具象クラスの元となるInterfaceを定義します。

C# Code

public interface IObject
{
    void Output();
}

VB Code

Public Interface IObject

    Sub Output()

End Interface

1.のInterfaceを継承して具象クラスを定義します。

C# Code

public class HogeObject : IObject
{

    #region IObject メンバ

    public void Output()
    {
        Console.WriteLine("ほげ");
    }

    #endregion
}

public class FooObject : IObject
{
    #region IObject メンバ

    public void Output()
    {
        Console.WriteLine("ふー");
    }

    #endregion
}

VB Code

Public Class HogeObject
    Implements IObject

    Public Sub Output() Implements IObject.Output
        Console.WriteLine("ほげ")
    End Sub

End Class

Public Class FooObject
    Implements IObject

    Public Sub Output() Implements IObject.Output
        Console.WriteLine("ふー")
    End Sub

End Class

文字列を引数とし、その値によってインスタンスを生成する具象クラスを切り替えるFactoryクラスを定義します。

C# Code

public class SimpleFactory
{
    public IObject CreateHoge(string objectName)
    {
        if ( objectName == "ほげ" )
        {
            return new HogeObject();
        }
        else if ( objectName == "ふー" )
        {
            return new FooObject();
        }
        else
        {
            throw new ArgumentException();
        }
    }
}

VB Code

Public Class SimpleFactory

    Public Function CreateObject(ByVal objectName As String) As IObject

        If objectName = "ほげ" Then

            Return New HogeObject()

        ElseIf objectName = "ふー" Then

            Return New FooObject()

        Else

            Throw New ArgumentException()

        End If

    End Function

End Class

3.のFactoryを使用するクラスを定義します。

C# Code

public class Program
{
    private static SimpleFactory _simpleFactory = new SimpleFactory();

    public static void Main(string[] args)
    {
        IObject obj;

        obj = _simpleFactory.CreateHoge("ほげ");

        obj.Output();

        obj = _simpleFactory.CreateHoge("ふー");

        obj.Output();

        Console.ReadLine();
    }
}

VB Code

Public Class Program

    Private Shared _simpleFactory As New SimpleFactory()

    Public Shared Sub Main(ByVal args As String())

        Dim obj As IObject

        obj = _simpleFactory.CreateObject("ほげ")

        obj.Output()

        obj = _simpleFactory.CreateObject("ふー")

        obj.Output()

        Console.ReadLine()

    End Sub

End Class

実行結果

ほげ
ふー

こんな感じです。

んで、どこが利点かといいますと、仮に「ほげ」、「ふー」の他に「ばー」を追加しようとしたとしましょう。

C# Code

public class BarObject : IObject
{
    #region IObject メンバ

    public void Output()
    {
        Console.WriteLine("ふー");
    }

    #endregion
}

VB Code

Public Class BarObject
    Implements IObject

    Public Sub Output() Implements IObject.Output
        Console.WriteLine("ばー")
    End Sub

End Class

この際、Simple Factoryを用いている場合、Programクラスの変更は必要なく、SimpleFactoryクラスの変更だけで済みます。

C# Code

public class SimpleFactory
{
    public IObject CreateHoge(string objectName)
    {
        if ( objectName == "ほげ" )
        {
            return new HogeObject();
        }
        else if ( objectName == "ふー" )
        {
            return new FooObject();
        }
        else if ( objectName == "ばー" )    // ※追加した部分
        {
            return new BarObject();
        }
        else
        {
            throw new ArgumentException();
        }
    }
}

VB Code

Public Class SimpleFactory

    Public Function CreateObject(ByVal objectName As String) As IObject

        If objectName = "ほげ" Then

            Return New HogeObject()

        ElseIf objectName = "ふー" Then

            Return New FooObject()

        ElseIf objectName = "ばー" Then        ' ※追加した部分

            Return New BarObject()

        Else

            Throw New ArgumentException()

        End If

    End Function

End Class

つまり、「処理のメインとなるクラスに変更を及ぼさない」設計が可能となります。そして、これは今後エントリにするFactory Methodパターン、Abstract Factoryパターンにも共通する特徴です。

次回はFactory Methodパターンについてまとめます。

デザインパターンを学ぶ～その１３：ちょっとだけDecoratorパターン(3)～

まさる — Fri, 17 Aug 2007 14:31:00 GMT

最後にその８のVB版。

VB Code

' 抽象ログクラス
Public MustInherit Class AbstractLog

    ' ログ出力
    Public MustOverride Sub WriteLog(ByVal logMessage As String)

End Class

' 標準出力ログクラス
Public Class StandardOutputLog
    Inherits AbstractLog

    ' ログ出力
    Public Overrides Sub WriteLog(ByVal logMessage As String)

        Console.WriteLine(logMessage)

    End Sub

End Class

' デバッグ出力ログクラス
Public Class DebugOutputLog
    Inherits AbstractLog

    ' 抽象ログ出力クラス変数
    Private _abstractLog As AbstractLog

    ' コンストラクタ
    Public Sub New(ByVal abstractLog As AbstractLog)

        Me._abstractLog = abstractLog

    End Sub

    ' ログ出力
    Public Overrides Sub WriteLog(ByVal logMessage As String)

        Me._abstractLog.WriteLog(logMessage)

        ' デバッグ出力にログ出力
        Debug.WriteLine(logMessage)

    End Sub

End Class

' イベントログ出力ログクラス
Public Class EventOutputLog
    Inherits AbstractLog

    ' 抽象ログ出力クラス変数
    Private _abstractLog As AbstractLog

    ' コンストラクタ
    Public Sub New(ByVal abstractLog As AbstractLog)

        Me._abstractLog = abstractLog

    End Sub

    ' ログ出力
    Public Overrides Sub WriteLog(ByVal logMessage As String)

        Me._abstractLog.WriteLog(logMessage)

        ' イベントログにログ出力
        ' ※イベントソースが無い場合は作成する
        If Not EventLog.SourceExists("Masaru") Then
            EventLog.CreateEventSource("Masaru", "TestLog")
        End If
        Dim eLog As New EventLog()
        eLog.Source = "Masaru"
        eLog.WriteEntry(logMessage)

    End Sub

End Class

' 実行コード
Public Shared Sub Main(ByVal args As String())

    Dim stdOutLog As New StandardOutputLog()

    stdOutLog.WriteLog("まさる")

    Dim dbgOutLog As New DebugOutputLog(stdOutLog)

    dbgOutLog.WriteLog("＠わんくま同盟")

    Dim evtOutLog As New EventOutputLog(dbgOutLog)

    evtOutLog.WriteLog("＠雪国っす")

    Console.ReadLine()

End Sub

実行結果

標準出力
デバッグ出力
イベントログ

これでひとまずC#=>VBの変換は終わりです。

今後はC#、VBのコードを同時に掲載しつつ、このシリーズをやっていこうと思います。