Membuat plugin kustom

Sekilas
Tujuan: Membangun plugin Dev Proxy kustom
Waktu: 30 menit
Plugin: Plugin kustom
Prerequisites:Siapkan Dev Proxy, .NET 10 SDK

Dalam artikel ini, Anda mempelajari cara membuat plugin kustom untuk Dev Proxy. Dengan membuat plugin untuk Dev Proxy, Anda dapat memperluas fungsionalitasnya dan menambahkan fitur kustom agar sesuai dengan kebutuhan Anda.

Plugin HTTP vs. plugin stdio

Dev Proxy mendukung dua jenis plugin tergantung pada lalu lintas yang ingin Anda cegat:

  • Plugin HTTP mencegat permintaan dan respons HTTP antara aplikasi dan API Anda. Mereka mewarisi dari BasePlugin dan mengambil alih metode seperti BeforeRequestAsync dan BeforeResponseAsync. Gunakan plugin HTTP saat Anda ingin mensimulasikan kesalahan API, menambahkan respons tiruan, memvalidasi header permintaan, atau memeriksa dan memodifikasi lalu lintas HTTP.

  • Plugin Stdio mencegat pesan yang dikirim melalui input/output standar (stdin, stdout, stderr) antara proses induk dan proses anak. Mereka mengimplementasikan IStdioPlugin antarmuka (yang BasePlugin juga mengimplementasikan) dan mengambil alih metode seperti BeforeStdinAsync, AfterStdoutAsync, dan AfterStderrAsync. Gunakan plugin stdio saat bekerja dengan alat yang berkomunikasi melalui stdio, seperti server Model Context Protocol (MCP).

Satu kelas plugin dapat menangani lalu lintas HTTP dan stdio dengan mengambil alih metode dari kedua set.

Prasyarat

Sebelum Anda mulai membuat plugin kustom, pastikan Anda memiliki prasyarat berikut:

Membuat plugin baru

Ikuti langkah-langkah berikutnya untuk membuat proyek baru:

  1. Buat proyek pustaka kelas baru menggunakan dotnet new classlib perintah .

    dotnet new classlib -n MyCustomPlugin

  2. Buka proyek yang baru dibuat di Visual Studio Code.

    code MyCustomPlugin

  3. Tambahkan paket Dev Proxy Abstractions NuGet ke proyek Anda.

    dotnet add package DevProxy.Abstractions

  4. Kecualikan pustaka tautan dinamis (DLL) dependensi dari output kompilasi dengan menambahkan tag ExcludeAssets untuk setiap PackageReference dalam file MyCustomPlugin.csproj.

    <ExcludeAssets>runtime</ExcludeAssets>

  5. Buat kelas baru yang mewarisi dari BaseProxy kelas .

    using DevProxy.Abstractions.Plugins;
using DevProxy.Abstractions.Proxy;
using Microsoft.Extensions.Logging;

namespace MyCustomPlugin;

public sealed class CatchApiCallsPlugin(
    ILogger<CatchApiCallsPlugin> logger,
    ISet<UrlToWatch> urlsToWatch) : BasePlugin(logger, urlsToWatch)
{
    public override string Name => nameof(CatchApiCallsPlugin);

    public override Task BeforeRequestAsync(ProxyRequestArgs e, CancellationToken cancellationToken)
    {
        Logger.LogTrace("{Method} called", nameof(BeforeRequestAsync));

        ArgumentNullException.ThrowIfNull(e);

        if (!e.HasRequestUrlMatch(UrlsToWatch))
        {
            Logger.LogRequest("URL not matched", MessageType.Skipped, new(e.Session));
            return Task.CompletedTask;
        }

        var headers = e.Session.HttpClient.Request.Headers;
        var header = headers.Where(h => h.Name == "Authorization").FirstOrDefault();
        if (header is null)
        {
            Logger.LogRequest($"Does not contain the Authorization header", MessageType.Warning, new LoggingContext(e.Session));
            return Task.CompletedTask;
        }

        Logger.LogTrace("Left {Name}", nameof(BeforeRequestAsync));
        return Task.CompletedTask;
    }
}

  6. Bangun proyek Anda.

    dotnet build

