C#初心者を卒業しよう(第7回)Dependency-inversion principle

2024年4月15日 23:43

はじめに

　今回は SOLID 原則の「D」Dependency-inversion principle (依存性逆転の原則)に従ってサンプルプログラムをリファクタリングしていきます。

解説

　この原則に従うなら、インターフェースに依存しなければなりませんが、前回そのように作らなかったので、ここでリファクタリングします。

変換種別の入力インターフェースを作成

public interface IInputConvertNumber
{
    public string? ReadConvertNumber();
}

　このインターフェースに依存するように InputConvertNumber クラスを書き換えます。

public class InputConvertNumber : IInputConvertNumber

　呼び出し側を変更します。

var inputConvertNumber =
    (IInputConvertNumber?)serviceProvider.GetService(typeof(InputConvertNumber)) ??
        throw new NotImplementedException(
            "Faild to create 'InputConvertNumber' object.");

　DI コンテナに登録します。

HostApplicationBuilder builder = Host.CreateApplicationBuilder(args);
builder.Services
    .AddTransient<DistanceService>()
    .AddScoped<InputConvertNumber>()
    .AddScoped<IInputConvertNumber, InputConvertNumber>()
    .AddScoped<InputDistance>()
    .AddScoped<OutputAnswer>()
    .AddScoped<ToYards>()
    .AddScoped<IDistance, ToYards>()
    .AddScoped<ToMeters>()
    .AddScoped<IDistance, ToMeters>();

距離の入力インターフェースを作成

public interface IInputConvertNumber
{
    string? ReadConvertNumber();
}

　このインターフェースに依存するように InputDistance クラスを書き換えます。

public class InputDistance : IInputDistance

　呼び出し側を変更します。

var inputDistance =
    (IInputDistance?)serviceProvider.GetService(typeof(InputDistance)) ??
        throw new NotImplementedException(
            "Faild to create 'InputDistance' object.");

　DI コンテナに登録します。

HostApplicationBuilder builder = Host.CreateApplicationBuilder(args);
builder.Services
    .AddTransient<DistanceService>()
    .AddScoped<InputConvertNumber>()
    .AddScoped<IInputConvertNumber, InputConvertNumber>()
    .AddScoped<InputDistance>()
    .AddScoped<IInputDistance, InputDistance>()
    .AddScoped<OutputAnswer>()
    .AddScoped<ToYards>()
    .AddScoped<IDistance, ToYards>()
    .AddScoped<ToMeters>()
    .AddScoped<IDistance, ToMeters>();

答えの出力インターフェースを作成

public interface IOutputAnswer
{
    void WriteAnswer(string message);
}

　このインターフェースに依存するように OutputDistance クラスを書き換えます。

public class OutputConsole : IOutputAnswer

　呼び出し側を変更します。

var outputAnswer =
    (IOutputAnswer?)serviceProvider.GetService(typeof(OutputConsole)) ??
        throw new NotImplementedException(
            "Faild to create 'OutputAnswer' object.");

　DI コンテナに登録します。

HostApplicationBuilder builder = Host.CreateApplicationBuilder(args);
builder.Services
    .AddTransient<DistanceService>()
    .AddScoped<InputConvertNumber>()
    .AddScoped<IInputConvertNumber, InputConvertNumber>()
    .AddScoped<InputDistance>()
    .AddScoped<IInputDistance, InputDistance>()
    .AddScoped<OutputConsole>()
    .AddScoped<IOutputAnswer, OutputConsole>()
    .AddScoped<ToYards>()
    .AddScoped<IDistance, ToYards>()
    .AddScoped<ToMeters>()
    .AddScoped<IDistance, ToMeters>();

プログラム全体

　Program.cs

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

HostApplicationBuilder builder = Host.CreateApplicationBuilder(args);
builder.Services
    .AddTransient<DistanceService>()
    .AddScoped<InputConvertNumber>()
    .AddScoped<IInputConvertNumber, InputConvertNumber>()
    .AddScoped<InputDistance>()
    .AddScoped<IInputDistance, InputDistance>()
    .AddScoped<OutputAnswer>()
    .AddScoped<IOutputAnswer, OutputAnswer>()
    .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 interface IDistance
{
    void Calculate(double distance);
    string CreateAnswerMessage();
}

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()
    {
        var inputConvertNumber =
            (IInputConvertNumber?)serviceProvider.GetService(typeof(InputConvertNumber)) ??
                throw new NotImplementedException(
                    "Faild to create 'InputConvertNumber' object.");
        if (Enum.TryParse(
                typeof(ConvertNumber),
                inputConvertNumber.ReadConvertNumber(),
                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()
    {
        var inputDistance =
            (IInputDistance?)serviceProvider.GetService(typeof(InputDistance)) ??
                throw new NotImplementedException(
                    "Faild to create 'InputDistance' object.");
        if (double.TryParse(inputDistance.ReadDistance(), out var distance))
        {
            return distance;
        }
        throw new FormatException("Invalid input distance.");
    }

    protected virtual void OutputAnswer(IDistance distance)
    {
        var outputMessage = distance.CreateAnswerMessage();
        var outputAnswer =
            (IOutputAnswer?)serviceProvider.GetService(typeof(OutputAnswer)) ??
                throw new NotImplementedException(
                    "Faild to create 'OutputAnswer' object.");
        outputAnswer.WriteAnswer(outputMessage);
    }
}

public interface IInputConvertNumber
{
    string? ReadConvertNumber();
}

public class InputConvertNumber : IInputConvertNumber
{
    public string? ReadConvertNumber()
    {
        Console.WriteLine("Please input convert number.");
        foreach (var value in Const.CONVERT_VALUE_DIC.Values)
        {
            Console.WriteLine(value.ConvertMessage);
        }
        return Console.ReadLine();
    }
}

public interface IInputDistance
{
    string? ReadDistance();
}

public class InputDistance : IInputDistance
{
    public string? ReadDistance()
    {
        Console.WriteLine("Please input distance.");
        return Console.ReadLine();
    }
}

public interface IOutputAnswer
{
    void WriteAnswer(string message);
}

public class OutputAnswer : IOutputAnswer
{
    public void WriteAnswer(string message)
    {
        Console.WriteLine(message);
    }
}

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.";
    }
}

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.";
    }
}

ダウンロード

練習問題

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

練習問題06

　このサンプルプログラムの出力先をファイルと切り替えられるようにしてください。

おわりに

　今回のリファクタリングで入出力の切り替えができるようになりました。
　長かったこのサンプルプログラムによるシリーズもここで終了です。
　次回からは新しいサンプルプログラムになります。

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