Должен ли я включить геттеры и сеттеры в диаграмму классов?

Question

Мне необходимо нарисовать диаграмму классов для моего приложения JSF для проектной документации.Таким образом, у меня есть много классов в виде управляемых bean-компонентов, со многими атрибутами, поэтому у меня много методов получения и установки.

Когда я рисую диаграмму классов, я должен также включить в диаграмму методы получения и установки или я могу просто оставить их?

Answer 1

Неуместно включать их. Вы можете просто добавить одну строку, говоря методы доступа

Answer 2

Включение геттеров и сеттеров было бы плохой идеей. Они тратят «недвижимость» на дублирование информации, которая уже показана в разделе атрибутов / свойств класса.

Answer 3

Вы не должны включать геттеры и сеттеры в свою диаграмму, пока они не сделают что-то особенное: проверку на ноль и так далее.Но это признак плохого дизайна, поэтому общий ответ - «Нет, не стоит».

Answer 4

Может быть полезно сделать соглашение о получении / установщике явным для соответствующих свойств, создав собственные стереотипы «получить / установить» и «получить», которые будут использоваться для классификации этих частных свойств. См. Мой ответ на Ярлык для обозначения или включения геттеров и сеттеров в диаграммах классов UML .

Answer 5

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

если ваше свойство реализовано с помощью закрытой переменной и пары методов получения и установки с одинаковой видимостью, вы просто создаете свойство с этой видимостью.

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

и так, сын ...