Vytvořte vlastní plugin

V tomto článku se dozvíte, jak vytvořit vlastní modul plug-in pro vývojový proxy server. Vytvořením modulů plug-in pro Dev Proxy můžete rozšířit jeho funkce a přidat vlastní funkce tak, aby vyhovovaly vašim potřebám.

Požadavky

Než začnete vytvářet vlastní modul plug-in, ujistěte se, že máte následující požadavky:

• .NET v9 Core SDK
• Nejnovější verzi knihovny DLL Dev Proxy Abstractions můžete najít na stránce vydání GitHubu.

Vytvořte nový plugin

Pokud chcete vytvořit nový projekt, postupujte podle dalších kroků:

1. Pomocí příkazu dotnet new classlib vytvořte nový projekt knihovny tříd.

   dotnet new classlib -n MyCustomPlugin
   

2. Otevřete nově vytvořený projekt v editoru Visual Studio Code.

   code MyCustomPlugin
   

3. Přidejte knihovnu DLL pro abstrakce dev proxy (DevProxy.Abstractions.dll) do složky projektu.

4. Přidejte DevProxy.Abstractions.dll jako odkaz do souboru projektu DevProxyCustomPlugin.csproj.

   <ItemGroup>
     <Reference Include="DevProxy.Abstractions">
       <HintPath>.\DevProxy.Abstractions.dll</HintPath>
       <Private>false</Private>
       <ExcludeAssets>runtime</ExcludeAssets>
     </Reference>
   </ItemGroup>
   

5. Přidejte balíčky NuGet vyžadované pro váš projekt.

   dotnet add package Microsoft.Extensions.Configuration
   dotnet add package Microsoft.Extensions.Configuration.Binder
   dotnet add package Microsoft.Extensions.Logging.Abstractions
   dotnet add package Unobtanium.Web.Proxy
   

6. Vylučte knihovny DLL závislostí z výstupu sestavení přidáním ExcludeAssets značky pro každý PackageReference v DevProxyCustomPlugin.csproj souboru.

   <ExcludeAssets>runtime</ExcludeAssets>
   

7. Vytvořte novou třídu, která dědí z BaseProxy třídy.

   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)
       {
           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;
       }
   }
   

8. Sestavte svůj projekt.

   dotnet build
   

Použijte svůj vlastní plugin

Pokud chcete použít vlastní modul plug-in, musíte ho přidat do konfiguračního souboru dev proxy serveru:

1. Do souboru přidejte novou konfiguraci devproxyrc.json modulu plug-in.

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

2. Spusťte dev proxy server.

   devproxy
   

Ukázkový plugin zkontroluje všechny odpovídající adresy URL na přítomnost požadované Authorization hlavičky. Pokud záhlaví není k dispozici, zobrazí se zpráva s upozorněním.

Přidání vlastní konfigurace do modulu plug-in (volitelné)

Logiku modulu plug-in můžete rozšířit přidáním vlastní konfigurace:

1. Dědí z BasePlugin<TConfiguration> třídy. Dev Proxy za běhu zveřejňuje konfiguraci pluginu prostřednictvím vlastnosti 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(
       ILogger<CatchApiCallsPlugin> logger,
       ISet<UrlToWatch> urlsToWatch,
       IProxyConfiguration proxyConfiguration,
       IConfigurationSection pluginConfigurationSection) :
       BasePlugin<CatchApiCallsConfiguration>(
           logger,
           urlsToWatch,
           proxyConfiguration,
           pluginConfigurationSection)
   {
       public override string Name => nameof(CatchApiCallsPlugin);
   
       public override Task BeforeRequestAsync(ProxyRequestArgs e)
       {
           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. Sestavte svůj projekt.

   dotnet build
   

3. Aktualizujte devproxyrc.json soubor tak, aby zahrnoval novou konfiguraci.

   {
     "plugins": [{
       "name": "CatchApiCallsPlugin",
       "enabled": true,
       "pluginPath": "./bin/Debug/net9.0/MyCustomPlugin.dll",
       "configSection": "catchApiCalls"
     }],
     "catchApiCalls": {
       "requiredHeader": "Authorization" // Example configuration
     }
   }
   

4. Spusťte dev proxy server.

   devproxy