Gunakan plugin kustom Anda

Untuk menggunakan plugin kustom, Anda perlu menambahkannya ke file konfigurasi Dev Proxy:

  1. Tambahkan konfigurasi plugin baru dalam devproxyrc.json file.

    File: devproxyrc.json

    {
  "plugins": [{
    "name": "CatchApiCallsPlugin",
    "enabled": true,
    "pluginPath": "./bin/Debug/net10.0/MyCustomPlugin.dll",
  }]
}

  2. Jalankan Proksi Dev.

    devproxy

Contoh plugin memeriksa semua URL yang cocok untuk header yang diperlukan Authorization . Jika header tidak ada, akan muncul pesan peringatan.

Menambahkan konfigurasi kustom ke plugin Anda (opsional)

Anda dapat memperluas logika plugin Anda dengan menambahkan konfigurasi kustom:

  1. Menginherit dari kelas BasePlugin<TConfiguration>. Dev Proxy mengekspos konfigurasi plugin yang diurai selama runtime melalui properti Configuration.

    using DevProxy.Abstractions.Plugins;
using DevProxy.Abstractions.Proxy;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.Logging;

namespace MyCustomPlugin;

public sealed class CatchApiCallsConfiguration
{
    public string? RequiredHeader { get; set; }
}

public sealed class CatchApiCallsPlugin(
    HttpClient httpClient,
    ILogger<CatchApiCallsPlugin> logger,
    ISet<UrlToWatch> urlsToWatch,
    IProxyConfiguration proxyConfiguration,
    IConfigurationSection pluginConfigurationSection) :
    BasePlugin<CatchApiCallsConfiguration>(
        httpClient,
        logger,
        urlsToWatch,
        proxyConfiguration,
        pluginConfigurationSection)
{
    public override string Name => nameof(CatchApiCallsPlugin);

    public override Task BeforeRequestAsync(ProxyRequestArgs e, CancellationToken cancellationToken)
    {
        Logger.LogTrace("{Method} called", nameof(BeforeRequestAsync));

        ArgumentNullException.ThrowIfNull(e);

        if (!e.HasRequestUrlMatch(UrlsToWatch))
        {
            Logger.LogRequest("URL not matched", MessageType.Skipped, new(e.Session));
            return Task.CompletedTask;
        }

        // Start using your custom configuration
        var requiredHeader = Configuration.RequiredHeader ?? string.Empty;
        if (string.IsNullOrEmpty(requiredHeader))
        {
            // Required header is not set, so we don't need to do anything
            Logger.LogRequest("Required header not set", MessageType.Skipped, new LoggingContext(e.Session));
            return Task.CompletedTask;
        }

        var headers = e.Session.HttpClient.Request.Headers;
        var header = headers.Where(h => h.Name == requiredHeader).FirstOrDefault();
        if (header is null)
        {
            Logger.LogRequest($"Does not contain the {requiredHeader} header", MessageType.Warning, new LoggingContext(e.Session));
            return Task.CompletedTask;
        }

        Logger.LogTrace("Left {Name}", nameof(BeforeRequestAsync));
        return Task.CompletedTask;
    }
}

  2. Bangun proyek Anda.

    dotnet build

  3. Perbarui file Anda devproxyrc.json untuk menyertakan konfigurasi baru.

    File: devproxyrc.json

    {
  "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v3.1.0/rc.schema.json",
  "plugins": [{
    "name": "CatchApiCallsPlugin",
    "enabled": true,
    "pluginPath": "./bin/Debug/net10.0/MyCustomPlugin.dll",
    "configSection": "catchApiCalls"
  }],
  "catchApiCalls": {
    "requiredHeader": "Authorization"
  }
}

  4. Jalankan Proksi Dev.

    devproxy

Lihat juga

  • Last updated on