当.NET Core类库中以EF Core迁移数据库暨SQL ServerSlickflow.NET 开源工作流引擎基础介绍(九) — .NET Core2.0 版本实现介绍。

by admin on 2018年10月5日

前言

假设大家正用EntityFramework
Core作为ORM框架的话,想必都见面遇上数据库迁移的有的问题。

起始我是以ASP.NET
Core的Web项目面临开展的,但新兴察觉放在此处并无是老合理,一些关于数据库的迁移,比如新增表,字段,修改字段类型等等,不该和最上层的Web项目所涉,数据的迁文件放到这里为深感有些多余,有硌乱乱之感觉到,所以才想在单身出来由特别的花色进展管理会比较好,也较清楚!

专注目标框架选择的是.NET Core 2.0而不是.NET
Standard 2.0。

前言:.NET Core 是.NET
Framework的初一代版本,是微软开支之率先个跨平台
(Windows、Mac
OSX、Linux)
的应用程序开发框架(Application
Framework),未来啊用会见支撑 FreeBSD 与 Alpine 平台。.Net
Core也是微软在相同起来向上时就是开源之软件平台,其付出目标是超过平台的 .NET
平台。

0、前期准备

a)、表实体定义,这个是于.NET
Standard 2.0底类库中存放的。

    /// <summary>
    /// 系统应用的用户实体
    /// </summary>
    public class ApplicationUser : BaseModel
    {
        /// <summary>
        /// 用户名
        /// </summary>
        public string UserName { get; set; }

        /// <summary>
        /// 密码
        /// </summary>
        public string Password { get; set; }

        /// <summary>
        /// 邮件地址
        /// </summary>
        public string Email { get; set; }
    }

b)、新建一个.NET Core
2.0底类库,并定义好我们所要动的数据库上下文,很简短,接下去开始我们的正文

    /// <summary>
    /// 系统上下文
    /// </summary>
    public class LightContext : DbContext
    {
        public LightContext(DbContextOptions<LightContext> options) : base(options)
        {
        }

        /// <summary>
        /// 系统应用用户
        /// </summary>
        public DbSet<ApplicationUser> ApplicationUser { get; set; }

        /// <summary>
        /// 角色表
        /// </summary>
        public DbSet<Role> Role { get; set; }
    }

.NET Core 平台的开支优势 :

1、问题集中

第一要包仓储类库中早就引入以下简单单Nuget包,没有的语请以包管理器进行设置。不建议直接引入原包:Microsoft.AspNetCore.All,按需要引入即可

Install-Package Microsoft.EntityFrameworkCore.SqlServer

Install-Package Microsoft.EntityFrameworkCore.Tools

a)打开CMD,然后切换至类库所在路径下,执行以下命令。不过你也可采取程序包管理器控制台(PMC)进行搬迁,但是会发一定量变化,部分令见下表:

迁移命令描述 CMD命令 PMC命令
创建迁移:migrationname为迁移名称 dotnet ef migrations add migrationname add-migration migrationname
移除迁移(删除最近的一次迁移) dotnet ef migrations remove remove-migration
应用最新的迁移(使迁移文件应用到数据库) dotnet ef database update update-database
应用指定的迁移 dotnet ef database update migrationname update-database migrationname
查看迁移列表 dotnet ef migrations list  
查看数据库上下文信息 dotnet ef dbcontext info  
dotnet ef

图片 1

左提示:

  未找到与命令“dotnet-ef”匹配的可执行文件

解决办法:

  以档次文件Light.Repository.csproj中补充加以下节点

<ItemGroup>
    <DotNetCliToolReference Include="Microsoft.EntityFrameworkCore.Tools.DotNet" Version="2.0.1" />
</ItemGroup>

再次履行方的下令,如果出现了EF
Core的标志(一头蓄势待发的野马)表示早已打响

图片 2

 b)、执行以下命令进行搬迁

dotnet ef migrations add InitLightDB

