Pomelo.EntityFrameworkCore.MySql 使用教程

1. 项目介绍

Pomelo.EntityFrameworkCore.MySql 是一个基于 Entity Framework Core (EF Core) 的 MySQL 数据库提供程序。它支持 MySQL、MariaDB、Amazon Aurora、Azure Database for MySQL 以及其他兼容 MySQL 的数据库。该项目的主要目标是提供高性能、可靠的 EF Core 支持，使得开发者能够轻松地在 .NET 应用中使用 MySQL 数据库。

Pomelo.EntityFrameworkCore.MySql 的主要特点包括：

• 支持最新的 EF Core 版本。
• 高性能的数据库通信，基于 MySqlConnector。
• 支持 JSON 和空间数据类型。
• 提供详细的配置选项和调试支持。

2. 项目快速启动

2.1 安装依赖

首先，在你的 .NET 项目中安装 Pomelo.EntityFrameworkCore.MySql 包。你可以使用以下命令：

dotnet add package Pomelo.EntityFrameworkCore.MySql --version 8.0.2

2.2 配置服务

在你的 ASP.NET Core 项目的 Startup.cs 文件中，配置服务以使用 Pomelo.EntityFrameworkCore.MySql：

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        // 替换为你的连接字符串
        var connectionString = "server=localhost;user=root;password=1234;database=ef";

        // 替换为你的服务器版本和类型
        var serverVersion = new MySqlServerVersion(new Version(8, 0, 36));

        // 替换 'YourDbContext' 为你的 DbContext 派生类的名称
        services.AddDbContext<YourDbContext>(
            dbContextOptions => dbContextOptions
                .UseMySql(connectionString, serverVersion)
                .LogTo(Console.WriteLine, LogLevel.Information)
                .EnableSensitiveDataLogging()
                .EnableDetailedErrors()
        );
    }
}

2.3 创建 DbContext

创建一个继承自 DbContext 的类，例如 YourDbContext：

public class YourDbContext : DbContext
{
    public YourDbContext(DbContextOptions<YourDbContext> options)
        : base(options)
    {
    }

    public DbSet<YourEntity> YourEntities { get; set; }
}

2.4 迁移数据库

使用 EF Core 的迁移工具来创建和更新数据库：

dotnet ef migrations add InitialCreate
dotnet ef database update

3. 应用案例和最佳实践

3.1 使用 JSON 支持

Pomelo.EntityFrameworkCore.MySql 支持 JSON 数据类型，可以方便地存储和查询 JSON 数据。例如：

public class YourEntity
{
    public int Id { get; set; }
    public string Name { get; set; }
    public JsonDocument Metadata { get; set; }
}

3.2 使用空间数据支持

Pomelo.EntityFrameworkCore.MySql 还支持空间数据类型，例如 NetTopologySuite：

public class YourEntity
{
    public int Id { get; set; }
    public Point Location { get; set; }
}

3.3 调试和性能优化

在开发环境中，启用详细日志和敏感数据记录可以帮助调试。在生产环境中，建议关闭这些选项以提高性能。

4. 典型生态项目

4.1 MySqlConnector

Pomelo.EntityFrameworkCore.MySql 基于 MySqlConnector，这是一个高性能的 MySQL 数据库驱动程序。

4.2 Entity Framework Core

Pomelo.EntityFrameworkCore.MySql 是 Entity Framework Core 的一个提供程序，支持 EF Core 的所有功能。

4.3 ASP.NET Core

Pomelo.EntityFrameworkCore.MySql 可以与 ASP.NET Core 无缝集成，提供强大的后端数据库支持。

通过以上步骤，你可以快速上手并使用 Pomelo.EntityFrameworkCore.MySql 在你的 .NET 项目中连接和操作 MySQL 数据库。