Именование сущностей

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

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

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

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

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

· Имя сущности должно быть существительным или словосочетанием на основе существительного в единственном числе. Используйте ПЕРСОНА вместо ПЕРСОНЫ или ЛЮДИ, и КОНТЕЙНЕР – вместо КОНТЕЙНЕРЫ.

· Имя сущности должно быть уникальным. Использование одинаковых имен для сущностей, содержащих различные данные, или разных имен для сущностей, содержащих одинаковые данные, будет без необходимости вводить в заблуждение разработчиков и конечных пользователей.

· Имя сущности должно указывать на данные, которые будут храниться в каждом из экземпляров.

· Имя сущности не должно содержать специальных символов (таких как !, @, #, $, %, &, * и тому подобных) или указывать на принадлежность (МОРОЖЕНОЕ ПЕРСОНЫ).

· Имя сущности не должно содержать акронимов или аббревиатур, если только они не являются частью принятых соглашений об именовании.

Всегда лучше использовать единообразные имена в рамках корпорации. В табл. П1 приведены примеры хороших и плохих имен для сущностей.

Таблица П1

Примеры имен сущностей с объяснениями

Хорошее имя Неудачное имя Пояснение
МАТЕМАТИЧЕСКАЯ ФОРМУЛА ФОРМУЛА ФОРМУЛА – слишком расплывчато, добавление прилагательного МАТЕМАТИЧЕСКАЯ значительно проясняет смысл.
КНИГА КНИГИ КНИГА – существительное в единственном числе.
СОФА КУШЕТКА СОФА . СОФА и КУШЕТКА имеют одинаковый смысл. Выберите что-то одно
МОРОЖЕНОЕ КАКОЕ-ТО МОРОЖЕНОЕ Местоимение КАКОЕ-ТО не привносит дополнительного значения или смысла к термину. Избегайте излишних дополнений.
ФОТОСНИМОК ИЗОБРАЖЕНИЕ ФОТОСНИМОК – достаточно определенно. ИЗОБРАЖЕНИЕ – несколько расплывчато.
ОЖИДАЕМОЕ ВРЕМЯ ПРИБЫТИЯ ОВП Аббревиатура ОВП может оказаться непонятной для пользователей.
КОМПАНИЯ КОМПАНИЯ XYZ XYZ – конкретный экземпляр компании и должен быть строкой в сущности КОМПАНИЯ.

Наши рекомендации