Создание проекта ядра правил Azure Logic Apps с помощью Visual Studio Code (предварительная версия)

Статья
06/13/2024

Область применения: Azure Logic Apps (стандартная версия)

Внимание

Эта возможность входит в предварительную версию, и на нее распространяются Дополнительные условия использования предварительных версий Microsoft Azure.

Если вы хотите интегрировать бизнес-логику со стандартными рабочими процессами в Azure Logic Apps, можно создать и создать проект обработчика правил Azure Logic Apps с помощью Visual Studio Code. Правила управляют бизнес-логикой для работы бизнес-процессов.

В этом руководстве описано, как создать проект обработчика правил Azure Logic Apps:

Предварительные требования и настройка для создания проекта подсистемы правил Azure Logic Apps, включая создание бизнес-правил для проекта с помощью Microsoft Rules Composer.
Экспортируйте существующие правила из Microsoft BizTalk Server, если у вас есть.
Создайте проект приложений логики уровня "Стандартный" для обработчика правил Azure Logic Apps с помощью Visual Studio Code.

Необходимые компоненты

Скачайте и установите Microsoft Rules Composer, который используется для создания наборов правил, бизнес-правил и словарей.

Чтобы создать бизнес для проекта подсистемы правил, ознакомьтесь со следующей документацией:
- Создание правил с помощью Microsoft Rules Composer
- Интеграция управления решениями и бизнес-логики с помощью обработчика правил Azure Logic Apps
В этом выпуске только Visual Studio Code поддерживает возможности разработки для проекта ядра правил Azure Logic Apps. Сведения о необходимых требованиях для использования Visual Studio Code см. в статье "Создание рабочего процесса приложения логики "Стандартный" в однотенантном azure Logic Apps с помощью Visual Studio Code.
Подсистема правил Azure Logic Apps использует возможность пользовательской функции кода в Visual Studio Code. Дополнительные сведения об использовании этой возможности см. в статье "Создание и запуск кода платформа .NET Framework из стандартных рабочих процессов в Azure Logic Apps".

Перед созданием проекта

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

Определите, как бизнес-правила соответствуют бизнес-процессам.
Планирование внедрения бизнес-правил в приложение.
Определите бизнес-логику, которую вы хотите представить с помощью правил в приложении.

Термин "бизнес-логика" может ссылаться на многие вещи. Например, бизнес-логика может быть "Заказы на покупку, превышающие 500 долларов, требуют утверждения руководителя".
Определите источники данных для элементов правила. При необходимости можно определить словари, которые представляют базовые привязки для конкретного домена.
Определите правила для использования из определений словаря или непосредственно из привязок данных. Из этих правил создайте набор правил, представляющий бизнес-логику.

Экспорт правил из Microsoft BizTalk Server

Чтобы повторно использовать существующие правила из Microsoft BizTalk Server, их можно экспортировать. Однако факты базы данных в настоящее время не поддерживаются. Перед экспортом правил удалите или рефакторинг их в другие типы фактов с помощью Microsoft BizTalk Rules Composer.

На сервере Microsoft BizTalk Server запустите мастер развертывания подсистемы бизнес-правил.
На странице мастера развертывания обработчика правил нажмите кнопку "Далее".
На странице "Задача развертывания" выберите "Экспорт политики или словаря в файл" из базы данных и нажмите кнопку "Далее".
На странице "Хранилище политик" в списке имен SQL Server выберите сервер SQL Server. В списке серверов базы данных конфигурации выберите BizTalkRuleEngineDb и нажмите кнопку "Далее".
На странице экспорта политики или словаря в списке политик выберите нужную политику. Чтобы найти и выбрать файл определения, нажмите кнопку "Обзор".
Затем нажмите кнопку Далее.
Подтвердите сведения о сервере, базе данных и политике или словаре и нажмите кнопку "Далее".
После завершения импорта или экспорта нажмите кнопку "Далее".
Просмотрите состояние завершения импорта или экспорта и нажмите кнопку "Готово".

Создание проекта ядра правил Azure Logic Apps

В Visual Studio Code на панели действий выберите значок Azure. (Клавиатура: SHIFT+ALT+A)
В открывающемся окне Azure на панели инструментов раздела "Рабочая область" в меню Azure Logic Apps выберите "Создать рабочую область приложения логики".
В поле "Выбор папки" перейдите к папке и выберите локальную папку, созданную для проекта.
Когда появится окно запроса "Создать рабочую область приложения логики", укажите имя рабочей области:

Этот пример продолжается с MyLogicAppRulesWorkspace.
Когда появится окно запроса "Выбор шаблона проекта для рабочей области приложения логики", выберите приложение логики с проектом обработчика правил (предварительная версия).

Следуйте последующим запросам, чтобы указать следующие примеры значений:

Товар	Пример значения
Имя функции для проекта функций	ПравилаFunction
Имя пространства имен для проекта функций	Contoso.Enterprise
Шаблон рабочего процесса: - Рабочий процесс с отслеживанием состояния - Рабочий процесс без отслеживания состояния	Рабочий процесс с отслеживанием состояния
Имя рабочего процесса	MyRulesWorkflow

Выберите "Открыть" в текущем окне.

После завершения этого шага Visual Studio Code создает рабочую область, которая включает проект функций и проект обработчика правил приложения логики, например:

Узел	Description
*<имя рабочей области>*	Содержит проект функции и проект рабочего процесса приложения логики.
Function	Содержит артефакты для проекта функции. Например, *<файл-имя> функции.cs* — это файл кода, в котором можно создать код.
Logic App	Содержит артефакты для проекта подсистемы правил приложения логики, включая рабочий процесс.

Написание кода обработчика правил

В рабочей области разверните узел "Функции ", если он еще не развернут.

<Откройте файл function-name>.cs, который называется RulesFunction.cs в этом примере.

По умолчанию этот файл содержит пример кода, содержащий следующие элементы кода, а также приведенные ранее примеры значений, где это необходимо:

Имя пространства имен
Имя класса
Имя функции
Параметры функции
Возвращаемый тип
Сложный тип

В следующем примере показан полный пример кода для функции с именем RulesFunction:

//------------------------------------------------------------
// Copyright (c) Microsoft Corporation. All rights reserved.
//------------------------------------------------------------

namespace Contoso.Enterprise
{
    using System;
    using System.Collections.Generic;
    using System.Threading.Tasks;
    using Microsoft.Azure.Functions.Extensions.Workflows;
    using Microsoft.Azure.WebJobs;
    using Microsoft.Azure.Workflows.RuleEngine;
    using Microsoft.Extensions.Logging;
    using System.Xml;

    /// <summary>
    /// Represents the RulesFunction flow invoked function.
    /// </summary>
    public class RulesFunction
    {
        private readonly ILogger<RulesFunction> logger;

        public RulesFunction(ILoggerFactory loggerFactory)
        {
            logger = loggerFactory.CreateLogger<RulesFunction>();
        }

        /// <summary>
        /// Execute the logic app workflow.
        /// </summary>
        /// <param name="ruleSetName">The ruleset name.</param>
        /// <param name="documentType">The document type for the input XML.</param>
        /// <param name="inputXml">The input XML type fact.</param>
        /// <param name="purchaseAmount">The purchase amount value used to create a .NET fact.</param>
        /// <param name="zipCode">The zip code value used to create a .NET fact.</param>
        [FunctionName("RulesFunction")]
        public Task<RuleExecutionResult> RunRules([WorkflowActionTrigger] string ruleSetName, string documentType, string inputXml, int purchaseAmount, string zipCode)
        {
            /***** Summary of steps below *****
            * 1. Get the ruleset to execute.
            * 2. Check if the ruleset was successfully retrieved.
            * 3. Create the rules engine object.
            * 4. Create TypedXmlDocument facts for all XML document facts.
            * 5. Initialize .NET facts.
            * 6. Execute rules engine.
            * 7. Retrieve relevant updates facts and send them back.
            */

            try
            {
                // Get the ruleset based on the ruleset name.
                 var ruleExplorer = new FileStoreRuleExplorer();
                 var ruleSet = ruleExplorer.GetRuleSet(ruleSetName);

                // Check if ruleset exists.
                if(ruleSet == null)
                {
                    // Log an error if ruleset not found.
                    this.logger.LogCritical($"RuleSet instance for '{ruleSetName}' was not found(null)");
                    throw new Exception($"RuleSet instance for '{ruleSetName}' was not found.");
                }

                // Create rules engine instance.
                var ruleEngine = new RuleEngine(ruleSet: ruleSet);

                // Create one or more typedXmlDcoument facts from one or more input XML documents.
                XmlDocument doc = new XmlDocument();
                doc.LoadXml(inputXml);
                var typedXmlDocument = new TypedXmlDocument(documentType, doc);

                // Initialize .NET facts.
                var currentPurchase = new ContosoNamespace.ContosoPurchase(purchaseAmount, zipCode);

                // Provide facts and run the rules engine.
                ruleEngine.Execute(new object[] { typedXmlDocument, currentPurchase });

                // Send back the relevant results (facts).
                var updatedDoc = typedXmlDocument.Document as XmlDocument;
                var ruleExectionOutput = new RuleExecutionResult()
                {
                    XmlDoc = updatedDoc.OuterXml,
                    PurchaseAmountPostTax = currentPurchase.PurchaseAmount + currentPurchase.GetSalesTax()
                };

                return Task.FromResult(ruleExectionOutput);
            }
            catch(RuleEngineException ruleEngineException)
            {
                // Log any rules engine exceptions.
                this.logger.LogCritical(ruleEngineException.ToString());
                throw;
            }
        }