图片 3

不当提示:

The specified framework version ‘2.0’ could
not be parsed
The specified framework
‘Microsoft.NETCore.App’, version ‘2.0’ was not found.

  • Check application dependencies and
    target a framework version installed at:
    \
  • Alternatively, install the framework
    version ‘2.0’.

解决方式:

  于项目文件中上加以下节点:

  <PropertyGroup>
    <TargetFramework>netcoreapp2.0</TargetFramework>
    <RuntimeFrameworkVersion>2.0.3</RuntimeFrameworkVersion>
  </PropertyGroup>

c)、重新履行b步骤的一声令下,报错信息如下:

图片 4

错误提示:

  Unable to create an object of type
‘LightContext’. Add an implementation of
‘IDesignTimeDbContextFactory<LightContext>’ to the project, or see
https://go.microsoft.com/fwlink/?linkid=851728 for additional patterns
supported at design time.

斯题目如是以Web项目,并且配备了DbContext的链接字符串的话,是不会见产出这个问题之。很显眼是迁移命令没有找到DbConnectionString导致的,接下我们以提示,实现一个IDesignTimeDbContextFactory<LightContext>试试

釜底抽薪智:

  创建一个以及DbContext同一目录下的DesignTimeDbContextFactory文件,然后实现接口中的措施CreateDbContext,并布置ConnectionString

   public class DesignTimeDbContextFactory : IDesignTimeDbContextFactory<LightContext>
    {
        public LightContext CreateDbContext(string[] args)
        {
            var builder = new DbContextOptionsBuilder<LightContext>();
            builder.UseSqlServer("Server=(localdb)\\MSSQLLocalDB;Integrated Security=true;Initial Catalog=Light;");
            return new LightContext(builder.Options);
        }
    }

 再次实施迁移命令,终于成了。

图片 5

事业有成唤醒:

  Done. To undo this action, use ‘ef
migrations remove’

与此同时类库下面会生成Migrations文件夹和有关的迁文件

图片 6

  1. 支撑还是可移转 (port) 到又多的操作系统平台以及芯片架构
    (也尽管是未来种会越出 x86 平台)。
  2. 不无明确的性能与高可靠度。
  3. 开发人员能高效和直觉的取 .NET Core 开发条件。
  4. 于直觉和富有生产力的动静下建应用程序,使用文件,示例与 NuGet 组件。

2、小试迁移命令

a)、使用以下命令下迁移,生成数据库与阐发

dotnet ef database update

图片 7

经VS的SQL
Server资源管理器查看转数据库的布局,其中__EFMigrationsHistory为每次迁移的记录表

图片 8

b)、因为string类型的字段迁移到数据库后的数据类型为nvarchar(max)并且是只是空类型的,下面我们就是下Fluent
API对ApplicationUser表字段进展安排,同样你也可采取性质注解的艺术进行部署,因为自身好非爱好“污染”表实体

    public static void ConfigApplicationUser(ModelBuilder modelBuilder)
        {
            modelBuilder.Entity<ApplicationUser>(m =>
            {
                m.Property(t => t.Email)
                        .HasMaxLength(50);

                m.Property(t => t.UserName)
                        .IsRequired()
                        .HasMaxLength(50);

                m.Property(t => t.Password)
                        .IsRequired()
                        .HasMaxLength(20);
            });
        }

接下来同使用方面的有数久命令还搬并更新数据库结构

图片 9

察数据库表结构早已更新

图片 10

 同理添加字段,删除字段都是均等的迁操作,还是颇便宜的

上述文字引用来源:https://zh.wikipedia.org/wiki/.NET\_Core

3、扩展

