見出し画像

C#初心者を卒業しよう(第５回)リファクタリングその２ Strategy

polluces

はじめに

　今回は、前回のサンプルプログラムを Strategy パターンを使ってさらにリファクタリングします。Strategy は GoF(Gang of Four) のパターンで、アルゴリズムを容易に切り替えられる様にします。

Strategy

Create() の引数を変更して単純化する

protected virtual IDistance? Create(Type convertType) =>
    (IDistance?)serviceProvider.GetService(convertType);

変換種別(ConvertNumber)を Key に Dictionary を作成する

　Dictionary の Value に設定するクラスを作成します。

public class ConvertValues
{
    public Type ConvertType { get; }
    public string ConvertMessage { get; }

    public ConvertValues(Type convertType, string convertMessage)
    {
        ConvertType = convertType;
        ConvertMessage = convertMessage;
    }
}

　Const クラスに Dictionary を追加します。

public static readonly IReadOnlyDictionary<ConvertNumber, ConvertValues> CONVERT_VALUE_DIC =
    new Dictionary<ConvertNumber, ConvertValues>
{
    {
        ConvertNumber.ToYards,
        new ConvertValues(
            typeof(ToYards),
            $"{(int)ConvertNumber.ToYards} : Convert meters to yards.")
    },
    {
        ConvertNumber.ToMeters,
        new ConvertValues(
            typeof(ToMeters),
            $"{(int)ConvertNumber.ToMeters} : Convert yards to meters.")
    },
};

　呼び出し側も変更します。
　まずは Create() の引数を変更します。

        var distanceObject =
            Create(Const.CONVERT_VALUE_DIC[convertNumber].ConvertType) ??
                throw new NotImplementedException(
                    "Faild to create 'IDistance' object.");

　次に InputConvertNumber() を変更します。

    protected virtual ConvertNumber InputConvertNumber()
    {
        Console.WriteLine("Please input convert number.");
        foreach (var value in Const.CONVERT_VALUE_DIC.Values)
        {
            Console.WriteLine(value.ConvertMessage);
        }
        if (Enum.TryParse(
                typeof(ConvertNumber),
                Console.ReadLine(),
                out var convertNumber))
        {
            if (Enum.IsDefined(typeof(ConvertNumber), convertNumber))
            {
                return (ConvertNumber)convertNumber;
            }
            throw new IndexOutOfRangeException(
                $"Input is out of range. {(int)convertNumber}");
        }
        throw new FormatException("Invalid input convert number.");
    }

ソース全体

using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;

HostApplicationBuilder builder = Host.CreateApplicationBuilder(args);
builder.Services
    .AddTransient<DistanceService>()
    .AddScoped<ToYards>()
    .AddScoped<IDistance, ToYards>()
    .AddScoped<ToMeters>()
    .AddScoped<IDistance, ToMeters>();
using IHost host = builder.Build();

var service = host.Services.GetService<DistanceService>() ??
    throw new NotImplementedException(
        "Faild to create 'DistanceService' object.");
service.Run();

public enum ConvertNumber
{
    ToYards = 1,
    ToMeters = 2,
}

public class ConvertValues
{
    public Type ConvertType { get; }
    public string ConvertMessage { get; }

    public ConvertValues(Type convertType, string convertMessage)
    {
        ConvertType = convertType;
        ConvertMessage = convertMessage;
    }
}

public class Const
{
    public static readonly double METER_TO_YARD = 1.0936133d;

    public static readonly IReadOnlyDictionary<ConvertNumber, ConvertValues> CONVERT_VALUE_DIC =
        new Dictionary<ConvertNumber, ConvertValues>
    {
        {
            ConvertNumber.ToYards,
            new ConvertValues(
                typeof(ToYards),
                $"{(int)ConvertNumber.ToYards} : Convert meters to yards.")
        },
        {
            ConvertNumber.ToMeters,
            new ConvertValues(
                typeof(ToMeters),
                $"{(int)ConvertNumber.ToMeters} : Convert yards to meters.")
        },
    };
}

public class DistanceService(IServiceProvider serviceProvider)
{
    public void Run()
    {
        var convertNumber = InputConvertNumber();
        var distanceObject =
            Create(Const.CONVERT_VALUE_DIC[convertNumber].ConvertType) ??
                throw new NotImplementedException(
                    "Faild to create 'IDistance' object.");

        var distance = InputDistance();
        distanceObject.Calculate(distance);

        OutputAnswer(distanceObject);
    }

    protected virtual ConvertNumber InputConvertNumber()
    {
        Console.WriteLine("Please input convert number.");
        foreach (var value in Const.CONVERT_VALUE_DIC.Values)
        {
            Console.WriteLine(value.ConvertMessage);
        }
        if (Enum.TryParse(
                typeof(ConvertNumber),
                Console.ReadLine(),
                out var convertNumber))
        {
            if (Enum.IsDefined(typeof(ConvertNumber), convertNumber))
            {
                return (ConvertNumber)convertNumber;
            }
            throw new IndexOutOfRangeException(
                $"Input is out of range. {(int)convertNumber}");
        }
        throw new FormatException("Invalid input convert number.");
    }

    protected virtual IDistance? Create(Type convertType) =>
        (IDistance?)serviceProvider.GetService(convertType);

    protected virtual double InputDistance()
    {
        Console.WriteLine("Please input distance.");
        if (double.TryParse(Console.ReadLine(), out var distance))
        {
            return distance;
        }
        throw new FormatException("Invalid input distance.");
    }

    protected virtual void OutputAnswer(IDistance distance)
    {
        var outputMessage = distance.CreateAnswerMessage();
        Console.WriteLine(outputMessage);
    }
}

public interface IDistance
{
    void Calculate(double distance);
    string CreateAnswerMessage();
}

public class ToMeters : IDistance
{
    private double _yards;
    private double _meters;

    public void Calculate(double yards)
    {
        _yards = yards;
        _meters = yards / Const.METER_TO_YARD;
    }

    public string CreateAnswerMessage()
    {
        return $"{_yards} yards is {_meters} meters.";
    }
}

public class ToYards : IDistance
{
    private double _yards;
    private double _meters;

    public void Calculate(double meters)
    {
        _meters = meters;
        _yards = meters * Const.METER_TO_YARD;
    }

    public string CreateAnswerMessage()
    {
        return $"{_meters} meters is {_yards} yards.";
    }
}

ダウンロード

　ダウンロード用に置いてあるものは、クラスごとにファイルを分けてあります。

練習問題

　より理解を深めるために、以下の練習問題に取り組んでみてください。

練習問題 05

　今回の練習問題も、前回と全く同じです。

　このサンプルプログラムに
「メートル」を「フィート」に、
「フィート」を「メートル」に
変換できる機能を追加してください。

　機能を追加したら、前回の練習問題で作成したプログラムと比較してみてください。

おわりに

　ここまでリファクタリングした事によって、練習問題05 のような場合にはプログラムロジックを変更せずに追加出来るようになりました。
　次回は SOLID原則の S Single-responsibility principle (単一責務の原則) に従うようにリファクタリングします。


よろしければサポートをお願いします。 いただいたサポートは、書籍代、開発機器購入などに充てさせていただきます。