|
| 1 | +--- |
| 2 | +title: СтроительМенеджераПараметров |
| 3 | +--- |
| 4 | + |
| 5 | +# СтроительМенеджераПараметров |
| 6 | + |
| 7 | +Инкапсулирует создание и настройку `МенеджерПараметров` (`configor`) с заранее заданным дефолтным составом провайдеров. |
| 8 | + |
| 9 | +Создаётся лениво при первом обращении к [`СоветДругогоМастера.ПолучитьСтроительМенеджераПараметров()`](20-СоветДругогоМастера.md#получитьстроительменеджерапараметров) и кэшируется в `СоветДругогоМастера`: повторные вызовы возвращают тот же экземпляр, поэтому правки строителя, сделанные клиентским кодом, доходят до `Поделки`. Все настройки выполняются **до** передачи `СоветДругогоМастера` в [`Поделка`](../../../api/050-Классы/). |
| 10 | + |
| 11 | +## Дефолтный состав провайдеров |
| 12 | + |
| 13 | +| Идентификатор | Тип | Приоритет | |
| 14 | +| --- | --- | --- | |
| 15 | +| `env` | `ПровайдерПараметровENV` | 1 | |
| 16 | +| `default` | Файловый метапровайдер (`yaml` + `json` + `ini`)<br>имя файла `autumn-properties`, поиск с подкаталогом `src` | 2 | |
| 17 | +| `inline` | `ПровайдерПараметровСоответствие` | 3 | |
| 18 | + |
| 19 | +Файловый метапровайдер регистрирует три физических провайдера в менеджере под идентификаторами `<база>-yaml`, `<база>-json`, `<база>-ini` с одинаковым приоритетом. Настройки, заданные через метапровайдер (имя файла, каталоги поиска и т.п.), транслируются во все три физических провайдера. |
| 20 | + |
| 21 | +## Канонический нейминг |
| 22 | + |
| 23 | +Методы добавления провайдеров следуют единой схеме `ДобавитьПровайдер<Тип>`: |
| 24 | + |
| 25 | +| Метод | Назначение | |
| 26 | +| --- | --- | |
| 27 | +| `ДобавитьПровайдер` | универсальный — для произвольного класса-провайдера | |
| 28 | +| `ДобавитьПровайдерСоответствие` | inline-значения через `Соответствие` | |
| 29 | +| `ДобавитьПровайдерENV` | переменные среды | |
| 30 | +| `ДобавитьПровайдерФайлов` | мета-обёртка над несколькими форматами (`yaml`/`json`/`ini`) | |
| 31 | +| `ДобавитьПровайдерФайлНастроек` | один файл с автоопределением формата по расширению | |
| 32 | + |
| 33 | +## Пример |
| 34 | + |
| 35 | +```bsl |
| 36 | +Совет = Новый СоветДругогоМастера(); |
| 37 | +Строитель = Совет.ПолучитьСтроительМенеджераПараметров(); |
| 38 | +
|
| 39 | +// Заменить дефолтный inline-провайдер своим набором значений |
| 40 | +Значения = Новый Соответствие(); |
| 41 | +Значения.Вставить("моя.настройка", "значение"); |
| 42 | +Строитель.УдалитьПровайдер("inline"); |
| 43 | +Строитель.ДобавитьПровайдерСоответствие(Значения, 3, "inline"); |
| 44 | +
|
| 45 | +// Добавить ещё один файловый метапровайдер |
| 46 | +ДопФайлы = Строитель.ДобавитьПровайдерФайлов("dev", 1); |
| 47 | +ДопФайлы.УстановитьИмяФайла("autumn-properties.dev"); |
| 48 | +
|
| 49 | +// Подключить конкретный файл (формат — по расширению) |
| 50 | +Строитель.ДобавитьПровайдерФайлНастроек("./config/local.yaml", 0, "local"); |
| 51 | +
|
| 52 | +// Полностью пересобрать состав с нуля |
| 53 | +Строитель.ОчиститьПровайдеры(); |
| 54 | +Строитель.ДобавитьПровайдерENV("MYAPP_", 1, "env"); |
| 55 | +Строитель.ДобавитьПровайдерСоответствие(Значения, 2, "inline"); |
| 56 | +
|
| 57 | +Поделка = Новый Поделка(Совет); |
| 58 | +``` |
| 59 | + |
| 60 | +## МенеджерПараметров |
| 61 | + |
| 62 | +```bsl |
| 63 | +// Возвращает внутренний МенеджерПараметров configor. |
| 64 | +// |
| 65 | +// Возвращаемое значение: |
| 66 | +// МенеджерПараметров |
| 67 | +// |
| 68 | +Функция МенеджерПараметров() Экспорт |
| 69 | +``` |
| 70 | + |
| 71 | +## ДобавитьПровайдер |
| 72 | + |
| 73 | +```bsl |
| 74 | +// Регистрирует произвольный класс-провайдер в менеджере. |
| 75 | +// |
| 76 | +// Параметры: |
| 77 | +// КлассПровайдера - Объект - класс, реализующий интерфейс провайдера configor |
| 78 | +// Приоритет - Число - приоритет |
| 79 | +// Идентификатор - Строка - явный идентификатор; при коллизии configor добавит #2, #3, ... |
| 80 | +// |
| 81 | +// Возвращаемое значение: |
| 82 | +// Объект - переданный КлассПровайдера |
| 83 | +// |
| 84 | +Функция ДобавитьПровайдер(Знач КлассПровайдера, Знач Приоритет = Неопределено, Знач Идентификатор = Неопределено) Экспорт |
| 85 | +``` |
| 86 | + |
| 87 | +## ДобавитьПровайдерСоответствие |
| 88 | + |
| 89 | +```bsl |
| 90 | +// Регистрирует ПровайдерПараметровСоответствие с заданными значениями. |
| 91 | +// |
| 92 | +// Параметры: |
| 93 | +// Значения - Соответствие - значения параметров (по умолчанию пустое) |
| 94 | +// Приоритет - Число |
| 95 | +// Идентификатор - Строка |
| 96 | +// |
| 97 | +// Возвращаемое значение: |
| 98 | +// ПровайдерПараметровСоответствие |
| 99 | +// |
| 100 | +Функция ДобавитьПровайдерСоответствие(Знач Значения = Неопределено, Знач Приоритет = Неопределено, Знач Идентификатор = Неопределено) Экспорт |
| 101 | +``` |
| 102 | + |
| 103 | +## ДобавитьПровайдерENV |
| 104 | + |
| 105 | +```bsl |
| 106 | +// Регистрирует ПровайдерПараметровENV. |
| 107 | +// |
| 108 | +// Параметры: |
| 109 | +// Префикс - Строка - префикс переменных среды |
| 110 | +// Приоритет - Число |
| 111 | +// Идентификатор - Строка |
| 112 | +// |
| 113 | +// Возвращаемое значение: |
| 114 | +// ПровайдерПараметровENV |
| 115 | +// |
| 116 | +Функция ДобавитьПровайдерENV(Знач Префикс = "", Знач Приоритет = Неопределено, Знач Идентификатор = Неопределено) Экспорт |
| 117 | +``` |
| 118 | + |
| 119 | +## ДобавитьПровайдерФайлов |
| 120 | + |
| 121 | +```bsl |
| 122 | +// Регистрирует файловый метапровайдер — обёртку над несколькими физическими |
| 123 | +// файловыми провайдерами (yaml/json/ini) с одинаковым приоритетом. |
| 124 | +// |
| 125 | +// Параметры: |
| 126 | +// Идентификатор - Строка - базовый идентификатор метапровайдера |
| 127 | +// Приоритет - Число |
| 128 | +// Форматы - Строка - список форматов через пробел (по умолчанию "yaml json ini") |
| 129 | +// |
| 130 | +// Возвращаемое значение: |
| 131 | +// ФайловыйМетапровайдер |
| 132 | +// |
| 133 | +Функция ДобавитьПровайдерФайлов(Знач Идентификатор, Знач Приоритет, Знач Форматы = "yaml json ini") Экспорт |
| 134 | +``` |
| 135 | + |
| 136 | +## ДобавитьПровайдерФайлНастроек |
| 137 | + |
| 138 | +```bsl |
| 139 | +// Регистрирует один файловый провайдер по конкретному пути к файлу. |
| 140 | +// Формат определяется по расширению (.yaml/.yml — yaml, .json — json, .ini — ini). |
| 141 | +// |
| 142 | +// Параметры: |
| 143 | +// ПутьКФайлу - Строка - полный или относительный путь к файлу настроек |
| 144 | +// Приоритет - Число |
| 145 | +// Идентификатор - Строка |
| 146 | +// |
| 147 | +// Возвращаемое значение: |
| 148 | +// Объект - класс-провайдер (ПровайдерПараметровYAML/JSON/INI) |
| 149 | +// |
| 150 | +Функция ДобавитьПровайдерФайлНастроек(Знач ПутьКФайлу, Знач Приоритет = Неопределено, Знач Идентификатор = Неопределено) Экспорт |
| 151 | +``` |
| 152 | + |
| 153 | +## УдалитьПровайдер |
| 154 | + |
| 155 | +```bsl |
| 156 | +// Удаляет (отключает) провайдер по идентификатору. |
| 157 | +// |
| 158 | +// Если идентификатор соответствует файловому метапровайдеру — |
| 159 | +// отключает все его физические провайдеры и удаляет метапровайдер из реестра. |
| 160 | +// |
| 161 | +// Параметры: |
| 162 | +// Идентификатор - Строка |
| 163 | +// |
| 164 | +Процедура УдалитьПровайдер(Знач Идентификатор) Экспорт |
| 165 | +``` |
| 166 | + |
| 167 | +## ОчиститьПровайдеры |
| 168 | + |
| 169 | +```bsl |
| 170 | +// Полностью очищает состав провайдеров: пересоздаёт МенеджерПараметров |
| 171 | +// и сбрасывает реестр файловых метапровайдеров. |
| 172 | +// |
| 173 | +// Полезно когда нужно собрать собственную композицию с нуля, |
| 174 | +// не наследуя дефолтный состав (env / default / inline). |
| 175 | +// |
| 176 | +Процедура ОчиститьПровайдеры() Экспорт |
| 177 | +``` |
| 178 | + |
| 179 | +## Провайдер |
| 180 | + |
| 181 | +```bsl |
| 182 | +// Возвращает обёртку ПровайдерПараметров (configor) по идентификатору. |
| 183 | +// |
| 184 | +// Параметры: |
| 185 | +// Идентификатор - Строка |
| 186 | +// |
| 187 | +// Возвращаемое значение: |
| 188 | +// ПровайдерПараметров (обёртка configor) или Неопределено |
| 189 | +// |
| 190 | +Функция Провайдер(Знач Идентификатор) Экспорт |
| 191 | +``` |
| 192 | + |
| 193 | +## ПровайдерФайлов |
| 194 | + |
| 195 | +```bsl |
| 196 | +// Возвращает зарегистрированный файловый метапровайдер. |
| 197 | +// |
| 198 | +// Параметры: |
| 199 | +// Идентификатор - Строка |
| 200 | +// |
| 201 | +// Возвращаемое значение: |
| 202 | +// ФайловыйМетапровайдер |
| 203 | +// |
| 204 | +Функция ПровайдерФайлов(Знач Идентификатор) Экспорт |
| 205 | +``` |
| 206 | + |
| 207 | +## НастройкаПоискаФайла |
| 208 | + |
| 209 | +```bsl |
| 210 | +// Возвращает глобальный объект настроек поиска файлов МенеджерПараметров |
| 211 | +// (общий fallback для всех файловых провайдеров). |
| 212 | +// |
| 213 | +// Возвращаемое значение: |
| 214 | +// НастройкиФайловогоПровайдера |
| 215 | +// |
| 216 | +Функция НастройкаПоискаФайла() Экспорт |
| 217 | +``` |
| 218 | + |
| 219 | +## Файловый метапровайдер |
| 220 | + |
| 221 | +Возвращается методами `ДобавитьПровайдерФайлов` / `ПровайдерФайлов`. Проксирует настройки сразу в физические провайдеры (`<база>-yaml`, `<база>-json`, `<база>-ini`). |
| 222 | + |
| 223 | +Доступные методы: |
| 224 | + |
| 225 | +- `Идентификатор()` — базовый идентификатор |
| 226 | +- `ИдентификаторыФизическихПровайдеров()` — фиксированный массив идентификаторов |
| 227 | +- `Форматы()` — фиксированный массив форматов |
| 228 | +- `Настройки(Формат)` — `НастройкиФайловогоПровайдера` конкретного физического провайдера |
| 229 | +- `УстановитьПриоритет(Приоритет)` |
| 230 | +- `УстановитьИмяФайла(Имя)` |
| 231 | +- `УстановитьФайлПараметров(Путь)` |
| 232 | +- `ДобавитьСтандартныеКаталогиПоиска(ВложенныйКаталог = "")` |
| 233 | +- `ДобавитьКаталогПоиска(Каталог)` |
| 234 | +- `ОчиститьПутиПоиска()` |
| 235 | +- `УстановитьВложенныйКаталогПоиска(ВложенныйКаталог)` |
| 236 | +- `Отключить()` / `Включить()` |
0 commit comments