Фоновое задание для выполнения асинхронных операций.
Полное описание, параметры и ограничения
ФоновоеЗадание (BackgroundJob)
ФоновоеЗадание (BackgroundJob)
Доступен, начиная с версии 8.1.
Свойства:
ИмяМетода (MethodName)
ИнформацияОбОшибке (ErrorInfo)
Ключ (Key)
Конец (End)
Наименование (Description)
Начало (Begin)
НомерРодительскогоСеанса (ParentSessionNumber)
РазделениеДанных (DataSeparation)
Расположение (Location)
РегламентноеЗадание (ScheduledJob)
Состояние (State)
УникальныйИдентификатор (UUID)
Методы:
ОжидатьЗавершения (WaitForCompletion)
ОжидатьЗавершенияВыполнения (WaitForExecutionCompletion)
Отменить (Cancel)
ПолучитьСообщенияПользователю (GetUserMessages)
Описание:
Фоновое задание для выполнения асинхронных операций.
Доступность:
Сервер, толстый клиент, внешнее соединение, мобильное приложение (сервер), мобильный автономный сервер.
См. также:
МенеджерФоновыхЗаданий, метод НайтиПоУникальномуИдентификатору
МенеджерФоновыхЗаданий, метод Выполнить
РегламентноеЗадание, свойство ПоследнееЗадание
Использование в версии:
Доступен, начиная с версии 8.1.
Описание изменено в версии 8.3.27.
Методическая информация
Практические примеры
Отменить только свой расчёт и учитывать гонку завершения
Собственная ограниченная задача складывает миллион одинаковых цен в памяти. Отменяем только сохранённый UUID после проверки ключа и имени метода.
Где и как запускать
Полный серверный неглобальный общий модуль УчебныеФоновыеЗадачи отдельной собственной учебной конфигурации.
Подготовка
Создайте отдельную собственную учебную конфигурацию с именем УчебнаяКонфигурацияСинтаксиса. Не используйте рабочую базу или копию с включёнными заданиями обмена, рассылки и обработчиками бизнес-данных.
Создайте неглобальный общий модуль УчебныеФоновыеЗадачи: Сервер = Истина, Глобальный = Ложь, Привилегированный = Ложь. Вставьте полный модуль одного урока; имя модуля используется в строке запуска.
ВыполнитьПример() вызывайте из серверного обработчика своей учебной команды обычного сеанса 1С. Не запускайте из COM/внешнего соединения с файловой базой или из другого фонового задания файловой базы.
Нужны права запуска собственных фоновых заданий. Не включайте привилегированный режим для обхода отказа. Передаются только сериализуемые числа и строка режима.
Задание считает собственные числа в памяти и публикует СообщениеПользователю. Документы, регистры, файлы, интернет и настройки пользователей не меняются. История собственных заданий остаётся в базе по правилам платформы.
Выполнить возвращает объект задания, а не результат вычисления. Трёхсекундный таймаут ограничивает одно ожидание; он не отменяет задание и не доказывает успешное завершение.
Процедура Рассчитать(Количество, Цена, Режим) Экспорт
Если Количество < 0 Или Количество > 1000000 Или Количество <> Цел(Количество) Тогда
ВызватьИсключение "guide-owned: количество должно быть целым от 0 до 1000000";
КонецЕсли;
Если Цена < 0 Тогда
ВызватьИсключение "guide-owned: цена не может быть отрицательной";
КонецЕсли;
Если Режим = "Книга" Тогда
Сумма = Количество * Цена;
ИначеЕсли Режим = "Пакет" Тогда
Сумма = 0;
Для Номер = 1 По Количество Цикл
Сумма = Сумма + Цена;
КонецЦикла;
Иначе
ВызватьИсключение "guide-owned: неизвестный режим";
КонецЕсли;
Сообщение = Новый СообщениеПользователю;
Сообщение.Текст = "guide-owned: сумма " + Формат(Сумма, "ЧГ=0");
Сообщение.Сообщить();
КонецПроцедуры
Процедура ВыполнитьПример() Экспорт
Параметры = Новый Массив;
Параметры.Добавить(1000000);
Параметры.Добавить(250);
Параметры.Добавить("Пакет");
Ключ = "guide-owned-" + Строка(Новый УникальныйИдентификатор);
Задание = ФоновыеЗадания.Выполнить("УчебныеФоновыеЗадачи.Рассчитать", Параметры, Ключ, "guide-owned: расчёт книги");
Сообщить("Собственный идентификатор: " + Строка(Задание.УникальныйИдентификатор));
Идентификатор = Задание.УникальныйИдентификатор;
Задание = ФоновыеЗадания.НайтиПоУникальномуИдентификатору(Идентификатор);
Если Задание = Неопределено Тогда
Сообщить("Собственное задание не найдено; отменять нечего");
Возврат;
КонецЕсли;
Если Задание.Ключ <> Ключ Или Задание.ИмяМетода <> "УчебныеФоновыеЗадачи.Рассчитать" Тогда
ВызватьИсключение "Отмена запрещена: паспорт не совпадает с собственным запуском";
КонецЕсли;
Если Задание.Состояние = СостояниеФоновогоЗадания.Активно Тогда
Попытка
Задание.Отменить();
Исключение
Сообщить("Отмена не подтверждена: " + ОписаниеОшибки());
КонецПопытки;
КонецЕсли;
Задание = Задание.ОжидатьЗавершенияВыполнения(3);
Сообщить("Окончательное наблюдение: " + Строка(Задание.Состояние));
Если Задание.Состояние = СостояниеФоновогоЗадания.Отменено Тогда
Сообщить("Собственная задача отменена; сумма не подтверждается");
ИначеЕсли Задание.Состояние = СостояниеФоновогоЗадания.Завершено Тогда
Сообщить("Расчёт успел завершиться до отмены; это допустимая гонка");
ИначеЕсли Задание.Состояние = СостояниеФоновогоЗадания.Активно Тогда
Сообщить("Задание ещё активно: не объявляйте отмену завершённой");
Иначе
Сообщить("Проверьте ИнформацияОбОшибке собственного задания");
КонецЕсли;
КонецПроцедурыРазбор по шагам
Запустить ограниченный расчёт собственного пакета. Миллион итераций — конечная учебная работа, а не искусственная бесконечная задача.
Повторно найти собственный UUID и сверить паспорт. Отсутствующая задача не заменяется активной чужой.
Запросить отмену только если наблюдаемый статус Активно. Ошибку запроса показать пользователю, не скрывать.
Получить обновлённое состояние ограниченным ожиданием. Различить Отменено, Завершено, Активно и аварийное завершение.
Как проверить результат
Отменяется только UUID, возвращённый собственным запуском: другие задачи не перебираются и не отменяются.
Отменено и Завершено оба возможны: конечный расчёт может закончиться раньше запроса отмены. Активно после таймаута не считается подтверждением отмены.
Ожидаемый результат
Отмена демонстрируется как операция над собственным заданием, не как гарантированный откат результата.
На что обратить внимание
Проверка Активно и Отменить не атомарны: статус может измениться между ними.
Отмена реальной задачи не откатывает уже выполненные записи автоматически. Этот урок не записывает бизнес-данные вообще.
Не увеличивайте цикл до бесконечного и не отменяйте задания по одному только похожему наименованию.
Пример не запускался в вашей базе. Перед применением проверьте его в указанном учебном контексте.
Найти причину ошибки собственного фонового расчёта
Передаём -1 вместо количества и намеренно получаем собственную ошибку в фоне. Исключение внутри рабочего метода отличаем от исключения запуска.
Где и как запускать
Полный серверный неглобальный общий модуль УчебныеФоновыеЗадачи отдельной собственной учебной конфигурации.
Подготовка
Создайте отдельную собственную учебную конфигурацию с именем УчебнаяКонфигурацияСинтаксиса. Не используйте рабочую базу или копию с включёнными заданиями обмена, рассылки и обработчиками бизнес-данных.
Создайте неглобальный общий модуль УчебныеФоновыеЗадачи: Сервер = Истина, Глобальный = Ложь, Привилегированный = Ложь. Вставьте полный модуль одного урока; имя модуля используется в строке запуска.
ВыполнитьПример() вызывайте из серверного обработчика своей учебной команды обычного сеанса 1С. Не запускайте из COM/внешнего соединения с файловой базой или из другого фонового задания файловой базы.
Нужны права запуска собственных фоновых заданий. Не включайте привилегированный режим для обхода отказа. Передаются только сериализуемые числа и строка режима.
Задание считает собственные числа в памяти и публикует СообщениеПользователю. Документы, регистры, файлы, интернет и настройки пользователей не меняются. История собственных заданий остаётся в базе по правилам платформы.
Выполнить возвращает объект задания, а не результат вычисления. Трёхсекундный таймаут ограничивает одно ожидание; он не отменяет задание и не доказывает успешное завершение.
Процедура Рассчитать(Количество, Цена, Режим) Экспорт
Если Количество < 0 Или Количество > 1000000 Или Количество <> Цел(Количество) Тогда
ВызватьИсключение "guide-owned: количество должно быть целым от 0 до 1000000";
КонецЕсли;
Если Цена < 0 Тогда
ВызватьИсключение "guide-owned: цена не может быть отрицательной";
КонецЕсли;
Если Режим = "Книга" Тогда
Сумма = Количество * Цена;
ИначеЕсли Режим = "Пакет" Тогда
Сумма = 0;
Для Номер = 1 По Количество Цикл
Сумма = Сумма + Цена;
КонецЦикла;
Иначе
ВызватьИсключение "guide-owned: неизвестный режим";
КонецЕсли;
Сообщение = Новый СообщениеПользователю;
Сообщение.Текст = "guide-owned: сумма " + Формат(Сумма, "ЧГ=0");
Сообщение.Сообщить();
КонецПроцедуры
Процедура ВыполнитьПример() Экспорт
Параметры = Новый Массив;
Параметры.Добавить(-1);
Параметры.Добавить(250);
Параметры.Добавить("Книга");
Ключ = "guide-owned-" + Строка(Новый УникальныйИдентификатор);
Задание = ФоновыеЗадания.Выполнить("УчебныеФоновыеЗадачи.Рассчитать", Параметры, Ключ, "guide-owned: расчёт книги");
Сообщить("Собственный идентификатор: " + Строка(Задание.УникальныйИдентификатор));
Задание = Задание.ОжидатьЗавершенияВыполнения(3);
Если Задание.Состояние = СостояниеФоновогоЗадания.Активно Тогда
Сообщить("Таймаут: собственное задание ещё активно, успех не подтверждён");
Возврат;
КонецЕсли;
Если Задание.Состояние <> СостояниеФоновогоЗадания.ЗавершеноАварийно Тогда
Сообщить("Ожидалось аварийное завершение, фактически: " + Строка(Задание.Состояние));
Возврат;
КонецЕсли;
Ошибка = Задание.ИнформацияОбОшибке;
Если Ошибка = Неопределено Тогда
ВызватьИсключение "Аварийное состояние без доступной информации об ошибке";
КонецЕсли;
Сообщить(СтрНайти(Ошибка.Описание, "guide-owned: количество") > 0);
Сообщить("Модуль: " + Ошибка.ИмяМодуля);
Сообщить("Строка: " + Строка(Ошибка.НомерСтроки));
Сообщить("Описание: " + Ошибка.Описание);
КонецПроцедурыРазбор по шагам
Запустить ту же экспортную процедуру с отрицательным количеством: проверка входных данных находится внутри фонового метода.
Обновить объект ограниченным ожиданием. Если пока Активно, не читать отсутствующую ошибку как успешный результат.
Только при ЗавершеноАварийно получить ИнформацияОбОшибке, проверить собственный текст и вывести модуль, номер строки и описание.
Исправить -1 на 3 и повторить запуск с новым ключом. Это новая задача, а не изменение уже завершённой.
Как проверить результат
При аварийном завершении поиск собственного текста ошибки даёт Истина.
При количестве 3 задача должна завершиться успешно. Текст об отрицательном количестве исчезает; при таймауте окончательный результат пока неизвестен.
Ожидаемый результат
Полный воспроизводимый пример диагностики собственной валидации в фоне, без проведения документов.
На что обратить внимание
Выполнить может сам выбросить исключение до запуска, например из-за прав или несериализуемого параметра: тогда объекта задания нет.
ОжидатьЗавершенияВыполнения возвращает состояние, а не автоматически выбрасывает исключение из завершившегося рабочего метода.
Не перезапускайте финансовую или обменную операцию автоматически только потому, что истёк таймаут. Этот урок считает только собственные числа.
Пример не запускался в вашей базе. Перед применением проверьте его в указанном учебном контексте.