Creación de un complemento personalizado

En este artículo, aprenderá a crear un complemento personalizado para el proxy de desarrollo. Al crear complementos para el proxy de desarrollo, puede ampliar su funcionalidad y agregar características personalizadas para satisfacer sus necesidades.

Requisitos previos

Antes de empezar a crear un complemento personalizado, asegúrese de que tiene los siguientes requisitos previos:

• SDK de .NET Core
• La versión más reciente de la DLL de abstracciones de proxy de desarrollo, que puede encontrar en la página de versiones de GitHub del proxy de desarrollo.

Creación de un complemento

Siga los pasos siguientes para crear un proyecto:

1. Cree un nuevo proyecto de biblioteca de clases mediante el dotnet new classlib comando .

   dotnet new classlib -n MyCustomPlugin
   

2. Abra el proyecto recién creado en Visual Studio Code.

   code MyCustomPlugin
   

3. Agregue el archivo DLL de abstracciones de proxy de desarrollo (dev-proxy-abstractions.dll) a la carpeta del proyecto.

4. Agregue como dev-proxy-abstractions.dll referencia al archivo del proyecto DevProxyCustomPlugin.csproj .

   <ItemGroup>
     <Reference Include="dev-proxy-abstractions">
       <HintPath>.\dev-proxy-abstractions.dll</HintPath>
       <Private>false</Private>
       <ExcludeAssets>runtime</ExcludeAssets>
     </Reference>
   </ItemGroup>
   

5. Agregue los paquetes NuGet necesarios para el proyecto.

   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. Excluya los archivos DLL de dependencia de la salida de compilación agregando una ExcludeAssets etiqueta por PackageReference en el DevProxyCustomPlugin.csproj archivo.

   <ExcludeAssets>runtime</ExcludeAssets>
   

7. Cree una nueva clase que implemente la BaseProxyPlugin interfaz .

   using Microsoft.DevProxy.Abstractions;
   using Microsoft.Extensions.Configuration;
   using Microsoft.Extensions.Logging;
   
   namespace MyCustomPlugin;
   
   public class CatchApiCalls(IPluginEvents pluginEvents, IProxyContext context, ILogger logger, ISet<UrlToWatch> UrlsToWatch, IConfigurationSection? configSection = null) : BaseProxyPlugin(pluginEvents, context, logger, UrlsToWatch, configSection)
   {
     public override string Name => nameof(CatchApiCalls);
   
     public override async Task RegisterAsync()
     {
       await base.RegisterAsync();
   
       PluginEvents.BeforeRequest += BeforeRequestAsync;
     }
   
     private Task BeforeRequestAsync(object sender, ProxyRequestArgs e)
     {
       if (UrlsToWatch is null ||
         !e.HasRequestUrlMatch(UrlsToWatch))
       {
         // No match for the URL, so we don't need to do anything
         Logger.LogRequest("URL not matched", MessageType.Skipped, new LoggingContext(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;
       }
   
       return Task.CompletedTask;
     }
   }
   

8. Compile el proyecto.

   dotnet build
   

Uso del complemento personalizado

Para usar el complemento personalizado, debe agregarlo al archivo de configuración del proxy de desarrollo:

1. Agregue la nueva configuración del complemento en el devproxyrc.json archivo.

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

2. Ejecute el proxy de desarrollo.

   devproxy
   

El complemento de ejemplo comprueba todas las direcciones URL coincidentes para el encabezado de autorización necesario. Si el encabezado no está presente, se muestra un mensaje de advertencia.

Adición de una configuración personalizada al complemento (opcional)

Puede ampliar la lógica del complemento agregando una configuración personalizada:

1. Agregue un nuevo _configuration objeto y enlazarlo en el Register método .

   using Microsoft.DevProxy.Abstractions;
   using Microsoft.Extensions.Configuration;
   using Microsoft.Extensions.Logging;
   
   namespace MyCustomPlugin;
   
   public class CatchApiCallsConfiguration
   {
     public string? RequiredHeader { get; set; }
   }
   
   public class CatchApiCalls(IPluginEvents pluginEvents, IProxyContext context, ILogger logger, ISet<UrlToWatch> UrlsToWatch, IConfigurationSection? configSection = null) : BaseProxyPlugin(pluginEvents, context, logger, UrlsToWatch, configSection)
   {
     public override string Name => nameof(CatchApiCalls);
   
     // Define you custom configuration
     private readonly CatchApiCallsConfiguration _configuration = new();
   
     public override async Task RegisterAsync()
     {
       await base.RegisterAsync();
   
       // Bind your plugin configuration
       configSection?.Bind(_configuration);
   
       // Register your event handlers
       PluginEvents.BeforeRequest += BeforeRequestAsync;
     }
   
     private Task BeforeRequestAsync(object sender, ProxyRequestArgs e)
     {
       if (UrlsToWatch is null ||
         !e.HasRequestUrlMatch(UrlsToWatch))
       {
         // No match for the URL, so we don't need to do anything
         Logger.LogRequest("URL not matched", MessageType.Skipped, new LoggingContext(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;
       }
   
       return Task.CompletedTask;
     }
   }
   

2. Compile el proyecto.

   dotnet build
   

3. Actualice el devproxyrc.json archivo para incluir la nueva configuración.

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

4. Ejecute el proxy de desarrollo.

   devproxy