Введение
Система обработки исключительных ситуаций - комплекс решений реализованных в разных частях системы, обеспечивающих - описание, реализацию вызова и обработку исключительных ситуаций. Решения связаны набором соглашений, которым должны удовлетворять - студия, реализации действий, движки.
Для презентации всей картины, отражающей работу с исключениями, опишем ее в виде сценария, от появления понятия исключения, до вариантов использования информации предоставляемой исключением.
Тип исключения
Тип исключения - Соглашение о составе данных, являющихся частью экземпляра данного типа исключения.
Унифицированная структура (тип исключения) необходима в системе с целью передачи информации о ошибках между компонентами системы (сериализация\десериализация) исключив при этом необходимость поддержания множества типов исключений (создаваемых авторами действий) и реализации данных типов, для каждой из платформ исполнения. Достигается это путем создания одного "универсального" типа исключения, экземпляр которого жестко не специфицирован и в режиме исполнения может нести множество данных во вложенном словаре типа ключ-значение. То есть, соглашение между автором и потребителем исключения является так сказать "мягким" (оговоренным в документации на исключение), а не "жестким" (зафиксированным например в XSD, которое могло бы описывать тип исключения). Автор исключения декларирует в документации, что экземпляр его типа будет нести такие то данные, которые можно извлечь по ключу. Тот кого интересует конкретный контент заключенный в экземпляре исключения, сможет его достать по заранее известному ему ключу. Это возможно потому, что специфические типы исключений всегда обрабатываются специализированными обработчиками (которые точно знают, какие данные им нужно извлечь из экземпляра исключения).
Структура типа исключения
Идентификатор типа исключения
Идентификатор типа исключения - строка, однозначно идентифицирующая тип исключения
| Name | Наименование свойства | Тип | Описание |
|---|---|---|---|
| typeID | Идентификатор типа исключения | Строка | Строковый ID уникально идентифицирующий тип исключения в системе. Потребитель - всегда человек (не важно, просматривающий лог робота, или создающий сценарий робота). По данному идентификатору типа, человек обращается к справочной информации, чтобы узнать какое содержимое может содержать экземпляр данного типа во вложенном словаре. |
Базовый набор свойств исключения
Базовый набор свойств - свойства являющиеся частью любого экземпляра исключения.
| Name | Наименование свойства | Тип | Описание |
|---|---|---|---|
Message | Сообщение о ошибке | Строка | Сообщение о ошибке |
StackTrace | Стек вызовов | Строка | Строковое представление вложенности вызовов функций (от корня, до места возникновения исключения) |
Source | Источник ошибки | Строка | Имя объекта, вызывавшего ошибку |
InnerException | Вложенная ошибка | Robin.Exception | Вложенное исключение |
Словарь дополнительных значений
Еще одним членом структуры исключения является словарь ключ-значение, который заполняется данными в зависимости от типа возникшего исключения. Содержимое словаря описывает разработчик (в документации), при декларации типа исключения.
| 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_exceptions | Строка | Да | |
| catchN | Строка | Нет | |
| ctachN_exceptions | Строка | Нет | |
| finaly | Строка | Нет |
Выходные результаты Robin.BaseActions.TryCatch
Логика работы движка при обработке исключений
Движок обрабатывает все исключения, возникшие при выполнении последовательности (в том числе при обработке запроса "Выполни последовательность" полученного от действия).
Если исключение было не типа Robin.Exception, а типа, владельцем которого является платформа исполнения (Java, .NET и т.д.), то движок создает экземпляр Robin.Exception из экземпляра платформенного типа.
Тезисно:
- Создается одна универсальная структура для описания исключения (содержащая словарь для дополнительной информации специфической для типа исключнения). Эту структуру используют авторы экшенов чтобы бросить исключение. Если при выполнении действия движком он ловит исключение среды исполнения (clr, jvm и пр.) то экземпляр класса исключения преобразуется в данную структуру и дальше обрабатывается как и исключение брошенное автором действия. Единственное - устанавливается тип исключение Unknown (так как оно не предусматривалось автором действия и не было задекларировано).
- Авторы действий декларируют (наряду с параметрами и результатами) типы исключений которые может генерить их действие (документируя так же и возможные ключи-значения словаря входящего в состав структуры описывающей исключение. т.е. специфицируя и доп информацию которая может быть включена в исключение)
- Экземпляры задекларированных исключений действия доступны для использования в схеме робота так-же как и результаты работы действия. Но доступны они для использования сразу после их создания (еще до окончания работы действия).
- Действие TryCatch, при помощи которого и строится обработка исключений в схеме робота, имеет один задекларированный экземпляр исключения. Этот экземпляр устанавливается в значение, которое выбросило одно из действий помещенных в в блок Try.
Картинка во вложении
