基于 abp vNext 和 .NET Core 開發(fā)博客項(xiàng)目 - 數(shù)據(jù)訪問和代碼優(yōu)先

轉(zhuǎn)載于：https://github.com/Meowv/Blog

本篇主要使用Entity Framework Core完成對(duì)數(shù)據(jù)庫(kù)的訪問，以及使用Code-First的方式進(jìn)行數(shù)據(jù)遷移，自動(dòng)創(chuàng)建表結(jié)構(gòu)。

數(shù)據(jù)訪問

在.EntityFrameworkCore項(xiàng)目中添加我們的數(shù)據(jù)訪問上下文對(duì)象MeowvBlogDbContext，繼承自 AbpDbContext。然后重寫OnModelCreating方法。

OnModelCreating：定義EF Core 實(shí)體映射。先調(diào)用 base.OnModelCreating 讓 abp 框架為我們實(shí)現(xiàn)基礎(chǔ)映射，然后調(diào)用builder.Configure()擴(kuò)展方法來配置應(yīng)用程序的實(shí)體。當(dāng)然也可以不用擴(kuò)展，直接寫在里面，這樣一大坨顯得不好看而已。

在abp框架中，可以使用 [ConnectionStringName] Attribute 為我們的DbContext配置連接字符串名稱。先加上，然后再在appsettings.json中進(jìn)行配置，因?yàn)橹凹闪硕鄠€(gè)數(shù)據(jù)庫(kù)，所以這里我們也配置多個(gè)連接字符串，與之對(duì)應(yīng)。

本項(xiàng)目默認(rèn)采用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)
{
}

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

}

//appsettings.json
{
“ConnectionStrings”: {
“Enable”: “MySQL”,
“MySql”: “Server=localhost;User Id=root;Password=123456;Database=meowv_blog_tutorial”,
“SqlServer”: “”,
“PostgreSql”: “”,
“Sqlite”: “”
}
}

然后新建我們的擴(kuò)展類MeowvBlogDbContextModelCreatingExtensions.cs和擴(kuò)展方法Configure()。注意，擴(kuò)展方法是靜態(tài)的，需加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注冊(cè)到依賴注入，根據(jù)你配置的值使用不同的數(shù)據(jù)庫(kù)。在.Domain層創(chuàng)建配置文件訪問類AppSettings.cs

//AppSettings.cs
using Microsoft.Extensions.Configuration;
using System.IO;

namespace Meowv.Blog.Domain.Configurations
{
///
/// appsettings.json配置文件數(shù)據(jù)讀取類
///
public class AppSettings
{
///
/// 配置文件的根節(jié)點(diǎn)
///
private static readonly IConfigurationRoot _config;

/// <summary>/// Constructor/// </summary>static AppSettings(){// 加載appsettings.json，并構(gòu)建IConfigurationRootvar builder = new ConfigurationBuilder().SetBasePath(Directory.GetCurrentDirectory()).AddJsonFile("appsettings.json", true, true);_config = builder.Build();}/// <summary>/// EnableDb/// </summary>public static string EnableDb => _config["ConnectionStrings:Enable"];/// <summary>/// ConnectionStrings/// </summary>public static string ConnectionStrings => _config.GetConnectionString(EnableDb); }

}

獲取配置文件內(nèi)容比較容易，代碼中有注釋也很容易理解。

值得一提的是，ABP會(huì)自動(dòng)為DbContext中的實(shí)體創(chuàng)建默認(rèn)倉(cāng)儲(chǔ). 需要在注冊(cè)的時(shí)使用options添加AddDefaultRepositories()。

默認(rèn)情況下為每個(gè)實(shí)體創(chuàng)建一個(gè)倉(cāng)儲(chǔ)，如果想要為其他實(shí)體也創(chuàng)建倉(cāng)儲(chǔ)，可以將 includeAllEntities 設(shè)置為 true，然后就可以在服務(wù)中注入和使用 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);
});

Configure<AbpDbContextOptions>(options =>{switch (AppSettings.EnableDb){case "MySQL":options.UseMySQL();break;case "SqlServer":options.UseSqlServer();break;case "PostgreSql":options.UsePostgreSql();break;case "Sqlite":options.UseSqlite();break;default:options.UseMySQL();break;}});} }

}

現(xiàn)在可以來初步設(shè)計(jì)博客所需表為：發(fā)表文章表(posts)、分類表(categories)、標(biāo)簽表(tags)、文章對(duì)應(yīng)標(biāo)簽表(post_tags)、友情鏈接表(friendlinks)