a)、为了便于演示,其实上面在类库中尽迁移时的数据库连接字符串是描写深的,那么极端好之法子是应该去读取Web项目下就布置好之连接,这样就算会担保上下的一致性,不用再行失去为EF的动迁而单独维护一个剩余的数据库连接配置。改造为充分简短,即经过Configuration组件读取appsettings.json的ConnectionStrings节点,改造之后是这样子的:

    public class DesignTimeDbContextFactory : IDesignTimeDbContextFactory<LightContext>
    {
        public LightContext CreateDbContext(string[] args)
        {
            Directory.SetCurrentDirectory("..");//设置当前路径为当前解决方案的路径
            string appSettingBasePath = Directory.GetCurrentDirectory() + "/Light.AuthorityApi";//改成你的appsettings.json所在的项目名称
            var configBuilder = new ConfigurationBuilder()
                .SetBasePath(appSettingBasePath)
                .AddJsonFile("appsettings.json")
                .Build();

            var builder = new DbContextOptionsBuilder<LightContext>();
            //builder.UseSqlServer("Server=(localdb)\\MSSQLLocalDB;Integrated Security=true;Initial Catalog=Light;");
            builder.UseSqlServer(configBuilder.GetConnectionString("LightConnection"));
            return new LightContext(builder.Options);
        }
    }

留意需格外引入下面这Nuget包:

Install-Package Microsoft.Extensions.Configuration.Json

b)、属性注解[Column(Order = 1)]针对EF
Core来说还从未达标可以调数据库生成字段的各个,不过我们要好改迁移文件的实体性质的依次来达成我们纪念要之法力。下面是自个儿调动后更转的阐发,是匪是看出来与地方的起啊两样,一图胜万语:

图片 11

 c)、最后一步,自己动手试试看:创建一个SeedData迁移文件来补充加数据库的启数据。:)

1. .NET Core 2.0 迁移指南

4、最后

EF
Core的强大远不止这些,还有更多的下方式等在我们错过发现,去追。每天进步一点点,是件好快乐的工作!

    由于.NET Core跨平台开发暨性能方面的优势,再加上.NET
Core2.0本的生产,越来越多之客户逐渐迁移到.NET
Core框架进行软件系统的支出。Slickflow引擎组件的.NET
Core版本的出,也是为了缓解越平台引擎产品之落实。本文大致讲述了创建.NET
Core2.0 为对象版本类库,数据看项目与Asp.NET Mvc
Core等品类项目的搭建过程,方便用户迅速上手。

1.1 数据访问项目

1) IRepository模式实现

   
Repository模式实现通用数据看接口,其好处是率先定义有标准的增删改查接口,其次可以满足对接后端不同之数处理框架,如Dapper,EF和NHibernate等框架。

/// <summary>
    /// 数据操作类接口
    /// </summary>
    /// <typeparam name="T">数据实体类型</typeparam>
    public interface IRepository<T> where T : class
    {
        DbSet<T> GetDbSet();

        T GetByID(dynamic id);
        T Get(Expression<Func<T, bool>> predicate);
        IQueryable<T> GetAll();

        IQueryable<T> Query(string sql, params object[] parameters);
        IEnumerable<T> Query(Expression<Func<T, bool>> predicate);
        int Count(Expression<Func<T, bool>> predicate = null);


        //insert, update, delete
        T Insert(T entity);
        void Insert(params T[] entities);
        void Insert(IEnumerable<T> entities);
        void Update(T entity);
        void Update(params T[] entities);
        void Update(IEnumerable<T> entities);
        void Delete(dynamic id);
        void Delete(params T[] entities);
        void Delete(IEnumerable<T> entities);
    }

2) UnitOfWork 解决工作

   
引擎内部逻辑处理日常是多表的插入编辑操作,为保持数据事务完整性,需要实现会话事务之参数传递,提供提交和回滚的处理方式。Slickflow.Data.IDbSession用来落实UnitOfWork模式。

    /// <summary>
    /// 数据会话接口
    /// </summary>
    public interface IDbSession : IDisposable
    {
        DbContext DbContext { get; }
        IRepository<T> GetRepository<T>() where T : class;
        int SaveChanges();
        int ExecuteSqlCommand(string sql, params object[] paramters);
    }

   
