雷达智富

首页 > 内容 > 程序笔记 > 正文

程序笔记

ASP.NET 使用Entity Framework (EF) 创建迁移修改SQLite数据库表结构

2024-12-06 19

在 ASP.NET 中,使用 Entity Framework (EF) 创建并连接 SQLite 数据库是一种轻量级、高效的数据库管理方式。以下是详细步骤:

安装必要的 NuGet 包

安装EntityFrameworkCore.Sqlite包:

Install-Package Microsoft.EntityFrameworkCore.Sqlite
Install-Package Microsoft.EntityFrameworkCore.Tools

如果需要使用迁移命令,还需要安装 dotnet-ef 工具(对于 CLI 用户):

dotnet tool install --global dotnet-ef

数据库迁移一定是要的,除非你创建完数据库表不会再变动了,如果要修改SQLite数据库表结构就需要迁移工具。使用迁移工具时需要注意路径,所以下面以站点和Models类库举例说明。

创建实体模型

以ASP.NET网站连接SQLite为例,我先创建一个网站MyWebApplication,然后创建一个类库MyWebApplication.Models。

在MyWebApplication.Models类库里创建一个用于表示数据库表的模型类。例如,一个简单的 Product 实体:

public class Product
{
    public int Id { get; set; }
    public string Name { get; set; }
    public decimal Price { get; set; }
}

创建数据库上下文类,定义一个继承自 DbContext 的类,用于管理实体和数据库之间的交互。这里重写OnConfiguring方法,设置.db文件所在位置。

注意,可以在program.cs里注入的方式配置数据库连接地址,但是在执行迁移命令时,必须在OnConfiguring里指定文件路径,否则执行命令会报错。

如果我们想把SQLite数据库文件放在网站根目录,那么路径可以像下面那样配置,这样迁移更新的时候会更新配置路径所在的.db文件。

using Microsoft.EntityFrameworkCore;

public class AppDbContext : DbContext
{
    public DbSet<Product> Products { get; set; }

    protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
    {
        // 使用 SQLite 数据库,指定数据库文件路径
        optionsBuilder.UseSqlite("Data Source=../MyWebApplication/MyWebApplication.db");
    }
}

EnsureCreated 创建数据库(不推荐)

在使用 Entity Framework (EF) 和 SQLite 时,EnsureCreated 方法的作用是检查数据库是否存在,如果不存在则创建数据库和表。它是一个简单的方式来快速生成数据库,但它不会管理数据库迁移,也不适合生产环境。

using (var context = new AppDbContext())
{
    context.Database.EnsureCreated();
}

以上代码会检查数据库是否存在,如果不存在就会创建.db数据库,但是不支持迁移,不能修改数据库表结构,只适用于简单场景。建议使用数据库迁移的方式创建数据库。

设置 EF 数据库迁移

添加迁移: 在Models项目目录下运行以下命令,生成初始迁移文件:

dotnet ef migrations add InitialCreate

// 或者带上自定义参数
// dotnet ef migrations add InitialCreate --context AppDbContext --output-dir Migrations/SqliteMigrations

这个命令会自动在Models文件夹下创建一个Migrations文件夹和两个.cs文件。

然后应用迁移,生成数据库: 执行迁移,将数据库架构应用到 SQLite 文件:

dotnet ef database update

执行update命令后,会根据AppDbContext里设置的数据库路径生成数据库.db文件。

在 ASP.NET 项目中注册DBContext服务

在Program.cs 中配置依赖注入,确保在 ASP.NET 项目中可以使用 AppDbContext:

builder.Services.AddDbContext<AppDbContext>(options =>
            options.UseSqlite("Data Source=MyWebApplication.db"));

这时候,可以修改AppDbContext.cs里,使用配置的连接地址,去掉写死的数据库路径了。

public AppDbContext(DbContextOptions<AppDbContext> options)
    : base(options)
{
}
//protected override void OnConfiguring(DbContextOptionsBuilder options)
//=> options.UseSqlite("Data Source=../MyWebApplication/MyWebApplication.db");

public DbSet<Product> Products { get; set; } = null!;

增删改查等用法就是EF的标准用法, 不需要多说了,下面的代码演示了往Product表里插入了一条数据。

private readonly ILogger<HomeController> _logger;
private readonly AppDbContext _context;

public HomeController(ILogger<HomeController> logger, AppDbContext context)
{
    _logger = logger;
    _context = context;
}

public IActionResult Index()
{
    _context.Products.Add(new Product() { Name = "xx" });
    _context.SaveChanges();
    var products = _context.Products.ToList();
    return View();
}

修改SQLite数据库表结构

假如,我现在要删除Product表的字段Description。先修改Product.cs模型类,把Description属性去掉。然后在Models目录下执行如下命令:

dotnet ef migrations add RemoveDescriptionToProduct

其中RemoveDescriptionToProduct这个名字可以自己定义。

如果报错:Unable to create an object of type 'AppDbContext'. For the different patterns supported at design time, see https://go.microsoft.com/fwlink/?linkid=851728

那么需要修改一下AppDbContext.cs,在OnConfiguring里指定数据库路径,等执行完迁移修改命令可以再改回来:

    public class AppDbContext : DbContext
    {
        //public AppDbContext(DbContextOptions<AppDbContext> options)
        //    : base(options)
        //{
        //}
        protected override void OnConfiguring(DbContextOptionsBuilder options)
        => options.UseSqlite("Data Source=../MyWebApplication/MyWebApplication.db");

        public DbSet<Product> Products { get; set; } = null!;

    }

执行成功后,在Migrations文件夹下会多出一个20241205050341_RemoveDescriptionToProduct.cs类,这里包含了此次表结构的修改。

public partial class RemoveDescriptionToProduct : Migration
{
    protected override void Up(MigrationBuilder migrationBuilder)
    {
        migrationBuilder.DropColumn(
            name: "Description",
            table: "Products");
    }

    protected override void Down(MigrationBuilder migrationBuilder)
    {
        migrationBuilder.AddColumn<string>(
            name: "Description",
            table: "Products",
            type: "TEXT",
            nullable: true);
    }
}

然后执行update命令就会把修改更新到.db文件。

dotnet ef database update

这样SQLite数据库表结构就更新好了,记得把AppDbContext.cs里数据库连接字符串的地方再改回注入的方式配置就行了。

更新于:12天前
赞一波!2

文章评论

评论问答