16 583
правки
Brainroot (обсуждение | вклад) (Убрал кавычки в при каждой загрузке сценария поле mycell будет получать значение 10) |
м (Поправил типографику и орфографию. Вырезал теги переводчика.) |
||
Строка 1: | Строка 1: | ||
В обновлённом движке правил wb-rules присутствует ряд важных нововведений, касающихся логики написания сценариев. | В обновлённом движке правил wb-rules присутствует ряд важных нововведений, касающихся логики написания сценариев. | ||
= Сценарии = | = Сценарии = | ||
== Изоляция сценариев == | |||
Начиная с версии wb-rules 2.0, каждый файл сценария запускается в своём отдельном пространстве имён — '''контексте'''. Таким образом, каждый сценарий может определять | |||
Начиная с версии wb-rules 2.0, каждый файл сценария запускается в своём отдельном пространстве имён | |||
свои функции и глобальные переменные без риска изменить поведение других сценариев. | свои функции и глобальные переменные без риска изменить поведение других сценариев. | ||
=== Пример === | |||
В качестве примера приведём два сценария, одновременно запускаемых в движке правил. Каждый сценарий определяет глобальные переменные и функции. | |||
В качестве примера приведём два сценария, одновременно запускаемых в движке правил. | |||
Каждый сценарий определяет глобальные переменные и функции. | |||
В предыдущих версиях wb-rules обращение к глобальной переменной, изменяемой в нескольких файлах сценариев, может привести к неопределённому поведению. В версиях, начиная с 2.0, поведение строго определено и такое же, как будто сценарий единственный в системе. | |||
В предыдущих версиях wb-rules обращение к глобальной переменной, изменяемой в нескольких | |||
файлах сценариев, может привести к неопределённому поведению. В версиях, начиная с 2.0, | |||
поведение строго определено и такое же, как будто сценарий единственный в системе. | |||
В комментариях указан вывод команд log для ранних версий и для актуальной версии. | В комментариях указан вывод команд log для ранних версий и для актуальной версии. | ||
'''Сценарий 1 (rules1.js)''' | '''Сценарий 1 (rules1.js)''' | ||
<syntaxhighlight lang="js"> | <syntaxhighlight lang="js"> | ||
test1 = 42; | test1 = 42; | ||
setTimeout(function myFuncOne() { | setTimeout(function myFuncOne() { | ||
log("myFuncOne called"); | log("myFuncOne called"); | ||
Строка 43: | Строка 29: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
'''Сценарий 2 (rules2.js)''' | '''Сценарий 2 (rules2.js)''' | ||
<syntaxhighlight lang="js"> | <syntaxhighlight lang="js"> | ||
Строка 49: | Строка 34: | ||
test2 = "Hello"; | test2 = "Hello"; | ||
setTimeout(function myFuncTwo() { | setTimeout(function myFuncTwo() { | ||
log("myFuncTwo called"); | log("myFuncTwo called"); | ||
Строка 58: | Строка 42: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
=== Примечание === | |||
В предыдущих версиях wb-rules для изоляции правил рекомендовалось использовать замыкание, т.е. | В предыдущих версиях wb-rules для изоляции правил рекомендовалось использовать замыкание, т.е. | ||
оборачивание кода сценария в конструкцию: | оборачивание кода сценария в конструкцию: | ||
Строка 70: | Строка 52: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Начиная с версии 2.0, в подобной конструкции нет необходимости. Тем не менее, старые сценарии, использующие эту конструкцию, продолжат работу без изменений в поведении. | |||
Начиная с версии 2.0, в подобной конструкции нет необходимости. Тем не менее, старые сценарии, | |||
использующие эту конструкцию, продолжат работу без изменений в поведении. | |||
=== Обходные пути === | |||
Если в вашей системе использовалось общее глобальное пространство для хранения общих данных и функций, есть несколько способов реализации такого поведения: | |||
общее для | |||
==== Использование модулей ==== | |||
Можно написать модуль для организации взаимодействия. У модулей есть статическое хранилище, общее для всех файлов, импортировавших модуль. (см. [[#module.static|module.static]]) | |||
==== Постоянное хранилище ==== | ==== Постоянное хранилище ==== | ||
Для обмена данными также можно использовать глобальные постоянные хранилища (PersistentStorage). | Для обмена данными также можно использовать глобальные постоянные хранилища (PersistentStorage). | ||
'''Внимание:''' при использовании глобальных постоянных хранилищ может произойти совпадение имён, в этом случае возможно нарушение поведения, которое трудно обнаружить. | |||
'''Внимание:''' при использовании глобальных постоянных хранилищ может произойти совпадение имён, в | |||
этом случае возможно | |||
<syntaxhighlight lang="js"> | <syntaxhighlight lang="js"> | ||
var ps = new PersistentStorage("my-global-storage", {global: true}); | var ps = new PersistentStorage("my-global-storage", {global: true}); | ||
/// ... | /// ... | ||
ps.myvar = "value"; // это значение доступно для всех пользователей хранилища с именем "my-global-storage" | ps.myvar = "value"; // это значение доступно для всех пользователей хранилища с именем "my-global-storage" | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==== Прототип глобального объекта ==== | |||
'''ВНИМАНИЕ:''' метод считается «грязным», т.к. все переменные и функции, опубликованные таким образом, становятся доступными всем сценариям в системе. Старайтесь избегать этого способа. За неопределённое поведение при использовании этого метода несёт ответственность сам программист. | |||
'''ВНИМАНИЕ:''' метод считается | |||
становятся доступными всем сценариям в системе. Старайтесь избегать этого способа. За неопределённое | |||
поведение при использовании этого метода несёт ответственность сам программист. | |||
Глобальные объекты всех сценариев имеют общий объект — ''прототип'', в котором определены стандартные функции wb-rules (такие, как <code>defineRule</code>, <code>setTimeout</code> и т.д.). Через него можно передавать переменные или функции в общую область видимости. | |||
Глобальные объекты всех сценариев имеют общий объект | |||
wb-rules (такие, как defineRule, setTimeout и т.д.). Через него можно передавать переменные или функции | |||
в общую область видимости. | |||
<syntaxhighlight lang="js"> | <syntaxhighlight lang="js"> | ||
global.__proto__.myVar = 42; // теперь myVar | global.__proto__.myVar = 42; // теперь myVar — общая переменная для всех сценариев | ||
// из других сценариев к переменной можно обращаться так | // из других сценариев к переменной можно обращаться так | ||
log("shared myVar: {}", myVar); | log("shared myVar: {}", myVar); | ||
// или вот так, что чуть более аккуратно, т.к. однозначно показывает, где определена переменная | // или вот так, что чуть более аккуратно, т.к. однозначно показывает, где определена переменная | ||
log("shared myVar: {}", global.__proto__.myVar); | log("shared myVar: {}", global.__proto__.myVar); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Правило поиска переменной в первом случае будет выглядеть так: | Правило поиска переменной в первом случае будет выглядеть так: | ||
# Проверяем, есть ли <code>myVar</code> среди локальных переменных (определённой как <code>var myVar = ...</code>). | |||
# Проверяем, есть ли myVar среди локальных переменных (определённой как var myVar = ...). | # Если нет, проверяем, есть ли <code>myVar</code> в глобальном объекте (определённой как <code>myVar = ...</code>). | ||
# Если нет, проверяем, есть ли myVar в глобальном объекте (определённой как myVar = ...). | # Если нет, проверяем, есть ли <code>myVar</code> в ''прототипе'' глобального объекта (определённой как <code>global.__proto__.myVar</code>). | ||
# Если нет, проверяем, есть ли myVar в ''прототипе'' глобального объекта (определённой как global.__proto__.myVar). | |||
Поиск останавливается, как только переменная найдена. | Поиск останавливается, как только переменная найдена. | ||
Таким образом, первый способ обращения будет работать только в том случае, если <code>myVar</code> не определена в верхних областях видимости. | |||
Таким образом, первый способ обращения будет работать только в том случае, если myVar не определена в верхних областях видимости. | |||
== Анонимные правила == | == Анонимные правила == | ||
Теперь правила можно объявлять анонимно (без задания специального имени). Это позволит уменьшить путаницу и неочевидное поведение системы при дублировании имён правил в одном скрипте.Уникальные имена для анонимных правил генерируются автоматически. Старый синтаксис (с явным заданием имени правила) продолжит работу без изменений. | |||
Теперь правила можно объявлять анонимно (без задания специального имени). Это позволит уменьшить путаницу и неочевидное | |||
поведение системы при дублировании имён правил в одном скрипте. | |||
'''ВНИМАНИЕ:''' начиная с версии 2.0, при объявлении правил с одинаковыми именами в одном файле теперь будет возвращаться ошибка. | |||
=== Пример === | |||
<syntaxhighlight lang="js"> | <syntaxhighlight lang="js"> | ||
defineRule({ | defineRule({ | ||
Строка 179: | Строка 117: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
== Управление правилами == | |||
В wb-rules 2.0 также появляется возможность управлять выполнением правил. Теперь функция <code>defineRule()</code> возвращает идентификатор созданного правила (аналогично <code>setTimeout()/setInterval()</code>), который можно использовать позже для: | |||
В wb-rules 2.0 также появляется возможность управлять выполнением правил. Теперь функция defineRule() возвращает идентификатор | |||
созданного правила (аналогично setTimeout()/setInterval() ), который можно использовать позже для: | |||
* выключения/включения отработки правила; | * выключения/включения отработки правила; | ||
* принудительного запуска тела правила. | * принудительного запуска тела правила. | ||
По умолчанию, все правила включены. | По умолчанию, все правила включены. | ||
=== Пример === | |||
<syntaxhighlight lang="js"> | <syntaxhighlight lang="js"> | ||
var myRule = defineRule({ | var myRule = defineRule({ | ||
Строка 205: | Строка 135: | ||
}); | }); | ||
// ... | // ... | ||
disableRule(myRule); // отключить проверку и выполнение правила | disableRule(myRule); // отключить проверку и выполнение правила | ||
enableRule(myRule); // разрешить выполнение правила | enableRule(myRule); // разрешить выполнение правила | ||
runRule(myRule); // принудительно запустить тело правила (функцию then) | runRule(myRule); // принудительно запустить тело правила (функцию then) | ||
// на текущий момент не поддерживается передача аргументов в then | // на текущий момент не поддерживается передача аргументов в then | ||
</syntaxhighlight> | </syntaxhighlight> | ||
== Постоянное хранилище данных == | |||
В wb-rules 2.0 добавлена поддержка постоянных хранилищ. По сути, это объекты, значения в которых будут сохраняться | В wb-rules 2.0 добавлена поддержка постоянных хранилищ. По сути, это объекты, значения в которых будут сохраняться | ||
даже при потере питания контроллера. Такие хранилища удобно использовать для хранения состояний или конфигурации. | даже при потере питания контроллера. Такие хранилища удобно использовать для хранения состояний или конфигурации. | ||
<syntaxhighlight lang="js"> | <syntaxhighlight lang="js"> | ||
var ps = new PersistentStorage("my-storage"); | var ps = new PersistentStorage("my-storage"); | ||
ps.key = "Hello World"; | ps.key = "Hello World"; | ||
log(ps.key); | log(ps.key); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
По умолчанию, хранилища создаются локальными для данного файла сценария, с привязкой к имени файла. Таким образом, при создании хранилищ с одинаковыми именами в разных файлах сценариев, создастся два разных хранилища (и сценарий не получит доступа к «чужим» данным). | |||
По умолчанию, хранилища создаются локальными для данного файла сценария, с привязкой к имени файла. Таким образом, при создании хранилищ с | |||
одинаковыми именами в разных файлах сценариев, создастся два разных хранилища (и сценарий не получит | |||
доступа к | |||
Однако, есть возможность создавать глобальные хранилища. Для этого нужно добавить аргумент { global: true } в вызов конструктора: | |||
Однако, есть возможность создавать глобальные хранилища. Для этого нужно добавить аргумент { global: true } в | |||
вызов конструктора: | |||
<syntaxhighlight lang="js"> | <syntaxhighlight lang="js"> | ||
var ps = new PersistentStorage("my-storage", { global: true }); | var ps = new PersistentStorage("my-storage", { global: true }); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Если такое хранилище уже было создано когда-либо ранее, сценарий получит к нему доступ. | Если такое хранилище уже было создано когда-либо ранее, сценарий получит к нему доступ. | ||
== Виртуальные устройства == | |||
В предыдущих версиях wb-rules значения контролов виртуальных устройств хранились только в MQTT retained, что не очень надёжно (в случае потери питания данные могли быть легко утеряны). Начиная с версии 2.0, эти значения сохраняются также в специальное хранилище в постоянной памяти и восстанавливаются при загрузке сценария. | |||
Если необходимо каждый раз при перезагрузке скрипта восстанавливать строго определённое значение (т.е. не восстанавливать предыдущее сохранённое), | Если необходимо каждый раз при перезагрузке скрипта восстанавливать строго определённое значение (т.е. не восстанавливать предыдущее сохранённое), | ||
можно добавить в описание контрола поле forceDefault: | можно добавить в описание контрола поле <code>forceDefault</code>: | ||
<syntaxhighlight lang="js"> | <syntaxhighlight lang="js"> | ||
defineVirtualDevice("vdev", { | defineVirtualDevice("vdev", { | ||
Строка 277: | Строка 187: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
По умолчанию поле принимает значение <code>false</code>. | |||
По умолчанию поле принимает значение false. | |||
= Модули = | = Модули = | ||
Начиная с версии 2.0, в движке правил wb-rules появилась поддержка подключаемых JS-модулей (похожая по поведению на | Начиная с версии 2.0, в движке правил wb-rules появилась поддержка подключаемых JS-модулей (похожая по поведению на аналогичную в Node.js, но с некоторыми особенностями). | ||
аналогичную в Node.js, но с некоторыми особенностями). | |||
== Расположение == | |||
Поиск модулей происходит по следующим путям (в заданном порядке): | Поиск модулей происходит по следующим путям (в заданном порядке): | ||
< | * <code>/etc/wb-rules-modules</code> | ||
* <code>/usr/share/wb-rules-modules</code> | |||
* /usr/share/wb-rules-modules | |||
Таким образом, пользовательские модули удобно складывать в <code>/etc/wb-rules-modules</code>. | |||
Таким образом, пользовательские модули удобно складывать в /etc/wb-rules-modules. | |||
Добавить свои пути можно редактированием <code>/etc/default/wb-rules</code> добавлением путей | |||
Добавить свои пути можно редактированием /etc/default/wb-rules добавлением путей | к переменной WB_RULES_MODULES через разделитель <code>:</code>: | ||
к переменной WB_RULES_MODULES через разделитель | |||
<syntaxhighlight lang="bash"> | <syntaxhighlight lang="bash"> | ||
... | ... | ||
Строка 308: | Строка 210: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
== Подключение модуля к сценарию == | |||
Подключение модуля происходит с помощью функции <code>require()</code>. Она возвращает объект, экспортированный | |||
Подключение модуля происходит с помощью функции require(). Она возвращает объект, экспортированный | |||
модулем (exports). | модулем (exports). | ||
<syntaxhighlight lang="js"> | <syntaxhighlight lang="js"> | ||
... | ... | ||
Строка 322: | Строка 221: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
При этом движок правил будет искать файл <code>myModule.js</code> по очереди в директориях поиска (см. Расположение). | |||
При этом движок правил будет искать файл myModule.js по очереди в директориях поиска (см. Расположение). | |||
Также допустим поиск файла модуля по поддиректориям в директориях поиска, тогда вызов будет выглядеть так: | Также допустим поиск файла модуля по поддиректориям в директориях поиска, тогда вызов будет выглядеть так: | ||
<syntaxhighlight lang="js"> | <syntaxhighlight lang="js"> | ||
... | ... | ||
Строка 336: | Строка 231: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
После того, как файл будет найден, его содержимое будет выполнено, и из файла будет передан объект exports. | После того, как файл будет найден, его содержимое будет выполнено, и из файла будет передан объект exports. | ||
'''Примечание 1:''' если модуль был подключен в одном сценарии несколько раз (несколько вызовов require("myModule")), | '''Примечание 1:''' если модуль был подключен в одном сценарии несколько раз (несколько вызовов require("myModule")), | ||
содержимое файла модуля будет выполнено только в первый раз, а при повторных вызовах будет возвращаться сохранённый | содержимое файла модуля будет выполнено только в первый раз, а при повторных вызовах будет возвращаться сохранённый | ||
объект exports. | объект exports. | ||
'''Примечание 2:''' если модуль подключается в разных сценариях, для каждого сценария будет создан свой объект модуля | '''Примечание 2:''' если модуль подключается в разных сценариях, для каждого сценария будет создан свой объект модуля | ||
и заново выполнен весь код модуля. Если модулю требуется использовать данные, общие для всех файлов сценариев, | и заново выполнен весь код модуля. Если модулю требуется использовать данные, общие для всех файлов сценариев, | ||
для хранения данных следует использовать объект module.static. | для хранения данных следует использовать объект <code>module.static</code>. | ||
== Создание модуля == | == Создание модуля == | ||
Для создания модуля достаточно создать файл с именем, соответствующим имени модуля (с расширением .js) в директории <code>/etc/wb-rules-modules</code>. | |||
Для создания модуля достаточно создать файл с именем, | |||
/etc/wb-rules-modules. | |||
В этом файле будут доступны все стандартные функции wb-rules, а также набор специальных объектов, с помощью | В этом файле будут доступны все стандартные функции wb-rules, а также набор специальных объектов, с помощью | ||
которого можно реализовать необходимый функционал модуля. | которого можно реализовать необходимый функционал модуля. | ||
=== Объект exports === | |||
С помощью объекта exports можно передавать пользовательскому сценарию параметры и методы. | С помощью объекта exports можно передавать пользовательскому сценарию параметры и методы. | ||
==== Пример ==== | |||
Файл модуля <code>/etc/wb-rules-modules/myModule.js</code> | |||
<syntaxhighlight lang="js"> | <syntaxhighlight lang="js"> | ||
exports.hello = function(text) { | exports.hello = function(text) { | ||
Строка 376: | Строка 260: | ||
}; | }; | ||
exports.answer = 42; | exports.answer = 42; | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Файл сценария scenario.js | Файл сценария scenario.js | ||
<syntaxhighlight lang="js"> | <syntaxhighlight lang="js"> | ||
Строка 388: | Строка 270: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
'''Будьте внимательны:''' объект exports можно '''только дополнять значениями''', но не переопределять. | '''Будьте внимательны:''' объект exports можно '''только дополнять значениями''', но не переопределять. | ||
Иначе значения экспортированы не будут! | Иначе значения экспортированы не будут! | ||
<syntaxhighlight lang="js"> | <syntaxhighlight lang="js"> | ||
exports = function(text) { | exports = function(text) { | ||
Строка 398: | Строка 278: | ||
}; | }; | ||
// Ожидание: | // Ожидание: | ||
var m = require("my-module"); | var m = require("my-module"); | ||
m("world"); // не работает | m("world"); // не работает | ||
// На практике m будет пустым объектом. | // На практике m будет пустым объектом. | ||
// Та же проблема произойдёт при использовании такой конструкции: | // Та же проблема произойдёт при использовании такой конструкции: | ||
Строка 414: | Строка 292: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
=== Объект module === | |||
Объект module содержит параметры, относящиеся непосредственно к файлу модуля. | Объект module содержит параметры, относящиеся непосредственно к файлу модуля. | ||
==== module.filename ==== | |||
Содержит полный путь до файла ''модуля''. Например, для модуля, сохранённого в <code>/etc/wb-rules-modules/myModule.js</code>: | |||
<syntaxhighlight lang="js"> | <syntaxhighlight lang="js"> | ||
log(module.filename); // выведет /etc/wb-rules-modules/myModule.js | log(module.filename); // выведет /etc/wb-rules-modules/myModule.js | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==== module.static ==== | |||
Объект, хранящий данные, общие для всех экземпляров данного модуля. Его следует использовать для тех данных, | Объект, хранящий данные, общие для всех экземпляров данного модуля. Его следует использовать для тех данных, | ||
которые должны быть доступны сразу во всех сценариях, использующих данный модуль. | которые должны быть доступны сразу во всех сценариях, использующих данный модуль. | ||
< | Файл <code>/etc/wb-rules-modules/myModule.js</code> | ||
<syntaxhighlight lang="js"> | <syntaxhighlight lang="js"> | ||
exports.counter = function() { | exports.counter = function() { | ||
Строка 450: | Строка 320: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
< | Файл сценария <code>scenario1.js</code> | ||
<syntaxhighlight lang="js"> | <syntaxhighlight lang="js"> | ||
var m = require("myModule"); | var m = require("myModule"); | ||
Строка 458: | Строка 327: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
< | Файл сценария <code>scenario2.js</code> | ||
<syntaxhighlight lang="js"> | <syntaxhighlight lang="js"> | ||
var m = require("myModule"); | var m = require("myModule"); | ||
Строка 467: | Строка 335: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
В результате работы двух скриптов в логе окажется 5 сообщений: | В результате работы двух скриптов в логе окажется 5 сообщений: | ||
<syntaxhighlight> | <syntaxhighlight> | ||
Number of calls: 1 | Number of calls: 1 | ||
Строка 479: | Строка 345: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
=== __filename === | |||
Переменная <code>__filename</code> берётся из глобального объекта сценария, к которому подключается модуль, и содержит имя файла | |||
< | |||
сценария. | сценария. | ||
В случае, если модуль подключается в другом модуле, переменная <code>__filename</code>, тем не менее, будет содержать именно | |||
В случае, если модуль подключается в другом модуле, переменная __filename, тем не менее, будет содержать именно | имя файла сценария — вершины дерева зависимостей. | ||
имя файла сценария | |||
< | Файл <code>/etc/wb-rules-modules/myModule.js</code> | ||
<syntaxhighlight lang="js"> | <syntaxhighlight lang="js"> | ||
exports.hello = function() { | exports.hello = function() { | ||
Строка 498: | Строка 360: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
< | Файл сценария <code>/etc/wb-rules/scenario1.js</code> | ||
<syntaxhighlight lang="js"> | <syntaxhighlight lang="js"> | ||
var m = require("myModule"); | var m = require("myModule"); | ||
Строка 505: | Строка 366: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
= Замеры производительности = | = Замеры производительности = | ||
Cм. [[Special:MyLanguage/Движок_правил_wb-rules_2.0/Производительность|Замеры производительности]] | Cм. [[Special:MyLanguage/Движок_правил_wb-rules_2.0/Производительность|Замеры производительности]] | ||