ОбъектМетаданных: ОперацияWebСервиса

Типы · MetadataObject: WebServiceOperation

Используется для обращения к метаданным объекта конфигурации - операция Web-сервиса.

Полное описание, параметры и ограничения

ОбъектМетаданных: ОперацияWebСервиса (MetadataObject: WebServiceOperation)

ОбъектМетаданных: ОперацияWebСервиса (MetadataObject: WebServiceOperation)

Доступен, начиная с версии 8.1.

Свойства:
Имя (Name)
Комментарий (Comment)
ОбъектРасширяемойКонфигурации (ExtendedConfigurationObject)
ПринадлежностьОбъекта (ObjectBelonging)
Синоним (Synonym)
ВозможноПустое (Nillable)
ВТранзакции (Transactioned)
ИмяПроцедуры (ProcedureName)
Параметры (Parameters)
РежимУправленияБлокировкойДанных (DataLockControlMode)
ТипВозвращаемогоЗначенияXDTO (XDTOReturningValueType)

Методы:
ЕстьИзмененияРасширениямиКонфигурации (ChangedByConfigurationExtensions)
ПолноеИмя (FullName)
Представление (Presentation)
РасширениеКонфигурации (ConfigurationExtension)
Родитель (Parent)

Описание:

Используется для обращения к метаданным объекта конфигурации - операция Web-сервиса.

Доступность:

Сервер, толстый клиент, внешнее соединение.

Использование в версии:

Доступен, начиная с версии 8.1.

Методическая информация

Практические примеры

Разобрать контракт опубликованного в конфигурации Web-сервиса

Сравниваем определения SOAP-операций и параметров с деревом конфигурации, не вызывая сервис и не скачивая WSDL.

Где и как запускать

Учебная база: создайте серверный общий модуль УчебныеЗадачи (флаг Сервер). Код без директив вставьте в тело процедуры ВыполнитьПример() Экспорт. Вызовите её из серверного обработчика команды учебной обработки. Не запускайте в рабочей базе.

Подготовка

  1. Запускайте в учебной копии конфигурации. Примеры читают структуру метаданных, но не создают объекты, не записывают регистры и не проводят документы.

  2. Сверяйте вывод с деревом конфигурации в Конфигураторе. Имена, длины и настройки в УНФ, КА2, БП, УТ 11 и УТ 10.3 могут различаться.


Для Каждого Сервис Из Метаданные.WebСервисы Цикл
    Сообщить(СтрШаблон("%1 (%2): пространство %3; файл %4",
        Сервис.Имя, Сервис.Синоним, Сервис.ПространствоИмен, Сервис.ИмяФайлаПубликации));
    Сообщить(Сервис.Комментарий);
    Сообщить(СтрШаблон("Пакетов XDTO %1; повторное использование %2; время жизни %3",
        Сервис.ПакетыXDTO.Количество(), Сервис.ПовторноеИспользованиеСеансов, Сервис.ВремяЖизниСеанса));
    Сообщить(Сервис.Модуль = Неопределено);
    Для Каждого Операция Из Сервис.Операции Цикл
        Сообщить(СтрШаблон("Операция %1 (%2) → %3", Операция.Имя, Операция.Синоним, Операция.ИмяПроцедуры));
        Сообщить(Операция.Комментарий);
        Сообщить(СтрШаблон("Результат %1; возможно пустое %2; в транзакции %3; блокировки %4",
            Операция.ТипВозвращаемогоЗначенияXDTO, Операция.ВозможноПустое,
            Операция.ВТранзакции, Операция.РежимУправленияБлокировкойДанных));
        Для Каждого Параметр Из Операция.Параметры Цикл
            Сообщить(СтрШаблон("Параметр %1 (%2): %3; направление %4; возможно пустое %5",
                Параметр.Имя, Параметр.Синоним, Параметр.ТипЗначенияXDTO,
                Параметр.НаправлениеПередачи, Параметр.ВозможноПустое));
            Сообщить(Параметр.Комментарий);
        КонецЦикла;
    КонецЦикла;
КонецЦикла;

Разбор по шагам

  1. WebСервисы описывают SOAP-контракт, а HTTPСервисы — маршруты HTTP: коллекции не взаимозаменяемы.

  2. ПространствоИмен и расширенные имена типов XDTO читаем вместе, поскольку одинаковые локальные имена могут принадлежать разным схемам.

  3. У параметра отдельно смотрим направление передачи и возможность пустого значения; это разные характеристики.

  4. ВТранзакции — настройка операции. Мы не вызываем операцию, поэтому никакая её бизнес-транзакция не выполняется.

Как проверить результат

  1. Число и имена операций совпадают с деревом выбранного Web-сервиса в Конфигураторе.

  2. Для операции сравните тип результата, ИмяПроцедуры и все направления параметров.

  3. При пустой коллекции WebСервисы цикл завершается без обращения к отсутствующему сервису.

Ожидаемый результат

Получена схема SOAP-операций и типов их параметров для изучения серверного обработчика.

На что обратить внимание

  1. ИмяФайлаПубликации не доказывает наличие текущей веб-публикации или доступность WSDL.

  2. ВозможноПустое не следует приравнивать к произвольному отсутствию поля во внешнем JSON: это другой формат обмена.

  3. Метаданные не проверяют фактическую реализацию метода, права пользователя и корректность полезной нагрузки.

Пример не запускался в вашей базе. Перед применением проверьте его в указанном учебном контексте.

