Инструменты пользователя

Инструменты сайта


dotnet-adapters-demo

Разработка адаптеров на платформе .NET Framework/.NET Core

В данном обучающем материале описаны шаги для построения веб-сервисов, взаимодействующие через платформу X-Road версии 6.

Чтобы облегчить материал вам предоставляется решение DemoAdapters.sln , состоящее из следующих проектов: · Consumer.XRoad_End

· Consumer.Xroad_Start

· Producer.Data

· Producer.Service

· Producer.Xroad_End

· Producer.Xroad_Start

Producer.Data – проект .NET Core Library содержит доменные сущности и прилагаемые к ним конфигурации для взаимодействия с базой данных через ORM Entity Framework Core. Папка SQL_Scripts содержит скрипт для создания таблиц в СУБД Postgres и тестовые данные.

Producer.Service – слой бизнес логики также является проектом .NET Core Library и содержит сервисы которые служат в качестве связующего звена между слоем представления и слоем данных.

*Хочется отметить, что два вышеописанные проекты ни в коем образе не влияют на инфраструктуру взаимодействия с * Xroad.

Producer.Xroad_End – веб-сервис на Asp.NET Core версии 2.2, готовая реализация Producer – ДЕМО адаптера.

Producer.Xroad_Start – пустой шаблон проекта на Asp.NET Core 2.2 для обучения разработке адаптеров типа Producer.

Consumer.XRoad_End – WinForms проект содержит готовую реализацию ДЕМО адаптера типа Consumer.

Consumer.Xroad_Start – пустой шаблон проекта WinForms для разработки адаптера типа Consumer.

В конечном итоге у нас должна появиться две системы, взаимодействующие через систему X-Road. Первая система будет запрашивать данные о человеке по ПИН и выводить эти данные на форму. Вторая система будет являться источником этих данных и будет по запросу выдавать их.

Разработка Producer

Разработка провайдера услуг или так называемого Producer будет вестись на платформе .NET Core версии 2.

Выбор платформы неограничен, потому что протокол SOAP описывает лишь спецификации к реализуемым веб-сервисам с помощью языка описания веб-сервисов WSDL.

Нам предстоит решить следующую задачу:

На сервере располагается база данных с информацией о людях. БД содержит таблицу Person с колонками:

  1. PIN – персональный идентификационный номер
  2. Name – ФИО человека
  3. Gender – пол человека
  4. BirthDate – дата рождения человека
  5. Photo – фотография человека

Требуется реализовать SOAP сервис называемый GetPerson который будет выдавать информацию о человеке по входящему пин и зарегистрировать этот сервис в системе X-Road

Для этого вам предоставляется тестовый проект называемый Producer.Xroad_Start куда вам нужно будет подключить библиотеку XRoadLib.AspNetCore версии 1.3.7 из Nuget репозитории.

Создадим папку DataContract где будут размещаться типы для сериализации в формат XML и для десериализации типов во входящих запросах. Эти типы будут далее описываться в XML схеме при генерации WSDL файла.

Для задания имени XML типа и пространства имен создаваемого класса его нужно пометить стандартным атрибутом XmlType и в качестве параметров указать TypeName = имя типа, Namespace = пространство имен.

Но вы можете опустить эти аргументы и просто указать что данный класс просто является XmlType либо вовсе проигнорировать данный атрибут.

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

Пример:

[XmlType(TypeName = "Person", Namespace = "http://producer.xroad.com")]
 
public class PersonModel : XRoadSerializable

Генерирует следующий тип XML который будет находиться в пространстве имен http://producer.xroad.com

<xsd:complexType name="Person">

Атрибут XRoadXmlElement наследует атрибут XmlElement и добавляет новые свойства такие как IsOptional и UseXop

Параметр IsOptional указывает что поле является опциональными и при сериализации поле со значением NULL не включается в XML.

