Создание вспомогательных классов ODataProxy для подключения к D365O по протоколу OData

Описание

Для уменьшения количества кода, требуемого для подключения к OData вебсервисам, необходимо использовать автоматически генерируемый прокси класс. Этот класс содержит множество вложенных классов, которые соответствуют data entity, находящимся по указанному адресу, который может быть адресом D365O. Используя их, можно считывать, создавать, обновлять и удалять данные.

Чтобы еще больше упростить подключение к OData вебсервисам D365O, мною был написан базовый класс OData клиента ODataServiceBase, который убирает необходимость самостоятельно инициализировать подключение к прокси классу и добавлять авторизационные хедеры OAuth, необходимые в вебсервисах D365O.

Рекомендуется создать проект, который будет содержать сгенерированный прокси класс и класс ODataServiceBase, и использовать ссылку на него в собственных проектах.

Подготовительный этап

1. Подключить ссылку на проект, содержащий классы AuthenticationUtility из статьи «Создание классов AuthenticationUtility».
2. Добавить пакет Microsoft.OData.Client как описано в статье «Добавление пакета Microsoft.OData.Client».

Принцип работы

Класс ODataServiceBase содержит только конструктор, инициализирующий необходимые для подключения к D365O элементы.

Сначала в нем создается объект клиента прокси класса:

Copy to Clipboard

В качестве URL используется базовый адрес D365O из AuthenticationUtility Microsoft с приставкой data.

Далее к объекту клиента крепится хедер авторизации из AuthenticationUtility Microsoft:

Copy to Clipboard

Сам по себе класс ODataServiceBase больше ничего не делает, — он используется как базовый класс для классов-наследников, которые и содержат логику подключений к data entity клиента, объявленого в ODataServiceBase.

Генерация прокси класса

Для генерации прокси класса сначала нужно добавить расширение для Visual Studio, открыв Tools / Extensions and Updates.

В открывшемся окне выбрать слева вкладку Online / Visual Studio Gallery.

После этого в поиске в правом верхнем углу ввести OData v4 Client Code Generator и нажать Download возле найденного результата.

При этом откроется окно, в котором нужно нажать кнопку Install. После установки окно Extensions and Updates можно закрыть.

Далее нужно создать проект C# и добавить в него новый элемент типа OData Client.

При этом создастся файл с расширением .tt. Файл будет выглядеть как показано в примере далее, но без выделенных жирным шрифтом строк:

Copy to Clipboard

<#@ include file="ODataProxy.ttinclude" #>
<#+
public static class Configuration
{
	// The URI of the metadata document. The value must be set to a valid service document URI or a local file path 
    // eg : "http://services.odata.org/V4/OData/OData.svc/", "File:///C:/Odata.edmx", or @"C:\Odata.edmx"
    // ### Notice ### If the OData service requires authentication for accessing the metadata document, the value of
    // MetadataDocumentUri has to be set to a local file path, or the client code generation process will fail.
	public const string MetadataDocumentUri = "https://oit-adm-boryseda2b5401719f08ddevaos.cloudax.dynamics.com/data";

// The use of DataServiceCollection enables entity and property tracking. The value must be set to true or false.
	public const bool UseDataServiceCollection = true;

// The namespace of the client code generated. It replaces the original namespace in the metadata document, 
    // unless the model has several namespaces.
	public const string NamespacePrefix = "ODataProxy";

// The target language of the generated client code. The value must be set to "CSharp" or "VB".
	public const string TargetLanguage = "CSharp";
	
	// The path for the temporary file where the metadata xml document can be stored. Use this if your metadata is too big to be stored in a string literal. Ensure that you have write permission for this path.
	// For example - "C:\\temp\\Test.xml"	
	public const string TempFilePath = "C:\\Users\\Admina570032937\\Documents\\Visual Studio 2015\\Projects\\ODataProxy\\ODataProxy\\ODataProxyEdm.xml";

// This flag indicates whether to enable naming alias. The value must be set to true or false.
	public const bool EnableNamingAlias = true;

// This flag indicates whether to ignore unexpected elements and attributes in the metadata document and generate
	// the client code if any. The value must be set to true or false.
	public const bool IgnoreUnexpectedElementsAndAttributes = true;
}

public static class Customization
{
	/// <summary>
	/// Changes the text to use upper camel case, which upper case for the first character.
	/// </summary>
	/// <param name="text">Text to convert.</param>
	/// <returns>The converted text in upper camel case</returns>
	internal static string CustomizeNaming(string text)
	{
		if (string.IsNullOrEmpty(text))
		{
			return text;
		}

if (text.Length == 1)
		{
			return Char.ToUpperInvariant(text[0]).ToString(CultureInfo.InvariantCulture);
		}

return Char.ToUpperInvariant(text[0]) + text.Substring(1);
	}

/// <summary>
	/// Changes the namespace to use upper camel case, which upper case for the first character of all segments.
	/// </summary>
	/// <param name="fullNamespace">Namespace to convert.</param>
	/// <returns>The converted namespace in upper camel case</returns>
	internal static string CustomizeNamespace(string fullNamespace)
	{
		if (string.IsNullOrEmpty(fullNamespace))
		{
			return fullNamespace;
		}

string[] segs = fullNamespace.Split('.');
		string upperNamespace = string.Empty;
		int n = segs.Length;
		for (int i = 0; i < n; ++i)
		{
			upperNamespace += Customization.CustomizeNaming(segs[i]);
			upperNamespace += (i == n - 1 ? string.Empty : ".");
		}

return upperNamespace;
	}
}
#>