Проверить возвращаемый тип и обработчик операции FillCatalogs

Операция имеет свой возвращаемый XDTO-тип, параметр пустоты и настройку транзакции. Чтение имени обработчика не выполняет обмен.

Где и как запускать

Учебная база: создайте серверный общий модуль УчебныеЗадачи (флаг Сервер). Код без директив вставьте в тело процедуры ВыполнитьПример() Экспорт. Вызовите её из серверного обработчика команды учебной обработки. Не запускайте в рабочей базе.

Подготовка

  1. Запускайте в учебной копии конфигурации. Примеры читают структуру метаданных, но не создают объекты, не записывают регистры и не проводят документы.

  2. Сверяйте вывод с деревом конфигурации в Конфигураторе. Имена, длины и настройки в УНФ, КА2, БП, УТ 11 и УТ 10.3 могут различаться.

  3. Имена объектов взяты из XML КА2 Progress: C:\claude\KA2\Progress\XML_CF_KA2_PROGRESS. Исходные XML не изменяйте. Выполняйте код только в своей учебной копии соответствующей конфигурации.

  4. В другой конфигурации предварительно найдите аналогичный объект в Конфигураторе и замените только строку имени в поиске. Отсутствие имени обрабатывается до чтения свойств; оно не доказывает отсутствие аналогичной возможности.

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

Сервис = Метаданные.WebСервисы.Найти("CustomerOrdersExchange");
Если Сервис = Неопределено Тогда
    ВызватьИсключение "В учебной конфигурации отсутствует WebСервисы.CustomerOrdersExchange";
КонецЕсли;
Операция = Сервис.Операции.Найти("FillCatalogs");
Если Операция = Неопределено Тогда
    ВызватьИсключение "В учебной копии нет операции CustomerOrdersExchange.FillCatalogs";
КонецЕсли;
Сообщить(Операция.Имя = "FillCatalogs");
Сообщить("Синоним: " + Операция.Синоним);
Сообщить("Комментарий: " + Операция.Комментарий);
Сообщить(Операция.ПолноеИмя());
Сообщить(Операция.Представление());
Сообщить("Принадлежность: " + Строка(Операция.ПринадлежностьОбъекта));
Сообщить("Идентификатор заимствования: " + Строка(Операция.ОбъектРасширяемойКонфигурации));
Сообщить("Изменён расширениями: " + Строка(Операция.ЕстьИзмененияРасширениямиКонфигурации()));
Сообщить("Расширение-владелец: " + Строка(Операция.РасширениеКонфигурации()));
Родитель = Операция.Родитель();
Если Родитель = Неопределено Тогда
    ВызватьИсключение "Не получен родитель своего описания контракта";
КонецЕсли;
Сообщить(Родитель = Сервис);
Сообщить(Операция.ИмяПроцедуры = "FillCatalogs");
Сообщить(НЕ Операция.ВТранзакции);
Сообщить(НЕ Операция.ВозможноПустое);
Сообщить(Операция.РежимУправленияБлокировкойДанных = Метаданные.СвойстваОбъектов.РежимУправленияБлокировкойДанныхПоУмолчанию.Управляемый);
Сообщить(Операция.Параметры.Количество() = 2);
ВозвращаемыйТип = Операция.ТипВозвращаемогоЗначенияXDTO;
Если ТипЗнч(ВозвращаемыйТип) <> Тип("РасширенноеИмяXML") Тогда
    ВызватьИсключение "Ожидалось расширенное имя возвращаемого XDTO-типа";
КонецЕсли;
Сообщить(ВозвращаемыйТип.ЛокальноеИмя = "MessageExchange");
Сообщить("URI возвращаемого типа: " + ВозвращаемыйТип.URIПространстваИмен);
Сообщить("Операция не вызвана: исследуется только описание");

Разбор по шагам

  1. Операция ищется внутри конкретного найденного сервиса. Отсутствие обрабатывается до её свойств; родитель сравнивается с сервисом.

  2. ИмяПроцедуры — настройка обработчика. ВТранзакции = Ложь означает отсутствие транзакционной обёртки по этой настройке, не гарантию отсутствия транзакций внутри бизнес-кода.

  3. ВозможноПустое относится к возвращаемому значению операции. Параметры имеют свои независимые флаги пустоты.

  4. ТипВозвращаемогоЗначенияXDTO проверяется до чтения ЛокальноеИмя/URI. Префикс d6p1 из XML не используется как идентификатор типа вместо URI.

  5. Количество 2 — число объявленных параметров. Метод не вызывает процедуру FillCatalogs и не блокирует данные.

Как проверить результат

  1. Восемь контрольных Истина и фактический URI возвращаемого типа.

  2. Не создано сообщение обмена, не началась транзакция этой проверкой.

Ожидаемый результат

Возвращаемый контракт, параметры и настройка обработчика разделены.

На что обратить внимание

  1. Имя процедуры не доказывает её корректность: её исходник проверяют отдельно.

  2. Не считать ВТранзакции = Ложь доказательством отсутствия записи данных внутри реальной операции.

Пример не запускался в вашей базе. Перед применением проверьте его в указанном учебном контексте.

Не хотите разбираться сами?

Адаптируем это решение под вашу базу. Оценка бесплатно.

Оставить задачу

1С, 1С:Предприятие — товарные знаки ООО «1С». Сайт не является официальным представительством фирмы «1С» и не аффилирован с ней.