SqlSugarSetup.cs 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868
  1. // Admin.NET 项目的版权、商标、专利和其他相关权利均受相应法律法规的保护。使用本项目应遵守相关法律法规和许可证的要求。
  2. //
  3. // 本项目主要遵循 MIT 许可证和 Apache 许可证(版本 2.0)进行分发和使用。许可证位于源代码树根目录中的 LICENSE-MIT 和 LICENSE-APACHE 文件。
  4. //
  5. // 不得利用本项目从事危害国家安全、扰乱社会秩序、侵犯他人合法权益等法律法规禁止的活动!任何基于本项目二次开发而产生的一切法律纠纷和责任,我们不承担任何责任!
  6. using Microsoft.Data.Sqlite;
  7. using DbType = SqlSugar.DbType;
  8. namespace Admin.NET.Core;
  9. public static class SqlSugarSetup
  10. {
  11. // 多租户实例
  12. public static ITenant ITenant { get; set; }
  13. // 是否正在处理种子数据
  14. private static bool _isHandlingSeedData = false;
  15. /// <summary>
  16. /// SqlSugar 上下文初始化
  17. /// </summary>
  18. /// <param name="services"></param>
  19. public static void AddSqlSugar(this IServiceCollection services)
  20. {
  21. // 注册雪花Id
  22. var snowIdOpt = App.GetConfig<SnowIdOptions>("SnowId", true);
  23. YitIdHelper.SetIdGenerator(snowIdOpt);
  24. // 自定义 SqlSugar 雪花ID算法
  25. SnowFlakeSingle.WorkId = snowIdOpt.WorkerId;
  26. StaticConfig.CustomSnowFlakeFunc = YitIdHelper.NextId;
  27. // 注册 MongoDb
  28. InstanceFactory.CustomAssemblies = [typeof(SqlSugar.MongoDb.MongoDbProvider).Assembly];
  29. // 动态表达式 SqlFunc 支持,https://www.donet5.com/Home/Doc?typeId=2569
  30. StaticConfig.DynamicExpressionParserType = typeof(DynamicExpressionParser);
  31. StaticConfig.DynamicExpressionParsingConfig = new ParsingConfig
  32. {
  33. CustomTypeProvider = new SqlSugarTypeProvider()
  34. };
  35. var dbOptions = App.GetConfig<DbConnectionOptions>("DbConnection", true);
  36. // Docker 等对已有库部署:避免每次启动跑 CodeFirst/全量种子导致冲突(见 docker-compose 环境变量 DOCKER_SKIP_DBINIT)
  37. if (string.Equals(Environment.GetEnvironmentVariable("DOCKER_SKIP_DBINIT"), "1", StringComparison.Ordinal)
  38. && dbOptions.ConnectionConfigs != null)
  39. {
  40. foreach (var c in dbOptions.ConnectionConfigs)
  41. {
  42. if (c.DbSettings != null)
  43. {
  44. c.DbSettings.EnableInitDb = false;
  45. c.DbSettings.EnableInitView = false;
  46. }
  47. if (c.TableSettings != null)
  48. c.TableSettings.EnableInitTable = false;
  49. if (c.SeedSettings != null)
  50. c.SeedSettings.EnableInitSeed = false;
  51. }
  52. }
  53. dbOptions.ConnectionConfigs.ForEach(SetDbConfig);
  54. SqlSugarScope sqlSugar = new(dbOptions.ConnectionConfigs.Adapt<List<ConnectionConfig>>(), db =>
  55. {
  56. dbOptions.ConnectionConfigs.ForEach(config =>
  57. {
  58. var dbProvider = db.GetConnectionScope(config.ConfigId);
  59. SetDbAop(dbProvider, dbOptions.EnableConsoleSql, dbOptions.SuperAdminIgnoreIDeletedFilter);
  60. SetDbDiffLog(dbProvider, config);
  61. });
  62. });
  63. ITenant = sqlSugar;
  64. services.AddSingleton<ISqlSugarClient>(sqlSugar); // 单例注册
  65. services.AddScoped(typeof(SqlSugarRepository<>)); // 仓储注册
  66. services.AddUnitOfWork<SqlSugarUnitOfWork>(); // 事务与工作单元注册
  67. // 初始化数据库表结构及种子数据
  68. dbOptions.ConnectionConfigs.ForEach(config =>
  69. {
  70. InitDatabase(sqlSugar, config);
  71. });
  72. }
  73. /// <summary>
  74. /// 配置连接属性
  75. /// </summary>
  76. /// <param name="config"></param>
  77. public static void SetDbConfig(DbConnectionConfig config)
  78. {
  79. if (config.DbSettings.EnableConnStringEncrypt)
  80. config.ConnectionString = CryptogramUtil.Decrypt(config.ConnectionString);
  81. var configureExternalServices = new ConfigureExternalServices
  82. {
  83. EntityNameService = (type, entity) => // 处理表
  84. {
  85. entity.IsDisabledDelete = true; // 禁止删除非 sqlsugar 创建的列
  86. // 只处理贴了特性[SugarTable]表
  87. if (!type.GetCustomAttributes<SugarTable>().Any())
  88. return;
  89. if (config.DbSettings.EnableUnderLine && !entity.DbTableName.Contains('_'))
  90. entity.DbTableName = entity.DbTableName.ToUnderLine(); // 驼峰转下划线
  91. },
  92. EntityService = (type, column) => // 处理列
  93. {
  94. // 只处理贴了特性[SugarColumn]列
  95. if (!type.GetCustomAttributes<SugarColumn>().Any())
  96. return;
  97. if (new NullabilityInfoContext().Create(type).WriteState is NullabilityState.Nullable)
  98. column.IsNullable = true;
  99. if (config.DbSettings.EnableUnderLine && !column.IsIgnore && !column.DbColumnName.Contains('_'))
  100. column.DbColumnName = column.DbColumnName.ToUnderLine(); // 驼峰转下划线
  101. },
  102. DataInfoCacheService = new SqlSugarCache(),
  103. };
  104. config.ConfigureExternalServices = configureExternalServices;
  105. config.InitKeyType = InitKeyType.Attribute;
  106. config.IsAutoCloseConnection = true;
  107. config.MoreSettings = new ConnMoreSettings
  108. {
  109. IsAutoRemoveDataCache = true, // 启用自动删除缓存,所有增删改会自动调用.RemoveDataCache()
  110. IsAutoDeleteQueryFilter = true, // 启用删除查询过滤器
  111. IsAutoUpdateQueryFilter = true, // 启用更新查询过滤器
  112. SqlServerCodeFirstNvarchar = true // 采用Nvarchar
  113. };
  114. // 若库类型是人大金仓则默认设置PG模式
  115. if (config.DbType == DbType.Kdbndp)
  116. config.MoreSettings.DatabaseModel = DbType.PostgreSQL; // 配置PG模式主要是兼容系统表差异
  117. // 若库类型是Oracle则默认主键名字和参数名字最大长度
  118. if (config.DbType == DbType.Oracle)
  119. config.MoreSettings.MaxParameterNameLength = 30;
  120. }
  121. /// <summary>
  122. /// 配置Aop
  123. /// </summary>
  124. /// <param name="db"></param>
  125. /// <param name="enableConsoleSql"></param>
  126. /// <param name="superAdminIgnoreIDeletedFilter"></param>
  127. public static void SetDbAop(SqlSugarScopeProvider db, bool enableConsoleSql, bool superAdminIgnoreIDeletedFilter)
  128. {
  129. // 设置超时时间
  130. db.Ado.CommandTimeOut = 30;
  131. // 打印SQL语句
  132. if (enableConsoleSql)
  133. {
  134. db.Aop.OnLogExecuting = (sql, pars) =>
  135. {
  136. //// 若参数值超过100个字符则进行截取
  137. //foreach (var par in pars)
  138. //{
  139. // if (par.DbType != System.Data.DbType.String || par.Value == null) continue;
  140. // if (par.Value.ToString().Length > 100)
  141. // par.Value = string.Concat(par.Value.ToString()[..100], "......");
  142. //}
  143. var log = $"【{DateTime.Now}——执行SQL】\r\n{UtilMethods.GetNativeSql(sql, pars)}\r\n";
  144. var originColor = Console.ForegroundColor;
  145. if (sql.StartsWith("SELECT", StringComparison.OrdinalIgnoreCase))
  146. Console.ForegroundColor = ConsoleColor.Green;
  147. if (sql.StartsWith("UPDATE", StringComparison.OrdinalIgnoreCase) || sql.StartsWith("INSERT", StringComparison.OrdinalIgnoreCase))
  148. Console.ForegroundColor = ConsoleColor.Yellow;
  149. if (sql.StartsWith("DELETE", StringComparison.OrdinalIgnoreCase))
  150. Console.ForegroundColor = ConsoleColor.Red;
  151. Console.WriteLine(log);
  152. Console.ForegroundColor = originColor;
  153. };
  154. }
  155. db.Aop.OnError = ex =>
  156. {
  157. if (ex.Parametres == null) return;
  158. var log = $"【{DateTime.Now}——错误SQL】\r\n{UtilMethods.GetNativeSql(ex.Sql, (SugarParameter[])ex.Parametres)}\r\n";
  159. Log.Error(log, ex);
  160. };
  161. db.Aop.OnLogExecuted = (sql, pars) =>
  162. {
  163. //// 若参数值超过100个字符则进行截取
  164. //foreach (var par in pars)
  165. //{
  166. // if (par.DbType != System.Data.DbType.String || par.Value == null) continue;
  167. // if (par.Value.ToString().Length > 100)
  168. // par.Value = string.Concat(par.Value.ToString()[..100], "......");
  169. //}
  170. // 执行时间超过5秒时
  171. if (!(db.Ado.SqlExecutionTime.TotalSeconds > 5)) return;
  172. var fileName = db.Ado.SqlStackTrace.FirstFileName; // 文件名
  173. var fileLine = db.Ado.SqlStackTrace.FirstLine; // 行号
  174. var firstMethodName = db.Ado.SqlStackTrace.FirstMethodName; // 方法名
  175. var log = $"【{DateTime.Now}——超时SQL】\r\n【所在文件名】:{fileName}\r\n【代码行数】:{fileLine}\r\n【方法名】:{firstMethodName}\r\n" + $"【SQL语句】:{UtilMethods.GetNativeSql(sql, pars)}";
  176. Log.Warning(log);
  177. };
  178. // 数据审计
  179. db.Aop.DataExecuting = (_, entityInfo) =>
  180. {
  181. // 若正在处理种子数据则直接返回
  182. if (_isHandlingSeedData) return;
  183. // 新增/插入
  184. if (entityInfo.OperationType == DataFilterType.InsertByObject)
  185. {
  186. // 若主键是长整型且空则赋值雪花Id
  187. if (entityInfo.EntityColumnInfo.IsPrimarykey && !entityInfo.EntityColumnInfo.IsIdentity && entityInfo.EntityColumnInfo.PropertyInfo.PropertyType == typeof(long))
  188. {
  189. var id = entityInfo.EntityColumnInfo.PropertyInfo.GetValue(entityInfo.EntityValue);
  190. if (id == null || (long)id == 0)
  191. entityInfo.SetValue(YitIdHelper.NextId());
  192. }
  193. // 若创建时间为空则赋值当前时间
  194. else if (entityInfo.PropertyName == nameof(EntityBase.CreateTime))
  195. {
  196. var createTime = entityInfo.EntityColumnInfo.PropertyInfo.GetValue(entityInfo.EntityValue)!;
  197. if (createTime == null || createTime.Equals(DateTime.MinValue))
  198. entityInfo.SetValue(DateTime.Now);
  199. }
  200. // 若当前用户为空(非web线程时)
  201. if (App.User == null) return;
  202. dynamic entityValue = entityInfo.EntityValue;
  203. if (entityInfo.PropertyName == nameof(EntityBaseTenantId.TenantId))
  204. {
  205. var tenantId = entityValue.TenantId;
  206. if (tenantId == null || tenantId == 0)
  207. entityInfo.SetValue(App.User.FindFirst(ClaimConst.TenantId)?.Value);
  208. }
  209. else if (entityInfo.PropertyName == nameof(EntityBase.CreateUserId))
  210. {
  211. var createUserId = entityValue.CreateUserId;
  212. if (createUserId == 0 || createUserId == null)
  213. entityInfo.SetValue(App.User.FindFirst(ClaimConst.UserId)?.Value);
  214. }
  215. else if (entityInfo.PropertyName == nameof(EntityBase.CreateUserName))
  216. {
  217. var createUserName = entityValue.CreateUserName;
  218. if (string.IsNullOrEmpty(createUserName))
  219. entityInfo.SetValue(App.User.FindFirst(ClaimConst.RealName)?.Value);
  220. }
  221. else if (entityInfo.PropertyName == "CreateOrgId")
  222. {
  223. var createOrgId = entityValue.CreateOrgId;
  224. if (createOrgId == 0 || createOrgId == null)
  225. entityInfo.SetValue(App.User.FindFirst(ClaimConst.OrgId)?.Value);
  226. }
  227. else if (entityInfo.PropertyName == "CreateOrgName")
  228. {
  229. var createOrgName = entityValue.CreateOrgName;
  230. if (string.IsNullOrEmpty(createOrgName))
  231. entityInfo.SetValue(App.User.FindFirst(ClaimConst.OrgName)?.Value);
  232. }
  233. }
  234. // 编辑/更新
  235. else if (entityInfo.OperationType == DataFilterType.UpdateByObject)
  236. {
  237. if (entityInfo.PropertyName == nameof(EntityBase.UpdateTime))
  238. entityInfo.SetValue(DateTime.Now);
  239. else if (entityInfo.PropertyName == nameof(EntityBaseDel.DeleteTime))
  240. {
  241. dynamic entityValue = entityInfo.EntityValue;
  242. var isDelete = entityValue.IsDelete;
  243. if (isDelete == true)
  244. {
  245. entityInfo.SetValue(DateTime.Now);
  246. }
  247. }
  248. // 若当前用户为空(非web线程时)
  249. if (App.User == null) return;
  250. if (entityInfo.PropertyName == nameof(EntityBase.UpdateUserId))
  251. entityInfo.SetValue(App.User?.FindFirst(ClaimConst.UserId)?.Value);
  252. else if (entityInfo.PropertyName == nameof(EntityBase.UpdateUserName))
  253. entityInfo.SetValue(App.User?.FindFirst(ClaimConst.RealName)?.Value);
  254. }
  255. };
  256. // 是否为超级管理员
  257. var isSuperAdmin = App.User?.FindFirst(ClaimConst.AccountType)?.Value == ((int)AccountTypeEnum.SuperAdmin).ToString();
  258. // 配置假删除过滤器,如果当前用户是超级管理员并且允许忽略软删除过滤器则不会应用
  259. if (!isSuperAdmin || !superAdminIgnoreIDeletedFilter)
  260. db.QueryFilter.AddTableFilter<IDeletedFilter>(u => u.IsDelete == false);
  261. // 超管排除其他过滤器
  262. if (isSuperAdmin) return;
  263. // 配置租户过滤器
  264. var tenantId = App.User?.FindFirst(ClaimConst.TenantId)?.Value;
  265. if (!string.IsNullOrWhiteSpace(tenantId))
  266. db.QueryFilter.AddTableFilter<ITenantIdFilter>(u => u.TenantId == long.Parse(tenantId));
  267. // 配置用户机构(数据范围)过滤器
  268. SqlSugarFilter.SetOrgEntityFilter(db);
  269. // 配置自定义过滤器
  270. SqlSugarFilter.SetCustomEntityFilter(db);
  271. }
  272. /// <summary>
  273. /// 开启库表差异化日志
  274. /// </summary>
  275. /// <param name="db"></param>
  276. /// <param name="config"></param>
  277. private static void SetDbDiffLog(SqlSugarScopeProvider db, DbConnectionConfig config)
  278. {
  279. if (!config.DbSettings.EnableDiffLog) return;
  280. async void AopOnDiffLogEvent(DiffLogModel u)
  281. {
  282. // 记录差异数据
  283. var diffData = new List<dynamic>();
  284. for (int i = 0; i < u.AfterData.Count; i++)
  285. {
  286. var diffColumns = new List<dynamic>();
  287. var afterColumns = u.AfterData[i].Columns;
  288. var beforeColumns = u.BeforeData[i].Columns;
  289. for (int j = 0; j < afterColumns.Count; j++)
  290. {
  291. if (afterColumns[j].Value.Equals(beforeColumns[j].Value)) continue;
  292. diffColumns.Add(new
  293. {
  294. afterColumns[j].IsPrimaryKey,
  295. afterColumns[j].ColumnName,
  296. afterColumns[j].ColumnDescription,
  297. BeforeValue = beforeColumns[j].Value,
  298. AfterValue = afterColumns[j].Value,
  299. });
  300. }
  301. diffData.Add(new { u.AfterData[i].TableName, u.AfterData[i].TableDescription, Columns = diffColumns });
  302. }
  303. var logDiff = new SysLogDiff
  304. {
  305. // 差异数据(字段描述、列名、值、表名、表描述)
  306. DiffData = JSON.Serialize(diffData),
  307. // 传进来的对象(如果对象为空,则使用首个数据的表名作为业务对象)
  308. BusinessData = u.BusinessData == null ? u.AfterData.FirstOrDefault()?.TableName : JSON.Serialize(u.BusinessData),
  309. // 枚举(insert、update、delete)
  310. DiffType = u.DiffType.ToString(),
  311. Sql = u.Sql,
  312. Parameters = JSON.Serialize(u.Parameters.Select(e => new { e.ParameterName, e.Value, TypeName = e.DbType.ToString() })),
  313. Elapsed = u.Time == null ? 0 : (long)u.Time.Value.TotalMilliseconds
  314. };
  315. var logDb = ITenant.IsAnyConnection(SqlSugarConst.LogConfigId) ? ITenant.GetConnectionScope(SqlSugarConst.LogConfigId) : ITenant.GetConnectionScope(SqlSugarConst.MainConfigId);
  316. await logDb.CopyNew().Insertable(logDiff).ExecuteCommandAsync();
  317. Console.ForegroundColor = ConsoleColor.Red;
  318. Console.WriteLine(DateTime.Now + $"\r\n*****开始差异日志*****\r\n{Environment.NewLine}{JSON.Serialize(logDiff)}{Environment.NewLine}*****结束差异日志*****\r\n");
  319. }
  320. db.Aop.OnDiffLogEvent = AopOnDiffLogEvent;
  321. }
  322. /// <summary>
  323. /// 初始化视图
  324. /// </summary>
  325. /// <param name="dbProvider"></param>
  326. private static void InitView(SqlSugarScopeProvider dbProvider)
  327. {
  328. var totalWatch = Stopwatch.StartNew(); // 开始总计时
  329. Log.Information($"初始化视图 {dbProvider.CurrentConnectionConfig.DbType} - {dbProvider.CurrentConnectionConfig.ConfigId}");
  330. var viewTypeList = App.EffectiveTypes.Where(u => !u.IsInterface && !u.IsAbstract && u.IsClass && u.GetInterfaces().Any(i => i.HasImplementedRawGeneric(typeof(ISqlSugarView)))).ToList();
  331. int taskIndex = 0, size = viewTypeList.Count;
  332. var taskList = viewTypeList.Select(viewType => Task.Run(() =>
  333. {
  334. // 开始计时
  335. var stopWatch = Stopwatch.StartNew();
  336. // 获取视图实体和配置信息
  337. var entityInfo = dbProvider.EntityMaintenance.GetEntityInfo(viewType) ?? throw new Exception("获取视图实体配置有误");
  338. // 如果视图存在,则删除视图
  339. if (dbProvider.DbMaintenance.GetViewInfoList(false).Any(it => it.Name.EqualIgnoreCase(entityInfo.DbTableName)))
  340. dbProvider.DbMaintenance.DropView(entityInfo.DbTableName);
  341. // 获取初始化视图查询SQL
  342. var sql = viewType.GetMethod(nameof(ISqlSugarView.GetQueryableSqlString))?.Invoke(Activator.CreateInstance(viewType), [dbProvider]) as string;
  343. if (string.IsNullOrWhiteSpace(sql)) throw new Exception("视图初始化Sql语句不能为空");
  344. // 创建视图
  345. dbProvider.Ado.ExecuteCommand($"CREATE VIEW {entityInfo.DbTableName} AS " + Environment.NewLine + " " + sql);
  346. // 停止计时
  347. stopWatch.Stop();
  348. Console.ForegroundColor = ConsoleColor.Green;
  349. Console.WriteLine($"初始化视图 {viewType.FullName,-58} ({dbProvider.CurrentConnectionConfig.ConfigId} - {Interlocked.Increment(ref taskIndex):D003}/{size:D003},耗时:{stopWatch.ElapsedMilliseconds:N0} ms)");
  350. }));
  351. Task.WaitAll(taskList.ToArray());
  352. totalWatch.Stop(); // 停止总计时
  353. Console.ForegroundColor = ConsoleColor.Green;
  354. Console.WriteLine($"初始化视图 {dbProvider.CurrentConnectionConfig.DbType} - {dbProvider.CurrentConnectionConfig.ConfigId} 总耗时:{totalWatch.ElapsedMilliseconds:N0} ms");
  355. }
  356. /// <summary>
  357. /// 等待数据库就绪
  358. /// </summary>
  359. /// <param name="dbProvider"></param>
  360. private static void WaitForDatabaseReady(SqlSugarScopeProvider dbProvider)
  361. {
  362. do
  363. {
  364. try
  365. {
  366. if (dbProvider.Ado.Connection.State != ConnectionState.Open)
  367. dbProvider.Ado.Connection.Open();
  368. // 如果连接成功,直接返回
  369. Log.Information("数据库连接成功。");
  370. return;
  371. }
  372. catch (Exception ex)
  373. {
  374. Log.Warning($"数据库尚未就绪,等待中... 错误:{ex.Message}");
  375. Thread.Sleep(1000);
  376. }
  377. } while (true);
  378. }
  379. /// <summary>
  380. /// 初始化数据库
  381. /// </summary>
  382. /// <param name="db">SqlSugarScope 实例</param>
  383. /// <param name="config">数据库连接配置</param>
  384. private static void InitDatabase(SqlSugarScope db, DbConnectionConfig config)
  385. {
  386. var dbProvider = db.GetConnectionScope(config.ConfigId);
  387. // 初始化数据库 如果是没有数据库的话,是先初始化数据库再做连接
  388. if (config.DbSettings.EnableInitDb)
  389. {
  390. Log.Information($"初始化数据库 {config.DbType} - {config.ConfigId} - {config.ConnectionString}");
  391. if (config.DbType != DbType.Oracle) dbProvider.DbMaintenance.CreateDatabase();
  392. }
  393. // 等待数据库连接就绪
  394. WaitForDatabaseReady(dbProvider);
  395. // 初始化表结构
  396. if (config.TableSettings.EnableInitTable)
  397. {
  398. Log.Information($"初始化表结构 {config.DbType} - {config.ConfigId}");
  399. var entityTypes = GetEntityTypesForInit(config);
  400. var originCommandTimeout = dbProvider.Ado.CommandTimeOut;
  401. dbProvider.Ado.CommandTimeOut = ResolveInitTableCommandTimeout(config);
  402. try
  403. {
  404. RunPreInitMigrations(dbProvider, entityTypes);
  405. InitializeTables(dbProvider, entityTypes, config);
  406. }
  407. finally
  408. {
  409. dbProvider.Ado.CommandTimeOut = originCommandTimeout;
  410. }
  411. }
  412. // 初始化视图
  413. if (config.DbSettings.EnableInitView) InitView(dbProvider);
  414. // 初始化种子数据
  415. if (config.SeedSettings.EnableInitSeed) InitSeedData(db, config);
  416. }
  417. /// <summary>
  418. /// 获取需要初始化的实体类型
  419. /// </summary>
  420. /// <param name="config">数据库连接配置</param>
  421. /// <returns>实体类型列表</returns>
  422. private static List<Type> GetEntityTypesForInit(DbConnectionConfig config)
  423. {
  424. return App.EffectiveTypes
  425. .Where(u => !u.IsInterface && !u.IsAbstract && u.IsClass && u.IsDefined(typeof(SugarTable), false))
  426. .Where(u => !u.GetCustomAttributes<IgnoreTableAttribute>().Any())
  427. .WhereIF(config.TableSettings.EnableIncreTable, u => u.IsDefined(typeof(IncreTableAttribute), false))
  428. .Where(u => IsEntityForConfig(u, config))
  429. .ToList();
  430. }
  431. /// <summary>
  432. /// 在全局 InitTables 之前执行插件级预迁移,避免 CodeFirst 先补出新列。
  433. /// </summary>
  434. private static void RunPreInitMigrations(SqlSugarScopeProvider dbProvider, List<Type> entityTypes)
  435. {
  436. if (!entityTypes.Any(t => t.FullName?.Contains(".Entity.S0.") == true))
  437. return;
  438. var migrationType = App.EffectiveTypes.FirstOrDefault(t =>
  439. t.FullName == "Admin.NET.Plugin.AiDOP.Infrastructure.AidopS0ExcelColumnMigration");
  440. var migrateMethod = migrationType?.GetMethod("Migrate", BindingFlags.Public | BindingFlags.Static);
  441. if (migrateMethod == null)
  442. return;
  443. migrateMethod.Invoke(null, [dbProvider]);
  444. }
  445. /// <summary>
  446. /// 判断实体是否属于当前配置
  447. /// </summary>
  448. /// <param name="entityType">实体类型</param>
  449. /// <param name="config">数据库连接配置</param>
  450. /// <returns>是否属于当前配置</returns>
  451. private static bool IsEntityForConfig(Type entityType, DbConnectionConfig config)
  452. {
  453. switch (config.ConfigId.ToString())
  454. {
  455. case SqlSugarConst.MainConfigId:
  456. return entityType.GetCustomAttributes<SysTableAttribute>().Any() ||
  457. (!entityType.GetCustomAttributes<LogTableAttribute>().Any() &&
  458. !entityType.GetCustomAttributes<TenantAttribute>().Any(o => o.configId.ToString() != config.ConfigId.ToString()));
  459. case SqlSugarConst.LogConfigId:
  460. return entityType.GetCustomAttributes<LogTableAttribute>().Any();
  461. default:
  462. {
  463. var tenantAttribute = entityType.GetCustomAttribute<TenantAttribute>();
  464. return tenantAttribute != null && tenantAttribute.configId.ToString() == config.ConfigId.ToString();
  465. }
  466. }
  467. }
  468. /// <summary>
  469. /// 初始化表结构
  470. /// </summary>
  471. /// <param name="dbProvider">SqlSugarScopeProvider 实例</param>
  472. /// <param name="entityTypes">实体类型列表</param>
  473. /// <param name="config">数据库连接配置</param>
  474. private static void InitializeTables(SqlSugarScopeProvider dbProvider, List<Type> entityTypes, DbConnectionConfig config)
  475. {
  476. // 删除视图再初始化表结构,防止因为视图导致无法同步表结构
  477. var viewTypeList = App.EffectiveTypes.Where(u => !u.IsInterface && !u.IsAbstract && u.IsClass && u.GetInterfaces().Any(i => i.HasImplementedRawGeneric(typeof(ISqlSugarView)))).ToList();
  478. foreach (var viewType in viewTypeList)
  479. {
  480. var entityInfo = dbProvider.EntityMaintenance.GetEntityInfo(viewType) ?? throw new Exception("获取视图实体配置有误");
  481. if (dbProvider.DbMaintenance.GetViewInfoList(false).Any(it => it.Name.EqualIgnoreCase(entityInfo.DbTableName)))
  482. {
  483. try
  484. {
  485. dbProvider.DbMaintenance.DropView(entityInfo.DbTableName);
  486. }
  487. catch (Exception ex)
  488. {
  489. // 低权限账号下可能不具备 DROP VIEW 权限,跳过视图删除避免启动中断
  490. Console.WriteLine($"跳过删除视图 {entityInfo.DbTableName}:{ex.Message}");
  491. }
  492. }
  493. }
  494. var maxDegree = ResolveInitTableMaxDegreeOfParallelism(config);
  495. int count = 0, sum = entityTypes.Count;
  496. void InitOne(Type entityType)
  497. {
  498. Console.WriteLine($"初始化表结构 {entityType.FullName,-64} ({config.ConfigId} - {Interlocked.Increment(ref count):D003}/{sum:D003})");
  499. UpdateNullableColumns(dbProvider, entityType);
  500. InitializeTable(dbProvider, entityType, config);
  501. }
  502. if (maxDegree <= 1)
  503. {
  504. foreach (var entityType in entityTypes)
  505. InitOne(entityType);
  506. return;
  507. }
  508. Parallel.ForEach(entityTypes, new ParallelOptions { MaxDegreeOfParallelism = maxDegree }, InitOne);
  509. }
  510. /// <summary>
  511. /// 更新表中不存在于实体的字段为可空
  512. /// </summary>
  513. /// <param name="dbProvider">SqlSugarScopeProvider 实例</param>
  514. /// <param name="entityType">实体类型</param>
  515. private static void UpdateNullableColumns(SqlSugarScopeProvider dbProvider, Type entityType)
  516. {
  517. var entityInfo = dbProvider.EntityMaintenance.GetEntityInfo(entityType);
  518. var dbColumns = dbProvider.DbMaintenance.GetColumnInfosByTableName(entityInfo.DbTableName) ?? new List<DbColumnInfo>();
  519. foreach (var dbColumn in dbColumns.Where(c => !c.IsPrimarykey && entityInfo.Columns.All(u => u.DbColumnName != c.DbColumnName)))
  520. {
  521. dbColumn.IsNullable = true;
  522. Retry(() =>
  523. {
  524. dbProvider.DbMaintenance.UpdateColumn(entityInfo.DbTableName, dbColumn);
  525. }, maxRetry: 3, retryIntervalMs: 1000);
  526. }
  527. }
  528. /// <summary>
  529. /// 初始化表
  530. /// </summary>
  531. /// <param name="dbProvider">SqlSugarScopeProvider 实例</param>
  532. /// <param name="entityType">实体类型</param>
  533. private static void InitializeTable(SqlSugarScopeProvider dbProvider, Type entityType, DbConnectionConfig config)
  534. {
  535. Retry(() =>
  536. {
  537. if (entityType.GetCustomAttribute<SplitTableAttribute>() == null)
  538. {
  539. dbProvider.CodeFirst.InitTables(entityType);
  540. }
  541. else
  542. {
  543. dbProvider.CodeFirst.SplitTables().InitTables(entityType);
  544. }
  545. }, ResolveInitTableRetryCount(config), ResolveInitTableRetryIntervalMs(config));
  546. }
  547. /// <summary>
  548. /// 初始化种子数据
  549. /// </summary>
  550. /// <param name="db">SqlSugarScope 实例</param>
  551. /// <param name="config">数据库连接配置</param>
  552. private static void InitSeedData(SqlSugarScope db, DbConnectionConfig config)
  553. {
  554. _isHandlingSeedData = true;
  555. try
  556. {
  557. Log.Information($"初始化种子数据 {config.DbType} - {config.ConfigId}");
  558. var seedDataTypes = GetSeedDataTypes(config);
  559. int count = 0, sum = seedDataTypes.Count;
  560. foreach (var seedType in seedDataTypes)
  561. {
  562. var entityType = seedType.GetInterfaces().First().GetGenericArguments().First();
  563. if (!IsEntityForConfig(entityType, config)) continue;
  564. var seedData = GetSeedData(seedType)?.ToList();
  565. if (seedData == null) continue;
  566. AdjustSeedDataIds(seedData, config);
  567. try
  568. {
  569. var dbProvider = db.GetConnectionScope(config.ConfigId);
  570. InsertOrUpdateSeedData(dbProvider, seedType, entityType, seedData, config, ref count, sum);
  571. }
  572. catch (Exception ex)
  573. {
  574. throw Oops.Oh($"初始化种子数据失败: Seed={seedType.FullName}, Entity={entityType.FullName}, ConfigId={config.ConfigId}", ex);
  575. }
  576. }
  577. }
  578. finally
  579. {
  580. _isHandlingSeedData = false;
  581. }
  582. }
  583. /// <summary>
  584. /// 获取种子数据类型
  585. /// </summary>
  586. /// <param name="config">数据库连接配置</param>
  587. /// <returns>种子数据类型列表</returns>
  588. private static List<Type> GetSeedDataTypes(DbConnectionConfig config)
  589. {
  590. return App.EffectiveTypes
  591. .Where(u => !u.IsInterface && !u.IsAbstract && u.IsClass && u.GetInterfaces().Any(i => i.HasImplementedRawGeneric(typeof(ISqlSugarEntitySeedData<>))))
  592. .WhereIF(config.SeedSettings.EnableIncreSeed, u => u.IsDefined(typeof(IncreSeedAttribute), false))
  593. .OrderBy(u => u.GetCustomAttributes(typeof(SeedDataAttribute), false).Length > 0 ? ((SeedDataAttribute)u.GetCustomAttributes(typeof(SeedDataAttribute), false)[0]).Order : 0)
  594. .ToList();
  595. }
  596. /// <summary>
  597. /// 获取种子数据
  598. /// </summary>
  599. /// <param name="seedType">种子数据类型</param>
  600. /// <returns>种子数据列表</returns>
  601. private static IEnumerable<object> GetSeedData(Type seedType)
  602. {
  603. var instance = Activator.CreateInstance(seedType);
  604. var hasDataMethod = seedType.GetMethod("HasData");
  605. return ((IEnumerable)hasDataMethod?.Invoke(instance, null))?.Cast<object>();
  606. }
  607. /// <summary>
  608. /// 调整种子数据的 ID
  609. /// </summary>
  610. /// <param name="seedData">种子数据列表</param>
  611. /// <param name="config">数据库连接配置</param>
  612. private static void AdjustSeedDataIds(IEnumerable<object> seedData, DbConnectionConfig config)
  613. {
  614. var seedId = config.ConfigId.ToLong();
  615. foreach (var data in seedData)
  616. {
  617. var idProperty = data.GetType().GetProperty(nameof(EntityBaseId.Id));
  618. if (idProperty == null || idProperty.PropertyType != typeof(Int64)) continue;
  619. var idValue = idProperty.GetValue(data);
  620. if (idValue == null || idValue.ToString() == "0" || string.IsNullOrWhiteSpace(idValue.ToString()))
  621. {
  622. idProperty.SetValue(data, ++seedId);
  623. }
  624. }
  625. }
  626. /// <summary>
  627. /// 插入或更新种子数据
  628. /// </summary>
  629. /// <param name="dbProvider">SqlSugarScopeProvider 实例</param>
  630. /// <param name="seedType">种子数据类型</param>
  631. /// <param name="entityType">实体类型</param>
  632. /// <param name="seedData">种子数据列表</param>
  633. /// <param name="config">数据库连接配置</param>
  634. /// <param name="count">当前处理的数量</param>
  635. /// <param name="sum">总数量</param>
  636. private static void InsertOrUpdateSeedData(SqlSugarScopeProvider dbProvider, Type seedType, Type entityType, IEnumerable<object> seedData, DbConnectionConfig config, ref int count, int sum)
  637. {
  638. var entityInfo = dbProvider.EntityMaintenance.GetEntityInfo(entityType);
  639. var dataList = seedData.ToList();
  640. if (entityType.GetCustomAttribute<SplitTableAttribute>(true) != null)
  641. {
  642. var initMethod = seedType.GetMethod("Init");
  643. initMethod?.Invoke(Activator.CreateInstance(seedType), new object[] { dbProvider });
  644. }
  645. else
  646. {
  647. int updateCount = 0, insertCount = 0;
  648. if (entityInfo.Columns.Any(u => u.IsPrimarykey))
  649. {
  650. var storage = dbProvider.StorageableByObject(dataList).ToStorage();
  651. if (seedType.GetCustomAttribute<IgnoreUpdateSeedAttribute>() == null)
  652. {
  653. updateCount = storage.AsUpdateable
  654. .IgnoreColumns(entityInfo.Columns
  655. .Where(u => u.PropertyInfo.GetCustomAttribute<IgnoreUpdateSeedColumnAttribute>() != null)
  656. .Select(u => u.PropertyName).ToArray())
  657. .ExecuteCommand();
  658. }
  659. insertCount = storage.AsInsertable.ExecuteCommand();
  660. }
  661. else
  662. {
  663. if (!dbProvider.Queryable(entityInfo.DbTableName, entityInfo.DbTableName).Any())
  664. {
  665. insertCount = dataList.Count;
  666. dbProvider.InsertableByObject(dataList).ExecuteCommand();
  667. }
  668. }
  669. Console.WriteLine($"添加数据 {entityInfo.DbTableName,-32} ({config.ConfigId} - {Interlocked.Increment(ref count):D003}/{sum:D003},数据量:{dataList.Count:D003},插入 {insertCount:D003} 条记录,修改 {updateCount:D003} 条记录)");
  670. }
  671. }
  672. /// <summary>
  673. /// 初始化租户业务数据库
  674. /// </summary>
  675. /// <param name="iTenant"></param>
  676. /// <param name="config"></param>
  677. public static void InitTenantDatabase(ITenant iTenant, DbConnectionConfig config)
  678. {
  679. SetDbConfig(config);
  680. if (!iTenant.IsAnyConnection(config.ConfigId.ToString()))
  681. iTenant.AddConnection(config);
  682. var db = iTenant.GetConnectionScope(config.ConfigId.ToString());
  683. db.DbMaintenance.CreateDatabase();
  684. // 获取所有业务表-初始化租户库表结构(排除系统表、日志表、特定库表)
  685. var entityTypes = App.EffectiveTypes
  686. .Where(u => !u.GetCustomAttributes<IgnoreTableAttribute>().Any())
  687. .Where(u => !u.IsInterface && !u.IsAbstract && u.IsClass && u.IsDefined(typeof(SugarTable), false) &&
  688. !u.IsDefined(typeof(SysTableAttribute), false) && !u.IsDefined(typeof(LogTableAttribute), false) && !u.IsDefined(typeof(TenantAttribute), false)).ToList();
  689. if (entityTypes.Count == 0) return;
  690. foreach (var entityType in entityTypes)
  691. {
  692. var splitTable = entityType.GetCustomAttribute<SplitTableAttribute>();
  693. if (splitTable == null)
  694. db.CodeFirst.InitTables(entityType);
  695. else
  696. db.CodeFirst.SplitTables().InitTables(entityType);
  697. }
  698. }
  699. /// <summary>
  700. /// 简单的重试机制
  701. /// </summary>
  702. /// <param name="action"></param>
  703. /// <param name="maxRetry"></param>
  704. /// <param name="retryIntervalMs"></param>
  705. private static void Retry(Action action, int maxRetry, int retryIntervalMs)
  706. {
  707. int attempt = 0;
  708. while (true)
  709. {
  710. try
  711. {
  712. action();
  713. return;
  714. }
  715. catch (Exception ex) when (IsRetryableDatabaseInitException(ex))
  716. {
  717. if (++attempt >= maxRetry)
  718. {
  719. Log.Error($"简单的重试机制:{ex.Message}"); throw;
  720. }
  721. Log.Information($"数据库初始化异常,正在重试... (尝试 {attempt}/{maxRetry}) {ex.Message}");
  722. Thread.Sleep(retryIntervalMs);
  723. }
  724. }
  725. }
  726. private static int ResolveInitTableMaxDegreeOfParallelism(DbConnectionConfig config)
  727. {
  728. var value = config.TableSettings?.InitTableMaxDegreeOfParallelism ?? 1;
  729. return value <= 0 ? 1 : value;
  730. }
  731. private static int ResolveInitTableRetryCount(DbConnectionConfig config)
  732. {
  733. var value = config.TableSettings?.InitTableRetryCount ?? 3;
  734. return value <= 0 ? 1 : value;
  735. }
  736. private static int ResolveInitTableRetryIntervalMs(DbConnectionConfig config)
  737. {
  738. var value = config.TableSettings?.InitTableRetryIntervalMs ?? 2000;
  739. return value < 0 ? 2000 : value;
  740. }
  741. private static int ResolveInitTableCommandTimeout(DbConnectionConfig config)
  742. {
  743. var value = config.TableSettings?.InitTableCommandTimeoutSeconds ?? 120;
  744. return value <= 0 ? 120 : value;
  745. }
  746. private static bool IsRetryableDatabaseInitException(Exception ex)
  747. {
  748. if (ex is SqliteException sqliteException && sqliteException.SqliteErrorCode == 5)
  749. return true;
  750. var current = ex;
  751. while (current != null)
  752. {
  753. if (current is TimeoutException)
  754. return true;
  755. var typeName = current.GetType().FullName ?? "";
  756. var message = current.Message ?? "";
  757. if (typeName.Contains("SqlSugarException", StringComparison.OrdinalIgnoreCase) &&
  758. ContainsRetryableDatabaseMessage(message))
  759. return true;
  760. if (typeName.Contains("MySql", StringComparison.OrdinalIgnoreCase) &&
  761. ContainsRetryableDatabaseMessage(message))
  762. return true;
  763. if (ContainsRetryableDatabaseMessage(message))
  764. return true;
  765. current = current.InnerException;
  766. }
  767. return false;
  768. }
  769. private static bool ContainsRetryableDatabaseMessage(string message)
  770. {
  771. return message.Contains("timeout", StringComparison.OrdinalIgnoreCase)
  772. || message.Contains("timed out", StringComparison.OrdinalIgnoreCase)
  773. || message.Contains("Lock wait timeout", StringComparison.OrdinalIgnoreCase)
  774. || message.Contains("Deadlock found", StringComparison.OrdinalIgnoreCase)
  775. || message.Contains("database is locked", StringComparison.OrdinalIgnoreCase)
  776. || message.Contains("SQLITE_BUSY", StringComparison.OrdinalIgnoreCase);
  777. }
  778. }