4.4 异构、多数据库的存取组件

在一个大型系统中，应该允许访问多个数据库，甚至是多个异构的数据库。例如表单模块使用mysql，数据仓库模块使用oracle等等。按照这个目标，数据的配置信息：

    "Database": {
      "ConnectionStrings": [
        {
          "Name": "MicroStrutLibrary",
          "ConnectionString": "Data Source=XXXX;Initial Catalog=XXXX;User Id=OperUser;Password=OperUser;MultipleActiveResultSets=true;Persist Security Info=true",
          "ProviderName": "System.Data.SqlClient"
        },
        {
          "Name": "CMS",
          "ConnectionString": "Data Source=XXXX;Initial Catalog=XXXX;User Id=OperUser;Password=OperUser;MultipleActiveResultSets=true;Persist Security Info=true",
          "ProviderName": "System.Data.SqlClient"
        }
      ],
      "Providers": [
        {
          "Name": "System.Data.SqlClient",
          "Type": "MicroStrutLibrary.Infrastructure.Core.Data.Entity.SqlServerDbContextOptionsBuilderProvider, MicroStrutLibrary.Infrastructure.Core.Data.Entity"
        }
      ]
    }

每个数据库都有一个Name（名称，以后都用这个名称访问）、ConnectionString（数据库链接串）、ProviderName（提供程序名）。对于ProviderName（提供程序名）在Providers中描述了对应的实现类描述TypeDescription。从上面我们可以看出，我们可以设置多个数据库，不同的数据库可以设置不同的Provider，也就是不同的数据库类型，从而实现了多个异构数据库的存取操作。

对于数据库配置信息类DataConfigInfo，实现ConfigInfo，应该很简单，就不赘述了，可以参见可换源的配置。

框架中，每个模块（例如公共模块、数据仓库模块、表单模块、CMS模块、授权认证模块等）都对应于一个数据库上下文DbContext。这个数据库上下文指向一个数据库，也就是要对应上数据配置中的Name属性。我们的做法是新建一个DbNameAttribute，放在DbContext上，以确定具体数据库的Name。

    /// <summary>
    /// 指定数据库名称特性
    /// </summary>
    [AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = false)]
    public class DbNameAttribute : Attribute
    {
        /// <summary>
        /// 数据库名称
        /// </summary>
        public string Name { get; set; }

        /// <summary>
        /// 构造函数
        /// </summary>
        /// <param name="name"></param>
        public DbNameAttribute(string name)
        {
            this.Name = name;
        }
}

DBNameAttribute中的Name应该设置的就是配置中的Name，从而确保DbContext对应的是哪个数据库。

例如公共模块部分的DbContext写法如下：

    [DbName("MicroStrutLibrary")]
    public class CommonDbContext : EntityDbContext
    {
        public CommonDbContext(DbContextOptions<CommonDbContext> options) : base(options)
        {
        }

        public DbSet<AccessoryInfo> Accessories { get; set; }

        public DbSet<SystemParameterInfo> SystemParameters { get; set; }
        public DbSet<SystemParameterDetailInfo> SystemParameterDetails { get; set; }
    ……
    }

大家会注意到CommonDbContext继承EntityDbContext，他是框架的数据库上下文抽象基类，继承DbContext。这个抽象类的重写OnModelCreating方法，找出当前具体实现EntityDbContext类（例如CommonDbContext）的所有DbSet属性，形成该EntityDbContext用到的所有DbSet泛型的参数类，就是AccessoryInfo、SystemParameterInfo等类。然后找出所有继承ORMapping关系映射基类EntityTypeConfiguration的子类，创建映射绑定关系。

抽象的关系映射基类EntityTypeConfiguration代码如下：

    public abstract class EntityTypeConfiguration<T> where T: class
    {
        public void Bind(ModelBuilder modelBuilder)
        {
            InnerBind(modelBuilder.Entity<T>());
        }

        protected abstract void InnerBind(EntityTypeBuilder<T> builder);
    }

例如系统参数的ORMapping类就可以写成：

    /// <summary>
    /// 系统参数 映射信息
    /// </summary>
    public class SystemParameterMapper : EntityTypeConfiguration<SystemParameterInfo>
    {
        protected override void InnerBind(EntityTypeBuilder<SystemParameterInfo> builder)
        {
            builder.ToTable("SYSTEM_PARAMETER_INFO");

            builder.Property(p => p.AppCode).HasColumnName("APP_CODE").IsRequired();
            builder.Property(p => p.SystemParaCode).HasColumnName("SYSTEM_PARA_CODE").IsRequired();
            builder.Property(p => p.SystemParaName).HasColumnName("SYSTEM_PARA_NAME").IsRequired();
            builder.Property(p => p.SortOrder).HasColumnName("SORT_ORDER").IsRequired();
            builder.Property(p => p.Remark).HasColumnName("REMARK");

            builder.HasKey(p => new { p.AppCode, p.SystemParaCode });

            builder.HasMany(p => p.DetailList).WithOne().HasForeignKey(f => new { f.AppCode, f.SystemParaCode }).OnDelete(DeleteBehavior.Cascade);
        }
    }

