SOLID проти статичних методів

Ось проблема, з якою я часто стикаюся: Нехай буде проект веб-магазину, який має клас продукту. Я хочу додати функцію, яка дозволяє користувачам розміщувати відгуки на продукт. Тож у мене є клас Огляд, який посилається на товар. Тепер мені потрібен метод, в якому перераховані всі відгуки до товару. Є дві можливості:

(А)

public class Product {
  ...
  public Collection<Review> getReviews() {...}
}

(B)

public class Review {
  ...
  static public Collection<Review> forProduct( Product product ) {...}
}

Подивившись на код, я вибрав би (A): він не статичний і йому не потрібен параметр. Однак я відчуваю, що (A) порушує Принцип єдиної відповідальності (SRP) та Принцип відкритого закриття (OCP), тоді як (B) не:

• (SRP) Коли я хочу змінити спосіб збирання відгуків для продукту, я повинен змінити клас продукту. Але має бути лише одна причина, чому потрібно змінити клас продукту. І це точно не відгуки. Якщо я упакую кожну функцію, яка має щось спільне з продуктами в Продукті, вона незабаром буде забита.

• (OCP) Я повинен змінити клас продукту, щоб розширити його за допомогою цієї функції. Я думаю, що це порушує частину принципу "Закрито для змін". Перш ніж я отримав запит замовника на реалізацію оглядів, я вважав Продукт готовим і "закрив" його.

Що важливіше: слідувати принципам SOLID або мати більш простий інтерфейс?

Або я взагалі щось не так роблю?

Результат

О, дякую за всі ваші чудові відповіді! Важко вибрати одну як офіційну відповідь.

Дозвольте підсумувати основні аргументи з відповідей:

• pro (A): OCP не є законом і читабельність коду також має значення.
• pro (A): відносини сутності повинні бути судноплавними. Обидва класи можуть знати про цей взаємозв'язок.
• pro (A) + (B): зробіть і те, і делегуйте в (A) - (B), щоб виріб мінявся повторно.
• pro (C): покладіть методи пошуку в третій клас (сервіс) там, де він не є статичним.
• contra (B): перешкоджає глузуванню під час тестів.

Кілька додаткових речей, які сприяли мої коледжі на роботі:

• pro (B): наша рамка ORM може автоматично генерувати код для (B).
• pro (A): з технічних причин нашої системи ORM потрібно буде в деяких випадках змінити "закритий" об'єкт, незалежно від того, куди шукає шукач. Тому я не завжди зможу дотримуватися SOLID.
• contra (C): сильно метушиться ;-)

Висновок

Я використовую обидва (A) + (B) з делегацією для мого поточного проекту. Однак у середовищі, орієнтованій на сервіс, я піду з (C).

Що важливіше: слідувати принципам SOLID або мати більш простий інтерфейс?

Інтерфейс відносно SOLID

Вони не є взаємовиключними. Інтерфейс повинен виражати характер вашої бізнес-моделі в ідеалі з точки зору ділової моделі. Принципи SOLID - це Коан для максимізації об'єктно-орієнтованої кодової ремонтоздатності (і я маю на увазі "ремонтопридатність" у широкому сенсі). Перша підтримує використання та маніпулювання вашою бізнес-моделлю, а остання оптимізує обслуговування коду.

Відкритий / закритий принцип

"не чіпай цього!" є занадто спрощеною інтерпретацією. І якщо припустити, що ми маємо на увазі, що "клас" є довільним, і не обов'язково правильним. Скоріше, OCP означає, що ви створили свій код таким, що зміна його поведінки не вимагає (не повинна) безпосередньо змінювати існуючий, робочий код. Крім того, недоторкання коду в першу чергу є ідеальним способом збереження цілісності існуючих інтерфейсів; на мій погляд, це суттєвий результат ОКП.

Нарешті, я бачу OCP як показник існуючої якості дизайну. Якщо я виявляю, що надто часто тріщить відкриті заняття (або методи) та / або без справжніх (га, га) причин для цього, то це, можливо, говорить про те, що у мене поганий дизайн (і / або я не знати, як кодувати ОО).

