integración de .NET Aspire Pomelo MySQLEntity Framework Core

Incluye:integración de hospedaje y Client integración

MySQL es un sistema de administración de bases de datos relacionales (RDBMS) de código abierto que usa lenguaje de consulta estructurado (SQL) para administrar y manipular datos. Se emplea en muchos entornos diferentes, desde proyectos pequeños hasta sistemas empresariales a gran escala y es una opción popular hospedar datos que respaldan microservicios en una aplicación nativa de nube. La integración de .NET Aspire Pomelo MySQLEntity Framework Core permite conectarse a bases de datos de MySQL existentes o crear nuevas instancias desde .NET con la imagen de contenedor de mysql.

Integración de hospedaje

El MySQL que hospeda la integración modela el server como el tipo de MySqlServerResource y la base de datos como el tipo de MySqlDatabaseResource. Para acceder a estos tipos y APIs, agregue el paquete NuGet 📦Aspire.Hosting.MySql en el proyecto del host de la aplicación .

dotnet add package Aspire.Hosting.MySql

<PackageReference Include="Aspire.Hosting.MySql"
                  Version="*" />

Para obtener más información, consulte dotnet add package o Administrar las dependencias del paquete en .NET aplicaciones.

Agregar el recurso MySQLserver y el recurso de la base de datos

En el proyecto host de la aplicación, llame a AddMySql para agregar y devolver un generador de recursos de tipo MySQL. Encadene una llamada al generador de recursos devuelto hacia AddDatabasepara agregar un recurso de base de datos MySQL.

var builder = DistributedApplication.CreateBuilder(args);

var mysql = builder.AddMySql("mysql")
                   .WithLifetime(ContainerLifetime.Persistent);

var mysqldb = mysql.AddDatabase("mysqldb");

var myService = builder.AddProject<Projects.ExampleProject>()
                       .WithReference(mysqldb)
                       .WaitFor(mysqldb);

// After adding all resources, run the app...

Cuando .NET.NET Aspire agrega una imagen de contenedor al host de la aplicación, como se muestra en el ejemplo anterior con la imagen de mysql, crea una nueva instancia de MySQL en el equipo local. Se usa una referencia al generador de recursos de MySQL (la variable mysql) para agregar una base de datos. La base de datos se denomina mysqldb y, a continuación, se agrega al ExampleProject. El recurso MySQL incluye credenciales predeterminadas con un username de root y un password aleatorio generado mediante el método CreateDefaultPasswordParameter.

Cuando se ejecuta el host de la aplicación, la contraseña se almacena en el almacén de secretos del host de la aplicación. Queda añadido a la sección Parameters, por ejemplo:

{
  "Parameters:mysql-password": "<THE_GENERATED_PASSWORD>"
}

El nombre del parámetro es mysql-password, pero realmente solo da formato al nombre del recurso con un sufijo -password. Para obtener más información, consulte almacenamiento seguro de secretos de aplicación en desarrollo en ASP.NET Core y Agregar MySQL recurso con parámetros.

El método WithReference configura una conexión en el ExampleProject denominado mysqldb.

Agrega un recurso de MySQL con un volumen de datos

Para agregar un volumen de datos al recurso de SQL Server, llame al método WithDataVolume en el recurso SQL Server:

var builder = DistributedApplication.CreateBuilder(args);

var mysql = builder.AddMySql("mysql")
                   .WithDataVolume();

var mysqldb = mysql.AddDatabase("mysqldb");

builder.AddProject<Projects.ExampleProject>()
       .WithReference(mysqldb)
       .WaitFor(mysqldb);

// After adding all resources, run the app...

El volumen de datos se utiliza para persistir los datos de MySQLserver más allá del ciclo de vida de su contenedor. El volumen de datos se monta en la ruta de acceso /var/lib/mysql del contenedor de SQL Server y, cuando no se proporciona un parámetro name, el nombre se genera de forma aleatoria. Para obtener más información sobre los volúmenes de datos y los detalles sobre por qué se prefieren a enlazar montajes, consulte Docker documentos: Volúmenes.

Añade un recurso MySQL con un montaje de enlace para datos.

Para agregar un montaje de vinculación de datos al recurso de MySQL, llame al método WithDataBindMount.

var builder = DistributedApplication.CreateBuilder(args);

var mysql = builder.AddMySql("mysql")
                   .WithDataBindMount(source: @"C:\MySql\Data");

var db = sql.AddDatabase("mysqldb");

builder.AddProject<Projects.ExampleProject>()
       .WithReference(mysqldb)
       .WaitFor(mysqldb);

// After adding all resources, run the app...

