SqlSugarSetup.cs 43 KB

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