Термин (или «шаблон»?) Для «Сделай что-нибудь, если это еще не сделано» [закрыто]

Звучит довольно просто, я знаю, но недавно мой коллега сказал мне, что вызываемый метод startHttpServerслишком сложен для понимания, потому что он запускает сервер, только если он еще не запущен. Я обнаруживаю, что попадаю в неприятности, когда отвечаю: «Серьезно? Я занимаюсь этим десятилетиями - это обычная практика в программировании» Чаще, чем я хочу признаться, он возвращается с некоторыми документальными свидетельствами, которые показывают, что все сообщество программистов отстает от его точки зрения, и я в конечном итоге чувствую себя застенчивым.

Вопрос : Есть ли документированный шаблон проектирования, стоящий за концепцией метода, который является запретным, если требуемое действие уже действует? Или, если не шаблон, у него тоже есть имя? И если нет, есть ли причина думать, что слишком сложно подумать о написании метода таким образом?

Как уже сказал Ник Уильямс : понятие, которое описывает ОП, называется идемпотентом (существительное Идемпотентность ). Это действительно обычная практика, особенно в API высокого уровня.

НО: переименуйте функцию.

Вместо того чтобы startHttpServerназывать это makeSureHttpServerIsRunningили ensureHttpServerIsRunning.

Когда вызывается функция startHttpServer, читатели ожидают, что она запустит HTTP-сервер; при вызове десять раз подряд у меня будет десять запущенных серверов. Ваша функция не делает это большую часть времени. Кроме того, имя «start» говорит о том, что если я хочу, чтобы работал только один сервер, мне нужно будет отслеживать, была ли функция уже вызвана или нет.

Когда функция вызывается makeSureHttpServerIsRunning, я предполагаю, что она сделает все необходимое, чтобы убедиться, что HTTP-сервер работает, скорее всего, проверив, запущен ли он, и запустив его в противном случае. Я также предполагаю, что функция гарантирует, что сервер действительно работает (запуск сервера может занять некоторое время, когда он еще не работает).

Переименуйте его в EnsureServerRunning.

Совершенно однозначно и ясно, что он гарантирует, что он работает (если это не так), не подразумевая перезапуск, если это так.

(Альтернатива StartServerIfNotRunning:?)

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

Идемпотентные методы. Методы также могут иметь свойство "идемпотентности", заключающееся в том, что (кроме ошибок с ошибками или истечением срока действия) побочные эффекты от N> 0 идентичных запросов такие же, как и для одного запроса. ( С W3.org )

Побочным эффектом сервера здесь является то, что http-сервер запускается после вызова метода. Я не вижу ничего плохого в том, что метод делает это.

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

Как тот , кто реализует этот инструмент , startHttpServerвы должны пытаться сделать это самый простой, гладкой и бесшовные для использования ...

Логика функции

Технически, расщеплением startHttpServer«s логики в 2 -х функций и называя их по отдельности , все , что вы делаете это перемещение startHttpServer » s идемпотентность в код вызова обе функции вместо ... Кроме того, если вы не завернуть как логику в третьей функции (что делает startHttpServerв первую очередь), это вынуждает вас писать незадействованный код, экспоненциально дублируя его везде, где вам нужно будет позвонить startHttpServer. Короче говоря, startHttpServer должна сама вызывать isHttpServerRunningфункцию.

Итак, моя точка зрения такова:

• Реализуйте isHttpServerRunningфункцию, потому что это может понадобиться независимо в любом случае ...
• Реализуйте, startHttpServerиспользуя его, isHttpServerRunningчтобы определить его следующее действие соответственно ...

Тем не менее, вы можете startHttpServerвернуть любое значение, которое может понадобиться пользователю этой функции, например:

• 0 => Ошибка запуска сервера
• 1 => Успешный запуск сервера
• 2 => сервер уже запущен

Наименование функции

Прежде всего, какова основная цель пользователя? Чтобы запустить HTTP-сервер , верно?

По сути, нет проблем с намерением начать то, что уже началось, АКА 1*1=1. Так что, по крайней мере для меня, называть это " ensureHttpServerIsRunning", кажется, не является критически необходимым, я бы больше заботился о том, насколько длинным, естественным и запоминающимся является название функции.

Теперь, если вы хотите узнать, как подробно работает функция под капотом, для этого есть документация или источник кода, я имею в виду, как и для любой другой функции из библиотеки / framework / API / etc ...

Вы изучаете функцию один раз, а пишете ее несколько раз ...

Так или иначе, я бы придерживался того, startHttpServerчто короче, проще и понятнее, чем ensureHttpServerIsRunning.

Я полагаю, что ваш коллега имел в виду, что startHttpServerделает слишком много:

• Проверка, запущен ли сервер,
• Запуск сервера при необходимости.

Это две не связанные части кода. Например, похожая ситуация существует, когда настольное приложение должно гарантировать, что оно еще не запущено при запуске; будет часть кода, которая обрабатывает экземпляры приложения (например, с использованием мьютекса), и код, который запускает цикл сообщений приложения.

Это означает, что у вас должен быть не один, а как минимум… два метода :

• isHttpServerRunning: boolean
• startHttpServer

Точка входа в приложение вызовет первый метод, а затем второй, если возвращаемое значение равно false. Теперь каждый метод делает одно и то же, и его легко понять.

^{¹ Если логика, необходимая для того, чтобы узнать, работает ли сервер, слишком сложна, может потребоваться дальнейшее разделение на несколько методов.}

Поскольку вы не указываете язык, во JavaScript многие библиотеки имеют функцию «один раз», например Underscore . Поэтому, если вам это знакомо, назовите его «один раз» и, возможно, переименуйте ваш метод.

Сам, исходя из Java, на ум приходят термины «кэширование» или «ленивая оценка». «Идемпотент» технически правильный и хороший выбор, особенно если у вас есть более функциональный фон.

Я бы предпочел startHttpServerIfNotIsRunning.

Таким образом, условие четко упоминается уже в названии метода. Ensureили makeSureкажется мне немного расплывчатым, поскольку это не техническое выражение. Похоже, мы не знаем точно, что произойдет.

Ваш коллега должен был сказать вам, что вы не имеете права писать этот метод. Это уже было написано много раз, и написано лучше, чем вы, вероятно, напишите это. Например: http://docs.ansible.com/ansible/latest/systemd_module.html https://docs.saltstack.com/en/latest/ref/states/all/salt.states.service.html

С точки зрения архитектуры, наличие некоторого произвольного кода, управляющего веб-сервером, является кошмаром. Если только управление службами не является исключительно тем, что делает ваш код. Но я предполагаю, что вы не написали monit (или kubernetes или ...).