Выделенные жирным шрифтом MetadataDocumentUri и TempFilePath нужно указать самостоятельно.

MetadataDocumentUri – основной параметр файла, который содержит адрес ресурса с data entity. Для D365O он равен базовому адресу с приставкой /data. В примере это https://oit-adm-boryseda2b5401719f08ddevaos.cloudax.dynamics.com/data.

TempFilePath – это параметр, указывающий адрес на компьютере, куда нужно сохранить XML разметку data entity. По умолчанию параметр пуст, и это значит, что разметка будет храниться вместе с кодом C#. Возможно для некоторых ресурсов с развернутыми вебсервисами OData это приемлемо, из-за небольшого количества data entity, но в случае с D365O, количество data entity слишком велико для хранения XML разметки вместе с кодом, — они просто не помещаются в прокси класс. Поэтому для D365O этот параметр обязателен.

После сохранения изменений в файле автоматически выполняется скрипт генерации прокси класса и XML разметки (в одном или в двух разных файлах). Полученный прокси класс можно использовать у себя в программах.

Полученный результат содержит в себе, в частности, статус выполнения (успешно/неуспешно), а также выходные данные веб-сервиса, или сообщение с текстом ошибки, если что-то пошло не так. Для обработки результата проверяется статус выполнения запроса, после чего считывается его содержимое. Как в случае с получением выходных данных, так и в случае с получением текста ошибки, эта информация получается в виде строки JSON.

Программный код

Copy to Clipboard

using AuthenticationUtility;
using Microsoft.OData.Client;
using ODataProxy.Microsoft.Dynamics.DataEntities;
using System;

namespace ODataProxy
{
    public class ODataServiceBase
    {
        protected Resources client = null;

public ODataServiceBase()
        {
            client = this.buildODataClient();
        }

private Resources buildODataClient()
        {
            Uri oDataUri = new Uri(
                string.Format(
                    "{0}data",
                    ClientConfiguration.Default.UriString),
                UriKind.Absolute);

Resources oDataClient = new Resources(oDataUri);

oDataClient.SendingRequest2 += new EventHandler<SendingRequest2EventArgs>(
                delegate (
                    object delegateSender,
                    SendingRequest2EventArgs delegateE)
                {
                    var authenticationHeader = OAuthHelper.GetAuthenticationHeader();

delegateE.RequestMessage.SetHeader(
                        OAuthHelper.OAuthHeader,
                        authenticationHeader);
                });

return oDataClient;
        }
    }
}

Подготовил статью:

ДыкухаБорис Александрович

Senior Software Developer, OntargIT

Published On: / Рубрики: ERP /

Развивайте бизнес с нами!

OntargIT является официальным партнером Microsoft по внедрению технологий Dynamics 365. С нашим опытом в различных отраслях, мы обеспечим индивидуальный подход и эффективные решения, которые будут идеально соответствовать потребностям вашей компании. Оставьте заявку сейчас, и наша команда экспертов поможет вам воспользоваться всеми преимуществами Dynamics 365.

Отправляя свои данные, я даю согласие на то, чтобы со мной связались

Развивайте бизнес с нами!

Отправляя свои данные, я даю согласие на то, чтобы со мной связались

Индустрии

Услуги

Партнеры

Описание

Подготовительный этап

Принцип работы

Генерация прокси класса

Программный код

Подготовил статью:

Развивайте бизнес с нами!

Развивайте бизнес с нами!

Статус Microsoft Solutions Partner с бизнес-приложений, опыт внедрения и поддержки решений Microsoft Dynamics 365, Power Platform и AI.

Статус Microsoft Solutions Partner с бизнес-приложений, опыт внедрения и поддержки решений Microsoft Dynamics 365, Power Platform и AI.

Индустрии

Услуги

Партнеры

Создание вспомогательных классов ODataProxy для подключения к D365O по протоколу OData

Описание

Подготовительный этап

Принцип работы

Генерация прокси класса

Программный код

Подготовил статью:

Related Posts

Расширение возможностей CFO благодаря Microsoft Dynamics 365

Цифровая трансформация с Microsoft Dynamics 365

7 шагов для построения плана миграции на SaaS

Развивайте бизнес с нами!

Развивайте бизнес с нами!

Статус Microsoft Solutions Partner с бизнес-приложений, опыт внедрения и поддержки решений Microsoft Dynamics 365, Power Platform и AI.

Статус Microsoft Solutions Partner с бизнес-приложений, опыт внедрения и поддержки решений Microsoft Dynamics 365, Power Platform и AI.