.net5 core Razor项目实战系列之三：使用EntityFramework生成数据访问实体

EntityFramework是一种ORM框架，能够将数据库表的操作对应到实体上，

而不需要像传统的ADO.NET那样用Connection、Command、DataReader、DataSet等对象结合SQL去操作数据库，

一个实体就是一个c#类，只不过这个类比较特殊，只有属性，没有方法。

下面我们就用EntityFrameworkCore（对应.net core）来进行数据库操作，以便后续在完成页面功能的时候使用。

 

第一步：使用NuGet包管理器在项目中引入EntityFrameworkCore.Tools

引用这个包的作用是使用"Scaffold-DbContext"命令自动生成实体类，后面会介绍具体怎么使用。

 

第二步：使用NuGet包管理器在项目中引入 Pomelo.EntityFrameworkCore.MySql

这个包是来处理MySql数据库的，如果是使用的SQL Server数据库，则要换成引入 Microsoft.EntityFrameworkCore.SqlServer 包，这是微软官方提供的。

 

第三步：在程序包管理器控制台中执行“Scaffold-DbContext”命令来生成实体。

生成实体前的目录结构是这样的：

打开程序包管理控制台：

在控制台窗口中输入命令 Scaffold-DbContext "server=127.0.0.1;database=auth_manage;port=3306;user=root;password=1234;

Character Set=utf8mb4" Pomelo.EntityFrameworkCore.MySql -OutputDir DbUtil/Entity 并按Enter键：

Scaffold-DbContext命令中各参数含义如下：

（1）"server=127.0.0.1;database=auth_manage;port=3306;user=root;password=1234;Character Set=utf8mb4" 是数据库连接字符串。

（2）Pomelo.EntityFrameworkCore.MySql是目标数据库对应EF操作包。

（3）-OutputDir DbUtil/Entity 是将生成的实体输出到DbUtil文件夹下的 Entity文件夹，如果文件夹不存在会自动创建。

执行完毕后解决方案目录下生成了对应的实体类，如下：

任意点开一个实体类文件，如TAuth.cs，其代码如下：

using System;
using System.Collections.Generic;

#nullable disable

namespace AuthManagement.DbUtil.Entity
{
    public partial class TAuth
    {
        public int AuthId { get; set; }
        public short TargetType { get; set; }
        public int TargetId { get; set; }
        public string FuncCode { get; set; }
        public DateTime CreateTime { get; set; }
        public DateTime? ModifyTime { get; set; }
    }
}

和我们在数据库中定义的表一致。

接下来，我们对这些类做适当的改进，以满足我们项目的要求。

（1）改造auth_manageContext类，将其命名为 AuthDbContext 以符合c#的命名规则，如下图：

（2）对每个实体类增加 [Serializable] 特性以便序列化后写入t_log表，如下红色标识：

using System;
using System.Collections.Generic;

#nullable disable

namespace AuthManagement.DbUtil.Entity
{
    [Serializable]
    public partial class TAuth
    {
        public int AuthId { get; set; }
        public short TargetType { get; set; }
        public int TargetId { get; set; }
        public string FuncCode { get; set; }
        public DateTime CreateTime { get; set; }
        public DateTime? ModifyTime { get; set; }
    }
}

 

最后一步：对 AuthDbContext 做依赖注入的配置。

因为用 AuthDbContext 对数据库做增删改查时需要实例化 AuthDbContext context = new AuthDbContext()，

我们可以在 xxx.cshtml.cs 文件中实例化，但在.net core中更好的解决方法是在 Startup.cs 中进行依赖注入，代码如下：

public void ConfigureServices(IServiceCollection services)
{
    services.AddRazorPages();

    //for SQL Server
    //services.AddDbContext<AuthDbContext>(options => options.UseSqlServer(Configuration.GetConnectionString("MySql")));

    //for MySql
    services.AddDbContext<AuthDbContext>(options => options.UseMySql(
                Configuration.GetConnectionString("MySql"),ServerVersion.AutoDetect(Configuration.GetConnectionString("MySql"))));
}

上面用到了数据库连接，所以还要在appsettings.json中配置连接字符串，代码如下：

  "ConnectionStrings": {
    "MySql": "server=127.0.0.1;database=auth_manage;port=3306;user=root;password=1234;Character Set=utf8mb4"
  },

至此，数据库的访问就配置完成了，要了解EF Core更详细的用法，可以访问微软官网：

https://docs.microsoft.com/zh-cn/ef/core/