        /// <summary>
        /// Results from rules execution
        /// </summary>
        public class RuleExecutionResult
        {
            /// <summary>
            /// Rules updated XML document
            /// </summary>
            public string XmlDoc { get; set;}

            /// <summary>
            /// Purchase amount after tax
            /// </summary>
            public int PurchaseAmountPostTax { get; set;}
        }
    }
}

Определение функции включает RulesFunction метод по умолчанию RunRules , который можно использовать для начала работы. В этом примере метода RunRules показано, как передать параметры в обработчик правил Azure Logic Apps. В этом примере метод передает имя набора правил, тип входного документа, факт XML и другие значения для дальнейшей обработки.

Файл <функции>.cs также включает ILogger интерфейс, который обеспечивает поддержку ведения журнала событий в ресурс Application Insights. Вы можете отправлять сведения трассировки в Application Insights и хранить эти сведения вместе с данными трассировки из рабочих процессов, например:

private readonly ILogger<RulesFunction> logger;

    public RulesFunction(ILoggerFactory loggerFactory)
    {
        logger = loggerFactory.CreateLogger<RulesFunction>();
    }
    <...>

Обработчик правил Azure Logic Apps работает, как описано в следующих шагах:

Модуль использует FileStoreRuleExplorer объект для доступа к набору правил. Файл набора правил хранится в каталоге правил для приложения логики "Стандартный".

В этом примере вызывается SampleRuleSet.xmlфайл набора правил, созданный с помощью microsoft Rules Composer или экспортированного с помощью Microsoft BizTalk Server.
```
var ruleExplorer = new FileStoreRuleExplorer();
var ruleSet = ruleExplorer.GetRuleSet(ruleSetName);

// Check if the ruleset exists.
if(ruleSet == null)
{
    // Log an error if the ruleset isn't found.
    this.logger.LogCritical($"RuleSet instance for '{ruleSetName}' was not found(null)");
    throw new Exception($"RuleSet instance for '{ruleSetName}' was not found.");
}
```
Внимание

Наборы правил содержат ссылки на их факты. Microsoft Rules Composer ищет сборки фактов для проверки набора правил для редактирования. Чтобы открыть наборы правил, например SampleRuleSet.xml в Microsoft Rules Composer, необходимо разместить их с соответствующими сборками фактов .NET. В противном случае вы получите исключение.
Модуль использует ruleSet объект для создания экземпляра RuleEngine объекта.

Объект RuleEngine получает факты правила с помощью Execute метода.

В этом примере Execute метод получает два факта: XML-факт с именем typedXmlDocument и фактом .NET.currentPurchase

После запуска подсистемы значения фактов перезаписываются со значениями, которые приводят к выполнению подсистемы:

// Create rules engine instance.
var ruleEngine = new RuleEngine(ruleSet: ruleSet);

// Create one or more typedXml facts from one or more input XML documents.
XmlDocument doc = new XmlDocument();
doc.LoadXml(inputXml);
var typedXmlDocument = new TypedXmlDocument(documentType, doc);

// Initialize .NET facts.
var currentPurchase = new ContosoNamespace.ContosoPurchase(purchaseAmount, zipCode);

// Provide facts and run the rules engine.
ruleEngine.Execute(new object[] { typedXmlDocument, currentPurchase });

// Send back the relevant results (facts).
var updatedDoc = typedXmlDocument.Document as XmlDocument;

Подсистема RuleExecutionResult использует пользовательский класс для возврата значений в RunRules метод:

var ruleExectionOutput = new RuleExecutionResult()
{
    XmlDoc = updatedDoc.OuterXml,
    PurchaseAmountPostTax = currentPurchase.PurchaseAmount + currentPurchase.GetSalesTax()
};

return Task.FromResult(ruleExectionOutput);

Замените пример кода функции собственным и измените метод по умолчанию RunRules для собственных сценариев.

Этот пример продолжает использовать пример кода без каких-либо изменений.

Компиляция и сборка кода

Завершив написание кода, выполните компиляцию, чтобы убедиться, что ошибки сборки отсутствуют. Проект функции автоматически включает задачи сборки, которые компилируют и добавляют любые пользовательские библиотеки кода, включая сборки фактов .NET, в папку lib\custom в проекте приложения логики, где рабочие процессы ищут пользовательские функции для выполнения. Эти задачи помещают сборки в папку lib\custom\net472 .

В Visual Studio Code в меню терминала выберите новый терминал.
В появившемся списке рабочих каталогов выберите "Функции " в качестве текущего рабочего каталога для нового терминала.

