Соглашение о конфигурации (также известное как кодирование по соглашению ) — это парадигма проектирования программного обеспечения, используемая программными платформами , которая пытается уменьшить количество решений, которые разработчик, использующий структуру, должен принимать, не теряя при этом гибкости и не повторяясь (DRY ) принципы. [1]
Эта концепция была введена Дэвидом Хайнемейером Ханссоном для описания философии веб-фреймворка Ruby on Rails , но она связана с более ранними идеями, такими как концепция «разумных значений по умолчанию » и принцип наименьшего удивления в дизайне пользовательского интерфейса .
По сути, эта фраза означает, что разработчику нужно указать только нетрадиционные аспекты приложения. Например, если в модели есть класс Продажи, соответствующая таблица в базе данных по умолчанию называется «Продажи». Только в том случае, если кто-то отклоняется от этого соглашения, например, от таблицы «Продажи продукции», необходимо писать код, касающийся этих имен.
Когда соглашение, реализованное инструментом, соответствует желаемому поведению, он ведет себя так, как ожидалось, без необходимости записи файлов конфигурации. Только когда желаемое поведение отличается от реализованного соглашения, требуется явная настройка.
Использование этой фразы в Ruby on Rails особенно сосредоточено на структуре файла проекта и каталогов по умолчанию, что избавляет разработчиков от необходимости писать файлы конфигурации XML , чтобы указать, какие модули должна загружать платформа, что было обычным явлением во многих более ранних платформах.
Недостатки подхода, основанного на соглашении по сравнению с конфигурацией, могут возникать из-за конфликтов с другими принципами проектирования программного обеспечения, такими как принцип Дзен Python «явное лучше, чем неявное». Программная среда, основанная на соглашении о конфигурации, часто включает предметно-ориентированный язык с ограниченным набором конструкций или инверсию управления , в которой разработчик может влиять на поведение только с помощью ограниченного набора перехватчиков , и то и другое может затруднить реализацию поведения. выразить с помощью предоставленных соглашений сложнее, чем при использовании библиотеки программного обеспечения , которая не пытается уменьшить количество решений, которые должны принимать разработчики, или не требует инверсии управления.
Другие методы уменьшения количества решений, которые должен принимать разработчик, включают в себя идиомы программирования и библиотеки конфигурации с многоуровневой архитектурой .
Некоторым платформам требуется несколько файлов конфигурации, каждый из которых содержит множество настроек. Они предоставляют информацию, специфичную для каждого проекта, начиная от URL-адресов и заканчивая сопоставлениями между классами и таблицами базы данных. Многие файлы конфигурации со множеством параметров часто сложно поддерживать.
Например, ранние версии Java-сопоставителя персистентности Hibernate сопоставляли сущности и их поля с базой данных, описывая эти связи в XML-файлах. Большую часть этой информации можно было бы получить путем традиционного сопоставления имен классов с таблицами базы данных с одинаковыми именами , а полей с их столбцами соответственно. Более поздние версии отказались от файла конфигурации XML и вместо этого использовали эти самые соглашения, отклонения от которых можно указать с помощью аннотаций Java (см. спецификацию JavaBeans, ссылку ниже).
Многие современные фреймворки используют подход , основанный на соглашении, а не на конфигурации .
Однако эта концепция более старая, она восходит к концепции default , и совсем недавно ее можно обнаружить в корнях библиотек Java . Например, спецификация JavaBeans в значительной степени опирается на него. Цитируем спецификацию JavaBeans 1.01: [2]
«Как правило, мы не хотим изобретать огромный класс java.beans.everything, от которого людям придется наследовать. Вместо этого мы хотим, чтобы среда выполнения JavaBeans обеспечивала поведение по умолчанию для «обычных» объектов, но позволяла объектам переопределить заданную часть поведения по умолчанию, унаследовав от некоторого конкретного интерфейса java.beans.something».