Должны ли вы переслать объявление как можно больше?

Question

В Effective Objective-C, Matt Galloway предлагает следующее:..

«Всегда импорт заголовков в очень глубокой точке возможного Это обычно означает, вперед объявляя классы в заголовке и импортировать их соответствующие заголовки в реализации Это позволяет избежать классов сцепные вместе как можно больше."

Проблема с широким использованием этого практического проекта заключается в том, что все, что использует ваш класс, должно будет также импортировать класс декларации вперед. Это, по-видимому, является недостатком для клиента только для того, чтобы избежать потенциально увеличенного времени компиляции. Уменьшение сцепления также не имеет смысла, поскольку в силу использования прямого объявления связь уже установлена. Является ли это предложение хорошей практикой?

Answer 1

Проблема с использованием этого практического проекта в широком смысле заключается в том, что все, что использует ваш класс, должно будет также импортировать класс декларации вперед.

Я думаю, вы поняли советовать Мэтта: идея заключается в том, чтобы направить, объявить класс вместе с классом, который использует его в своей декларации, так что ваш заголовок остается использовать самостоятельно, не требуя ваших клиентов делать что-нибудь особенное.

Вот краткий пример: допустим, вы хотите использовать класс SingleWidget в своем классе DoubleWidget. Однако интерфейс, который предоставляет ваш класс, всегда использует SingleWidget через указатель или через ссылку; только реализация вызывает методы SingleWidget. Предложение Мэтта это сделать это

DoubleWidget.h

// Use forward declaration in the header 
class SingleWidget; 

class DoubleWidget { 
    SingleWidget &one; 
    SingleWidget &two; 
public: 
    DoubleWidget(SingleWidget& a, SingleWidget& b) : one(a), two(b) {} 
    void play(); 
}; 

DoubleWidget.cpp

#include "SingleWidget.h" 
// Include the header when you cannot avoid including it 
#include "DoubleWidget.h" 

void DoubleWidget::play() { 
    one.play(); 
    two.play(); 
} 

вместо этого:

DoubleWidget.h

// Do not include the header where a forward declaration is sufficient 
#include "SingleWidget.h" 

class DoubleWidget { 
    SingleWidget &one; 
    SingleWidget &two; 
public: 
    DoubleWidget(SingleWidget& a, SingleWidget& b) : one(a), two(b) {} 
    void play(); 
}; 

DoubleWid get.cpp

#include "DoubleWidget.h" 

void DoubleWidget::play() { 
    one.play(); 
    two.play(); 
} 

Обратите внимание, что в обоих случаях достаточно для пользователей вашего DoubleWidget класса включают DoubleWidget.h заголовок. Однако во втором случае пользователи также получают полное определение класса SingleWidget, не запрашивая его.

Сокращение сцепления также не имеет смысла, поскольку в силу использования прямого декларирования муфта уже установлена.

У вас есть какая-то связь там, но она очень слабая: ваш класс знает, что существует другой класс, и это все. Напротив, когда вы включаете заголовок, ваш класс знает все о другом классе: он знает его структуру, функции-члены, классы, на которые полагается другой класс, и т. Д. Это хорошая идея не «сбрасывать» всю эту информацию в открытый интерфейс вашего собственного класса.