Los montajes de enlaces de datos dependen del sistema de archivos de la máquina host para conservar los datos de MySQL a través de los reinicios del contenedor. El montaje de enlace de datos se monta en la ruta C:\MySql\Data en Windows (o en la ruta /MySql/Data en Unix) en el equipo host del contenedor MySQL. Para obtener más información sobre los montajes de enlace de datos, consulte la documentación Docker: Montajes de enlace.

Añadir recurso MySQL con parámetros

Cuando desee proporcionar una contraseña raíz MySQL explícitamente, puede pasarla como parámetro. Considere el siguiente ejemplo alternativo:

var password = builder.AddParameter("password", secret: true);

var mysql = builder.AddMySql("mysql", password)
                   .WithLifetime(ContainerLifetime.Persistent);

var mysqldb = mysql.AddDatabase("mysqldb");

var myService = builder.AddProject<Projects.ExampleProject>()
                       .WithReference(mysqldb)
                       .WaitFor(mysqldb);

Para obtener más información, vea Parámetros externos.

Adición de un recurso PhpMyAdmin

phpMyAdmin es una popular herramienta de administración basada en web para MySQL. Puede usarlo para examinar y modificar MySQL objetos como bases de datos, tablas, vistas e índices. Para usar phpMyAdmin en la solución de .NET.NET Aspire, llame al método WithPhpMyAdmin. Este método agrega un nuevo recurso de contenedor a la solución que hospeda phpMyAdmin y lo conecta al contenedor de MySQL:

var builder = DistributedApplication.CreateBuilder(args);

var mysql = builder.AddMySql("mysql")
                   .WithPhpMyAdmin();

var db = sql.AddDatabase("mysqldb");

builder.AddProject<Projects.ExampleProject>()
       .WithReference(mysqldb)
       .WaitFor(mysqldb);

// After adding all resources, run the app...

Al ejecutar la solución, el tablero de .NET.NET Aspire muestra los recursos de phpMyAdmin con un endpoint. Seleccione el vínculo al punto de conexión para ver phpMyAdmin en una nueva pestaña del explorador.

Hospedaje de comprobaciones de estado de integración

La integración de hospedaje de MySQL agrega automáticamente una comprobación de estado para el recurso MySQL. La comprobación de estado comprueba que el MySQLserver está en funcionamiento y que se puede establecer una conexión con este.

La integración de hospedaje se basa en el 📦 AspNetCore.HealthChecks.MySql paquete NuGet.

integración de Client

Para empezar a trabajar con la integración de .NET Aspire Pomelo MySQL Entity Framework, instale el 📦Aspire. Pomelo.EntityFrameworkCore.MySql paquete NuGet en el proyecto client-consuming, es decir, el proyecto de la aplicación que usa el MySQLEntity Framework Coreclient.

dotnet add package Aspire.Pomelo.EntityFrameworkCore.MySql

<PackageReference Include="Aspire.Pomelo.EntityFrameworkCore.MySql"
                  Version="*" />

Para obtener más información, consulte dotnet add package o Administrar las dependencias de paquetes en aplicaciones .NET.

Añadir un contexto de base de datos de MySQL

En el archivo Program.cs del proyecto que consume client, invoque el método de extensión AddMySqlDbContext en cualquier IHostApplicationBuilder a fin de registrar un DbContext para su uso mediante el contenedor de inyección de dependencias. El método toma un parámetro de nombre de conexión.

builder.AddMySqlDbContext<ExampleDbContext>(connectionName: "mysqldb");

Para recuperar el objeto ExampleDbContext de un servicio:

public class ExampleService(ExampleDbContext context)
{
    // Use context...
}

Para obtener más información sobre la inserción de dependencias, consulte .NET inserción de dependencias.

Añadir un contexto de base de datos MySQL con enriquecimiento

Para enriquecer el DbContext con servicios adicionales, como reintentos automáticos, comprobaciones de estado, registro y telemetría, llame al método EnrichMySqlDbContext:

builder.EnrichMySqlDbContext<ExampleDbContext>(
    connectionName: "mysqldb",
    configureSettings: settings =>
    {
        settings.DisableRetry = false;
        settings.CommandTimeout = 30 // seconds
    });

El parámetro settings es una instancia de la clase PomeloEntityFrameworkCoreMySqlSettings.

Configuración

La integración de .NET Aspire Pomelo MySQLEntity Framework Core proporciona varias opciones para configurar la conexión de base de datos en función de los requisitos y convenciones del proyecto.

Uso de una cadena de conexión

Al usar una cadena de conexión de la sección de configuración de ConnectionStrings, puede proporcionar el nombre de la cadena de conexión al llamar a builder.AddMySqlDatabaseDbContext<TContext>():