前面讲了数据库的配置说明，DbContext的具体实现和ORMapping的实现。但是在程序中如何嵌入这些内容，如何将DbContext与配置关联呢？尤其是数据库的Provider是写在配置中的，不能再在Startup中写死services.AddDbContext<BloggingContext>(options => options.UseSqlServer(connection))吧？这种写法，背离了我们使用配置方式的初衷了。

为了解决这个问题，我们写一个startup的扩展方法，将配置和DbContext等关联起来：

        public static DbContextOptionsBuilder UseDb<TContext>(this DbContextOptionsBuilder optionsBuilder, IServiceProvider serviceProvider) where TContext : DbContext
        {
            DataConfigInfo config = serviceProvider.GetService<IOptions<DataConfigInfo>>().Value;

            DbNameAttribute attribute = typeof(TContext).GetTypeInfo().GetCustomAttribute<DbNameAttribute>(false);

            ConnectionStringSettingInfo connectionStringSetting = config.ConnectionStrings.SingleOrDefault(o => o.Name == attribute.Name);
            ProviderSettingInfo providerSetting = config.Providers.SingleOrDefault(o => o.Name == connectionStringSetting.ProviderName);

            Type providerType = Type.GetType(providerSetting.Type);

            DbContextOptionsBuilderProvider providerInstance = Activator.CreateInstance(providerType) as DbContextOptionsBuilderProvider;

            providerInstance.ConnectionStringSetting = connectionStringSetting;
            providerInstance.ProviderSetting = providerSetting;

            providerInstance.Build(optionsBuilder);

            EntityDbContext.DbContexts.TryAdd(connectionStringSetting.Name, typeof(TContext));

            return optionsBuilder;
        }

这个方法的主要作用是：TContext泛型参数是EntityDbContext的实现类，例如CommonDbContext。以上面介绍的数据库配置信息和CommonDbContext为例说明：

1、获取当前CommonDbContext类的DbNameAttribute，也就是MicroStrutLibrary。

2、然后获取MicroStrutLibrary数据库连接串信息

"Name": "MicroStrutLibrary",

"ConnectionString": "Data Source=XXXX;Initial Catalog=XXXX;User Id=OperUser;Password=OperUser;MultipleActiveResultSets=true;Persist Security Info=true",

"ProviderName": "System.Data.SqlClient"

3、再找出对应的DbProvider信息

"Name": "System.Data.SqlClient",

"Type": "MicroStrutLibrary.Infrastructure.Core.Data.Entity.SqlServerDbContextOptionsBuilderProvider, MicroStrutLibrary.Infrastructure.Core.Data.Entity"

4、根据DbProvider信息创建DbContextOptionsBuilderProvider类的实例，并设置属性，执行实例的Build方法。具体这个类在下面讲解。

5、将当前TContext追加到EntityDbContext基类的静态属性DbContexts字典中。这个字典主要是存放数据库的Name和TContext的对应关系。目前暂且用不到（在通用数据查询功能中用的，以后会介绍）。

重点来了，DbContextOptionsBuilderProvider类就是针对每种类型数据库SQL Server、MySql、Oracle等的提供程序。Build方法的参数是各种数据库类型的OptionsBuilder，这个OptionsBuilder在.net core类库中，只需要在他们的基础上封装一下即可：

    public abstract class DbContextOptionsBuilderProvider
    {
        public ProviderSettingInfo ProviderSetting { get; set; }

        public ConnectionStringSettingInfo ConnectionStringSetting { get; set; }

        public abstract void Build(DbContextOptionsBuilder optionsBuilder);
   }

    public class SqlServerDbContextOptionsBuilderProvider : DbContextOptionsBuilderProvider
    {
        public override void Build(DbContextOptionsBuilder optionsBuilder)
        {
            //SQLServer 2008 R2以以下版本
            optionsBuilder.UseSqlServer(this.ConnectionStringSetting.ConnectionString, ob => ob.UseRowNumberForPaging());
            //SQLSever 2012以上版本
            //optionsBuilder.UseSqlServer(this.ConnectionStringSetting.ConnectionString);
        }
   }

上面就是一个SQLServer的具体实现，不过有个说明的是SQLServer 2008R2及以下版本没有offset fetch next语句，只能使用row_number() over方式，因此当数据库是SQLServer 2008R2及以下版本使用optionsBuilder.UseSqlServer(this.ConnectionStringSetting.ConnectionString, ob => ob.UseRowNumberForPaging())，而SQLServer 2012以上版本使用optionsBuilder.UseSqlServer(this.ConnectionStringSetting.ConnectionString)。

还有一点说明的是SQLServer数据库使用datetime2，而不是datetime，否则转换会报错。

面向云的.net core开发框架目录