В результате паттерны и рефакторинги начинают втыкать везде где только получается, с соответствующим поганым результатом.
Вот типичный пример «из книжки»:
public abstract class Animal
{
// Some code
}
public class Dog : Animal
{
public void Woof()
{
Console.WriteLine("Woof!");
}
// Some other code
}
public class Sparrow : Animal
{
public void Tweet()
{
Console.WriteLine("Tweet!");
}
// Some other code
}
public class Orca : Animal
{
public void Roar()
{
Console.WriteLine("Roar!");
}
// Some other code
}
public class Usage
{
public static void Talk(Animal animal)
{
if (animal is Sparrow)
{
var sparrow = (Sparrow) animal;
sparrow.Tweet();
}
else if (animal is Dog)
{
var dog = (Dog)animal;
dog.Woof();
}
else if (animal is Orca)
{
var orca = (Orca)animal;
orca.Roar();
}
else
{
throw new InvalidOperationException();
}
}
// Some other code
}
И любой программист семейства хомяковых, читавший про замену условной логики полиморфизмом, конечно же знает, что это плохой код. А хороший, объектно-ориентированный, выглядит так:public abstract class Animal
{
public abstract void Talk();
// Some other code
}
public class Dog : Animal
{
public override void Talk()
{
Console.WriteLine("Woof!");
}
// Some other code
}
public class Sparrow : Animal
{
public override void Talk()
{
Console.WriteLine("Tweet!");
}
// Some other code
}
public class Orca : Animal
{
public override void Talk()
{
Console.WriteLine("Roar!");
}
// Some other code
}
public class Usage
{
public static void Talk(Animal animal)
{
animal.Talk();
}
// Some other code
}
А вот типичный пример из жизни:
public abstract class Animal
{
// Some code
}
public class Dog : Animal
{
public void Woof()
{
Console.WriteLine("Woof!");
}
// Some other code
}
public class Sparrow : Animal
{
public void Tweet()
{
Console.WriteLine("Tweet!");
}
// Some other code
}
public class Cockroach : Animal
{
// Some code
}
public class Starfish : Animal
{
// Some code
}
public class Usage
{
public static void Talk(Animal animal)
{
if (animal is Dog) {
var dog = (Dog)animal;
dog.Woof();
}
}
// Some other code
}
От предыдущего примера этот отличает один принципиальный момент.
В первом случае условная логика фиктивна. Контракт, несмотря на ее, условной логики, наличие, неявно подразумевает, что все животные издают звуки. Т.е. условная логика используется для того, чтобы обобщить несколько методов. И полиморфизм здесь как нельзя кстати.
А вот во втором случае условная логика вполне себе осмысленна: если животное - собака, то пусть гавкнет. Причем на данном этапе жизни этого куска кода условие не подлежит никакому обобщению, и для его выполнения полностью достаточно публичного контракта. Поэтому этот код в рефакторинге не нуждается. По крайней мере не сам по себе. Вообще, на практике появление таких единичных даункастингов является следствием сделанных ранее по иерархии вызовов апкастингов. Поэтому правильный рефакторинг в данном случае затронет очень много кода, и не исключено, что в итоге он снизит читаемость и усложнит сопровождение. Прибавляя к этому время на сам рефакторинг, всегда надо подумать, нужен ли такой рефакторинг вообще.
На всякий случай покажу то говнище, которое получится, если во втором примере применить замену условной логики полиморфизмом аналогично первому:
public abstract class Animal
{
public abstract void Talk();
// Some other code
}
public class Dog : Animal
{
public override void Talk()
{
Console.WriteLine("Woof!");
}
// Some other code
}
public class Sparrow : Animal
{
public void Tweet()
{
Console.WriteLine("Tweet!");
}
public override void Talk()
{
}
// Some other code
}
public class Cockroach : Animal
{
public override void Talk()
{
}
// Some other code
}
public class Starfish : Animal
{
public override void Talk()
{
}
// Some other code
}
public class Usage
{
public static void Talk(Animal animal)
{
animal.Talk();
}
// Some other code
}
Получившийся пиздец фееричен и многогранен:
- Кода стало в несколько раз больше.
- Классы обзавелись методами с пустыми телами, которые в добавок к своей полной бесполезности еще и публичные.
- Нарушен принцип подстановки Лисков. Например, результат вызова метода Talk для объекта типа Sparrow отличается от ожидаемого.
- Нарушен принцип публичного контракта. Логика, которая до этого целиком размещалась вне иерархии классов, теперь размазана по всей этой иерархии ровным жидким слоем.
- И самое главное - по пизде пошел контракт. Если раньше это было «если животное - собака, то пусть гавкнет», то теперь стало что-то вроде ... эм ... бля, я даже не знаю как это описать!
Теперь пример чуть посложнее. По сути, это «плохой» вариант «хорошего» примера из Фаулера:
public class Employee
{
// Some other code
}
public class Waiter : Employee
{
public decimal HourlyWage { get; set; }
public decimal MaximumHoursPerMonth { get; set; }
public decimal HoursPerMonth { get; set; }
public decimal Bonus { get; set; }
// Some other code
}
public class Headwaiter : Waiter
{
public decimal BonusMonthlySalaryRatio { get; set; }
// Some other code
}
public class Cashier : Employee
{
public decimal MonthlySalary { get; set; }
public decimal Bonus { get; set; }
// Some other code
}
public class Cleaner : Employee
{
public decimal MonthlySalary { get; set; }
// Some other code
}
public class Manager : Employee
{
public decimal MonthlySalary { get; set; }
public decimal MonthlySalaryRatio { get; set; }
public bool IsEffective { get; set; }
// Some other code
}
public class Calculations
{
public static decimal GetPaymentAmount(Employee employee)
{
if (employee is Headwaiter)
{
var hw = (Headwaiter) employee;
return hw.HoursPerMonth > hw.MaximumHoursPerMonth
? (hw.HourlyWage*hw.MaximumHoursPerMonth + hw.Bonus)
*hw.BonusMonthlySalaryRatio
: hw.HourlyWage*hw.HoursPerMonth + hw.Bonus;
}
else if (employee is Waiter)
{
var w = (Waiter) employee;
var hours = Math.Min(w.HoursPerMonth, w.MaximumHoursPerMonth);
return w.HourlyWage*hours + w.Bonus;
}
else if (employee is Cashier)
{
var c = (Cashier) employee;
return c.MonthlySalary + c.Bonus;
}
else if (employee is Cleaner)
{
var c = (Cleaner) employee;
return c.MonthlySalary;
}
else if (employee is Manager)
{
var m = (Manager) employee;
return m.IsEffective
? m.MonthlySalary*m.MonthlySalaryRatio
: m.MonthlySalary;
}
else
{
throw new InvalidOperationException();
}
}
// Some other code
}
От примера Фаулера этот отличают две вещи: вычисление полностью базируется на публичном контракте (и находится вне иерархии) и необходимые для проведения вычисления свойства раскиданы по иерархии, а не собраны в базовом классе.C одной стороны очевидно, что код нуждается в рефакторинге. С другой, если безмозгло применить подход из примера 1, снова получится нарушение принципов замещения Лисков и открытого контракта.
На самом деле, рефакторинг сложнее ровно на одно действие - нужно вычленить из метода GetPaymentAmount ту часть, которая нуждается в замене на полиморфизм. Для этого в данном конкретном случае достаточно несколько раз применить Extract Method:
public class Calculations
{
public static decimal GetPaymentAmount(Employee employee)
{
if (employee is Headwaiter)
return GetHeadwaiterPaymentAmount((Headwaiter) employee);
if (employee is Waiter)
return GetWaiterPaymentAmount((Waiter) employee);
if (employee is Cashier)
return GetCashierPaymentAmount((Cashier) employee);
if (employee is Cleaner)
return GetCleanerPaymentAmount((Cleaner) employee);
if (employee is Manager)
return GetManagerPaymentAmount((Manager) employee);
throw new InvalidOperationException();
}
public static decimal GetHeadwaiterPaymentAmount(Headwaiter hw)
{
return hw.HoursPerMonth > hw.MaximumHoursPerMonth
? (hw.HourlyWage * hw.MaximumHoursPerMonth + hw.Bonus)
* hw.BonusMonthlySalaryRatio
: hw.HourlyWage * hw.HoursPerMonth + hw.Bonus;
}
public static decimal GetWaiterPaymentAmount(Waiter w)
{
var hours = Math.Min(w.HoursPerMonth, w.MaximumHoursPerMonth);
return w.HourlyWage * hours + w.Bonus;
}
public static decimal GetCashierPaymentAmount(Cashier c)
{
return c.MonthlySalary + c.Bonus;
}
public static decimal GetCleanerPaymentAmount(Cleaner c)
{
return c.MonthlySalary;
}
public static decimal GetManagerPaymentAmount(Manager m)
{
return m.IsEffective
? m.MonthlySalary * m.MonthlySalaryRatio
: m.MonthlySalary;
}
// Some other code
}
И вот теперь метод GetPaymentAmount можно подвергнуть желанной процедуре:
public abstract class Employee
{
public abstract decimal GetPaymentAmount();
// Some other code
}
public class Waiter : Employee
{
public decimal HourlyWage { get; set; }
public decimal MaximumHoursPerMonth { get; set; }
public decimal HoursPerMonth { get; set; }
public decimal Bonus { get; set; }
public override decimal GetPaymentAmount()
{
return PaymentCalculations.GetWaiterPaymentAmount(this);
}
// Some other code
}
public class Headwaiter : Waiter
{
public decimal BonusMonthlySalaryRatio { get; set; }
public override decimal GetPaymentAmount()
{
return PaymentCalculations.GetHeadwaiterPaymentAmount(this);
}
// Some other code
}
public class Cashier : Employee
{
public decimal MonthlySalary { get; set; }
public decimal Bonus { get; set; }
public override decimal GetPaymentAmount()
{
return PaymentCalculations.GetCashierPaymentAmount(this);
}
// Some other code
}
public class Cleaner : Employee
{
public decimal MonthlySalary { get; set; }
public override decimal GetPaymentAmount()
{
return PaymentCalculations.GetCleanerPaymentAmount(this);
}
// Some other code
}
public class Manager : Employee
{
public decimal MonthlySalary { get; set; }
public decimal MonthlySalaryRatio { get; set; }
public bool IsEffective { get; set; }
public override decimal GetPaymentAmount()
{
return PaymentCalculations.GetManagerPaymentAmount(this);
}
// Some other code
}
public class PaymentCalculations
{
public static decimal GetPaymentAmount(Employee employee)
{
return employee.GetPaymentAmount();
}
public static decimal GetHeadwaiterPaymentAmount(Headwaiter hw)
{
return hw.HoursPerMonth > hw.MaximumHoursPerMonth
? (hw.HourlyWage * hw.MaximumHoursPerMonth + hw.Bonus)
* hw.BonusMonthlySalaryRatio
: hw.HourlyWage * hw.HoursPerMonth + hw.Bonus;
}
public static decimal GetWaiterPaymentAmount(Waiter w)
{
var hours = Math.Min(w.HoursPerMonth, w.MaximumHoursPerMonth);
return w.HourlyWage * hours + w.Bonus;
}
public static decimal GetCashierPaymentAmount(Cashier c)
{
return c.MonthlySalary + c.Bonus;
}
public static decimal GetCleanerPaymentAmount(Cleaner c)
{
return c.MonthlySalary;
}
public static decimal GetManagerPaymentAmount(Manager m)
{
return m.IsEffective
? m.MonthlySalary * m.MonthlySalaryRatio
: m.MonthlySalary;
}
}
В результате:
- Фиктивная условная логика заменена полиморфизмом.
- Неявный контракт стал явным. Теперь на этапе компиляции будет контроллироваться, что для всех сотрудников есть расчет зарплаты.
- Метод GetPaymentAmount распался на атомарные методы, которые проще покрывать тестами. И теперь его вообще можно выкинуть, обращаясь напрямую к методу Employee.GetPaymentAmount.
- Вся логика рассчета зарплаты находится в одном месте, классе PaymentCalculations (функциональная кохессия).
- В иерархию внесено минимум дополнительного кода.
Есть правда несколько открытых моментов. Например, должны ли классы иерархии сами выбирать метод реализации, или же он должен выбираться через IoC-контейнер. Или же насколько публичными должны быть методы PaymentCalculations, и не надо ли его вообще раздробить на что-то более атомарное. Но это уже другие, отдельные темы.
P.S.: К этому посту открыты комментарии. Цель - собрать еще интересные примеры условной логики с проверкой типов, и может быть по результатам сделать еще один пост.
P.S.S.: Комментарии премодерируются.
Комментариев нет:
Отправить комментарий