builder.AddMySqlDatabaseDbContext<MyDbContext>("mysql");

Luego, la cadena de conexión se recuperará de la sección de configuración ConnectionStrings.

{
  "ConnectionStrings": {
    "mysql": "Server=mysql;Database=mysqldb"
  }
}

El EnrichMySqlDbContext no usará la sección de configuración del ConnectionStrings, ya que espera que se registre un DbContext en el momento en que se llama.

Para obtener más información, consulte la documentación de MySqlConnector: ConnectionString.

Uso de proveedores de configuración

La integración de .NET Aspire Pomelo MySQLEntity Framework Core admite Microsoft.Extensions.Configuration. Carga el PomeloEntityFrameworkCoreMySqlSettings desde archivos de configuración como appsettings.json mediante la clave Aspire:Pomelo:EntityFrameworkCore:MySql.

En el ejemplo siguiente se muestra un appsettings.json que configura algunas de las opciones disponibles:

{
  "Aspire": {
    "Pomelo": {
      "EntityFrameworkCore": {
        "MySql": {
          "ConnectionString": "YOUR_CONNECTIONSTRING",
          "DisableHealthChecks": true,
          "DisableTracing": true
        }
      }
    }
  }
}

Para obtener el esquema de integración completo MySQLJSON, consulte Aspire.Pomelo.EntityFrameworkCore.MySql/ConfigurationSchema.json.

Usa delegados insertados

También puede pasar el delegado Action<PomeloEntityFrameworkCoreMySqlSettings> para configurar algunas o todas las opciones en línea, por ejemplo, para deshabilitar las comprobaciones de salud desde el código:

builder.AddMySqlDbContext<MyDbContext>(
    "mysqldb",
    static settings => settings.DisableHealthChecks = true);

o

builder.EnrichMySqlDbContext<MyDbContext>(
    static settings => settings.DisableHealthChecks = true);

Comprobaciones de estado

De forma predeterminada, las integraciones .NET.NET Aspire habilitan verificaciones de salud de para todos los servicios. Para obtener más información, consulte .NET.NET Aspire integrations overview.

La integración de .NET Aspire Pomelo MySQLEntity Framework Core:

• Agrega la comprobación de salud si PomeloEntityFrameworkCoreMySqlSettings.DisableHealthChecks es false, que invoca el método CanConnectAsync de EF Core.
• Se integra con el punto de conexión HTTP de /health, que especifica que todas las comprobaciones de estado registradas deben pasar para que la aplicación se considere lista para aceptar el tráfico.

Observabilidad y telemetría

.NET .NET Aspire integraciones configuran automáticamente las configuraciones de registro, seguimiento y métricas, que a veces se conocen como los pilares de la observabilidad. Para obtener más información sobre la observabilidad de integración y la telemetría, consulte información general sobre las integraciones de .NET.NET Aspire. En función del servicio de respaldo, algunas integraciones solo pueden admitir algunas de estas características. Por ejemplo, algunas integraciones admiten el registro y el seguimiento, pero no las métricas. Las características de telemetría también se pueden deshabilitar mediante las técnicas presentadas en la sección Configuración.

Registro

La integración de MySQLEntity Framework Core.NET Aspire Pomelo usa las siguientes categorías de registro:

• Microsoft.EntityFrameworkCore.ChangeTracking
• Microsoft.EntityFrameworkCore.Database.Command
• Microsoft.EntityFrameworkCore.Database.Connection
• Microsoft.EntityFrameworkCore.Database.Transaction
• Microsoft.EntityFrameworkCore.Infrastructure
• Microsoft.EntityFrameworkCore.Migrations
• Microsoft.EntityFrameworkCore.Model
• Microsoft.EntityFrameworkCore.Model.Validation
• Microsoft.EntityFrameworkCore.Query
• Microsoft.EntityFrameworkCore.Update

Rastreo

La integración de .NET Aspire Pomelo MySQLEntity Framework Core emitirá las siguientes actividades de seguimiento mediante OpenTelemetry:

• MySqlConnector

Métricas

La integración de .NET Aspire Pomelo MySQLEntity Framework Core admite actualmente las siguientes métricas:

• MySqlConnector:
  • db.client.connections.create_time
  • db.client.connections.use_time
  • db.client.connections.wait_time
  • db.client.connections.idle.max
  • db.client.connections.idle.min
  • db.client.connections.max
  • db.client.connections.pending_requests
  • db.client.connections.timeouts
  • db.client.connections.usage

Consulte también

• MySQL base de datos
• Entity Framework Core documentos
• .NET .NET Aspire integraciones
• .NET Aspire GitHub repo