Часто нам приходится по ходу исполнения программы получать значения, которые хранятся в базе данных и не меняются годами. Яркий пример - значения констант. Отчасти, можно причислить сюда же поиск элемента справочника или узла плана обмена по коду, получение значений реквизитов объектов по ссылке.
Не думая, "на лету" такие задачи решаются конструкциями вида:
Если ДатаДокумента > Константы.ДатаНачалаПримененияПостановления1137.Получить() Тогда
В результате, каждый раз когда выполняется этот код - происходит "дерганье" базы данных.
Программисты более щепетильно относящиеся к своему коду, выполняют один запрос к базе данных, кэшируя все данные которые им понадобятся, однако такой подход не всегда приводит к желаемой разгрузке БД:
- Цикл выполнения кода может быть неявным (например, групповое перепроведение документов)
- Получить строгий набор данных (не больше и не меньше), которые потребуются позже, иногда затруднительно или вовсе невозможно.
- Кэшированные значения требуется использовать в разных вызовах/формах
Модуль с повторным использованием возвращаемых значений
Для решения описанных проблем в платформе есть модули с повторным использованием возвращаемых значений. Фактически, это обычный общий модуль (клиентский или серверный), в котором Повторное использование возвращаемых значений установлено в "На время вызова" или "На время сеанса". В самом модуле процедуры и функции описываются как обычно.
Вся соль заключается в том, что при многократных вызовах экспортных функций таких модулей - в первый раз вызов действительно производится как мы и ожидаем, а все последующие вызовы приводят к возврату закэшированного значения без реального выполнения кода функции. Этот эффект можно наблюдать в замере производительности.
Возвращаемые значения, естественно, кэшируются в разрезе значений переданных параметров, т.е. при выполнении кода
Узел1 = НашМодуль.ПолучитьУзелОбменаСБухгалтерией("0001"); Узел2 = НашМодуль.ПолучитьУзелОбменаСБухгалтерией("0002");
Оба вызова действительно приведут к выполнению соответствующей процедуры и вернут разные ссылки, а при последующих попытках получить узел с кодом 0001 или 0002 - будут возвращаться соответствующие узлы без вызова процедуры и, как следствие, базы данных.
Значения кэшируются отдельно для каждого сеанса на клиенте или сервере (в зависимости от того клиентский или серверный модуль). Т.е. если есть особенности настройки прав доступа или другой зависимости полученного значения от текущего пользователя - все отработает корректно.
Чего делать нельзя
Есть одно ограничение. В качестве параметров функций можно указывать только простые типы. Неопределено, Null, Булево, Дата, Строка, Число, Ссылка. Никаких структур, таблиц значений, объектов и т.п. Если вы попытаетесь передать в качестве параметра, например, структуру - все отработает, но о повторном использовании полученного значения можете забыть.
Возвращаемое значение при этом может быть любого типа.
Также, стоит обращать внимание на размер данных которые вы кэшируете. Всю память сервера вы забьете вряд ли, но помнить о том, что ресурсы не бесконечны стоит.
Баг или фича от 1С
Интересное свойство есть у повторно используемых значений. Баг это или фича непонятно, но знать о нем не помешет. Если выполнить код следующего характера:
ЗначениеСтруктура1 = НашМодуль.ПолучитьСтруктуруЗначенийРеквизитов(СсылкаНаОбъект); ЗначениеСтруктура1.Наименование = "Новое наименование"; ЗначениеСтруктура2 = НашМодуль.ПолучитьСтруктуруЗначенийРеквизитов(СсылкаНаОбъект);
То в ЗначениеСтруктура2.Наименование будет лежать именно "Новое наименование". В принципе, это можно использовать для обновления значений, реально измененных в БД, но когда прикроют и прикроют ли лавочку - непонятно. При разработке типовых решений так делать запрещено.
Что делать при изменении закэшированных данных
Есть всего лишь один "легитимный" метод обработать ситуацию с изменением закэшированного значения в базе данных. Это метод ОбновитьПовторноИспользуемыеЗначения(). Будут сброшены значения всех функций по всем параметрам всех модулей. Обновить по конкретным значениям параметров / функциям / модулям нельзя.
Соответственно, из-за такого волюнтаристского подхода, пользоваться этой функцией необходимо крайне осмотрительно: вся система после его использования какое-то время будет работать существенно медленнее.
Посягаем на святое: пишем запрос в цикле
Кроме очевидных вариантов использования функций с повторным использованием возвращаемых значений, есть немало интересных, универсальных, нестандартных подходов, среди которых:
- Написание универсальных процедур, возвращающих реквизиты произвольных ссылок (есть в БСП)
- Написание процедур, возвращающих значения констант по имени константы (есть в большинстве типовых)
- Возврат "чуть большего" объема данных, чем необходимо ради уменьшения количества вызовов (напр. если требуется получить курсы сразу нескольких валют, имеет смысл вызывать функцию по дате без отбора валюты, получить курсы всех валют и далее "разбираться на месте" какая из валют в настоящий момент нужна)
- Написание процедуры, выполняющей запрос с кэшированием результата (входящими параметрами при этом будут текст запроса и пара-тройка имен и значений параметров)
Но есть еще один подход, на котором я хочу остановиться подробно. Это использование функции, содержащей вызов БД, с повторным использованием возвращаемого значения в цикле. Т.е. фактически это запрос в цикле. Вообще, нас учили так не делать, но бывают случаи, когда такое построение кода приведет к лучшей производительности, если:
- Количество различных значений входящих параметров, которые встретятся внутри цикла небольшое и подавляющее большинство сочетаний с высокой долей вероятности было получено ранее в этом сеансе.
- Заранее получить строгий набор сочетаний значений входящих параметров, которые встретятся в цикле затруднительно, а получение значений для всех возможных сочетаний значений входящих параметров приведет к считыванию большого объема данных из БД
Как видите формулировки не точные и больше похожи на напутствия, чем на правила. Поэтому всегда держите в голове контекст, оценивайте текущую картину, обдумывайте условия в которых будет работать ваш код.
Модули платформы 1С:Предприятие 8.3, 8.2
Общие модули
Функции, которые объявлены с флагом "экспорт" в таком модуле, можно вызывать из любых мест конфигурации. Вызов делается через ИмяОбщегоМодуля.ИмяФункции().
В таких модулях отсутствует раздел переменных.
Выполнение общих модулей зависит от выставленных параметров в их свойствах:
Флаг "Глобальный"
Если этот флаг установлен, то контекст такого модуля становится глобальным. То есть при обращении к его экспортным функциям не нужно указывать имя модуля. Но имена его экспортных функций должны быть уникальными в пределах глобального контекста конфигурации.
Флаг "Сервер"
Функции такого модуля могут выполняться на сервере.
Флаг "Клиент (обычное приложение)"
Функции такого модуля могут выполняться на клиенте в режиме обычного приложения.
Флаг "Клиент (управляемое приложение)"
Функции такого модуля могут выполняться на клиенте в режиме управляемого приложения.
Флаг "Вызов сервера"
Флаг доступен для модулей с установленным флагом "Сервер". Разрешает вызов на клиенте экспортных функций этого модуля (которые будут выполняться на сервере).
Флаг "Внешнее соединение"
Экспортные функции такого модуля могут быть вызваны при подключении из внешнего источника.
Флаг "Привилегированный"
В модуле с таким флагом будет отключена проверка прав. Подходит для повышения производительности или действий по администрированию.
Параметр "Повторное использование"
Если включить данный параметр, то возвращаемые значения экспортных функций будут кэшироваться сразу после первого вызова. Кэширование возможно на время вызова (время исполнение определенной процедуры) или на время сеанса пользователя.
Модуль приложения
Предназначен для обработки событий запуска и завершения приложения. Бывает двух видов: для обычного и управляемого приложений.
Не следует его перегружать, так как это влияет на время запуска приложения.
Модуль сеанса
Специальный модуль, который используется для инициализации параметров сеанса. Нужен для того, чтобы не дублировать код в различных модулях приложений.
Использовать его следует осторожно, так как модуль может выполняться несколько раз, а также выполняться без дальнейшего запуска базы. Выполняется до модулей приложения.
С уважением, (преподаватель и разработчик ).
В статье представлен краткий обзор и особенности такой функциональности, как Повторное использование возвращаемых значений общих модулей.
Проблемы при работе с 1С
Зачастую, работая с программой 1С, требуется получение значений, хранящихся в базе данных, они не меняются годами. Примером может быть значение констант. К этой группе значений можно условно причислить поиск одного из элементов справочника или поиск узла плана обмена, используя код, а также необходимость получить значение реквизитов объектов.
Решаются подобные задачи быстро и просто с использованием конструкций следующего типа:
Если ДатаДокумента > Константы.ДатаНачалаПримененияПостановления1137.Получить() Тогда
Но при каждом выполнении данного кода происходит обращение к базе данных.
Многие программисты пользуются следующим способом для разгрузки базы данных. Они выполняют всего один запрос к БЗ и кэшируют те данные, которые могут быть им нужны. Однако этот способ не разгружает базы данных до желаемого значения. Причины этого могут быть следующими:
· не вполне ясный цикл выполнения кода (например, при групповом перепроведении документов);
· получение строгого набора данных, необходимых не в данный момент, иногда невозможно или удается с трудом;
· использование уже кэшированных данных в различных формах/вызовах.
Модуль с повторным использованием возвращаемых значений
Решить описанные выше проблемы поможет использование моделей с повторным использованием возвращаемых значений. Что это такое? Это общий клиентский либо серверный модуль, в котором в функции "На время вызова" или "На время сеанса" следует установить Повторное использование возвращаемых значений. Все операции и функции непосредственно в модуле описываются как раньше.
Безусловным преимуществом этого способа является то, что возврат закэшированного значения происходит без реального выполнения кода функции. Это происходит со всеми следующими за первым вызовами экспортных функций данных модулей. Такой же эффект можно увидеть при измерении производительности.
При выполнении кода осуществляется кэширование возвращаемых значений через значения переданных параметров. Таким образом это происходит непосредственно при выполнении кода
Узел1 = НашМодуль.ПолучитьУзелОбменаСБухгалтерией("0001");
Узел2 = НашМодуль.ПолучитьУзелОбменаСБухгалтерией("0002");
И один, и другой вызов приводят к выполнению соответствующей операции и возвращают разные ссылки. Однако уже при следующих вызовах узлы с кодом 0001 или 0002 будут возвращаться, не вызывая повторную операцию и, соответственно, не обращаясь к базе данных.
Значения будут кэшированы изолированно при каждом сеансе и на клиенте, и на сервере (это зависит от того, от какого модуля был совершен вызов, – клиентского или серверного). Все отработает безупречно в том случае, если в настройках прав доступа либо любой другой зависимости полученного значения есть какие-либо особенности.
Несколько НО
Как в любом правиле, в этом способе есть исключения. Не следует указывать сложные типы в параметрах функций, достаточно простых типа Дата, Число, Неопределенно и так далее. Не стоит пытаться указать в качестве параметров, к примеру, структуру, объект или таблицу значений. Результат в первый раз вы получите, но во второй раз уже ничего толкового не выйдет.
Возвращаемое значение может при этом быть любого типа.
Кроме этого, не забывайте обращать внимание на то, данные какого размера вы кэшируете, так как память сервера хоть и огромна, но не безгранична.
Фича или баг от 1С
У значений, которые используются повторно, есть интересная черта. Можно предположить, что это фич или бага, но в любом случае на это стоит обратить внимание.
При введении следующего кода:
ЗначениеСтруктура1 = НашМодуль.ПолучитьСтруктуруЗначенийРеквизитов(СсылкаНаОбъект);
ЗначениеСтруктура1.Наименование = "Новое наименование";
ЗначениеСтруктура2 = НашМодуль.ПолучитьСтруктуруЗначенийРеквизитов(СсылкаНаОбъект);
в ЗначениеСтруктура2.Наименование появится именно Новое наименование. Это может быть использовано для того, чтобы обновлять значения, которые действительно были изменены в базе данных, но неизвестно, сколько еще времени это можно будет делать. Потому как при создании типовых решений так делать нельзя.
Если были изменены закэшированные данные
Если в базе данных были изменены закэшированные значения, воспользоваться можно одним-единственным способом – методом ОбновитьПовторноИспользуемыеЗначения. В этом случае во всех модулях происходит сброс значений настроек всех функций. Отсутствует возможность обновления по одним каким-то значениям параметров, либо функциям, либо модулям.
Как осуществляется запрос в цикле
Если вы не хотите воспользоваться функцией с повторным использованием возвращаемых значений, предлагаем вашему вниманию еще несколько креативных подходов для решения проблемы.
· Универсальные процедуры, которые возвращают реквизиты произвольных ссылок.
· Создание процедуры, которые возвращают значения констант по их имени. Кстати, такие процедуры есть в типовых версиях.
· Возвращение объема, чуть большего, чем тот, который необходим, чтобы уменьшить число вызовов. К примеру, при необходимости получения курса одновременно нескольких валют, желательно вызывать функцию исключительно по дате без отбора валют. Получив все курсы, определять, какая валюта сейчас нужна, а которая нет.
· Создание процедуры, которая будет выполнять запрос с одновременным кэшированием полученного результата (входящие параметры – текст запроса, несколько имен и значений параметров).
О еще одном методе хочется рассказать подробнее. Этот метод построен на использовании функции, которая содержит вызов базы данных, с повторным использованием возвращаемого значения непосредственно в цикле, то есть своеобразный запрос в цикле. В некоторых случаях подобное построение может улучшить производительность. Следует выполнять следующее условие: должно быть небольшим число различных значений входящих параметров, встречающихся в цикле, а большая часть сочетаний хотя бы раз уже была получена ранее в данном сеансе. Следует помнить, что заранее получить определенный набор сочетаний всех значений входящих параметров крайне сложно, а попытки получить значения для всевозможных сочетаний могут привести к считыванию слишком большого количества данных из базы данных.
Мы привели вам лишь примерные функции и методы. Поэтому прежде чем воспользоваться ими, оцените те условия, в которых будет работать ваш код.
/
Клиент-серверное взаимодействие и вопросы безопасности
Использование модулей с повторным использованием возвращаемых значений
Область применения: управляемое приложение, мобильное приложение, обычное приложение.
1. Общие модули с повторным использованием возвращаемых значений (далее: кэш) предусмотрены для кэширования результатов работы функций, которые в них размещены - на время сеанса или на время вызова . Их следует применять для экономии вычислительных ресурсов сервера и для минимизации клиент-серверного взаимодействия.
См. также: раздел "Повторное использование возвращаемых значений" документации по платформе 1С:Предприятие,
Использование значений, влияющих на поведение клиентского приложения
2. В то же время, чрезмерное (неоправданное) применение общих модулей с повторным использованием возвращаемых значений может приводить к излишнему потреблению памяти.
2.1. Недопустимо создать общие модули с повторным использованием, из которых возвращаются данные, вычисление которых выполняется быстрее, чем получение из кэша. Например, строковые константы. Кроме того, что получение строковой константы каждый раз будет работать гораздо быстрее, чем получение ее из общего модуля с повторным использованием, эти данные будут занимать память кэша.
Например, неправильно размещать в модуле с повторным использованием:
Имеет смысл кэшировать данные, полученные из базы данных, внешних источников данных или путем сложных (ресурсоемких) вычислений. Причем в ряде случаев, даже значения, полученные из базы данных, не стоит кэшировать, если выгода от их кэширования – неочевидна. Например, не стоит кэшировать константы (объект метаданных) примитивных типов, поскольку часто они привносят лишь незначительную долю от общего времени выполнения ресурсоемкой операции.
2.2. Следует помещать в кэш только такие данные, к которым потом будут часто обращаться.
В частности, следует иметь в виду, что кэш не хранит данные вечно. Закэшированное значение будет удалено из кэша через 20 минут после вычисления или через 6 минут после последнего использования (в зависимости от того, что наступит раньше*). Кроме этого значение будет удалено при нехватке оперативной памяти в рабочем процессе сервера, при перезапуске рабочего процесса и при переключении клиента на другой рабочий процесс. Поэтому если никто "не успел" воспользоваться данными из кэша, то этот ресурс был потрачен зря.
* Примечание: конкретные цифры могут варьироваться в зависимости от используемой версии платформы 1С:Предприятие.
2.3. Диапазон значений входных параметров функций, размещенных в общих модулей с повторным использованием, не должен быть широким.
Например, в конфигурации предусмотрена функция, получающая на вход контрагента. Если контрагентов в базе очень много, а сценарий работы пользователей таков, что вероятность того, что кто-то за 5 минут обратится к этому же контрагенту, очень невысокая, то ресурсы будут потрачены впустую. Кроме того, если эту «трату» умножить на количество одновременно работающих пользователей, то бесполезные расходы ресурсов становятся значительными.
3. Не следует изменять данные, полученные из кэша. В противном случае, возможны скрытые ошибки в работе программы, а также бесполезное расходование памяти (ресурсов кэша). Поэтому в качестве возвращаемых значений рекомендуется использовать значения, состояние которых изменить нельзя, например: ФиксированныйМассив , ФиксированнаяСтруктура .
Это ограничение вызвано тем, что кэш возвращает каждый раз не копию объекта, а ссылку на один и тот же объект в памяти. Например, если в массив, который возвращает функция с повторным использованием, при каждом вызове при проведении документов дописывать новое значение, то в результате кэш очень быстро «распухнет». Кроме того, при очередном сбросе кэша, добавленные значения будут потеряны и код, который на них опирался, будет работать некорректно.
4. Если в модуле с повторным использованием размещено несколько экспортных функций, которые не только вызываются «снаружи», но и вызывают друг друга, то следует иметь в виду, что результат «внутренних» вызовов не кэшируется.
Например, если в модуле ОбменДаннымиПовтИсп
размещено две экспортных функции:
Функция АвтономнаяРаботаПоддерживается() Экспорт Возврат . . . КонецФункции Функция ЭтоАвтономноеРабочееМесто() Экспорт Возврат АвтономнаяРаботаПоддерживается() И . . . ; КонецФункции
которые последовательно вызываются из прикладного кода,
ОбменДаннымиПовтИсп.АвтономнаяРаботаПоддерживается(); ... = ОбменДаннымиПовтИсп.ЭтоАвтономноеРабочееМесто();
то функция АвтономнаяРаботаПоддерживается будет вычислена дважды.
Статья продолжает цикл «Первые шаги в разработке на 1С», в ней детально рассмотрены следующие вопросы:
- Что такое программный модуль и из каких разделов он состоит?
- Для чего нужен модуль приложения? Почему их два? Когда какой запускается? Какие есть тонкости работы?
- Какие события связаны с началом работы системы, как и где их обрабатывать?
- Для чего нужен модуль внешнего соединения? Когда и как его использовать?
- Когда используется модуль сеанса?
- Что такое общие модули? Какие у него свойства и правила работы? Для чего нужно использовать свойство “Повторное использование возвращаемых значений”?
- Когда используется модуль формы и какие события в нем могут быть обработаны?
- Для чего предназначен модуль объекта? Из каких разделов он состоит? Как посмотреть доступные события модуля?
- Какие тонкости работы существуют с модулями менеджера значения (для констант) и модулями набора записей (для регистров)?
- В чем отличия между модулем объекта и модулем менеджера? Когда нужно использовать последний?
Применимость
В статье рассматривается платформа «1C:Предприятие» 8.3.4.496. Материал актуален и для текущих релизов платформы.
Модули в «1С:Предприятие 8.3»
Модули – это те объекты, где содержится программный код.
В Платформе существует достаточно большое количество видов модулей, каждый из которых имеет свое предназначение и особенности.
Любая строка кода должна находиться в каком-либо модуле. Различают модули общего предназначения и модули объекта. Некоторые модули могут быть скомпилированы как на Клиенте, так и на Сервере, а некоторые только на Сервере.
Модуль может состоять из нескольких разделов. В разделе описания переменных описываются локальные переменные данного модуля, которые впоследствии могут быть использованы в любой процедуре.
Внутри каждой процедуры можно обращаться к переменной модуля. Кроме того, внутри самой процедуры может быть еще одно объявление переменной с таким же именем. Это будет локальная переменная данной процедуры.
Несмотря на одинаковое название, это две разные переменные: одна используется внутри конкретной процедуры, а другая – вне ее.
В некоторых модулях для переменных может указываться место компиляции (доступность) на Сервере или на Клиенте. Например:
За разделом описания переменных следует раздел процедур и функций, где указываются локальные методы данного модуля. В некоторых модулях следует указывать, где будет скомпилирована процедура или функция.
В принципе, директиву компиляции можно не указывать. В этом случае директивой компиляции по умолчанию является Сервер. Тем не менее, для удобства анализа программного кода рекомендуется явно указывать, где будет скомпилирована данная процедура. Порядок описания процедур никакого значения не имеет.
В конце модуля, после описания всех процедур и функций, располагается раздел основной программы, где могут содержаться некоторые операторы, инициализироваться локальные переменные модуля формы. Данный раздел выполняется при обращении к модулю.
Так, например, при открытии формы элемента прежде всего выполняется раздел основной программы модуля формы.
Следует отметить, что раздел объявления переменных и раздел основной программы существуют не для всех модулей (т.е. в некоторых модулях данные разделы недопустимы). Раздел описания процедур и функций может существовать абсолютно в любом модуле.
Модуль приложения
Данный модуль предназначен для того, чтобы обработать события запуска приложения и завершения его работы. Например, при запуске приложения можно загружать курсы валют из Интернета. При завершении приложения можно удостовериться у пользователя о его намерениях закончить работу.
Также в модуле приложения существуют специальные обработчики, которые позволяют перехватить внешние события от оборудования.
Это могут быть события от ридера магнитных карт, фискального регистратора. И эти события можно каким-то образом тоже обработать.
Следует обратить внимание, что в модуле приложения отслеживается именно интерактивный запуск системы.
Модуль приложения не будет работать, если запуск программы 1С осуществляется, например, в режиме com-соединения. В этом случае окно программы не создается.
Следует отметить, что в Платформе 8.3 существует два разных модуля приложения: модуль Управляемого приложения и модуль Обычного приложения. События модуля управляемого приложения отрабатываются при запуске Тонкого и Толстого клиента Управляемого приложения и Веб-клиента.
Модуль Обычного приложения работает при запуске Толстого клиента в режиме Обычного приложения , в котором присутствует обычный командный интерфейс в виде Главного меню .
Если приложение работает и в режиме Управляемого , и в режиме Обычного приложения , то необходимо описывать процедуры-обработчики как для модуля Управляемого приложения , так и для модуля Обычного приложения .
Модуль Управляемого приложения можно выбрать из контекстного меню корневого узла конфигурации.
Также этот модуль можно открыть из палитры свойств корневого элемента конфигурации.
Чтобы открыть модуль Обычного приложения , следует обратиться к настройкам конфигурации (команда Параметры в меню Сервис ).
Откроется форма Параметры . На закладке Общие должен быть указан режим редактирования конфигурации Управляемое приложение и Обычное приложение .
В этом случае модуль Обычного приложения также можно будет открыть из свойств корневого узла.
Список событий, которые можно обрабатывать, для Управляемого и Обычного приложения одинаков.
В данном модуле можно размещать раздел объявления переменных, раздел описания произвольных процедур и функций и раздел основной программы. Но кроме произвольных процедур и функций в модуле могут быть расположены специальные обработчики событий.
Список доступных обработчиков можно посмотреть, если при открытом модуле вызвать список процедур и функций текущего модуля.
В раскрывшемся окне Процедуры и функции отображаются все процедуры и функции данного модуля, а также события, для которых обработчики еще не созданы.
Есть два события, связанные с началом работы системы (“перед” и “при”). Два события, связанные с завершением работы системы (“перед” и “при”). А также обработка внешнего события (например, события торгового оборудования).
Когда выполняется обработчик события “перед”, считается, что действие еще не совершено. Когда выполняется обработчик события “при” – действие уже совершено.
Событие ПередНачаломРаботыСистемы возникает в тот момент, когда производится запуск Предприятия 8.3, но само приложение еще не появилось на экране. У данного события есть такой параметр, как Отказ .
Если этот параметр примет значение Истина , то приложение не запустится. Событие ПриНачалеРаботыСистемы предполагает, что действие уже совершено, окно уже создано, и в этом случае мы можем, например, отобразить какую-то специальную форму. От запуска отказаться уже нельзя.
Аналогично перед завершением работы системы приложение еще открыто и можно отказаться от его завершения. При завершении работы системы окно приложения уже закрылось. Возможно выполнить лишь дополнительные действия, например, по удалению каких-то файлов или отправке электронного письма.
В модуле Управляемого приложения не указываются директивы компиляции процедур и функций, так как модуль целиком компилируется на стороне Клиента. Это означает, что в процедурах и функциях модуля мы не сможем непосредственно обратиться, например, к справочникам.
Если из модуля Управляемого приложения необходимо сделать Серверный вызов, то для этого нужно будет создавать специальные с выставленным флагом .
В модуле Обычного приложения подобных ограничений нет, так как данный модуль будет компилироваться при загрузке Толстого клиента. В Толстом клиенте доступны практически все типы данных.
Процедуры, функции и переменные модуля приложения могут быть описаны как экспортные.
Поскольку модуль скомпилирован целиком на Клиенте, это означает, что в клиентских процедурах мы можем обращаться к данному методу и данному свойству.
Например, из модуля формы какого-либо объекта можно вызвать процедуру или функцию модуля приложения. Однако для описания общих алгоритмов рекомендуется использовать Общие модули. Основное предназначение модуля приложения – обработать точку старта и точку завершения.
По аналогии с модулем приложения данный модуль предназначен для того, чтобы обработать событие открытия программы и событие завершения работы.
В отличии от модуля приложения, который инициируется в момент интерактивного запуска приложения, модуль внешнего соединения работает в режиме com-соединения, т.е. когда создается объект 1С:Предприятие 8 и осуществляется подключение к определенной базе.
В этом модуле есть события: ПриНачалеРаботыСистемы и ПриЗавершенииРаботыСистемы .
Модуль внешнего соединения можно открывать используя либо контекстное меню на уровне корневого объекта конфигурации, либо палитру свойств для корневого узла.
Сам процесс внешнего соединения – это процесс программной работы с информационной базой, а не интерактивный. Соответственно, в этот момент нельзя использовать диалоговых форм, выводить предупреждающие сообщения, так как нет пользовательского интерфейса.
В Модуле внешнего соединения возможно описывать экспортные переменные и экспортные методы, которые будут доступны на той стороне, где происходит внешний вызов 1С:Предприятие 8.3.
Поскольку во внешнем соединении нет пользовательского интерфейса, Модуль внешнего соединения компилируется целиком на Сервере.
Модуль сеанса
Данный модуль нужен для того, чтобы инициализировать параметры сеанса. Параметры сеанса – это быстрые глобальные переменные, значения которых доступны в любом месте конфигурации.
Открыть Модуль сеанса можно либо через контекстное меню, либо через палитру свойств корневого узла.
В Модуле сеанса предусмотрено событие УстановкаПараметровСеанса .
При старте приложения данная процедура вызывается самой первой. Параметры сеанса нужны при любой работе приложения: как при интерактивном запуске, так и при запуске в режиме внешнего соединения.
В Модуле сеанса описываются различные действия по инициализации параметров сеанса в зависимости от разных условий.
В данном модуле, как правило, описываются несколько процедур, которые вызываются из процедуры УстановкаПараметровСеанса . Поэтому все эти процедуры выделены в отдельный модуль.
Модуль сеанса всегда исполняется в привилегированном режиме. Это означает, что не будет выполняться проверка прав доступа при обращении к базе данных. Модуль сеанса компилируется на Сервере, т.е. возможно обращение к любым серверным методам (в том числе и чтение значений из базы).
В Модуле сеанса возможно определять только процедуры и функции, т.е. нет раздела описания переменных и нет раздела основной программы. В Модуле сеанса нельзя описывать экспортные методы.
Если при запуске системы необходимо выполнить некоторые действия на Сервере, например, создать элемент какого-либо справочника, то, как вариант, возможно использовать Модуль сеанса, т.к. он компилируется на Сервере и всегда достоверно выполняется при старте системы. Однако при этом необходимо учитывать следующие моменты:
- процедура УстановкаПараметровСеанса выполняется не только при старте системы, а также при обращении к неинициализированным параметрам сеанса. Т.е. обработчик УстановкаПараметровСеанса может вызываться неоднократно в процессе работы приложения;
- если количество элементов в массиве параметров сеанса равно нулю (у массива требуемых параметров тип данных Неопределено), то это момент запуска приложения;
- поскольку Модуль сеанса работает в привелигированном режиме и проверки прав доступа не будет, следует очень аккуратно работать с объектами базы данных, так как пользователь может получить доступ к тем данным, которые ему не должны быть предоставлены;
- при запуске системы достоверно еще не известно: будет ли запущено приложение. При этом в обработчике события УстановкаПараметровСеанса могут быть произведены лишние действия.
Данные модули представляют собой описание некоторых общих алгоритмов, т.е. процедур и функций, которые могут вызываться из различных мест.
Логически связанные методы можно группировать в разные Общие модули. Эти модули создаются внутри ветки Общие.
Можно добавить любое количество общих модулей. Чтобы методы Общих модулей были доступны в других местах конфигурации, необходимо их определять с ключевым словом Экспорт. Клиентские процедуры общих модулей будут доступны на Клиенте, а серверные – на Сервере.
В Общих модулях доступен только раздел описания процедур и функций. Т.е. в Общем модуле нельзя описывать переменные и нельзя описывать раздел основной программы.
Если необходима глобальная переменная, то можно использовать либо параметры сеанса, либо экспортные переменные модуля приложения.
Для Общих модулей можно задавать некоторые параметры, которые будут влиять на поведение данного модуля. Если для Общего модуля выставлено свойство Глобальный, то объявленные в данном модуле экспортные методы будут доступны из вне напрямую, без каких-либо дополнительных указаний.
Т.е. данный Общий модуль будет участвовать в формировании глобального контекста конфигурации.
Свойство Глобальный для общих модулей может быть полезным. Однако не стоит его использовать повсеместно для всех общих модулей.
Те , которые отмечены признаком Глобальный , будут компилироваться при старте системы. Чем больше таких модулей, тем медленнее программа будет стартовать.
Если флаг Глобальный для Общего модуля не указан, то компиляция данного модуля будет выполняться в момент первого обращения к нему (т.е. уже после старта системы).
Кроме того, использование глобальных общих модулей влияет на понимание кода. Вызов методов не глобального общего модуля осуществляется через имя Общего модуля
и имя метода, например:
МодульРасчетаСебестоимости.РаспределитьКосвенныеЗатраты();
При этом имена Общих модулей должны отражать содержание описываемых в них процедур. Указание имени Общего модуля при вызове процедуры способствует лучшему пониманию кода.
Для Общего модуля в Палитре свойств можно установить свойство Привилегированный .
В привилегированном модуле не контролируются права доступа. Это необходимо в том случае, если в Общем модуле требуется выполнять массовую обработку данных, получение данных из базы.
Контроль прав доступа увеличивает время обращения к базе данных, а массовые алгоритмы, зачастую, должны работать как можно быстрее.
Например, ресурсоемкой операцией является расчет заработной платы. Необходимо, чтобы она выполнялась как можно быстрее. Для этого алгоритмы, которые рассчитывают заработную плату, помещают в привилегированные .
При этом все процедуры, которые обеспечивают заполнение документов по начислению заработной платы, находятся вне этих Общих модулей . Именно в этих процедурах и выполняется контроль прав доступа.
Таким образом можно достичь значительного повышения быстродействия. Особенно это касается случая применения механизма построчного разграничения доступа к записям таблицы.
Если Общий модуль является привилегированным, то процедуры этого модуля могут быть скомпилированы только на Сервере.
Бывают ситуации, когда пользователю какой-то объект должен быть недоступен, например, определенный справочник. Но при проведении какого-то одного документа обращение к данному справочнику необходимо.
Т.е. возникает потребность временно расширить права пользователя, а потом вернуть их в исходное состояние. Этот эффект может быть получен при использовании привилегированных Общих модулей .
Для этого в привилегированном Общем модуле следует оформить процедуру, которая обращается к нужным данным.
Данная процедура будет вызываться из соответствующего документа. Т.е. пользователю на момент вызова этой процедуры фактически предоставляются расширенные права.
Для Общих модулей существует возможность указывать место компиляции. С помощью флагов устанавливается: будет ли доступен Общий модуль на Клиенте (управляемое приложение), на Сервере, в режиме работы Внешнего соединения.
Кроме того, если перевести режим редактирования конфигурации в Управляемое приложение и обычное приложение, то будет возможен еще один контекст компиляции – Клиент (обычное приложение).
Таким образом, выделяется четыре варианта функционирования программы. В зависимости от запущенного приложения, в зависимости от работы на Клиенте или на Сервере будут доступны или недоступны определенные Общие модули.
Кроме возможности указывать флаги компиляции имеется возможность указывать директивы компиляции для процедур и функций, располагающихся в Общем модуле.
Если для метода указана директива компиляции, то не смотря на то, что Общий модуль доступен во всех указанных контекстах, доступность конкретного метода будет ограничена директивой компиляции.
При этом процедура не может быть доступна в контексте, который не доступен в целом для всего модуля.
Если директиву компиляции для процедуры (функции) не указывать, то она будет скомпилирована во всех контекстах, определенных для модуля.
Т.е. по сути будет сделано несколько копий процедуры. Выбор конкретного скомпилированного экземпляра зависит от места вызова процедуры (по правилу ближайшего вызова). При этом следует учитывать, что код такой процедуры должен быть написан с учетом его доступности во всех определенных для модуля контекстах.
Общие модули, одновременно доступные в нескольких различных контекстах, в основном предназначены для того, чтобы создавать процедуры, доступные в нескольких контекстах.
При создании Общего модуля, правилом хорошего тона считается не указывать директивы компиляции. Т.е. доступность процедур и функций должна определяться свойствами самого модуля.
При таком подходе в отдельных Общих модулях будут располагаться клиентские процедуры, и в отдельных Общих модулях – процедуры серверные.
Модули, у которых установлено несколько флагов компиляции, на практике используются крайне редко. Это некоторые общие действия, доступные как на Клиенте, так и на Сервере. Обычно, это какие-то простейшие вычисления.
Важно! С Клиента возможно обращаться к экспортным серверным методам Общего модуля, но только в том случае, если данный Общий модуль скомпилирован только на Сервере. При этом для обеспечения доступа с Клиента предназначен специальный флажок .
Для неглобальных Общих модулей существует возможность кэширования тех значений, которые возвращаются функциями. Т.е. система может после первого вызова функции запомнить результат ее выполнения. Если данная функция будет вызвана еще раз с теми же параметрами, система выдаст значение уже из кэша.
Цель данного механизма – ускорить повторные вызовы. Для настройки подобного поведения необходимо в Палитре свойств модуля выставить соответствующее значение для свойства Повторное использование возвращаемых значений.
По умолчанию для данного свойства определено значение Не использовать. Другие возможные значения: кэшировать На время вызова , либо На время сеанса .
Данное свойство имеет смысл использовать только для тех функций, результат которых зависит исключительно от входных параметров. Данный механизм доступен только для не глобальных Общих модулей.
Если выбрано значение соответствующего параметра На время вызова, то кэш будет действовать до тех пор, пока работает та процедура, откуда был сделан вызов метода Общего модуля. Если выбрано значение На время сеанса, то условно считается, что кэш будет действовать, пока пользователь работает.
Тем не менее, существуют определенные временные ограничения. Очистка кэша происходит автоматически через 20 минут после попадания значения в кэш.
Модуль формы
Данный модуль предназначен для того, чтобы обработать действия пользователя. Например, описать алгоритм реакции программы при нажатии кнопки. Или, например, в момент ввода в поле значения сразу же выполнить проверку на корректность.
Кроме событий, связанных с элементами управления формы (кнопки, поля ввода) существуют события, связанные непосредственно с самой формой.
Например, можно обработать событие открытия формы и провести некую начальную инициализацию. Также можно обработать событие закрытия формы и проверить, а все ли правильно ввел пользователь.
Существуют формы управляемые и формы обычные. Модули данных форм различаются прежде всего тем, что модуль управляемой формы четко разделяется на контекст. Каждая процедура (функция) должна иметь директиву компиляции. В обычной форме весь код используется на Клиенте.
В модуле управляемой формы можно объявлять процедуры и функции, можно объявлять переменные и описывать раздел основной программы.
Программный код основной программы будет выполняться в момент инициализации формы, т.е. когда пользователь начинает ее открывать. На рисунке представлен список стандартных событий для управляемой формы.
Список событий управляемой формы виден также в списке свойств непосредственно для самой формы. Данный список вызывается в редакторе управляемых форм.
В управляемой форме можно обработать событие записи элемента. Данное событие присутствует только для форм объектов (справочников, документов и некоторых других). Если форма не привязана к конкретному объекту, то событие записи отсутствует.
Для модуля обычной формы перечень стандартных событий несколько меньше, т.к. в управляемой форме многие события сделаны парными (одно выполняется на Клиенте, а другое на Сервере). В обычной форме весь код исполняется на Клиенте.
Модуль объекта
Данные модули характерны для справочников, документов, планов видов расчетов, планов счетов и многих других объектов. Модуль объекта предназначен для обработки стандартных событий. Например, событие на ввод элемента справочника, событие на запись элемента, удаление, проведение документа и т.д.
В принципе, событие записи существует и в Модуле формы. Но событие записи в Модуле формы возникает в процессе интерактивной записи, при работе с конкретной формой.
Событие записи в Модуле объекта будет выполняться при любой записи из любой формы данного объекта. Кроме того, если объект записывается программно, в этом случае будет срабатывать событие модуля объекта.
В событии записи Модуля объекта можно встраивать все проверки на корректность записываемых данных, так как эта процедура будет отрабатывать в момент абсолютно любой записи.
Модуль данного объекта можно вызывать через контекстное меню, из Палитры свойств объекта и из окна редактирования объекта.
Ниже на рисунке представлен перечень доступных событий модуля справочника.
В Модуле объекта можно размещать раздел описания переменных, описывать произвольные функции, которые могут быть и не связаны с событием, а также раздел основной программы.
В разделе основной программы можно, например, выполнять инициализацию локальных переменных данного модуля. Этот программный код будет выполняться при обращении к данному Модулю объекта.
Следует отметить, что все процедуры Модуля объекта скомпилированы на Сервере. Соответственно директивы компиляции у процедур и функций Модуля объекта указывать не требуется. У некоторых объектов конфигурации не существует Модулей объектов.
Это связано с особенностями самих объектов. К таким объектам относятся Константы и Регистры . Для Констант не существует модуля объекта, но существует очень похожий модуль, который называется Модулем менеджера значения .
В Модуле менеджера значения можно выполнить обработку событий записи Константы и обработку проверки заполнения.
Весь контекст модуля исполняется на Сервере.
Для регистров существует Модуль набора записей.
В данном модуле также имеется возможность обрабатывать события записи и выполнять проверку заполнения.
В Модулях объектов, Модулях менеджера значения (для констант) и Модулях набора записей (для регистров) можно описывать методы, которые можно делать экспортными, и эти методы будут доступны из вне.
Т.е. помимо использования фиксированных методов класса объектов можно создавать для объекта дополнительные методы в Модуле объекта. В данном модуле следует описать соответствующую процедуру с ключевым словом Экспорт .
Тогда будет возможно обращаться к этой процедуре из вне. Причем данный метод будет отображаться в контекстной подсказке. Новые методы в контекстной подсказке выделяются синим шрифтом (синий значок p() для процедур и f() для функций).
Аналогичным образом можно создавать новое свойство, объявив переменную с ключевым словом Экспорт . К этому свойству также можно будет обращаться из вне.
Таким образом возможно расширять функциональность объектов (доопределять новые методы и новые свойства). При этом свойства являются динамическими и не сохраняются в базе данных.
Если необходимо использовать для объекта свойство, которое будет храниться в базе данных, следует создавать реквизит объекта.
Модуль менеджера
Данный модуль существует для многих объектов (справочники, документы, регистры и др.). Модуль открывается либо через контекстное меню для объекта, либо через Палитру свойств , либо через окно редактирования.
В Модуле менеджера можно переопределить некоторые стандартные события.Например, в ОбработкеПолученияДанныхВыбора , когда выбирается элемент из справочника, можно сделать какую-то дополнительную фильтрацию или проверку.
Кроме этого в Модуле менеджера можно создать дополнительные методы и указать, что они являются экспортными. В этом случае возможно обращение к данным методам из вне.
Для того, чтобы выполнить данное обращение, необходимо получить тип данных СправочникМенеджер .
Отличие экспортных методов Модуля менеджера и Модуля объекта состоит в том, что для обращения к методу Модуля объекта вначале нужно получить сам объект (т.е каким-то образом получить ссылку и далее эту ссылку преобразовать в объект).
После этого будут доступны экспортные переменные и методы Модуля объекта. Для Модуля менеджера обращение более простое, например:
Справочники.Контрагенты.ИмяМетода
Это два разных обращения. Преобразование из ссылки в объект (метод ПолучитьОбъект ) – это достаточно серьезное действие для системы, так как при получении объекта читаются абсолютно все данные этого объекта, что может быть достаточно длительным.
Второе отличие в том, что МодульОбъекта вызывается в контексте конкретного элемента. Соответственно можно считать, что он применим для данного элемента (в большинстве случаев закладывается именно такая логика).
Что касается Модуля менеджера, то в нем описывается какое-то общее действие для группы или для всех элементов справочника или какого-то документа. Например, если необходимо напечатать элемент справочника, можно использовать Модуль объекта.
Но в Модуле менеджера возможно сделать более универсальный механизм, который будет печатать, в том числе, и группу элементов.
Кроме того, обращение к Модулю объекта – это все-таки более длительное действие. Поэтому решать данную задачу в модуле менеджера более предпочтительно.
На этом завершим наше знакомство с модулями в конфигурации системы «1С:Предприятие». Если подвести краткое резюме всему вышенаписанному, то в сухом остатке получаются следующие выводы:
- Программный модуль – это часть конфигурации, которая может содержать только текст на встроенном языке 1С
- Программные модули классифицируются по видам, которые мы рассмотрели в этой статье. Каждый вид определяется местом размещения и доступным программным контекстом.
- Структура модуля состоит из некоторых разделов, которые располагаются в определенной последовательности. Состав разделов определяется видом модуля.
Также отметим, что мы сознательно опустили один вид модуля, а именно модуль команды. Ничего примечательного он из себя не представляет, и мы предлагаем вам самостоятельно ознакомиться с его функциональностью.
Пока весь наш программный код мы рассматривали отрывочно от прикладного решения, и как правило, писали его в какой-то своей небольшой тестовой конфигурации. А вы в курсе, что «нельзя просто так взять» и начать редактировать код типовой конфигурации? Нет? Тогда в следующей статье мы все это объясним!
