Używanie kodu niestandardowego w łączniku niestandardowym

Niestandardowy kod przekształca treść żądań i odpowiedzi, wykraczając poza zakres istniejących szablonów zasad. Użycie kodu ma pierwszeństwo przed definicją bez kodu.

Aby uzyskać więcej informacji, zobacz Tworzenie łącznika niestandardowego od podstaw.

Klasa skryptu

Kod musi zaimplementować metodę o nazwie ExecuteAsync, która jest uruchamiana w czasie wykonywania. W razie potrzeby możesz utworzyć inne metody w tej klasie i wywołać je z ExecuteAsync metody . Nazwa klasy musi być Script i musi implementować ScriptBase.

public class Script : ScriptBase
{
    public override Task<HttpResponseMessage> ExecuteAsync()
    {
        // Your code here
    }
}

Definicje klas pomocy technicznej i interfejsów

Klasa Script odwołuje się do następujących klas i interfejsów. Użyj ich do lokalnego testowania i kompilacji.

public abstract class ScriptBase
{
    // Context object
    public IScriptContext Context { get; }

    // CancellationToken for the execution
    public CancellationToken CancellationToken { get; }

    // Helper: Creates a StringContent object from the serialized JSON
    public static StringContent CreateJsonContent(string serializedJson);

    // Abstract method for your code
    public abstract Task<HttpResponseMessage> ExecuteAsync();
}

public interface IScriptContext
{
    // Correlation Id
    string CorrelationId { get; }

    // Connector Operation Id
    string OperationId { get; }

    // Incoming request
    HttpRequestMessage Request { get; }

    // Logger instance
    ILogger Logger { get; }

    // Used to send an HTTP request
    // Use this method to send requests instead of HttpClient.SendAsync
    Task<HttpResponseMessage> SendAsync(
        HttpRequestMessage request,
        CancellationToken cancellationToken);
}

Przykłady

Skrypt „Hello world”

Ten przykładowy skrypt zawsze zwraca Hello world jako odpowiedź dla wszystkich żądań.

public override async Task<HttpResponseMessage> ExecuteAsync()
{
    // Create a new response
    var response = new HttpResponseMessage();

    // Set the content
    // Initialize a new JObject and call .ToString() to get the serialized JSON
    response.Content = CreateJsonContent(new JObject
    {
        ["greeting"] = "Hello World!",
    }.ToString());

    return response;
}

Skrypt wyrażenia regularnego

Poniższy przykład przyjmuje tekst do dopasowania oraz wyrażenie regularne i zwraca w odpowiedzi wynik dopasowania.

public override async Task<HttpResponseMessage> ExecuteAsync()
{
    // Check if the operation ID matches what is specified in the OpenAPI definition of the connector
    if (this.Context.OperationId == "RegexIsMatch")
    {
        return await this.HandleRegexIsMatchOperation().ConfigureAwait(false);
    }

    // Handle an invalid operation ID
    HttpResponseMessage response = new HttpResponseMessage(HttpStatusCode.BadRequest);
    response.Content = CreateJsonContent($"Unknown operation ID '{this.Context.OperationId}'");
    return response;
}

private async Task<HttpResponseMessage> HandleRegexIsMatchOperation()
{
    HttpResponseMessage response;

    // We assume the body of the incoming request looks like this:
    // {
    //   "textToCheck": "<some text>",
    //   "regex": "<some regex pattern>"
    // }
    var contentAsString = await this.Context.Request.Content.ReadAsStringAsync().ConfigureAwait(false);

    // Parse as JSON object
    var contentAsJson = JObject.Parse(contentAsString);

    // Get the value of text to check
    var textToCheck = (string)contentAsJson["textToCheck"];

    // Create a regex based on the request content
    var regexInput = (string)contentAsJson["regex"];
    var rx = new Regex(regexInput);

    JObject output = new JObject
    {
        ["textToCheck"] = textToCheck,
        ["isMatch"] = rx.IsMatch(textToCheck),
    };

    response = new HttpResponseMessage(HttpStatusCode.OK);
    response.Content = CreateJsonContent(output.ToString());
    return response;
}