Параметр UseXop указывает следует ли включать поле типа Stream в тело сообщения в виде закодированной base64 строки либо выносить в отдельную часть HTTP запроса. Тогда HTTP запрос помечается как multipart/related и разделяется на несколько условных частей разделяемых значением mime/boundary.

Пример:

[XRoadXmlElement(ElementName = "Photo", IsOptional = false, Order = 4)]
 
public Stream Photo { get; set; }

Здесь мы создаем обязательное поле Photo в типе Person идущий 4-ым по очереди.

Данный код сгенерирует следующий xml:

<xsd:element xmime:expectedContentTypes="application/octet-stream" name="Photo" type="xsd:base64Binary"/>

Как вы заметили добавился атрибут expectedContentTypes со значением application/octet-stream это указывает что это поле будет содержать двоичные данные закодированные в base64.

В итоге в папке DataContract вы должны создать два типа:

  [XmlType(TypeName = "Gender")]
    public enum GenderEnum
    {
 
        Male = 1,
        Female = 0
    }
 
 
    [XmlType(TypeName = "Person", Namespace = "http://sample.com")]
    public class PersonModel : XRoadSerializable
    {
        [XRoadXmlElement(ElementName = "Pin", IsOptional = false, Order = 0)]
        public string Pin { get; set; }
 
        [XRoadXmlElement(ElementName = "Name", IsOptional = false, Order = 1)]
        public string Name { get; set; }
 
        [XRoadXmlElement(ElementName = "BirthDate", IsOptional = false, Order = 2)]
        public DateTime BirthDate { get; set; }
 
        [XRoadXmlElement(ElementName = "Gender", IsOptional = false, Order = 3)]
        public GenderEnum Gender { get; set; }
 
        [XRoadXmlElement(ElementName = "Photo", IsOptional = false, Order = 4)]
        public Stream Photo { get; set; }
    }

И так мы определили какие данные будут передаваться через X-Road.

Далее нам следует определить сервисы которые будут доступны клиентам данной системы.

Создаем папку ServiceContract и объявляем следующий интерфейс:

public interface IPersonSoapService
 
{
 
    [XRoadService("GetPerson", AddedInVersion = 1)]
 
    [XRoadTitle("RU","Сервис для выдачи персональных данных по пин")]
 
    PersonModel GetPerson(string pin);
 
}

Атрибут XRoadService обязателен. В нем вы указываете название вашего сервиса и версию если вы предполагаете, что она будет меняться со временем.

Атрибут XRoadTitle не обязателен, он служит для добавления информации для разработчиков. При добавлении такого атрибута в wsdl появится следующий тег с внутренними полями

<wsdl:documentation>
	<xrd:title xml:lang="RU">
		Сервис для выдачи персональных данных по пин
	</xrd:title>
</wsdl:documentation>

А ниже приведен отрывок wsdl файла:

<wsdl:portType name="PortTypeName">
	<wsdl:operation name="GetPerson">
		<wsdl:documentation>
			<xrd:title xml:lang="RU">Сервис для выдачи персональных данных по пин</xrd:title>
		</wsdl:documentation>
		<wsdl:input message="tns:GetPerson"/>
		<wsdl:output message="tns:GetPersonResponse"/>
	</wsdl:operation>
</wsdl:portType

В реализации сервиса вы можете прописать любое поведение которые вы учтете нужным это может быть формирование запроса на основе данных из базы данных либо делать какие-либо вычисления и т.д.

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

Здесь мы реализуем метод GetPerson следующим образом:

public PersonModel GetPerson(string pin)
 {
  	var person = _personService.GetPerson(pin);
  	return person == null ? null : ConvertToModel(person);
 }

Как мы видим PersonSoapService возвращает объект Person либо null;

Далее мы конвертируем объект person в модель PersonModel для последующей передачи через X-Road;

Я также хотел отметить, что в системе X-Road ошибки подразделяются на две группы: Technical Issue и Non-Techincal Issue чем они отличаются вы можете прочитать здесь https://github.com/nordic-institute/X-Road/blob/develop/doc/Protocols/pr-mess_x-road_message_protocol.md#annex-d-example-fault-messages В нашем случае если мы не сможем найти человека по заданному пин то мы возвращаем ответ с атрубтом nil=true;