在.Domain層編寫實(shí)體類，Post.cs、Category.cs、Tag.cs、PostTag.cs、FriendLink.cs。把主鍵設(shè)置為int型，直接繼承Entity。關(guān)于這點(diǎn)可以參考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
{
///
/// 標(biāo)題
///
public string Title { get; set; }

/// <summary>/// 作者/// </summary>public string Author { get; set; }/// <summary>/// 鏈接/// </summary>public string Url { get; set; }/// <summary>/// HTML/// </summary>public string Html { get; set; }/// <summary>/// Markdown/// </summary>public string Markdown { get; set; }/// <summary>/// 分類Id/// </summary>public int CategoryId { get; set; }/// <summary>/// 創(chuàng)建時(shí)間/// </summary>public DateTime CreationTime { get; set; } }

}

//Category.cs
using Volo.Abp.Domain.Entities;

namespace Meowv.Blog.Domain.Blog
{
///
/// Category
///
public class Category : Entity
{
///
/// 分類名稱
///
public string CategoryName { get; set; }

/// <summary>/// 展示名稱/// </summary>public string DisplayName { get; set; } }

}

//Tag.cs
using Volo.Abp.Domain.Entities;

namespace Meowv.Blog.Domain.Blog
{
///
/// Tag
///
public class Tag : Entity
{
///
/// 標(biāo)簽名稱
///
public string TagName { get; set; }

/// <summary>/// 展示名稱/// </summary>public string DisplayName { 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; }

/// <summary>/// 標(biāo)簽Id/// </summary>public int TagId { get; set; } }

}

//FriendLink.cs
using Volo.Abp.Domain.Entities;

namespace Meowv.Blog.Domain.Blog
{
///
/// FriendLink
///
public class FriendLink : Entity
{
///
/// 標(biāo)題
///
public string Title { get; set; }

/// <summary>/// 鏈接/// </summary>public string LinkUrl { get; set; } }

}

創(chuàng)建好實(shí)體類后，在MeowvBlogDbContext添加DbSet屬性

//MeowvBlogDbContext.cs
…
[ConnectionStringName(“MySql”)]
public class MeowvBlogDbContext : AbpDbContext
{
public DbSet Posts { get; set; }

public DbSet<Category> Categories { get; set; }public DbSet<Tag> Tags { get; set; }public DbSet<PostTag> PostTags { get; set; }public DbSet<FriendLink> FriendLinks { get; set; }... }

…

在.Domain.Shared層添加全局常量類MeowvBlogConsts.cs和表名常量類MeowvBlogDbConsts.cs，搞一個(gè)表前綴的常量，我這里寫的是meowv_，大家可以隨意。代表我們的表名都將以meowv_開頭。然后在MeowvBlogDbConsts中將表名稱定義好。

//MeowvBlogConsts.cs
namespace Meowv.Blog.Domain.Shared
{
///
/// 全局常量
///
public class MeowvBlogConsts
{
///
/// 數(shù)據(jù)庫(kù)表前綴
///
public const string DbTablePrefix = “meowv_”;
}
}

//MeowvBlogDbConsts.cs
namespace Meowv.Blog.Domain.Shared
{
public class MeowvBlogDbConsts
{
public static class DbTableName
{
public const string Posts = “Posts”;

public const string Categories = "Categories";public const string Tags = "Tags";public const string PostTags = "Post_Tags";public const string Friendlinks = "Friendlinks";} }

}

在Configure()方法中配置表模型，包括表名、字段類型和長(zhǎng)度等信息。對(duì)于下面代碼不是很明白的可以看看微軟的自定義 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));

builder.Entity<Post>(b =>{b.ToTable(MeowvBlogConsts.DbTablePrefix + DbTableName.Posts);b.HasKey(x => x.Id);b.Property(x => x.Title).HasMaxLength(200).IsRequired();b.Property(x => x.Author).HasMaxLength(10);b.Property(x => x.Url).HasMaxLength(100).IsRequired();b.Property(x => x.Html).HasColumnType("longtext").IsRequired();b.Property(x => x.Markdown).HasColumnType("longtext").IsRequired();b.Property(x => x.CategoryId).HasColumnType("int");b.Property(x => x.CreationTime).HasColumnType("datetime");});builder.Entity<Category>(b =>{b.ToTable(MeowvBlogConsts.DbTablePrefix + DbTableName.Categories);b.HasKey(x => x.Id);b.Property(x => x.CategoryName).HasMaxLength(50).IsRequired();b.Property(x => x.DisplayName).HasMaxLength(50).IsRequired();});builder.Entity<Tag>(b =>{b.ToTable(MeowvBlogConsts.DbTablePrefix + DbTableName.Tags);b.HasKey(x => x.Id);b.Property(x => x.TagName).HasMaxLength(50).IsRequired();b.Property(x => x.DisplayName).HasMaxLength(50).IsRequired();});builder.Entity<PostTag>(b =>{b.ToTable(MeowvBlogConsts.DbTablePrefix + DbTableName.PostTags);b.HasKey(x => x.Id);b.Property(x => x.PostId).HasColumnType("int").IsRequired();b.Property(x => x.TagId).HasColumnType("int").IsRequired();});builder.Entity<FriendLink>(b =>{b.ToTable(MeowvBlogConsts.DbTablePrefix + DbTableName.Friendlinks);b.HasKey(x => x.Id);b.Property(x => x.Title).HasMaxLength(20).IsRequired();b.Property(x => x.LinkUrl).HasMaxLength(100).IsRequired();});} }

}

