Перейти к содержанию

BSL152 - Кеширование программного интерфейса

← Все правила

Кратко

Кеширование программного интерфейса

Идентификаторы

Поле Значение
Код правила BSL152
Совместимый псевдоним CachedPublic
Серьёзность WARNING
Без конфигурации Да
BSLLS JSON, режим ON без переопределений Да
Флаг реестра implemented Да
Теги design, performance

Флаг implemented отражает реестр и не подтверждает проверенное совпадение с BSLLS.

Поведение

  • Публичный идентификатор BSL152 и псевдоним CachedPublic стабильны.
  • Правило сообщает о случаях, описанных на этой странице.
  • Подавления и проектная конфигурация применяются до публикации результата.
  • Для выполнения правила не требуется внешний анализатор или сетевой доступ.

Настройка и подавление

Код BSL### - основной стабильный идентификатор. Совместимый псевдоним принимается в select, ignore и совместимых блоковых комментариях.

[tool.onec-hbk-bsl]
select = ["BSL152"]
ignore = ["CachedPublic"]

Все три семейства подавлений работают для текущей строки и диапазона. Если открывающий комментарий стоит после кода, он действует только на эту строку. Используйте любой один вариант:

  • noqa:
Значение = "пример";  // noqa: BSL152
  • bsl-disable (совместимый вариант):
Значение = "пример";  // bsl-disable: BSL152
  • совместимый BSLLS-вариант:
Значение = "пример";  // BSLLS:CachedPublic-off

Если тот же открывающий комментарий стоит на отдельной строке, он начинает диапазон. Закройте его парным маркером того же семейства:

// noqa: BSL152
// код без этой диагностики
// noqa-enable: BSL152

// bsl-disable: BSL152
// код без этой диагностики
// bsl-enable: BSL152

// BSLLS:CachedPublic-off
// код без этой диагностики
// BSLLS:CachedPublic-on

Чтобы отключить правило до конца файла, не добавляйте закрывающий noqa-enable, bsl-enable или BSLLS:…-on.

Открывающий и закрывающий маркеры должны принадлежать одному семейству.

Описание диагностики

Не следует создавать программный интерфейс в модулях с повторным использованием возвращаемых значений.

3.6. Другой пример скрытия деталей реализации библиотеки от потребителя. Допустим: в первой версии библиотеки потребителям предоставлялась экспортная функция общего модуля с повторным использованием возвращаемых значений; Но в следующей версии библиотеки это проектное решение пересмотрено в пользу «обычного» общего модуля, куда эта функция была перенесена (аналогично, если в обратную сторону). В данном примере, для того чтобы избавить потребителя библиотеки от дополнительных усилий по замене вызовов «старой» функции на новую, рекомендуется сразу размещать экспортную функцию в «обычном» модуле, в его разделе «программный интерфейс». Тогда эта функция, в зависимости от текущего проектного решения, может вызывать служебную функцию из модуля с повторным использованием возвращаемых значений или из любого другого модуля, или непосредственно сама содержать реализацию. Однако для потребителя ее местоположение уже не будет меняться в следующих версиях библиотеки.

Примеры

Источники