Синтаксис и применение АннотацияXS.По умолчанию в платформе 1С:Предприятие. Описание и примеры кода.
Синтаксис
Новый АннотацияXSПолное описание, параметры и ограничения
АннотацияXS.По умолчанию
АннотацияXS (XSAnnotation)
По умолчанию
Синтаксис:
Новый АннотацияXS
Методическая информация
Практические примеры
Импортировать тип цены из другого пространства имён
Основная схема содержит цену, собственная часть — тип Amount с ограничением неотрицательности. Импорт связывает разные namespace без загрузки.
Где и как запускать
Полный модуль серверного общего модуля УчебныеЗадачи (флаг Сервер) в учебной базе. Вызовите ВыполнитьПример() из серверного обработчика своей обработки. Вставляйте обе процедуры на уровне модуля.
Подготовка
Каждый урок выполните отдельно в учебной базе. Две XSD включены строками: основная схема и её собственная часть.
urn:guide:owned-xsd-part — условное расположение собственной части. РазрешеннаяСхема присваивается непосредственно, дополнительно передаётся собственный НаборСхемXML как разыменователь.
В коде нет файлового чтения, http URL, DTD или загрузки внешней XSD. Не заменяйте URN рабочими URL и не используйте непроверенную внешнюю схему.
Проверить проверяет схемы. Он не проверяет XML с фактической ценой или кодом; проверку экземпляра выполняйте отдельно.
Процедура ВыполнитьПример() Экспорт
ОсновнаяXSD = "<xs:schema xmlns:xs=""http://www.w3.org/2001/XMLSchema"" xmlns:m=""urn:guide:money"" targetNamespace=""urn:guide:directives""><xs:element name=""price"" type=""xs:decimal""/></xs:schema>";
ЧастьXSD = "<xs:schema xmlns:xs=""http://www.w3.org/2001/XMLSchema"" targetNamespace=""urn:guide:money""><xs:simpleType name=""Amount""><xs:restriction base=""xs:decimal""><xs:minInclusive value=""0""/></xs:restriction></xs:simpleType></xs:schema>";
Основная = ПрочитатьСвоюСхему(ОсновнаяXSD);
Часть = ПрочитатьСвоюСхему(ЧастьXSD);
Часть.РасположениеСхемы = "urn:guide:owned-xsd-part";
Директива = Новый ИмпортXS;
Директива.РасположениеСхемы = "urn:guide:owned-xsd-part";
Директива.РазрешеннаяСхема = Часть;
Если Основная.ПространствоИмен = Часть.ПространствоИмен Тогда
ВызватьИсключение "Для этого импорта нужны разные namespace";
КонецЕсли;
Директива.ПространствоИмен = "urn:guide:money";
Директива.Префикс = "m";
Сообщить(Директива.ПространствоИмен = Часть.ПространствоИмен);
Сообщить(Директива.Префикс = "m");
Аннотация = Новый АннотацияXS;
Пояснение = Новый ДокументацияXS;
Пояснение.Источник = "urn:guide:directive-note";
Пояснение.Язык = "ru";
Аннотация.Состав.Добавить(Пояснение);
Директива.Аннотация = Аннотация;
Основная.Содержимое.Вставить(0, Директива);
Корень = Основная.ОбъявленияЭлементов.Получить("price", "urn:guide:directives");
Если Корень = Неопределено Тогда
ВызватьИсключение "Не найден собственный корень price";
КонецЕсли;
Корень.ИмяТипа = Новый РасширенноеИмяXML("urn:guide:money", "Amount");
Директива.ОбновитьЭлементDOM();
Основная.ОбновитьЭлементDOM();
Разыменователь = Новый НаборСхемXML;
Разыменователь.Добавить(Часть);
Набор = Новый НаборСхемXML;
Набор.Добавить(Основная);
Если Не Набор.Проверить(Разыменователь) Тогда
ВызватьИсключение "Собственные связанные XSD не прошли проверку";
КонецЕсли;
Сообщить(Основная.Директивы.Количество() = 1);
Сообщить(Директива.Контейнер = Основная);
Сообщить(Директива.КорневойКонтейнер = Основная);
Сообщить(Директива.Схема = Основная);
Сообщить(Директива.ТипКомпоненты = ТипКомпонентыXS.Импорт);
Сообщить(Директива.ЭлементDOM <> Неопределено);
Сообщить(Директива.Содержит(Директива.Аннотация));
Сообщить(Директива.Компоненты.Количество() > 0);
Сообщить(Директива.РазрешеннаяСхема = Часть);
Сообщить(Директива.РасположениеСхемы = "urn:guide:owned-xsd-part");
Сообщить(Корень.ИмяТипа.URIПространстваИмен = "urn:guide:money" И Корень.ИмяТипа.ЛокальноеИмя = "Amount");
ИсходныйТип = Часть.ОпределенияТипов.Получить("Amount", "urn:guide:money");
Если ИсходныйТип = Неопределено Тогда
ВызватьИсключение "Не найден тип в собственной части";
КонецЕсли;
Копия = Директива.КлонироватьКомпоненту(Истина);
Если ТипЗнч(Копия) <> Тип("ИмпортXS") Или Копия.Аннотация = Неопределено Тогда
ВызватьИсключение "Не скопирована директива с аннотацией";
КонецЕсли;
Если Копия.Аннотация.Состав.Количество() <> 1 Тогда
ВызватьИсключение "В копии должна быть одна собственная документация";
КонецЕсли;
ПояснениеКопии = Копия.Аннотация.Состав.Получить(0);
Если ТипЗнч(ПояснениеКопии) <> Тип("ДокументацияXS") Тогда
ВызватьИсключение "В копии получен не тот компонент";
КонецЕсли;
ПояснениеКопии.Источник = "urn:guide:directive-note:copy";
ПояснениеКопии.Язык = "en";
Сообщить(Пояснение.Источник = "urn:guide:directive-note" И Пояснение.Язык = "ru");
Сообщить(ПояснениеКопии.Источник = "urn:guide:directive-note:copy" И ПояснениеКопии.Язык = "en");
Сообщить(Основная.Директивы.Количество() = 1);
КонецПроцедуры
Функция ПрочитатьСвоюСхему(ТекстXSD)
Чтение = Новый ЧтениеXML;
Чтение.УстановитьСтроку(ТекстXSD);
Попытка
ПостроительДерева = Новый ПостроительDOM;
ДокументСхемы = ПостроительДерева.Прочитать(Чтение);
Чтение.Закрыть();
Исключение
Чтение.Закрыть();
ВызватьИсключение;
КонецПопытки;
ПостроительСхем = Новый ПостроительСхемXML;
Результат = ПостроительСхем.СоздатьСхемуXML(ДокументСхемы.ЭлементДокумента);
Если Результат = Неопределено Тогда
ВызватьИсключение "Не построена собственная схема";
КонецЕсли;
Возврат Результат;
КонецФункцииРазбор по шагам
Читаем две свои строки XSD в отдельные СхемаXML. Функция закрывает ЧтениеXML при успехе и исключении.
ИмпортXS создаётся конструктором. ПространствоИмен указывает urn:guide:money, Префикс m служит генерации XML и не меняет смысл namespace.
Директива вставляется в начало Содержимое: xs:import должен предшествовать глобальному элементу.
Корень price получает QName типа Amount: URI первым аргументом, локальное имя вторым.
РазрешеннаяСхема задаётся собственным объектом. Проверить получает собственный разыменователь с частью, а не URL.
Рекурсивная копия меняет только своё пояснение. Она не присоединяется: исходная схема сохраняет одну директиву.
Как проверить результат
Если проверки проходят, все шестнадцать сообщений Истина; корень ссылается на Amount из urn:guide:money.
Отдельно проверяйте экземпляр price: 12.50 соответствует ограничению Amount, -1 нарушает minInclusive. Этот BSL-код проверяет схему, не экземпляр.
Ожидаемый результат
Импортирован конкретный учебный тип цены с явно заданным источником в памяти.
На что обратить внимание
Импорт предназначен для другого namespace; включение работает иначе.
Рекурсивная копия директивы не выдается за глубокую независимую копию всей РазрешеннаяСхема.
Источник документации — маркер происхождения пустого поясняющего компонента, не URL для скачивания.
Пример не запускался в вашей базе. Перед применением проверьте его в указанном учебном контексте.
Включить свой тип валюты из той же области имён
Две части имеют urn:guide:directives. Включение подключает Currency, разрешающий три заглавные латинские буквы.
Где и как запускать
Полный модуль серверного общего модуля УчебныеЗадачи (флаг Сервер) в учебной базе. Вызовите ВыполнитьПример() из серверного обработчика своей обработки. Вставляйте обе процедуры на уровне модуля.
Подготовка
Каждый урок выполните отдельно в учебной базе. Две XSD включены строками: основная схема и её собственная часть.
urn:guide:owned-xsd-part — условное расположение собственной части. РазрешеннаяСхема присваивается непосредственно, дополнительно передаётся собственный НаборСхемXML как разыменователь.
В коде нет файлового чтения, http URL, DTD или загрузки внешней XSD. Не заменяйте URN рабочими URL и не используйте непроверенную внешнюю схему.
Проверить проверяет схемы. Он не проверяет XML с фактической ценой или кодом; проверку экземпляра выполняйте отдельно.
Процедура ВыполнитьПример() Экспорт
ОсновнаяXSD = "<xs:schema xmlns:xs=""http://www.w3.org/2001/XMLSchema"" xmlns:g=""urn:guide:directives"" targetNamespace=""urn:guide:directives""><xs:element name=""currency"" type=""xs:string""/></xs:schema>";
ЧастьXSD = "<xs:schema xmlns:xs=""http://www.w3.org/2001/XMLSchema"" targetNamespace=""urn:guide:directives""><xs:simpleType name=""Currency""><xs:restriction base=""xs:string""><xs:pattern value=""[A-Z]{3}""/></xs:restriction></xs:simpleType></xs:schema>";
Основная = ПрочитатьСвоюСхему(ОсновнаяXSD);
Часть = ПрочитатьСвоюСхему(ЧастьXSD);
Часть.РасположениеСхемы = "urn:guide:owned-xsd-part";
Директива = Новый ВключениеXS;
Директива.РасположениеСхемы = "urn:guide:owned-xsd-part";
Директива.РазрешеннаяСхема = Часть;
Если Основная.ПространствоИмен <> Часть.ПространствоИмен Тогда
ВызватьИсключение "Для этого включения нужны одинаковые namespace";
КонецЕсли;
Сообщить(Основная.ПространствоИмен = Часть.ПространствоИмен);
Аннотация = Новый АннотацияXS;
Пояснение = Новый ДокументацияXS;
Пояснение.Источник = "urn:guide:directive-note";
Пояснение.Язык = "ru";
Аннотация.Состав.Добавить(Пояснение);
Директива.Аннотация = Аннотация;
Основная.Содержимое.Вставить(0, Директива);
Корень = Основная.ОбъявленияЭлементов.Получить("currency", "urn:guide:directives");
Если Корень = Неопределено Тогда
ВызватьИсключение "Не найден собственный корень currency";
КонецЕсли;
Корень.ИмяТипа = Новый РасширенноеИмяXML("urn:guide:directives", "Currency");
Директива.ОбновитьЭлементDOM();
Основная.ОбновитьЭлементDOM();
Разыменователь = Новый НаборСхемXML;
Разыменователь.Добавить(Часть);
Набор = Новый НаборСхемXML;
Набор.Добавить(Основная);
Если Не Набор.Проверить(Разыменователь) Тогда
ВызватьИсключение "Собственные связанные XSD не прошли проверку";
КонецЕсли;
Сообщить(Основная.Директивы.Количество() = 1);
Сообщить(Директива.Контейнер = Основная);
Сообщить(Директива.КорневойКонтейнер = Основная);
Сообщить(Директива.Схема = Основная);
Сообщить(Директива.ТипКомпоненты = ТипКомпонентыXS.Включение);
Сообщить(Директива.ЭлементDOM <> Неопределено);
Сообщить(Директива.Содержит(Директива.Аннотация));
Сообщить(Директива.Компоненты.Количество() > 0);
Сообщить(Директива.РазрешеннаяСхема = Часть);
Сообщить(Директива.РасположениеСхемы = "urn:guide:owned-xsd-part");
Сообщить(Корень.ИмяТипа.URIПространстваИмен = "urn:guide:directives" И Корень.ИмяТипа.ЛокальноеИмя = "Currency");
ИсходныйТип = Часть.ОпределенияТипов.Получить("Currency", "urn:guide:directives");
Если ИсходныйТип = Неопределено Тогда
ВызватьИсключение "Не найден тип в собственной части";
КонецЕсли;
Копия = Директива.КлонироватьКомпоненту(Истина);
Если ТипЗнч(Копия) <> Тип("ВключениеXS") Или Копия.Аннотация = Неопределено Тогда
ВызватьИсключение "Не скопирована директива с аннотацией";
КонецЕсли;
Если Копия.Аннотация.Состав.Количество() <> 1 Тогда
ВызватьИсключение "В копии должна быть одна собственная документация";
КонецЕсли;
ПояснениеКопии = Копия.Аннотация.Состав.Получить(0);
Если ТипЗнч(ПояснениеКопии) <> Тип("ДокументацияXS") Тогда
ВызватьИсключение "В копии получен не тот компонент";
КонецЕсли;
ПояснениеКопии.Источник = "urn:guide:directive-note:copy";
ПояснениеКопии.Язык = "en";
Сообщить(Пояснение.Источник = "urn:guide:directive-note" И Пояснение.Язык = "ru");
Сообщить(ПояснениеКопии.Источник = "urn:guide:directive-note:copy" И ПояснениеКопии.Язык = "en");
Сообщить(Основная.Директивы.Количество() = 1);
КонецПроцедуры
Функция ПрочитатьСвоюСхему(ТекстXSD)
Чтение = Новый ЧтениеXML;
Чтение.УстановитьСтроку(ТекстXSD);
Попытка
ПостроительДерева = Новый ПостроительDOM;
ДокументСхемы = ПостроительДерева.Прочитать(Чтение);
Чтение.Закрыть();
Исключение
Чтение.Закрыть();
ВызватьИсключение;
КонецПопытки;
ПостроительСхем = Новый ПостроительСхемXML;
Результат = ПостроительСхем.СоздатьСхемуXML(ДокументСхемы.ЭлементДокумента);
Если Результат = Неопределено Тогда
ВызватьИсключение "Не построена собственная схема";
КонецЕсли;
Возврат Результат;
КонецФункцииРазбор по шагам
Основная и включаемая часть создаются из собственных строк с одинаковым targetNamespace.
ВключениеXS не имеет отдельного ПространствоИмен: namespace задаётся самими схемами и проверяется до включения.
Конструктор создаёт директиву, РазрешеннаяСхема получает собственную часть, Вставить(0, ...) располагает include перед элементом currency.
ИмяТипа корня становится QName Currency из той же области; проверка набора использует собственную часть.
Контейнер, КорневойКонтейнер и Схема описывают принадлежность директивы основной схеме, а РазрешеннаяСхема — подключаемую часть.
Копия пояснения получает другой источник и язык; исходная русская документация остаётся неизменной.
Как проверить результат
Если проверки проходят, все пятнадцать сообщений Истина; в основной схеме одна директива.
Для отдельной проверки экземпляров RUB подходит Currency; rub и RU не подходят шаблону. Эти строки не проверяются данным BSL-кодом автоматически.
Ожидаемый результат
Включение объединяет собственные части одной области имён.
На что обратить внимание
Не заменяйте включение импортом только из-за другого имени файла.
Одинаковый namespace не означает, что можно дублировать одно глобальное имя.
Копия директивы не добавляется повторно в схему.
Пример не запускался в вашей базе. Перед применением проверьте его в указанном учебном контексте.