Сравнение версий

Ключ

  • Эта строка добавлена.
  • Эта строка удалена.
  • Изменено форматирование.

Оглавление

Введение

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

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

Тип исключения

Тип исключения - Соглашение о составе данных, являющихся частью экземпляра данного типа исключения.

Унифицированная структура (тип исключения) необходима в системе с целью передачи информации о ошибках между компонентами системы (сериализация\десериализация) исключив при этом необходимость поддержания множества типов исключений (создаваемых авторами действий) и реализации данных типов, для каждой из платформ исполнения. Достигается это путем создания одного "универсального" типа исключения, экземпляр которого жестко не специфицирован и в режиме исполнения может нести множество данных во вложенном словаре типа ключ-значение. То есть, соглашение между автором и потребителем исключения является так сказать "мягким" (оговоренным в документации на исключение), а не "жестким" (зафиксированным например в XSD, которое могло бы описывать тип исключения). Автор исключения декларирует в документации, что экземпляр его типа будет нести такие то данные, которые можно извлечь по ключу. Тот кого интересует конкретный контент заключенный в экземпляре исключения, сможет его достать по заранее известному ему ключу. Это возможно потому, что специфические типы исключений всегда обрабатываются специализированными обработчиками (которые точно знают, какие данные им нужно извлечь из экземпляра исключения).

Структура типа исключения

Идентификатор типа исключения

Идентификатор типа исключения - строка, однозначно идентифицирующая тип исключения

...

NameНаименование свойстваТипОписание
Info


Сообщение о ошибкеRobin.DictionaryСловарь содержащий дополнительную информацию о исключении

Значение "Unknown" для typeID

Система не имеет возможности передавать между компонентами системы (например от движка Java в студию (.NET)) исключения нативных платформенных типов. Передается всегда сериализованный в XML экземпляр типа Robin.Exception. В данном экземпляре имеется свойство "typeID", которому присваивается идентификатор исключения объявленный автором действия. Но если произошло исключение среды исполнения (Java, .NET и т.п.), в поле typeID вписывается специальный зарезервированный идентификатор типа "Unknown". Что говорит о том, что произошло исключение на уровне платформы и все что может сделать среда исполнения Robin - сообщить о этом исключении, скопировав полезную информацию из экземпляра платформенного исключения в экземпляр типа Robin.Exception.

Работа с исключениями с точки зрения создателя действий

И так, Я - создатель действия. Все что я знаю о исключениях в системе Robin - тип исключения для моей платформы (полученный из SDK) и несколько простых правил, перечисленных ниже.

Декларация идентификаторов исключений типа Robin.Exception, которые могут быть выброшены моим действием

Для чего это нужно? Я как разработчик, декларирую идентификаторы тех исключений, экземпляры которых я создаю и бросаю сам.


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

Исключения генерируемые моим кодом

В моем коде, реализующем действие, я могу бросить исключение как типа Robin.Exception (и это будет значить что мне есть что сказать, т.к. данное исключение задекларированно задекларировано мной в .robin-impinfo), так и любое исключение платформенного типа. Но в последнем случае это будет означать что движок (который его поймает) самостоятельно сделает из него объект типа Robin.Exception и сообщит куда надо.

Обработка исключений, произошедших при вызове сторонних функций

Под сторонними функциями подразумевается все функции, которые реализованы НЕ в создаваемом действии.

Если я поймал исключение которое мне не интересно (т.е. его отлов не является частью логики реализуемого мной действия) и не важно, является оно платформенным или типа Robin.Exception, я пробрасываю его дальше, без его изменения. Система сама о нем позаботится.

Устройство и логика работы действия TryCatch

Общие принципы TryCatch

Устройство и принцип работы действия Robin.BaseActions.TryCatch в точности такие же, как реализации данной концепции в языках программирования. Robin.BaseActions.TryCatch контролирует выполнение нескольких именованных последовательностей действий. Каждая последовательность имеет один из трех типов - Try, Catch, Finaly. При этом наличие последовательности Try - обязательно одна, Catch - обязательно хотя бы одна, Finaly - не обязательно. Robin.BaseActions.TryCatch имеет одно выходное значение, которое содержит объект ошибки типа Robin.Exception (если конечно при выполнении последовательности Try произошла ошибка).

Входные параметры действия Robin.BaseActions.TryCatch

NameТипОбязательностьНазначение
tryСтрокаДаИдентификатор последовательности, в которой размещаются действия, ошибки которых отлавливаются.
catch1СтрокаДаИдентификатор последовательности в которой размещаются действия обработки типа ошибки.
catch1_exceptionsList<String>ДаСписок идентификаторов типов исключений (typeID), для обработки которых предназначена последовательность действий catch1.
catchNСтрокаНетНазначение аналогично "catch1". N - порядковый номер больше 1 (увеличивающийся для каждого нового бранча catch)
ctachN_exceptionsList<String>НетНазначение аналогично "catch1_exceptions".
finalyСтрокаНетИдентификатор последовательности в которой размещаются действия, которые выполнятся в любом случае (после последовательностей try и catch)

