RubyのSOLID設計原則

Bertrand Meyerは、彼の著書「Object-OrientedSoftwareConstruction」でオープン/クローズド原則を考案しました。

原則として、「ソフトウェアエンティティ（クラス、モジュール、関数など）は、拡張のために開いている必要がありますが、変更のために閉じている必要があります "。これが意味するのは、エンティティを変更せずに動作を変更できる必要があるということです。

上記の例では、従業員に給与明細を送信する機能がありますが、これはすべての従業員にとって非常に一般的です。ただし、新しい要件が発生します。従業員のタイプに基づいて給与明細を生成します。フルタイムの従業員と請負業者には、異なる給与生成ロジックが必要です。この場合、既存のPayrollGeneratorを変更して、次の機能を追加できます。

class PayslipGenerator
  def initialize(employee, month)
    @employee = employee
    @month = month
  end

  def generate_payslip
    # Code to read from database,
    # generate payslip
    if employee.contractor?
        # generate payslip for contractor
    else
        # generate a normal payslip
    end
    # and write it to a file
  end
end

しかし、これは悪いパターンです。その際、既存のクラスを変更します。従業員の契約に基づいて生成ロジックを追加する必要がある場合は、既存のクラスを変更する必要がありますが、そうすると、オープン/クローズの原則に違反します。クラスを変更することにより、意図しない変更を行うリスクがあります。何かが変更または追加されると、既存のコードに不明な問題が発生する可能性があります。これらのif-elseは、同じクラス内のより多くの場所に配置できます。したがって、新しい従業員タイプを追加すると、これらのif-elseが存在する場所を見逃す可能性があります。それらをすべて見つけて変更することはリスクが高く、問題を引き起こす可能性があります。

機能を拡張することで機能を追加できるが、エンティティの変更を回避できるように、このコードをリファクタリングできます。したがって、これらごとに個別のクラスを作成し、同じgenerateを使用してみましょう。 それぞれの方法：

class ContractorPayslipGenerator
  def initialize(employee, month)
    @employee = employee
    @month = month
  end

  def generate
    # Code to read from the database,
    # generate payslip
    # and write it to a file
  end
end

class FullTimePayslipGenerator
  def initialize(employee, month)
    @employee = employee
    @month = month
  end

  def generate
    # Code to read from the database,
    # generate payslip
    # and write it to a file
  end
end

これらのメソッド名が同じであることを確認してください。次に、PayslipGeneratorクラスを変更して、次のクラスを使用します。

GENERATORS = {
  'full_time' => FullTimePayslipGenerator,
  'contractor' => ContractorPayslipGenerator
}

class PayslipGenerator
  def initialize(employee, month)
    @employee = employee
    @month = month
  end

  def generate_payslip
    # Code to read from database,
    # generate payslip
    GENERATORS[employee.type].new(employee, month).generate()
    # and write it to a file
  end
end

ここには、従業員のタイプに基づいて呼び出されるクラスをマップするGENERATORS定数があります。これを使用して、呼び出すクラスを決定できます。これで、新しい機能を追加する必要がある場合、そのための新しいクラスを作成して、GENERATORS定数に追加するだけで済みます。これは、何かを壊したり、既存のロジックについて考える必要なしに、クラスを拡張するのに役立ちます。あらゆるタイプの給与明細ジェネレーターを簡単に追加または削除できます。

Liskov Substitution Principle-LSP

リスコフの置換原則は、「SがTのサブタイプである場合、タイプTのオブジェクトをタイプSのオブジェクトに置き換えることができる」と述べています。 。

この原理を理解するために、まず問題を理解しましょう。オープン/クローズドの原則の下で、ソフトウェアを拡張できるように設計しました。特定の仕事をするサブクラスの給与明細ジェネレーターを作成しました。発信者の場合、呼び出しているクラスは不明です。呼び出し元が違いを認識できないように、これらのクラスは同じ動作をする必要があります。動作とは、クラス内のメソッドが一貫している必要があることを意味します。これらのクラスのメソッドには、次の特性が必要です。

• 同じ名前を持っている
• 同じデータ型で同じ数の引数を取る
• 同じデータ型を返す

給与明細ジェネレータの例を見てみましょう。 2つの発電機があります。1つは正社員用で、もう1つは請負業者用です。ここで、これらの給与明細が一貫した動作をするようにするには、基本クラスからそれらを継承する必要があります。 Userという基本クラスを定義しましょう 。

class User
  def generate
  end
end

オープン/クローズ原則の例で作成したサブクラスには、基本クラスがありませんでした。基本クラスがUserになるように変更します ：

class ContractorPayslipGenerator < User
  def generate
    # Code to generate payslip
  end
end

class FullTimePayslipGenerator < User
  def generate
    # Code to generate payslip
  end
end

次に、Userを継承するサブクラスに必要な一連のメソッドを定義します。 クラス。これらのメソッドは基本クラスで定義します。この場合、必要なのはgenerateという1つのメソッドだけです。

class User
  def generate
    raise "NotImplemented"
  end
end

ここでは、raiseを持つgenerateメソッドを定義しました。 声明。したがって、基本クラスを継承するサブクラスには、generateメソッドが必要です。存在しない場合は、メソッドが実装されていないというエラーが発生します。このようにして、サブクラスに一貫性があることを確認できます。これにより、発信者は常にgenerateを確認できます メソッドが存在します。

この原則は、物事を壊したり、多くの変更を加えたりすることなく、サブクラスを簡単に置き換えるのに役立ちます。

class Generator
  def generate
    raise "NotImplemented"
  end
end

class ContractorPayslipGenerator < Generator
  def generate
    # Code to generate payslip
  end
end

class FullTimePayslipGenerator < Generator
  def generate
    # Code to generate payslip
  end
end

class UserReader
  def get
    raise "NotImplemented"
  end
end

class PostgresUserReader < UserReader
  def get
    # Code to read data from Postgres
  end
end

class FullTimePayslipGenerator < Generator
  def initialize(datasource)
    @datasource = datasource
  end

  def generate
    # Code to generate payslip
    data = datasource.get()
  end
end

datasource = PostgresUserReader.new()
FullTimePayslipGenerator.new(datasource)

class PostgresUserReader < UserReader
  def initialize(config)
    config = config
  end

  def get
    # initialize DB with the config
    self.config
    # Code to read data from Postgres
  end
end

  config = { url: "url", user: "user" }
  datasource = PostgresUserReader.new(config)
  FullTimePayslipGenerator.new(datasource)