基于 abp vNext 和 .NET Core 开发博客项目 - 数据访问和代码优先
基于 abp vNext 和 .NET Core 開發博客項目 - 數據訪問和代碼優先
轉載于：https://github.com/Meowv/Blog
本篇主要使用Entity Framework Core完成對數據庫的訪問，以及使用Code-First的方式進行數據遷移，自動創建表結構。
數據訪問
在.EntityFrameworkCore項目中添加我們的數據訪問上下文對象MeowvBlogDbContext，繼承自 AbpDbContext。然后重寫OnModelCreating方法。
OnModelCreating：定義EF Core 實體映射。先調用 base.OnModelCreating 讓 abp 框架為我們實現基礎映射，然后調用builder.Configure()擴展方法來配置應用程序的實體。當然也可以不用擴展，直接寫在里面，這樣一大坨顯得不好看而已。
在abp框架中，可以使用 [ConnectionStringName] Attribute 為我們的DbContext配置連接字符串名稱。先加上，然后再在appsettings.json中進行配置，因為之前集成了多個數據庫，所以這里我們也配置多個連接字符串，與之對應。
本項目默認采用MySql，你可以選擇任意你喜歡的。
//MeowvBlogDbContext.cs
using Microsoft.EntityFrameworkCore;
using Volo.Abp.Data;
using Volo.Abp.EntityFrameworkCore;
namespace Meowv.Blog.EntityFrameworkCore
{
[ConnectionStringName(“MySql”)]
public class MeowvBlogDbContext : AbpDbContext
{
public MeowvBlogDbContext(DbContextOptions options) : base(options)
{
}
}
//appsettings.json
{
“ConnectionStrings”: {
“Enable”: “MySQL”,
“MySql”: “Server=localhost;User Id=root;Password=123456;Database=meowv_blog_tutorial”,
“SqlServer”: “”,
“PostgreSql”: “”,
“Sqlite”: “”
}
}
然后新建我們的擴展類MeowvBlogDbContextModelCreatingExtensions.cs和擴展方法Configure()。注意，擴展方法是靜態的，需加static
//MeowvBlogDbContextModelCreatingExtensions.cs
using Microsoft.EntityFrameworkCore;
using Volo.Abp;
namespace Meowv.Blog.EntityFrameworkCore
{
public static class MeowvBlogDbContextModelCreatingExtensions
{
public static void Configure(this ModelBuilder builder)
{
Check.NotNull(builder, nameof(builder));
…
}
}
}
完成上述操作后在我們的模塊類MeowvBlogFrameworkCoreModule中將DbContext注冊到依賴注入，根據你配置的值使用不同的數據庫。在.Domain層創建配置文件訪問類AppSettings.cs
//AppSettings.cs
using Microsoft.Extensions.Configuration;
using System.IO;
namespace Meowv.Blog.Domain.Configurations
{
///
/// appsettings.json配置文件數據讀取類
///
public class AppSettings
{
///
/// 配置文件的根節點
///
private static readonly IConfigurationRoot _config;
}
獲取配置文件內容比較容易，代碼中有注釋也很容易理解。
值得一提的是，ABP會自動為DbContext中的實體創建默認倉儲. 需要在注冊的時使用options添加AddDefaultRepositories()。
默認情況下為每個實體創建一個倉儲，如果想要為其他實體也創建倉儲，可以將 includeAllEntities 設置為 true，然后就可以在服務中注入和使用 IRepository 或 IQueryableRepository
//MeowvBlogFrameworkCoreModule.cs
using Meowv.Blog.Domain;
using Meowv.Blog.Domain.Configurations;
using Microsoft.Extensions.DependencyInjection;
using Volo.Abp.EntityFrameworkCore;
using Volo.Abp.EntityFrameworkCore.MySQL;
using Volo.Abp.EntityFrameworkCore.PostgreSql;
using Volo.Abp.EntityFrameworkCore.Sqlite;
using Volo.Abp.EntityFrameworkCore.SqlServer;
using Volo.Abp.Modularity;
namespace Meowv.Blog.EntityFrameworkCore
{
[DependsOn(
typeof(MeowvBlogDomainModule),
typeof(AbpEntityFrameworkCoreModule),
typeof(AbpEntityFrameworkCoreMySQLModule),
typeof(AbpEntityFrameworkCoreSqlServerModule),
typeof(AbpEntityFrameworkCorePostgreSqlModule),
typeof(AbpEntityFrameworkCoreSqliteModule)
)]
public class MeowvBlogFrameworkCoreModule : AbpModule
{
public override void ConfigureServices(ServiceConfigurationContext context)
{
context.Services.AddAbpDbContext(options =>
{
options.AddDefaultRepositories(includeAllEntities: true);
});
}
現在可以來初步設計博客所需表為：發表文章表(posts)、分類表(categories)、標簽表(tags)、文章對應標簽表(post_tags)、友情鏈接表(friendlinks)
在.Domain層編寫實體類，Post.cs、Category.cs、Tag.cs、PostTag.cs、FriendLink.cs。把主鍵設置為int型，直接繼承Entity。關于這點可以參考ABP文檔，https://docs.abp.io/zh-Hans/abp/latest/Entities
//Post.cs
using System;
using Volo.Abp.Domain.Entities;
namespace Meowv.Blog.Domain.Blog
{
///
/// Post
///
public class Post : Entity
{
///
/// 標題
///
public string Title { get; set; }
}
//Category.cs
using Volo.Abp.Domain.Entities;
namespace Meowv.Blog.Domain.Blog
{
///
/// Category
///
public class Category : Entity
{
///
/// 分類名稱
///
public string CategoryName { get; set; }
}
//Tag.cs
using Volo.Abp.Domain.Entities;
namespace Meowv.Blog.Domain.Blog
{
///
/// Tag
///
public class Tag : Entity
{
///
/// 標簽名稱
///
public string TagName { get; set; }
}
//PostTag.cs
using Volo.Abp.Domain.Entities;
namespace Meowv.Blog.Domain.Blog
{
///
/// PostTag
///
public class PostTag : Entity
{
///
/// 文章Id
///
public int PostId { get; set; }
}
//FriendLink.cs
using Volo.Abp.Domain.Entities;
namespace Meowv.Blog.Domain.Blog
{
///
/// FriendLink
///
public class FriendLink : Entity
{
///
/// 標題
///
public string Title { get; set; }
}
創建好實體類后，在MeowvBlogDbContext添加DbSet屬性
//MeowvBlogDbContext.cs
…
[ConnectionStringName(“MySql”)]
public class MeowvBlogDbContext : AbpDbContext
{
public DbSet Posts { get; set; }
…
在.Domain.Shared層添加全局常量類MeowvBlogConsts.cs和表名常量類MeowvBlogDbConsts.cs，搞一個表前綴的常量，我這里寫的是meowv_，大家可以隨意。代表我們的表名都將以meowv_開頭。然后在MeowvBlogDbConsts中將表名稱定義好。
//MeowvBlogConsts.cs
namespace Meowv.Blog.Domain.Shared
{
///
/// 全局常量
///
public class MeowvBlogConsts
{
///
/// 數據庫表前綴
///
public const string DbTablePrefix = “meowv_”;
}
}
//MeowvBlogDbConsts.cs
namespace Meowv.Blog.Domain.Shared
{
public class MeowvBlogDbConsts
{
public static class DbTableName
{
public const string Posts = “Posts”;
}
在Configure()方法中配置表模型，包括表名、字段類型和長度等信息。對于下面代碼不是很明白的可以看看微軟的自定義 Code First 約定：https://docs.microsoft.com/zh-cn/ef/ef6/modeling/code-first/conventions/custom
//MeowvBlogDbContextModelCreatingExtensions.cs
using Meowv.Blog.Domain.Blog;
using Meowv.Blog.Domain.Shared;
using Microsoft.EntityFrameworkCore;
using Volo.Abp;
using static Meowv.Blog.Domain.Shared.MeowvBlogDbConsts;
namespace Meowv.Blog.EntityFrameworkCore
{
public static class MeowvBlogDbContextModelCreatingExtensions
{
public static void Configure(this ModelBuilder builder)
{
Check.NotNull(builder, nameof(builder));
}
此時項目層級目錄如下
圖片
代碼優先
在.EntityFrameworkCore.DbMigrations中新建模塊類MeowvBlogEntityFrameworkCoreDbMigrationsModule.cs、數據遷移上下文訪問對象MeowvBlogMigrationsDbContext.cs和一個Design Time Db Factory類MeowvBlogMigrationsDbContextFactory.cs
模塊類依賴MeowvBlogFrameworkCoreModule模塊和AbpModule。并在ConfigureServices方法中添加上下文的依賴注入。
//MeowvBlogEntityFrameworkCoreDbMigrationsModule.cs
using Microsoft.Extensions.DependencyInjection;
using Volo.Abp.Modularity;
namespace Meowv.Blog.EntityFrameworkCore.DbMigrations.EntityFrameworkCore
{
[DependsOn(
typeof(MeowvBlogFrameworkCoreModule)
)]
public class MeowvBlogEntityFrameworkCoreDbMigrationsModule : AbpModule
{
public override void ConfigureServices(ServiceConfigurationContext context)
{
context.Services.AddAbpDbContext();
}
}
}
MeowvBlogMigrationsDbContext和MeowvBlogDbContext沒什么大的區別
//MeowvBlogMigrationsDbContext.cs
using Microsoft.EntityFrameworkCore;
using Volo.Abp.EntityFrameworkCore;
namespace Meowv.Blog.EntityFrameworkCore.DbMigrations.EntityFrameworkCore
{
public class MeowvBlogMigrationsDbContext : AbpDbContext
{
public MeowvBlogMigrationsDbContext(DbContextOptions options) : base(options)
{
}
MeowvBlogMigrationsDbContextFactory類主要是用來使用Code-First命令的(Add-Migration 和 Update-Database …)
需要注意的地方，我們在這里要單獨設置配置文件的連接字符串，將.HttpApi.Hosting層的appsettings.json復制一份到.EntityFrameworkCore.DbMigrations，你用了什么數據庫就配置什么數據庫的連接字符串。
//appsettings.json
{
“ConnectionStrings”: {
“Default”: “Server=localhost;User Id=root;Password=123456;Database=meowv_blog”
}
}
//MeowvBlogMigrationsDbContextFactory.cs
using Microsoft.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore.Design;
using Microsoft.Extensions.Configuration;
using System.IO;
namespace Meowv.Blog.EntityFrameworkCore.DbMigrations.EntityFrameworkCore
{
public class MeowvBlogMigrationsDbContextFactory : IDesignTimeDbContextFactory
{
public MeowvBlogMigrationsDbContext CreateDbContext(string[] args)
{
var configuration = BuildConfiguration();
}
到這里差不多就結束了，默認數據庫meowv_blog_tutorial是不存在的，先去創建一個空的數據庫。
圖片
然后在Visual Studio中打開程序包管理控制臺，將.EntityFrameworkCore.DbMigrations設為啟動項目。
圖片
鍵入命令：Add-Migration Initial,會發現報錯啦，錯誤信息如下：
Add-Migration : 無法將“Add-Migration”項識別為 cmdlet、函數、腳本文件或可運行程序的名稱。請檢查名稱的拼寫，如果包括路徑，請確保路徑正確，然后再試一次。
所在位置 行:1 字符: 1
- Add-Migration Initial
- + CategoryInfo : ObjectNotFound: (Add-Migration:String) [], CommandNotFoundException+ FullyQualifiedErrorId : CommandNotFoundException
這是因為我們少添加了一個包，要使用代碼優先方式遷移數據，必須添加，Microsoft.EntityFrameworkCore.Tools。
緊接著直接用命令安裝Install-Package Microsoft.EntityFrameworkCore.Tools包，再試一遍
圖片
可以看到已經成功，并且生成了一個Migrations文件夾和對應的數據遷移文件。
最后輸入更新命令：Update-Database，然后打開數據瞅瞅。
圖片
完美，成功創建了數據庫表，而且命名也是我們想要的，字段類型也是ok的。__efmigrationshistory表是用來記錄遷移歷史的，這個可以不用管。當我們后續如果想要修改添加表字段，新增表的時候，都可以使用這種方式來完成。
解決方案層級目錄圖，供參考
圖片
本篇使用Entity Framework Core完成數據訪問和代碼優先的方式創建數據庫表，你學會了嗎？😁😁😁
開源地址：https://github.com/Meowv/Blog/tree/blog_tutorial
與50位技術專家面對面20年技術見證，附贈技術全景圖總結
以上是生活随笔為你收集整理的基于 abp vNext 和 .NET Core 开发博客项目 - 数据访问和代码优先的全部內容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： 基于 abp vNext 和 .NET
- 下一篇： 基于 abp vNext 和 .NET