Выходные результаты Robin.BaseActions.TryCatch

NameТипОписание
errorRobin.Exception

Если во время выполнения последовательности Try происходит исключение, его объект помещается в коллекцию результатов действия TryCatch под именем error (и как следствие становится доступным тем действиям, чьи входные параметры определены как ссылки на выходное значение TryCatch)

Если ошибки не было, то в выходной коллекции нет данного объекта и потребители (действия чьи параметры ссылаются на выход TryCatch) получат на вход в качестве значения - null

Логика работы действия TryCatch

Работа действия TryCatch начинается с выполнения последовательности действий try, путем вызова сервиса движка по выполнению последовательностей. Сам вызов сервиса обернут в try-catch языка программирования. Если при выполнении (вызванным сервисом движка) последовательности try будет выброшено исключение, то решение о выполнении той или иной последовательности действий (одной из catch) будет принято на основании typeID пойманного исключения.

...

Так же реализацией действия предусмотрена возможность поймать любую ошибку, произошедшую при выполнении последовательности действий, заключенных в блоке Try, вне зависимости от ее typeID.  Для этого используется захаркоженый typeID=Any. Данный typeID создан только для использования в действии TryCatch и его XML-описание используется только для отображение опции "Любая" в тулзе для Robin.Exception.

Логика работы движка при обработке исключений


Предупреждение

Движок обрабатывает все исключения, возникшие при выполнении последовательности (в том числе при обработке запроса "Выполни последовательность" полученного от действия).

Если исключение было не типа Robin.Exception, а типа, владельцем которого является платформа исполнения (Java, .NET и т.д.), то движок создает экземпляр Robin.Exception из экземпляра платформенного типа и устанавливает его typeID в "__Unknown__".

Проброс исключений между движками

...

Примечание

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

Возникновение и проброс исключения в движке

Между движками пробрасываются только те исключения, которые возникают в действиях. То есть движок должен отличать на момент отлова исключения, является оно ошибкой системы исполнения или ошибкой действия. Это можно сделать с помощью типа исключения. В действиях проставляется либо какой-то задекларированный тип исключения, либо тип Robin.Exception.Unknown, так как базовый класс действий отлавливает все исключения и для неизвестных исключений действия проставляет тип Robin.Exception.Unknown. 

...

Если в каком-либо сервисе происходит ошибка системы исполнения (движка) или сервис ловит ошибку системы исполнения при выполнении последовательности действий, то ошибка в действие не пробрасывается. В этом случае выполнение подсценария должно завершиться , а ошибка - отправиться агенту. 

Возврат ошибки

В случае отлова исключения, возникшего в действии, движок заполняет информацию об исключении в ActionInOut, который потом включается в сообщение FinishResult. И проставляет код ошибки, чтобы агент отличал ошибки, которые можно пробросить дальше, от ошибок системы исполнения. . Строка с исключением представляет собой xml - сериализованный RobinException.

Ошибки системы исполнения отправляются отдельным сообщением Error, и они не содержат внутри себя ActionInOut.

При этом для каждого исключения заполняется:

  1. Сообщение
  2. Тип
  3. Источник
  4. Вложенное исключение
  5. Словарь с данными. Это должен быть тип Robin.Dictionary, и ключи в нём тоже должны быть Робин-типами, так как этот словарь должен быть доступен другим действиям, которые выполняют анализ исключений
  6. Стектрейс как значение словаря. 
    Стектрейс представляет собой строку, лежащую (в нативных исключениях лежит в словаре под ключом stackTrace, и относится только к текущему действию без учёта вложенных исключенийтак как может быть конфликт с настоящим стектрейсом)

Получение ошибки агентом

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

Получение ошибки движком

При получении исключения движок воссоздает ActionInOut в сервисе по выполнению подсценария движок смотрит, есть в нём исключение или нет. Если есть, то сервис воссоздает его экземпляр из xml, включая все вложенные исключения, и пробрасывает ошибку из сервиса по выполнению подсценария дальшекоторое потом пробрасывает дальше. Кроме того, если исключение есть, то сервис сам сохраняет все полученные результаты, так как они потом сохранены не будут (сервис прокинет исключение в действие, а действие - в движок).

Проблема создания экземпляра исключения из XML представления исключения

При самостоятельном создании нативного экземпляра исключения, нельзя заполнить некоторые поля. Например стек вызова это поле только для чтения. 

...