基於 abp vNext 和 .NET Core 開發博客項目 - 數據訪問和代碼優先

上一篇文章(http://www.javashuo.com/article/p-cpfcpcrq-cv.html)完善了項目中的代碼,接入了Swagger。本篇主要使用Entity Framework Core完成對數據庫的訪問,以及使用Code-First的方式進行數據遷移,自動建立表結構。html

數據訪問

.EntityFrameworkCore項目中添加咱們的數據訪問上下文對象MeowvBlogDbContext,繼承自 AbpDbContext<T>。而後重寫OnModelCreating方法。git

OnModelCreating:定義EF Core 實體映射。先調用 base.OnModelCreating 讓 abp 框架爲咱們實現基礎映射,而後調用builder.Configure()擴展方法來配置應用程序的實體。固然也能夠不用擴展,直接寫在裏面,這樣一大坨顯得很差看而已。github

在abp框架中,可使用 [ConnectionStringName] Attribute 爲咱們的DbContext配置鏈接字符串名稱。先加上,而後再在appsettings.json中進行配置,由於以前集成了多個數據庫,因此這裏咱們也配置多個鏈接字符串,與之對應。數據庫

本項目默認採用MySql,你能夠選擇任意你喜歡的。json

//MeowvBlogDbContext.cs
using Microsoft.EntityFrameworkCore;
using Volo.Abp.Data;
using Volo.Abp.EntityFrameworkCore;

namespace Meowv.Blog.EntityFrameworkCore
{
    [ConnectionStringName("MySql")]
    public class MeowvBlogDbContext : AbpDbContext<MeowvBlogDbContext>
    {
        public MeowvBlogDbContext(DbContextOptions<MeowvBlogDbContext> 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": ""
  }
}

而後新建咱們的擴展類MeowvBlogDbContextModelCreatingExtensions.cs和擴展方法Configure()。注意,擴展方法是靜態的,需加staticapp

//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
{
    /// <summary>
    /// appsettings.json配置文件數據讀取類
    /// </summary>
    public class AppSettings
    {
        /// <summary>
        /// 配置文件的根節點
        /// </summary>
        private static readonly IConfigurationRoot _config;

        /// <summary>
        /// Constructor
        /// </summary>
        static AppSettings()
        {
            // 加載appsettings.json,並構建IConfigurationRoot
            var 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);
    }
}

獲取配置文件內容比較容易,代碼中有註釋也很容易理解。ide

值得一提的是,ABP會自動爲DbContext中的實體建立默認倉儲. 須要在註冊的時使用options添加AddDefaultRepositories()函數

默認狀況下爲每一個實體建立一個倉儲,若是想要爲其餘實體也建立倉儲,能夠將 includeAllEntities 設置爲 true,而後就能夠在服務中注入和使用 IRepository<TEntity>IQueryableRepository<TEntity>post

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

如今能夠來初步設計博客所需表爲:發表文章表(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
{
    /// <summary>
    /// Post
    /// </summary>
    public class Post : Entity<int>
    {
        /// <summary>
        /// 標題
        /// </summary>
        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>
        /// 建立時間
        /// </summary>
        public DateTime CreationTime { get; set; }
    }
}
//Category.cs
using Volo.Abp.Domain.Entities;

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

        /// <summary>
        /// 展現名稱
        /// </summary>
        public string DisplayName { get; set; }
    }
}
//Tag.cs
using Volo.Abp.Domain.Entities;

namespace Meowv.Blog.Domain.Blog
{
    /// <summary>
    /// Tag
    /// </summary>
    public class Tag : Entity<int>
    {
        /// <summary>
        /// 標籤名稱
        /// </summary>
        public string TagName { get; set; }

        /// <summary>
        /// 展現名稱
        /// </summary>
        public string DisplayName { get; set; }
    }
}
//PostTag.cs
using Volo.Abp.Domain.Entities;

namespace Meowv.Blog.Domain.Blog
{
    /// <summary>
    /// PostTag
    /// </summary>
    public class PostTag : Entity<int>
    {
        /// <summary>
        /// 文章Id
        /// </summary>
        public int PostId { get; set; }

        /// <summary>
        /// 標籤Id
        /// </summary>
        public int TagId { get; set; }
    }
}
//FriendLink.cs
using Volo.Abp.Domain.Entities;

namespace Meowv.Blog.Domain.Blog
{
    /// <summary>
    /// FriendLink
    /// </summary>
    public class FriendLink : Entity<int>
    {
        /// <summary>
        /// 標題
        /// </summary>
        public string Title { get; set; }

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

建立好實體類後,在MeowvBlogDbContext添加DbSet屬性

//MeowvBlogDbContext.cs
...
    [ConnectionStringName("MySql")]
    public class MeowvBlogDbContext : AbpDbContext<MeowvBlogDbContext>
    {
        public DbSet<Post> 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,搞一個表前綴的常量,我這裏寫的是meowv_,你們能夠隨意。表明咱們的表名都將以meowv_開頭。而後在MeowvBlogDbConsts中將表名稱定義好。

//MeowvBlogConsts.cs
namespace Meowv.Blog.Domain.Shared
{
    /// <summary>
    /// 全局常量
    /// </summary>
    public class MeowvBlogConsts
    {
        /// <summary>
        /// 數據庫表前綴
        /// </summary>
        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()方法中配置表模型,包括表名、字段類型和長度等信息。對於下面代碼不是很明白的能夠看看微軟的自定義 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();
            });
        }
    }
}

此時項目層級目錄以下

1

代碼優先

.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>();
        }
    }
}

MeowvBlogMigrationsDbContextMeowvBlogDbContext沒什麼大的區別

//MeowvBlogMigrationsDbContext.cs
using Microsoft.EntityFrameworkCore;
using Volo.Abp.EntityFrameworkCore;

namespace Meowv.Blog.EntityFrameworkCore.DbMigrations.EntityFrameworkCore
{
    public class MeowvBlogMigrationsDbContext : AbpDbContext<MeowvBlogMigrationsDbContext>
    {
        public MeowvBlogMigrationsDbContext(DbContextOptions<MeowvBlogMigrationsDbContext> options) : base(options)
        {

        }

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

            builder.Configure();
        }
    }
}

MeowvBlogMigrationsDbContextFactory類主要是用來使用Code-First命令的(Add-MigrationUpdate-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<MeowvBlogMigrationsDbContext>
    {
        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();
        }
    }
}

到這裏差很少就結束了,默認數據庫meowv_blog_tutorial是不存在的,先去建立一個空的數據庫。

2

而後在Visual Studio中打開程序包管理控制檯,將.EntityFrameworkCore.DbMigrations設爲啓動項目。

3

鍵入命令: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包,再試一遍

4

能夠看到已經成功,而且生成了一個Migrations文件夾和對應的數據遷移文件

最後輸入更新命令:Update-Database,而後打開數據瞅瞅。

5

完美,成功建立了數據庫表,並且命名也是咱們想要的,字段類型也是ok的。__efmigrationshistory表是用來記錄遷移歷史的,這個能夠不用管。當咱們後續若是想要修改添加表字段,新增表的時候,均可以使用這種方式來完成。

解決方案層級目錄圖,供參考

6

本篇使用Entity Framework Core完成數據訪問和代碼優先的方式建立數據庫表,你學會了嗎?😁😁😁

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

相關文章
相關標籤/搜索