Дайте найкраще, у нас є команда лікарів

Якщо аналіз ваших вимог говорить про те, що вам потрібно висловити взаємозв'язок "Огляд продукту" з обох позицій, зробіть це.

Тому, Вольфганг, у вас можуть бути вагомі причини для зміни цих існуючих класів. З огляду на нові вимоги, якщо Огляд тепер є основоположною частиною Продукту, якщо кожне розширення продукту потребує Огляду, якщо це робить код клієнта належним чином виразним, то інтегруйте його в Продукт.

SOLID - це вказівки, тому впливайте на прийняття рішень, а не диктуйте їх.

Одне, що слід пам’ятати при використанні статичних методів, - це їх вплив на тестабельність .

Тестування forProduct(Product product)не складе проблем.

Тестувати щось, що від цього буде, буде.

У вас не буде шва для ізоляції залежного коду під тестом (CUT), щоб використовувати макет, оскільки коли програма працює, статичні методи обов'язково існують.

Будемо мати метод, який називається, CUT()що викликаєforProduct()

Якщо forProduct()це staticви не можете перевірити , CUT()як атомна одиниця і всі тести стають інтеграційні тести , які перевіряють блок логіки.

Невдача в тесті на CUT може бути викликана проблемою в CUT()або в forProduct()(або будь-якому його залежному коді), що усуває переваги діагностики одиничних тестів.

Дивіться цей чудовий пост у блозі для отримання більш детальної інформації: http://googletesting.blogspot.com/2008/12/static-methods-are-death-to-testability.html

Це може призвести до розладу через невдалі тести та відмову від передового досвіду та переваг, що їх оточують.

Якщо ви вважаєте, що Продукт є правильним місцем для пошуку відгуків про товар, ви завжди можете надати продукту клас допомоги, щоб виконати роботу за нього. (Ви можете сказати, тому що ваш бізнес ніколи не буде говорити про огляд, окрім продукту).

Наприклад, я б спокусився ввести щось, що грало роль ретривера. Я, мабуть, дав би йому інтерфейс IRetrieveReviews. Ви можете помістити це в конструктор продукту (залежність впорскування). Якщо ви хочете змінити спосіб отримання оглядів, ви можете це легко зробити, ввівши інший співпрацівник - TwitterReviewRetrieverабо, AmazonReviewRetrieverабо MultipleSourceReviewRetrieverабо що-небудь інше, що вам потрібно.

Зараз обоє несуть єдину відповідальність (будучи передумовою для всіх речей, що стосуються товару, і отримувати огляди відповідно), і в майбутньому поведінку продукту щодо оглядів можна змінити, не змінюючи продукт (ви можете розширити його як ProductWithReviewsякщо б ти справді хотів бути педантичним щодо своїх твердих принципів, але це було б досить добре для мене).

У мене буде клас ProductReview. Ви кажете, що Огляд все одно новий. Це не означає, що це може бути просто будь-що. Це все одно має бути лише одна причина для зміни. Якщо ви зміните спосіб отримання відгуків з будь-якої причини, вам доведеться змінити клас «Огляд».

Це не правильно.

Ви ставите статичний метод у клас Огляд, тому що ... чому? Чи не з цим ти борешся? Чи не в цьому вся проблема?

Тоді не варто. Складіть клас, на який покладається лише огляд продуктів. Потім ви можете підкласифікувати його до ProductReviewsByStartRating, що завгодно. Або підклас, щоб отримати відгуки про клас продуктів.

Я не ставлю функцію "Огляд відгуків про продукт" ні в Productклас, ні в Reviewклас ...

У вас є місце, де ви можете отримати свої продукти, правда? Щось із, GetProductById(int productId)а може, GetProductsByCategory(int categoryId)і так далі.

Крім того, у вас має бути місце для отримання своїх відгуків із GetReviewbyId(int reviewId)позначкою a, а може, і а GetReviewsForProduct(int productId).