Visual Studio Code открывает окно терминала с командной строкой.
В окне терминала в командной строке введите dotnet restore .\RulesFunction.csproj.
После повторного применения командной строки введите dotnet build .\RulesFunction.csproj.

Если сборка выполнена успешно, окно терминала сообщает, что сборка выполнена успешно.
Убедитесь, что в проекте приложения логики существуют следующие элементы:
- В рабочей области разверните следующие папки: LogicApp>lib\custom>net472. Убедитесь, что вложенная папка с именем <net472 содержит несколько сборок, необходимых для выполнения кода, включая именованное имя> функции файла.dll.
- В рабочей области разверните следующие папки: LogicApp>lib\custom<>function-name.> Убедитесь, что имя вложенной папки с именем <функции> содержит файл function.json, который содержит метаданные о написанном коде функции. Конструктор рабочих процессов использует этот файл для определения необходимых входных и выходных данных при вызове кода.
В следующем примере показаны примеры созданных сборок и других файлов в проекте приложения логики:

Вызов правил из рабочего процесса

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

В рабочей области в разделе LogicApp разверните <узел имени> рабочего процесса, откройте контекстное меню для workflow.json и выберите "Открыть конструктор".

В открываемом конструкторе рабочих процессов рабочий процесс по умолчанию, включенный в проект приложения логики, отображается со следующим триггером и действиями:
- Встроенный триггер запроса с именем "При получении HTTP-запроса".
- Встроенное действие с именем Вызова функции локальных правил в этом приложении логики.
- Встроенное действие ответа с именем Response, которое используется для ответа на вызывающий объект только при использовании триггера запроса.
Выберите действие с именем Вызова функции локальных правил в этом приложении логики.

Откроется область сведений действия справа.
Проверьте и убедитесь, что значение параметра "Имя функции" задано для функции правил, которую требуется запустить. Просмотрите или измените другие значения параметров, которые использует ваша функция.

Отладка кода и рабочего процесса

Повторите следующие действия, чтобы запустить эмулятор хранилища Azurite три раза: каждый раз для следующих служба хранилища Azure служб:
- Служба BLOB-объектов Azure
- Служба очередей Azure
- Служба таблиц Azure
1. В меню представления Visual Studio Code выберите палитру команд.
2. В появившемся запросе найдите и выберите Azurite: Запуск службы BLOB-объектов.
3. В появившемся списке рабочих каталогов выберите LogicApp.
4. Повторите следующие действия для Azurite: запуск службы очередей и Azurite: запуск службы таблиц.
Если панель задач Visual Studio Code в нижней части экрана отображает три службы хранилища, запущенные, например:
На панели действий Visual Studio Code выберите "Запуск и отладка". (Клавиатура: CTRL+SHIFT+D)
В списке "Запуск и отладка " выберите "Присоединить к приложению логики" (LogicApp), если оно еще не выбрано, а затем нажмите кнопку "Воспроизвести " (зеленая стрелка).

Откроется окно терминала и отображается процесс отладки. Откроется окно консоли отладки и отображается состояние отладки. В нижней части Visual Studio Code панель задач становится оранжевым, указывая, что отладчик .NET загружается.
В списке "Запуск и отладка " выберите "Подключиться к функциям .NET (Функции)", а затем нажмите кнопку "Воспроизвести " (зеленая стрелка).
Чтобы задать любые точки останова, в определении функции (имя> функции.cs) или определении рабочего процесса (<workflow.json), найдите номер строки, в котором требуется точка останова, и выберите столбец слева, например:
Чтобы вручную запустить триггер запроса в рабочем процессе, откройте страницу обзора рабочего процесса.
1. В проекте приложения логики откройте контекстное меню файла workflow.json и выберите "Обзор".
  
  На странице обзора рабочего процесса кнопка запуска триггера доступна, если вы хотите вручную запустить рабочий процесс. В разделе "Свойства рабочего процесса" значение URL-адреса обратного вызова — это URL-адрес вызываемой конечной точки, созданной триггером запроса в рабочем процессе. Вы можете отправлять запросы на этот URL-адрес, чтобы активировать рабочий процесс из других приложений, включая другие рабочие процессы приложения логики.
На панели инструментов "Обзор" выберите "Запустить триггер".

После запуска рабочего процесса отладчик активирует первую точку останова.
В меню "Запуск" или на панели инструментов отладчика выберите действие отладки.

После завершения выполнения рабочего процесса на странице обзора отображаются завершенный запуск и основные сведения об этом выполнении.
Чтобы просмотреть дополнительные сведения о выполнении рабочего процесса, выберите завершенный запуск. Или в списке рядом с столбцом "Длительность " выберите "Показать запуск".