И так предположим вы описали все модели сообщений и снабдили сервисы метаданными, дальше теперь нам потребуется чтобы библиотека XRoadLib сгенерировал WSDL файлы динамически.

Генерация WSDL происходит на основе метаданных, которыми мы снабдили сервисы и модели. Чтобы указать в какой сборке находятся эти элементы мы должны создать следующий класс PersonSoapServiceManager унаследованный от обобщенного класса ServiceManager в качестве параметра типа указываем XRoadHeader40

В конструкторе PersonSoapServiceManager вызывается базовый конструктор со следующими параметрами:

* Версия протокола в виде строки - «4.0» для текущей реализации X-Road 6

* Тип SchemaExporter - по умолчанию вы можете воспользоваться DefaultSchemaExporter

DefaultSchemaExporter - в свою очередь в качестве параметров конструктора принимает наименование вашего XML пространства имен, и сборку откуда во время runtime будут выгружаться метаданные для последующей генерации WSDL файла.

В конечном итоге класс PersonSoapServiceManager будет выглядеть следующим образом

public class PersonSoapServiceManager : ServiceManager<XRoadHeader40>
{
 
    public PersonSoapServiceManager() 
 
        : base("4.0", new DefaultSchemaExporter("http://producer.xroad.com",
 
            typeof(PersonSoapServiceManager).GetTypeInfo().Assembly))
 
    {}
 
}

Далее открываем класс Startup.cs и регистрируем классы в IOC контейнере через метод ConfigureServices(IServiceCollection services):

services.AddScoped<IPersonSoapService, PersonSoapService>();
services.AddScoped<PersonSoapServiceManager>();
services.AddXRoadLib();
  Обратите внимание что время жизни сервиса является Scoped это означает каждый сервис «живет» в контексте http запроса а затем он уничтожается. Если вы укажете его как Singleton то это может спровоцировать ошибки типа ObjectDisposedException. Более подробную информацию вы найдете здесь
  https://docs.microsoft.com/en-us/aspnet/core/fundamentals/dependency-injection?view=aspnetcore-2.2

Расширяющий метод AddXRoadLib() является обязательными так как он проводит дополнительные настройки для корректной работы библиотеки.

Открываем метод Configure (IApplciationBuilder app,IHostingEnvironment env)

Добавляем следующую строчку кода:

app.UseXRoadLib(routeBuilder =>
{
	routeBuilder.MapWsdl<PersonSoapServiceManager>("");
	routeBuilder.MapWebService<PersonSoapServiceManager>("");
});

Здесь мы настраиваем настройку маршрутизации. Расширяющему методу UseXRoadLib передается лямбда выражение где у аргумента routeBuilder есть такие методы как MapWsdl и MapWebService

MapWsdl – служит для задания адреса где будет размещаться wsdl файл для типа PersonSoapServiceManager (Пожалуйста не ставьте знак «/» перед указанием относительного адреса иначе будет выводиться ошибка тоже касается и метода MapWebService) MapWebService – служит для задания адреса где будут обрабатываться SOAP запросы PersonSoapServiceManager.

Если вам непонятен смысл ServiceManager то просто представьте себе что это всего лишь контейнер который содержит набор сервисов. Этот контейнер указывает в какой сборке искать метаданные для дальнейшей генерации wsdl.

Прошу еще обратить внимания на класс DefaultSchemaExporter: при генерации wsdl файла вызывается метод ExportProtocolDefinition.

Этот метод принимает тип ProtocolDefinition, который содержит такие свойства как

  1. ProducerNamespace
  2· ContractAssembly
  3· TechNotesElementName
  4· PortTypeName
  5· BindingName
  6· PortName
  7· SoapAddressLocation
  8· И так далее.