Skrypt przesyłania dalej

Poniższy przykład przekazuje przychodzące żądanie do backendu.

public override async Task<HttpResponseMessage> ExecuteAsync()
{
    // Check if the operation ID matches what is specified in the OpenAPI definition of the connector
    if (this.Context.OperationId == "ForwardAsPostRequest")
    {
        return await this.HandleForwardOperation().ConfigureAwait(false);
    }

    // Handle an invalid operation ID
    HttpResponseMessage response = new HttpResponseMessage(HttpStatusCode.BadRequest);
    response.Content = CreateJsonContent($"Unknown operation ID '{this.Context.OperationId}'");
    return response;
}

private async Task<HttpResponseMessage> HandleForwardOperation()
{
    // Example case: If your OpenAPI definition defines the operation as 'GET', but the backend API expects a 'POST',
    // use this script to change the HTTP method.
    this.Context.Request.Method = HttpMethod.Post;

    // Use the context to forward/send an HTTP request
    HttpResponseMessage response = await this.Context.SendAsync(this.Context.Request, this.CancellationToken).ConfigureAwait(continueOnCapturedContext: false);
    return response;
}

Skrypt przekazywania i transformacji

Poniższy przykład przesyła żądanie przychodzące i przekształci odpowiedź zwróconą z wewnętrznej bazy danych.

public override async Task<HttpResponseMessage> ExecuteAsync()
{
    // Check if the operation ID matches what is specified in the OpenAPI definition of the connector
    if (this.Context.OperationId == "ForwardAndTransformRequest")
    {
        return await this.HandleForwardAndTransformOperation().ConfigureAwait(false);
    }

    // Handle an invalid operation ID
    HttpResponseMessage response = new HttpResponseMessage(HttpStatusCode.BadRequest);
    response.Content = CreateJsonContent($"Unknown operation ID '{this.Context.OperationId}'");
    return response;
}

private async Task<HttpResponseMessage> HandleForwardAndTransformOperation()
{
    // Use the context to forward/send an HTTP request
    HttpResponseMessage response = await this.Context.SendAsync(this.Context.Request, this.CancellationToken).ConfigureAwait(continueOnCapturedContext: false);

    // Do the transformation if the response was successful, otherwise return error responses as-is
    if (response.IsSuccessStatusCode)
    {
        var responseString = await response.Content.ReadAsStringAsync().ConfigureAwait(continueOnCapturedContext: false);
        
        // Example case: response string is some JSON object
        var result = JObject.Parse(responseString);
        
        // Wrap the original JSON object into a new JSON object with just one key ('wrapped')
        var newResult = new JObject
        {
            ["wrapped"] = result,
        };
        
        response.Content = CreateJsonContent(newResult.ToString());
    }

    return response;
}

Obsługiwane przestrzenie nazw

Nie wszystkie przestrzenie nazw języka C# są obsługiwane. Obecnie można używać funkcji tylko z następujących przestrzeni nazw.

Ważne

Obecnie obsługiwana wersja .NET to .NET Standard 2.0.

using System;
using System.Collections;
using System.Collections.Generic;
using System.Diagnostics;
using System.IO;
using System.IO.Compression;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Net.Security;
using System.Security.Authentication;
using System.Security.Cryptography;
using System.Text;
using System.Text.RegularExpressions;
using System.Threading;
using System.Threading.Tasks;
using System.Web;
using System.Xml;
using System.Xml.Linq;
using System.Drawing;
using System.Drawing.Drawing2D;
using System.Drawing.Imaging;
using Microsoft.Extensions.Logging;
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;

Przykłady GitHub