代码示例:Session作为参数,传入具体接口方法,最终促成工作的同样提交或回滚。

/// <summary>
        ///  运行流程测试
        /// </summary>
        /// <param name="runner">运行者</param>
        /// <returns>执行结果</returns>
        [HttpPost]
        public ResponseResult RunProcessApp([FromBody] WfAppRunner runner)
        {
            using (var session = DbFactory.CreateSession())
            {
                var transaction = session.DbContext.Database.BeginTransaction();
                var wfService = new WorkflowService();
                var result = wfService.RunProcessApp(runner, session);

                if (result.Status == WfExecutedStatus.Success)
                {
                    transaction.Commit();
                    return ResponseResult.Success();
                }
                else
                {
                    transaction.Rollback();
                    return ResponseResult.Error(result.Message);
                }
            }
        }

1.2 Asp.NET Mvc Core项目

1) Mvc和WebAPI路由联合布局

   
通常在.NET项目开被,Mvc项目用于前端页面展现,WebAPI用于后端接口实现。在列推行进程中,可以拿简单个档次整合呢同,便于环境布置。

app.UseMvc(route => {
                route.MapRoute(
                    name: "default",
                    template: "{controller=Home}/{action=Index}/{id?}");

                route.MapRoute(
                    name:"defaultApi", 
                    template: "api/{controller}/{action}/{id?}");
            });

2) 数据库连接串配置

    数据库链接串在appsettings.json文件被开展定义,读取方法如下:

            var dbType = ConfigurationExtensions.GetConnectionString(Configuration, "WfDBConnectionType");
            var sqlConnectionString = ConfigurationExtensions.GetConnectionString(Configuration, "WfDBConnectionString");

            Slickflow.Data.ConnectionString.DbType = dbType;
            Slickflow.Data.ConnectionString.Value = sqlConnectionString;

3) DbContext 数据库类型匹配

   
由于不同品类数据库的数目访问组件不同,所以专门做了接口对许配合,传入数据库连接串值。

        protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
        {
            if (ConnectionString.DbType == DatabaseTypeEnum.SQLSERVER.ToString())
                optionsBuilder.UseSqlServer(ConnectionString.Value);
            else if (ConnectionString.DbType == DatabaseTypeEnum.MYSQL.ToString())
                optionsBuilder.UseMySql(ConnectionString.Value);
            else if (ConnectionString.DbType == DatabaseTypeEnum.ORACLE.ToString())
                optionsBuilder.UseOracle(ConnectionString.Value);
        }

  

2. EF Core对大多数据库生成的支撑

    EF Code
First
大凡由于实体来蛮成数据库模型,简要过程描述为:首先定义好实体对象,对诺数据库字段类型,然后执行EF
Migrations的操作命令来生成数据库对象。其中常用的下令有:

   1) dotnet ef migrations add MyFirstMigraton

   2) dotnet ef migrations update database

   下面就是因WfProcess表的创来说明大致的始建过程。

2.1 MS SQLSERVER数据库

    采用的多寡访问组件默认为:Microsoft.EntityFrameworkCore。

 1) 实体属性标识

 /// <summary>
    /// 流程实体类
    /// </summary>
    [Table("WfProcess")]
    public class ProcessEntity
    {
        [Key]
        [DatabaseGenerated(DatabaseGeneratedOption.Identity)]
        [Column(Order = 0)]
        public int ID { get; set; }

        [Required]
        [Column(TypeName = "varchar(100)", Order = 1)]
        [MaxLength(100)]
        public string ProcessGUID { get; set; }

        [Required]
        [Column(TypeName = "nvarchar(50)", Order = 2)]
        [MaxLength(50)]
        public string ProcessName { get; set; }

        [Required]
        [Column(TypeName ="nvarchar(20)", Order = 3)]
        [MaxLength(20)]
        public string Version { get; set; }
    }

 2) 默认值赋值