Я настоятельно рекомендую наследоваться от класса DefaultSchemaExporter и переопределять метод ExportProtocolDefinition. В этом методе вы можете перезаписать свойства ProtocolDefinition и указать более близкие к реальности значения.

Если вы сделали все правильно согласно этому мануалу у вас запустится проект ASP.NET Core.

И в браузере вы увидите динамически сгенерированный wsdl.

Более подробную информацию о WSDL вы найдете здесь https://www.w3.org/TR/2001/NOTE-wsdl-20010315

На этом разработка Producer заканчивается. Я настоятельно рекомендую наследоваться от класса DefaultSchemaExporter и переопределять метод ExportProtocolDefinition. В этом методе вы можете перезаписать свойства ProtocolDefinition и указать более близкие к реальности значения.

Если вы сделали все правильно согласно этому мануалу у вас запустится проект ASP.NET Core.

И в браузере вы увидите динамически сгенерированный wsdl.

Более подробную информацию о WSDL вы найдете здесь https://www.w3.org/TR/2001/NOTE-wsdl-20010315

На этом разработка Producer заканчивается.

Разработка Consumer

Откройте контекстное меню проекта и нажмите кнопку «Добавить». Затем выбираете пункт «Ссылка на службу». В появившемся окне «Добавление ссылки на службу» в поле «Адрес» вставьте URL ссылку wsdl либо укажите абсолютный путь wsdl файла. Переименуйте пространство имен ServiceReference1 на Producer и нажмите OK.

В обозревателе решений внутри проекта Cosumer.XRoad_Start должна появиться вкладка ConnectedServices а внутри папка Producer. В этой папке хранятся сгенерированные типы WCF.

Открываем файл App.Config где хранятся настройки вашего приложения в виде XML. Там должна появиться XML структура

<system.serviceModel>
        <bindings>
            <basicHttpBinding>
                <binding name="BindingName" />
            </basicHttpBinding>
        </bindings>
        <client>
            <endpoint address="http://INSERT_CORRECT_SERVICE_URL" binding="basicHttpBinding"
                bindingConfiguration="BindingName" contract="Producer.PortTypeName"
                name="PortName" />
        </client>
</system.serviceModel>
</xml>
 
Поменяйте значение атрибута adddress="" у тега endpoint вписав туда URL вашего сервера безопасности.
 
Далее создайте класс XRoadPersonDataManager и реализуйте интерфейс IPersonDataManager, в методе GetPerson сформируйте запрос как показано на примере:
 
<code c#>
public PersonData GetPersonData(string pin)
{
    PortTypeNameClient client = new PortTypeNameClient();
    var getPersonRequest = new GetPersonRequest();
    getPersonRequest.id = Guid.NewGuid().ToString();
    getPersonRequest.userId = "Sample User id";
    getPersonRequest.issue = "Sample issue";
    getPersonRequest.protocolVersion = "4.0";
    getPersonRequest.client = new XRoadClientIdentifierType()
    {
        xRoadInstance = "ЭКЗЕМПЛЯР XROAD",
        memberClass = "КЛАСС УЧАСТНИКА XROAD",
        memberCode = "КОД УЧАСТНИКА"
    };
    getPersonRequest.service = new XRoadServiceIdentifierType()
    {
        xRoadInstance = "ЭКЗЕМПЛЯР XROAD",
        memberClass = "КЛАСС УЧАСТНИКА XROAD",
        memberCode = "КОД УЧАСТНИКА"
        serviceCode = "GetPerson",
        serviceVersion = "v1"
    };
    getPersonRequest.GetPerson = new GetPerson()
    {
        request = pin
    };
 
    GetPersonResponse1 response1 = client.GetPerson(getPersonRequest);
    var item = response1.GetPersonResponse.Item;
	if (item is fault)
	{
    	throw new ApplicationException( (item as fault).faultString);
    }
	return ConvertToPersonData(item);
}

Автор Б. Галиев

dotnet-adapters-demo.txt · Последние изменения: 2019/10/28 04:17 — admin1