Коли я хочу змінити спосіб збирання відгуків для продукту, я повинен змінити клас продукту.

Якщо ви відокремлюєте доступ до даних від класів домену, вам не потрібно буде змінювати жоден клас домену, коли ви змінюєте спосіб збирання оглядів.

Шаблони та принципи - це настанови, а не правила, написані в камені. На мою думку, питання не в тому, чи краще слідувати принципам SOLID або зберігати більш простий інтерфейс. Що ви повинні запитати у себе, це те, що є більш зрозумілим і зрозумілим більшості людей. Часто це означає, що він повинен бути максимально наближений до домену.

У цьому випадку я віддаю перевагу рішенню (B), оскільки для мене відправною точкою є Продукт, а не Огляд, але уявіть, що ви пишете програмне забезпечення для управління оглядами. У цьому випадку центром є Огляд, тому рішення (А) може бути кращим.

Коли у мене є маса таких методів ("з'єднання" між класами), я знімаю їх все зовні і створюю один (або більше) новий статичний клас для їх організації. Зазвичай ви можете бачити їх як запити чи сховища.

Ваш Продукт може просто делегувати ваш метод статичного огляду, і в цьому випадку ви надаєте зручний інтерфейс у природному місці (Product.getReviews), але деталі щодо вашої реалізації містяться в Review.getForProduct.

SOLID - це керівні принципи, і це повинно спричинити простий, розумний інтерфейс. Крім того, ви можете отримати SOLID з простих, розумних інтерфейсів. Вся справа в управлінні залежністю в коді. Мета - мінімізувати залежності, які створюють тертя та створюють бар'єри для неминучих змін.

Я трохи по-іншому сприймаю це питання, ніж більшість інших відповідей. Я думаю, що це Productі Reviewє в основному об'єктами передачі даних (DTO). У своєму коді я намагаюся змусити моїх докторів / організацій уникати поведінки. Вони просто приємний API для зберігання поточного стану моєї моделі.

Коли ви говорите про OO та SOLID, ви, як правило, говорите про "об'єкт", який не представляє стан (обов'язково), а натомість представляє якусь послугу, яка відповідає на запитання для вас, або якій ви можете делегувати частину своєї роботи . Наприклад:

interface IProductRepository
{
    void SaveNewProduct(IProduct product);
    IProduct GetProductById(ProductId productId);
    bool TryGetProductByName(string name, out IProduct product);
}

interface IProduct
{
    ProductId Id { get; }
    string Name { get; }
}

class ExistingProduct : IProduct
{
    public ProductId Id { get; private set; }
    public string Name { get; private set; }
}

Тоді ваші фактичний ProductRepositoryповернення буде ExistingProductдля GetProductByProductIdметоду і т.д.

Тепер ви дотримуєтесь принципу єдиної відповідальності (все, що успадковується IProduct, просто тримається на державі, і все, що успадковується, IProductRepositoryє відповідальним за те, як зберігати та повторно зволожувати вашу модель даних).

Якщо ви зміните схему бази даних, ви можете змінити реалізацію сховища, не змінюючи DTO і т.д.

Отже, коротше кажучи, я думаю, я б не вибрав жоден із ваших варіантів. :)

Статичні методи можуть бути складнішими для перевірки, але це не означає, що ви не можете їх використовувати - вам просто потрібно встановити їх, щоб не потрібно їх тестувати.

Зробіть як product.GetReviews, так і Review.ForProduct методами однієї лінії, які є щось на зразок

new ReviewService().GetReviews(productID);

ReviewService містить все більш складний код і має інтерфейс, призначений для перевірки, але не піддається впливу безпосередньо користувача.

Якщо ви повинні мати 100% охоплення, попросіть ваші тести інтеграції викликати методи продукту / класу огляду.

Це може допомогти, якщо ви думаєте про публічний дизайн API, а не дизайн класів - у цьому контексті важливий простий інтерфейс з логічним групуванням - фактична структура коду має значення лише для розробників.