EF Core快速上手

快速上手

为了简单，用sqlite来做演示，nuget安装Microsoft.EntityFrameworkCore.Sqlite

// 1. 定义实体类
using Microsoft.EntityFrameworkCore;

public class Product
{
    public int Id
    {
        get; set;
    } // EF 默认识别 Id 为自增主键
    public string Name { get; set; } = string.Empty;
    public double Price
    {
        get; set;
    }
}

// 2. 定义上下文
public class SimpleDbContext : DbContext
{
    public DbSet<Product> Products
    {
        get; set;
    }
	// 配置连接：告诉 EF Core 我们用 SQLite，数据库名叫 simple.db
    protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
    {
        optionsBuilder.UseSqlite("Data Source=simple.db");
    }
}
// 3. 运行 CRUD
class Program
{
    static void Main()
    {
        using var context = new SimpleDbContext();

        // 如果数据库不存在，根据实体结构自动创建
        context.Database.EnsureCreated();

        // 增 (Create)
        context.Products.Add(new Product { Name = "无线鼠标", Price = 99.0 });
        context.SaveChanges();

        // 查 (Read)
        var item = context.Products.FirstOrDefault(p => p.Name == "无线鼠标");
        Console.WriteLine($"[读取成功] 商品：{item?.Name}，价格：{item?.Price}");
        Console.ReadLine();
    }
}

数据库配置

OnConfiguring (配置管道)： 负责解决“数据库怎么连、连去哪”的问题。用来配置连接字符串、数据库驱动、日志打印等。

OnModelCreating (设置模型)： 负责解决“表结构长啥样”的问题。用来显式配置表名、字段长度、索引、外键等数据库约束。

可以直接用DataAnnotations方式进行标注。

[Table("tbl_users")] // 自定义表名
public class User
{
    [Key] // 显式指定主键
    public int UserId
    {
        get; set;
    }

    [Required] // 相当于 NOT NULL
    [MaxLength(50)] // 限制最大长度，防止生成 nvarchar(max) 导致无法建索引
    public string Username { get; set; } = string.Empty;

    [MaxLength(100)]
    public string? Email
    {
        get; set;
    } // C#可空类型 `?` 会被翻译为数据库的 NULL
}

也可以OnModelCreating中设置

using Microsoft.EntityFrameworkCore;

public class Employee
{
    public int EmpId { get; set; } // 这个名字不叫 Id，EF 默认识别不了主键，需要手动指定
    public string Name { get; set; } = string.Empty;
    public string? Email { get; set; }
    public decimal Salary { get; set; }
}

public class CompanyDbContext : DbContext
{
    public DbSet<Employee> Employees { get; set; }

    protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
    {
        optionsBuilder.UseSqlite("Data Source=company.db");
    }

    // OnModelCreating：管结构（直接在这里设置）
    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        base.OnModelCreating(modelBuilder);

        // 开始为 Employee 实体配置精细化约束
        modelBuilder.Entity<Employee>(entity =>
        {
            // 1. 自定义映射到数据库后的表名（默认会叫 Employees）
            entity.ToTable("tbl_employee_tuples");

            // 2. 显式指定主键（因为属性名不叫 Id）
            entity.HasKey(e => e.EmpId);

            // 3. 限制名字长度最大为 50，且为 NOT NULL
            entity.Property(e => e.Name)
                  .HasColumnName("emp_name") // 修改数据库里的列名
                  .HasMaxLength(50)         // 限制长度，防止生成 text 或 max 导致无法建索引
                  .IsRequired();            // 必填

            // 4. 精确控制金额的精度
            entity.Property(e => e.Salary)
                  .HasColumnType("decimal(18,2)"); // 18位总长，2位小数

            // 5. 为 Email 创建唯一索引，防止数据重复
            entity.HasIndex(e => e.Email)
                  .IsUnique();
        });
    }
}

配置隔离

如果表多，都写在OnModelCreating会很乱，不便于管理，所以就可以对每个表写单独的配置类，实现IEntityTypeConfiguration<T> 接口就可以

public class OrderConfiguration : IEntityTypeConfiguration<Order>
{
    public void Configure(EntityTypeBuilder<Order> builder)
    {
        // 所有的 Fluent API 约束转移到这里
        builder.ToTable("sys_orders");
        builder.HasKey(o => o.Id);

        builder.Property(o => o.OrderNo)
               .HasMaxLength(32)
               .IsRequired();

        builder.Property(o => o.TotalAmount)
               .HasColumnType("decimal(16,4)");

        builder.Property(o => o.CreatedAt)
               .HasDefaultValueSql("CURRENT_TIMESTAMP"); // 数据库端自动生成时间戳

        // 创建唯一索引
        builder.HasIndex(o => o.OrderNo).IsUnique();
    }
}

然后，让框架自动扫描，

public class AdvancedDbContext : DbContext
{
    public DbSet<Order> Orders { get; set; }

    protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
    {
        optionsBuilder.UseSqlite("Data Source=advanced.db");
    }

    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        base.OnModelCreating(modelBuilder);

        // 💡 核心：自动扫描当前程序集中所有实现了 IEntityTypeConfiguration 接口的类并应用
        modelBuilder.ApplyConfigurationsFromAssembly(typeof(AdvancedDbContext).Assembly);
    }
}

生成数据库常见命令

nuget安装，Microsoft.EntityFrameworkCore.Tools，打开PMC

命令	作用	什么时候用
Add-Migration <名称>	生成迁移脚本（暂存区）	当你修改了实体类或 Fluent API 配置时
Update-Database	将所有未应用的迁移推送到数据库	想让数据库结构与代码同步时
Remove-Migration	撤销最后一次生成的迁移脚本	Add-Migration 完发现代码写错了，且还没 Update-Database 时
Update-Database <以前的迁移名>	数据库结构版本回滚	发现刚上线的版本有严重问题，想把数据库退回到历史某个状态时
Script-Migration	将所有迁移直接打包成一个纯 .sql 文件	生产环境禁忌直接运行 Update-Database。应该用这个命令生成 SQL 脚本，交给 DBA 审核后再去生产环境执行。