基于EntityFramework 6 Code First实现动态建库，分库，数据库自动迁移
一、前言
公司原本有一个“xx系统”，ORM使用EntityFramework，Code First模式。该系统是针对某个客户企业的，现要求该系统支持多个企业使用，但是又不能给每个企业部署一份（难以维护），只能想办法从代码层面去解决这个问题。
二、思路
- 在原有的数据表增加外键，标记该数据属于哪个企业。这代码改动会非常大，之前的查询修改代码都需要增加外键筛选的逻辑。这显然不合理。
- 动态分库。每个企业注册时，为他生成一个独立的数据库，企业登录时切换到他对应的数据库。这样就完全不用修改以前的业务代码，只需要考虑企业数据库切换的问题。
三、实现
那么EntityFramework Code First模式怎么实现动态分库的功能呢？
- 首先建立一个主库，主库只存放企业用户的数据，包括企业登录名，密码，对应的数据库名 等等... 主库只有一个。
- 业务数据库，在企业注册的时候动态创建，业务数据库可以有多个，也可以放到不同的服务器。
- 企业登录时，读取主库，拿到业务数据库名称，然后保存到用户session中（也可以是别的缓存），该用户的后续请求都基于此数据库。
为了简单我建立了一个demo项目：
主库模型放在XHZNL.EFDynamicDatabaseBuilding.MasterEntity里面，主库只有一个企业表：Enterprise:
using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.ComponentModel.DataAnnotations.Schema;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
namespace XHZNL.EFDynamicDatabaseBuilding.MasterEntity
{
/// <summary>
/// 企业
/// </summary>
public class Enterprise
{
/// <summary>
/// ID
/// </summary>
[Required]
public Guid ID { get; set; }
/// <summary>
/// 企业名称
/// </summary>
[Required]
[Column(TypeName = "NVARCHAR")]
[MaxLength(50)]
public string Name { get; set; }
/// <summary>
/// 企业数据库名称
/// </summary>
[Required]
[Column(TypeName = "NVARCHAR")]
[MaxLength(100)]
public string DBName { get; set; }
/// <summary>
/// 企业 账号
/// </summary>
[Required]
[Column(TypeName = "NVARCHAR")]
[MaxLength(20)]
public string AdminAccount { get; set; }
/// <summary>
/// 企业 密码
/// </summary>
[Required]
[Column(TypeName = "NVARCHAR")]
[MaxLength(50)]
public string AdminPassword { get; set; }
}
}
XHZNL.EFDynamicDatabaseBuilding.MasterEntity.Services.BaseService:
using System;
using System.Collections.Generic;
using System.Data.Entity;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using XHZNL.EFDynamicDatabaseBuilding.Common;
namespace XHZNL.EFDynamicDatabaseBuilding.MasterEntity.Services
{
public class BaseService
{
/// <summary>
/// 获取context
/// </summary>
/// <returns></returns>
internal MasterDBContext GetDBContext()
{
try
{
var context = new MasterDBContext();
if (!context.Database.Exists())
{
context.Database.Create();
var dbInitializer = new MigrateDatabaseToLatestVersion<MasterDBContext, Migrations.Configuration>(true);
dbInitializer.InitializeDatabase(context);
}
if (!context.Database.CompatibleWithModel(false))
{
var dbInitializer = new MigrateDatabaseToLatestVersion<MasterDBContext, Migrations.Configuration>(true);
dbInitializer.InitializeDatabase(context);
}
return context;
}
catch (Exception ex)
{
return null;
}
}
}
}
XHZNL.EFDynamicDatabaseBuilding.MasterEntity.Services.EnterpriseService:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using XHZNL.EFDynamicDatabaseBuilding.Common;
namespace XHZNL.EFDynamicDatabaseBuilding.MasterEntity.Services
{
/// <summary>
/// 企业服务
/// </summary>
public class EnterpriseService : BaseService
{
public static readonly EnterpriseService Instance = new EnterpriseService();
private EnterpriseService() { }
/// <summary>
/// 根据账号密码 获取 企业
/// </summary>
/// <param name="account"></param>
/// <param name="password"></param>
/// <returns></returns>
public Enterprise Get(string account, string password)
{
try
{
using (var context = GetDBContext())
{
var model = context.Enterprises.FirstOrDefault(m => m.AdminAccount == account && m.AdminPassword == password);
if (model != null)
{
//设置当前业务数据库
CommonHelper.Instance.SetCurrentDBName(model.DBName);
}
return model;
}
}
catch (Exception ex)
{
return null;
}
}
/// <summary>
/// 添加企业
/// </summary>
/// <param name="id"></param>
/// <returns></returns>
public bool Add(Enterprise enterprise)
{
try
{
using (var context = GetDBContext())
{
enterprise.ID = Guid.NewGuid();
enterprise.DBName = "BusinessDB" + DateTime.Now.Ticks;
context.Enterprises.Add(enterprise);
return context.SaveChanges() > 0;
}
}
catch (Exception ex)
{
return false;
}
}
}
}
XHZNL.EFDynamicDatabaseBuilding.Common.CommonHelper:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Runtime.Remoting.Messaging;
using System.Text;
using System.Threading.Tasks;
namespace XHZNL.EFDynamicDatabaseBuilding.Common
{
public class CommonHelper
{
public static readonly CommonHelper Instance = new CommonHelper();
private CommonHelper() { }
/// <summary>
/// 获取当前数据库
/// </summary>
/// <returns></returns>
public string GetCurrentDBName()
{
var key = "CurrentDBName";
string name = null;
if (System.Web.HttpContext.Current != null && System.Web.HttpContext.Current.Session != null)
{
name = System.Web.HttpContext.Current.Session[key].ToString();
}
else
{
name = CallContext.GetData(key).ToString();
}
if (string.IsNullOrEmpty(name))
throw new Exception("CurrentDBName异常");
return name;
}
/// <summary>
/// 设置当前数据库
/// </summary>
/// <param name="name"></param>
public void SetCurrentDBName(string name)
{
var key = "CurrentDBName";
if (System.Web.HttpContext.Current != null && System.Web.HttpContext.Current.Session != null)
{
System.Web.HttpContext.Current.Session[key] = name;
}
else
{
CallContext.SetData(key, name);
}
}
}
}
web.config配置一下业务数据库的连接信息：
这个可以根据实际业务修改，分布到不同的服务器，这里只是为了演示。
业务数据库模型放在XHZNL.EFDynamicDatabaseBuilding.BusinessEntity里面，这里只有一个员工表
using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.ComponentModel.DataAnnotations.Schema;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
namespace XHZNL.EFDynamicDatabaseBuilding.BusinessEntity
{
/// <summary>
/// 员工
/// </summary>
public class Staff
{
/// <summary>
/// ID
/// </summary>
[Required]
public Guid ID { get; set; }
/// <summary>
/// 员工名称
/// </summary>
[Required]
[Column(TypeName = "NVARCHAR")]
[MaxLength(50)]
public string Name { get; set; }
}
}
数据库context:
using System;
using System.Collections.Generic;
using System.Data.Entity;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
namespace XHZNL.EFDynamicDatabaseBuilding.BusinessEntity
{
//[DbConfigurationType(typeof(MySql.Data.Entity.MySqlEFConfiguration))]//使用mysql时需要这个
internal class BusinessDBContext : DbContext
{
public BusinessDBContext() : base("name=BusinessDB")
{
Database.SetInitializer<BusinessDBContext>(null);
}
//修改上下文默认构造函数
public BusinessDBContext(string connectionString)
: base(connectionString)
{
}
/// <summary>
/// 员工
/// </summary>
public DbSet<Staff> Staffs { get; set; }
}
}
XHZNL.EFDynamicDatabaseBuilding.BusinessEntity.Migrations.Configuration:可以放一些种子数据...
namespace XHZNL.EFDynamicDatabaseBuilding.BusinessEntity.Migrations
{
using System;
using System.Data.Entity;
using System.Data.Entity.Migrations;
using System.Linq;
internal sealed class Configuration : DbMigrationsConfiguration<XHZNL.EFDynamicDatabaseBuilding.BusinessEntity.BusinessDBContext>
{
public Configuration()
{
AutomaticMigrationsEnabled = true;
AutomaticMigrationDataLossAllowed = true;
//SetSqlGenerator("MySql.Data.MySqlClient", new MySql.Data.Entity.MySqlMigrationSqlGenerator());//使用mysql时需要这个
}
protected override void Seed(XHZNL.EFDynamicDatabaseBuilding.BusinessEntity.BusinessDBContext context)
{
// This method will be called after migrating to the latest version.
// You can use the DbSet<T>.AddOrUpdate() helper extension method
// to avoid creating duplicate seed data.
var staff = new Staff() { ID = Guid.Parse("212cf53c-6801-4c00-b36b-996ac9809e04"), Name = "初始员工" };
context.Staffs.AddOrUpdate(staff);
context.SaveChanges();
}
}
}
关键的分库，建库，更新数据库代码在XHZNL.EFDynamicDatabaseBuilding.BusinessEntity.Services.BaseService，任何的模型修改都能在程序运行时自动更新到数据库:
using System;
using System.Collections.Generic;
using System.Data.Entity;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using XHZNL.EFDynamicDatabaseBuilding.Common;
namespace XHZNL.EFDynamicDatabaseBuilding.BusinessEntity.Services
{
public class BaseService
{
/// <summary>
/// 获取context
/// </summary>
/// <returns></returns>
internal BusinessDBContext GetDBContext()
{
try
{
//mysql连接字符串
//var connectionString = $"Data Source={AppConfig.DB_DataSource};Port={AppConfig.DB_Port};Initial Catalog={CommonHelper.Instance.GetCurrentDBName()};User ID={AppConfig.DB_UserID};Password={AppConfig.DB_Password};";
//sqlserver连接字符串
var connectionString = $"Data Source={AppConfig.DB_DataSource},{AppConfig.DB_Port};Initial Catalog={CommonHelper.Instance.GetCurrentDBName()};User ID={AppConfig.DB_UserID};Password={AppConfig.DB_Password};";
var context = new BusinessDBContext(connectionString);
//数据库是否存在 不存在则创建
if (!context.Database.Exists())
{
context.Database.Create();
var dbInitializer = new MigrateDatabaseToLatestVersion<BusinessDBContext, Migrations.Configuration>(true);
dbInitializer.InitializeDatabase(context);
}
//数据库接口是否和模型一致 不一致则更新
if (!context.Database.CompatibleWithModel(false))
{
var dbInitializer = new MigrateDatabaseToLatestVersion<BusinessDBContext, Migrations.Configuration>(true);
dbInitializer.InitializeDatabase(context);
}
return context;
}
catch (Exception ex)
{
return null;
}
}
}
}
其他的数据访问类继承BaseService，通过GetDBContext()方法获取context，这样确保得到正确的业务数据库。
四、效果
- 运行web项目：
此时数据库中只有一个主库：
- 点击注册企业：
注册2个企业用于测试
此时主库已有了2条企业数据：
- 分别用test1，test2登录，并添加员工数据：
企业登录后已经生成了对应的业务库
- 数据正确添加读取：
五、总结：
以上关于EntityFramework分库的核心就是通过动态构建connectionString，来得到context。至于如何动态构建，方法有很多，以上代码只是最简单的实现。代码在：https://github.com/xiajingren/EFDynamicDatabaseBuilding
基于EntityFramework 6 Code First实现动态建库，分库，数据库自动迁移的更多相关文章
- 【ITOO 3】.NET 动态建库建表：实用EF框架提供的codeFirst实现动态建库
导读:在上篇博客中,介绍了使用SQL字符拼接的方式,实现动态建库建表的方法.这样做虽然也能够实现效果,但是,太麻烦,而且,如果改动表结构,字段的话,会对代码修改很多.但是EF给我们提供了一种代码先行的 ...
- 使用CodeFirst实现动态建库
一.业务分析 以我们平时注册今目标为例,我们在注册今目标的过程中,具体步骤是这样的: 图1 今目标登陆流程 详细解释一下: 第一步:注册界面.输入手机号或者邮箱,点击确定进入基本信息界面. 第二步:基 ...
- 【ITOO 2】.NET 动态建库建表：使用SQL字符串拼接方式
导读:在最近接手的项目(高效云平台)中,有一个需求是要当企业用户注册时,给其动态的新建一个库和表.刚开始接手的时候,是一点头绪都没有,然后查了一些资料,也问了问上一版本的师哥师姐,终于有了点头绪.目前 ...
- [ITOO]动态建库 标签： 库数据库mysql 2016-07-17 21:23 241人阅读 评论(2) 收
最近一直在做权限系统的动态建库,动态建库,说白了就是在你点击"注册"按钮的时候,根据你输入的信息,来创建一个企业所需要的数据库的过程,因为现阶段并没有提供购买等功能,所以暂时咱们是 ...
- 让Code First下的数据库的迁移更加简单
Code First给我们的程序开发带了很多便利,之前的版本中一个比较不大方便的地方是数据库迁移,麻烦不说,往往还和上下文相关,在不同的版本之间的数据库进行迁移还很容易失败,并且一旦失败还不大容易找到 ...
- Oracle 11g 手工建库
假设数据库软件已经安装好,现在没有图形界面无法用dbca安装数据库,那么用手工建库,数据库名为edw 创建目录 [oracle@localhost ~]$ mkdir -p /u01/app/orac ...
- 【BZOJ-2879】美食节 最小费用最大流 + 动态建图
2879: [Noi2012]美食节 Time Limit: 10 Sec Memory Limit: 512 MBSubmit: 1366 Solved: 737[Submit][Status] ...
- EntityFramework Code First 手写代码实现生成数据库
第一步:写实体类 第二步:写一个实体操作类,此类必须继承Dbcontext,此处的属性,将会在初始化时(第一次作,增,删,改的时候),生成相应的表. 第三步:运行程序,会自动建表 注意: 若实体类发生 ...
- EntityFramework 5.0 CodeFirst 教程01-搭建环境和快速上手
----------------------------目录------------------------------ EntityFramework 5.0 CodeFirst 教程03-数据结构 ...
随机推荐
- spark机器学习从0到1特征抽取–CountVectorizer（十三）
一.概念 CountVectorizer 旨在通过计数来将一个文档转换为向量.当不存在先验字典时,Countvectorizer作为Estimator提取词汇进行训练,并生成一个CountVe ...
- uefi win10 Ubuntu 18的安装
uefi win10 Ubuntu 18的安装 (Ubuntu折腾的第一天) 安装时的踩坑记录
- UIStackView上手教程
https://www.jianshu.com/p/19fbf3ee2840 https://www.cnblogs.com/bokeyuanlibin/p/5693575.html https:// ...
- CF915D Almost Acyclic Graph
题目链接:http://codeforces.com/contest/915/problem/D 题目大意: 给出一个\(n\)个结点\(m\)条边的有向图(无自环.无重边,2 ≤ n ≤ 500, ...
- vscode环境配置(三)——解决控制台终端中文输出乱码
由于系统终端默认编码为GBK,所以需要修改为UTF-8 方法一 打开cmd输入chcp查看编码格式,查看以及修改如下图所示: 方法二
- 【python 】文件下载进度条（装逼利器）
基础版 import requests url = "http://mp.111ttt.cn/mp3free/81135985.mp3" rsp = requests.get(ur ...
- Altera的Cyclone系列器件命名规则
Altera的Cyclone系列器件命名规则如下 器件系列 + 器件类型(是否含有高速串行收发器) + LE逻辑单元数量 + 封装类型 + 高速串行收发器的数量(没有则不写) + 引脚数目 + 器件 ...
- [Unity2d系列教程] 001.引用外部DLL - C#
众所周知,Unity可以支持多种语言开发, C#, JS, Boo三种方式的开发, 能够很方便的集成一些外部插件,以便调用现有的动态链接库.学过C#的都知道C#可以生成一个dll供给其他的程序调用.那 ...
- Unity 离线建造系统
很多游戏,特别是养成类手游,都会有自己独特的建造系统,一个建造装置的状态循环或者说生命周期一般是这样的: 1.准备建造,设置各项资源的投入等 2.等待一段倒计时,正在建造中 3.建造结束,选择是否收取 ...
- DataFrame的apply用法
DataFrame的apply方法: def cal_value_percent(row,total_value): row['new_column']=row[estimated_value_col ...