//流程创建
            modelBuilder.Entity<ProcessEntity>(entity =>
            {
                entity.Property(e => e.Version).HasDefaultValue("1");
                entity.Property(e => e.IsUsing).HasDefaultValue(0);
                entity.Property(e => e.StartType).HasDefaultValue(0);
                entity.Property(e => e.EndType).HasDefaultValue(0);
                entity.Property(e => e.CreatedDateTime).HasDefaultValueSql("getdate()");
            });

 3) 生成令执行

dotnet ef migrations add
MyFirstMigration

2.2 MySQL数据库

    采用的数额访问组件默认为:Polemo.EntityFrameworkCore.MySQL。

  1) 实体属性标识

    /// <summary>
    /// 流程实体类
    /// </summary>
    [Table("WfProcess")]
    public class ProcessEntity
    {
        [Key]
        [DatabaseGenerated(DatabaseGeneratedOption.Identity)]
        [Column(Order = 0)]
        public int ID { get; set; }

        [Required]
        [Column(TypeName = "varchar(100)", Order = 1)]
        [MaxLength(100)]
        public string ProcessGUID { get; set; }

        [Required]
        [Column(TypeName = "varchar(50)", Order = 2)]
        [MaxLength(50)]
        public string ProcessName { get; set; }

        [Required]
        [Column(TypeName ="varchar(20)", Order = 3)]
        [MaxLength(20)]
        public string Version { get; set; }
    }

  2) 默认值赋值

            //流程创建
            modelBuilder.Entity<ProcessEntity>(entity =>
            {
                entity.Property(e => e.Version).HasDefaultValue("1");
                entity.Property(e => e.IsUsing).HasDefaultValue(0);
                entity.Property(e => e.StartType).HasDefaultValue(0);
                entity.Property(e => e.EndType).HasDefaultValue(0);
            });

  3) 生成令执行

dotnet ef migrations add
MyFirstMigration

3. Slickflow.WebAPI 快捷测试

 3.1 路由模式选定:

    仍然选定传统路由模式,便于接口快速识别及相当。

            app.UseMvc(route => {
                route.MapRoute(
                    name: "defaultApi",
                    template: "api/{controller}/{action}/{id?}");
            });

3.2 数据库链接串读取:

            var dbType = ConfigurationExtensions.GetConnectionString(Configuration, "WfDBConnectionType");
            var sqlConnectionString = ConfigurationExtensions.GetConnectionString(Configuration, "WfDBConnectionString");

            Slickflow.Data.ConnectionString.DbType = dbType;
            Slickflow.Data.ConnectionString.Value = sqlConnectionString;

3.3 测试接口方法

        /// <summary>
        ///  启动流程测试
        /// </summary>
        /// <param name="runner">运行者</param>
        /// <returns>执行结果</returns>
        [HttpPost]
        public ResponseResult StartProcess([FromBody] WfAppRunner runner)
        {
            using (var session = DbFactory.CreateSession())
            {
                var transaction = session.DbContext.Database.BeginTransaction();
                var wfService = new WorkflowService();
                var result = wfService.StartProcess(runner, session);

                if (result.Status == WfExecutedStatus.Success)
                {
                    transaction.Commit();
                    return ResponseResult.Success();
                }
                else
                {
                    transaction.Rollback();
                    return ResponseResult.Error(result.Message);
                }
            }
        }

3.4 RestClient 测试工具

   
 引擎接口测试用RestClient工具,比较方便快捷。通常采用统一之接口方法,将不同类型的流程JSON数据格式作为测试用例来付测试。

图片 12

4. 总结

     Slickflow 引擎产品的.NET
Core版本实现,用于跨平台运用之类别开发暨业务并。而且以数据库的支持及,采用EF
Core的Code First数据库迁移创建,方便用户支付环境的快搭建与布局。

相关文章

发表评论

电子邮件地址不会被公开。 必填项已用*标注

网站地图xml地图