Aby zobaczyć przykłady dotyczące łącznika DocuSign, przejdź do Power Platform Connectors w witrynie GitHub.

Kod niestandardowy – FAQ

Aby dowiedzieć się więcej o kodzie niestandardowym, zobacz Krok 4: (Opcjonalnie) Używanie niestandardowej obsługi kodu.

Pyt.: Czy mogę użyć wielu skryptów na łącznik niestandardowy?A: Nie. Można użyć tylko jednego pliku skryptu dla łącznika niestandardowego.

Pyt.: Otrzymuję wewnętrzny błąd serwera podczas aktualizowania łącznika niestandardowego. W czym może tkwić problem? A: Najprawdopodobniej występuje problem podczas kompilowania kodu. W przyszłości system będzie wyświetlał pełną listę błędów kompilacji, aby usprawnić to działanie. Na razie użyj klas pomocniczych , aby lokalnie przetestować błędy kompilacji jako obejście.

Pyt.: Czy mogę dodać rejestrowanie do kodu i uzyskać ślad do debugowania?A: Obecnie nie, ale obsługa tej funkcji zostanie dodana w przyszłości.

Pyt.: Jak mogę przetestować mój kod w międzyczasie?A: Przetestuj go lokalnie i upewnij się, że możesz skompilować kod przy użyciu tylko przestrzeni nazw podanych w obsługiwanych przestrzeniach nazw. Aby uzyskać informacje na temat testowania lokalnego, zobacz Pisanie kodu w łączniku niestandardowym.

Pyt.: Czy istnieją jakieś limity?A: Tak. Skrypt musi zostać wykonany w ciągu 2 minut, a rozmiar pliku skryptu nie może przekroczyć 1 MB. Ten nowy 2-minutowy limit czasu dotyczy wszystkich nowo utworzonych łączników niestandardowych. W przypadku istniejących łączników niestandardowych należy zaktualizować łącznik, aby zastosować nowy limit czasu.

Pyt.: Czy mogę utworzyć własnego klienta HTTP w kodzie skryptu?A: Obecnie tak, ale system blokuje tę funkcję w przyszłości. Zalecanym sposobem jest użycie metody this.Context.SendAsync.

Pyt.: Czy mogę używać kodu niestandardowego z lokalną bramą danych?Odp.: Nie, obecnie nie.

Pomoc techniczna usługi Virtual Network

W przypadku korzystania z łącznika w środowisku platformy Power Platform połączonym z siecią wirtualną obowiązują następujące ograniczenia:

Context.SendAsync używa publicznego punktu końcowego, więc nie może uzyskać dostępu do danych z prywatnych punktów końcowych w sieci wirtualnej.

Ogólne znane problemy i ograniczenia

W niektórych regionach nagłówek OperationId jest zwracany w formacie zakodowanym w standardzie base64. Jeśli implementacja OperationId wymaga wartości, zdekoduj ją do użycia w formacie base64.

public override async Task<HttpResponseMessage> ExecuteAsync()
{
    string realOperationId = this.Context.OperationId;
    // Resolve potential issue with base64 encoding of the OperationId
    // Test and decode if it's base64 encoded
    try {
        byte[] data = Convert.FromBase64String(this.Context.OperationId);
        realOperationId = System.Text.Encoding.UTF8.GetString(data);
    }
    catch (FormatException ex) {}
    // Check if the operation ID matches what is specified in the OpenAPI definition of the connector
    if (realOperationId == "RegexIsMatch")
    // Refer to the original examples above for remaining details
}

Następny krok

Tworzenie łącznika niestandardowego od podstaw

Przekazywanie opinii

Jesteśmy wdzięczni za opinie na temat problemów z platformą łączników oraz pomysły na nowe funkcje. Aby przekazać opinię, przejdź na stronę Przesyłanie problemów lub uzyskiwanie pomocy dotyczącej łączników i wybierz typ opinii.

Ostatnia aktualizacja o 2026-10-05