此時(shí)項(xiàng)目層級(jí)目錄如下

圖片

代碼優(yōu)先

在.EntityFrameworkCore.DbMigrations中新建模塊類MeowvBlogEntityFrameworkCoreDbMigrationsModule.cs、數(shù)據(jù)遷移上下文訪問對(duì)象MeowvBlogMigrationsDbContext.cs和一個(gè)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沒什么大的區(qū)別

//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)
{

}protected override void OnModelCreating(ModelBuilder builder){base.OnModelCreating(builder);builder.Configure();} }

}
MeowvBlogMigrationsDbContextFactory類主要是用來使用Code-First命令的(Add-Migration 和 Update-Database …)

需要注意的地方，我們?cè)谶@里要單獨(dú)設(shè)置配置文件的連接字符串，將.HttpApi.Hosting層的appsettings.json復(fù)制一份到.EntityFrameworkCore.DbMigrations，你用了什么數(shù)據(jù)庫(kù)就配置什么數(shù)據(jù)庫(kù)的連接字符串。

//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();

var builder = new DbContextOptionsBuilder<MeowvBlogMigrationsDbContext>().UseMySql(configuration.GetConnectionString("Default"));return new MeowvBlogMigrationsDbContext(builder.Options);}private static IConfigurationRoot BuildConfiguration(){var builder = new ConfigurationBuilder().SetBasePath(Directory.GetCurrentDirectory()).AddJsonFile("appsettings.json", optional: true, reloadOnChange: true);return builder.Build();} }

}
到這里差不多就結(jié)束了，默認(rèn)數(shù)據(jù)庫(kù)meowv_blog_tutorial是不存在的，先去創(chuàng)建一個(gè)空的數(shù)據(jù)庫(kù)。

圖片

然后在Visual Studio中打開程序包管理控制臺(tái)，將.EntityFrameworkCore.DbMigrations設(shè)為啟動(dòng)項(xiàng)目。

圖片

鍵入命令：Add-Migration Initial,會(huì)發(fā)現(xiàn)報(bào)錯(cuò)啦，錯(cuò)誤信息如下：

Add-Migration : 無(wú)法將“Add-Migration”項(xiàng)識(shí)別為 cmdlet、函數(shù)、腳本文件或可運(yùn)行程序的名稱。請(qǐng)檢查名稱的拼寫，如果包括路徑，請(qǐng)確保路徑正確，然后再試一次。
所在位置 行:1 字符: 1

• Add-Migration Initial
• + CategoryInfo : ObjectNotFound: (Add-Migration:String) [], CommandNotFoundException+ FullyQualifiedErrorId : CommandNotFoundException

這是因?yàn)槲覀兩偬砑恿艘粋€(gè)包，要使用代碼優(yōu)先方式遷移數(shù)據(jù)，必須添加，Microsoft.EntityFrameworkCore.Tools。

緊接著直接用命令安裝Install-Package Microsoft.EntityFrameworkCore.Tools包，再試一遍

圖片

可以看到已經(jīng)成功，并且生成了一個(gè)Migrations文件夾和對(duì)應(yīng)的數(shù)據(jù)遷移文件。

最后輸入更新命令：Update-Database，然后打開數(shù)據(jù)瞅瞅。

圖片

完美，成功創(chuàng)建了數(shù)據(jù)庫(kù)表，而且命名也是我們想要的，字段類型也是ok的。__efmigrationshistory表是用來記錄遷移歷史的，這個(gè)可以不用管。當(dāng)我們后續(xù)如果想要修改添加表字段，新增表的時(shí)候，都可以使用這種方式來完成。

解決方案層級(jí)目錄圖，供參考

圖片

本篇使用Entity Framework Core完成數(shù)據(jù)訪問和代碼優(yōu)先的方式創(chuàng)建數(shù)據(jù)庫(kù)表，你學(xué)會(huì)了嗎？😁😁😁

開源地址：https://github.com/Meowv/Blog/tree/blog_tutorial

與50位技術(shù)專家面對(duì)面20年技術(shù)見證，附贈(zèng)技術(shù)全景圖

總結(jié)

以上是生活随笔為你收集整理的基于 abp vNext 和 .NET Core 开发博客项目 - 数据访问和代码优先的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。