SqlSugarSetup.cs 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278
  1. namespace Admin.NET.Core;
  2. public static class SqlSugarSetup
  3. {
  4. /// <summary>
  5. /// Sqlsugar 上下文初始化
  6. /// </summary>
  7. /// <param name="services"></param>
  8. public static void AddSqlSugar(this IServiceCollection services)
  9. {
  10. var dbOptions = App.GetOptions<DbConnectionOptions>();
  11. dbOptions.ConnectionConfigs.ForEach(config =>
  12. {
  13. SetDbConfig(config);
  14. });
  15. SqlSugarScope sqlSugar = new(dbOptions.ConnectionConfigs.Adapt<List<ConnectionConfig>>(), db =>
  16. {
  17. dbOptions.ConnectionConfigs.ForEach(config =>
  18. {
  19. var dbProvider = db.GetConnectionScope(config.ConfigId);
  20. SetDbAop(dbProvider);
  21. SetDbDiffLog(dbProvider, config);
  22. });
  23. });
  24. // 初始化数据库表结构及种子数据
  25. dbOptions.ConnectionConfigs.ForEach(config =>
  26. {
  27. InitDatabase(sqlSugar, config);
  28. });
  29. services.AddSingleton<ISqlSugarClient>(sqlSugar); // 单例注册
  30. services.AddScoped(typeof(SqlSugarRepository<>)); // 仓储注册
  31. services.AddUnitOfWork<SqlSugarUnitOfWork>(); // 事务与工作单元注册
  32. }
  33. /// <summary>
  34. /// 配置连接属性
  35. /// </summary>
  36. /// <param name="config"></param>
  37. private static void SetDbConfig(DbConnectionConfig config)
  38. {
  39. var configureExternalServices = new ConfigureExternalServices
  40. {
  41. EntityNameService = (type, entity) => // 处理表
  42. {
  43. if (config.EnableUnderLine && !entity.DbTableName.Contains('_'))
  44. entity.DbTableName = UtilMethods.ToUnderLine(entity.DbTableName); // 驼峰转下划线
  45. },
  46. EntityService = (type, column) => // 处理列
  47. {
  48. if (new NullabilityInfoContext().Create(type).WriteState is NullabilityState.Nullable)
  49. column.IsNullable = true;
  50. if (config.EnableUnderLine && !column.IsIgnore && !column.DbColumnName.Contains('_'))
  51. column.DbColumnName = UtilMethods.ToUnderLine(column.DbColumnName); // 驼峰转下划线
  52. },
  53. DataInfoCacheService = new SqlSugarCache(),
  54. };
  55. config.ConfigureExternalServices = configureExternalServices;
  56. config.InitKeyType = InitKeyType.Attribute;
  57. config.IsAutoCloseConnection = true;
  58. config.MoreSettings = new ConnMoreSettings
  59. {
  60. IsAutoRemoveDataCache = true
  61. };
  62. }
  63. /// <summary>
  64. /// 配置Aop
  65. /// </summary>
  66. /// <param name="db"></param>
  67. public static void SetDbAop(SqlSugarScopeProvider db)
  68. {
  69. var config = db.CurrentConnectionConfig;
  70. // 设置超时时间
  71. db.Ado.CommandTimeOut = 30;
  72. // 打印SQL语句
  73. db.Aop.OnLogExecuting = (sql, pars) =>
  74. {
  75. if (sql.StartsWith("SELECT", StringComparison.OrdinalIgnoreCase))
  76. Console.ForegroundColor = ConsoleColor.Green;
  77. if (sql.StartsWith("UPDATE", StringComparison.OrdinalIgnoreCase) || sql.StartsWith("INSERT", StringComparison.OrdinalIgnoreCase))
  78. Console.ForegroundColor = ConsoleColor.White;
  79. if (sql.StartsWith("DELETE", StringComparison.OrdinalIgnoreCase))
  80. Console.ForegroundColor = ConsoleColor.Blue;
  81. Console.WriteLine("【" + DateTime.Now + "——执行SQL】\r\n" + UtilMethods.GetSqlString(config.DbType, sql, pars) + "\r\n");
  82. App.PrintToMiniProfiler("SqlSugar", "Info", sql + "\r\n" + db.Utilities.SerializeObject(pars.ToDictionary(it => it.ParameterName, it => it.Value)));
  83. };
  84. db.Aop.OnError = (ex) =>
  85. {
  86. if (ex.Parametres == null) return;
  87. Console.ForegroundColor = ConsoleColor.Red;
  88. var pars = db.Utilities.SerializeObject(((SugarParameter[])ex.Parametres).ToDictionary(it => it.ParameterName, it => it.Value));
  89. Console.WriteLine("【" + DateTime.Now + "——错误SQL】\r\n" + UtilMethods.GetSqlString(config.DbType, ex.Sql, (SugarParameter[])ex.Parametres) + "\r\n");
  90. App.PrintToMiniProfiler("SqlSugar", "Error", $"{ex.Message}{Environment.NewLine}{ex.Sql}{pars}{Environment.NewLine}");
  91. };
  92. // 数据审计
  93. db.Aop.DataExecuting = (oldValue, entityInfo) =>
  94. {
  95. if (entityInfo.OperationType == DataFilterType.InsertByObject)
  96. {
  97. // 主键(long类型)且没有值的---赋值雪花Id
  98. if (entityInfo.EntityColumnInfo.IsPrimarykey && entityInfo.EntityColumnInfo.PropertyInfo.PropertyType == typeof(long))
  99. {
  100. var id = entityInfo.EntityColumnInfo.PropertyInfo.GetValue(entityInfo.EntityValue);
  101. if (id == null || (long)id == 0)
  102. entityInfo.SetValue(YitIdHelper.NextId());
  103. }
  104. if (entityInfo.PropertyName == "CreateTime")
  105. entityInfo.SetValue(DateTime.Now);
  106. if (App.User != null)
  107. {
  108. if (entityInfo.PropertyName == "TenantId")
  109. {
  110. var tenantId = ((dynamic)entityInfo.EntityValue).TenantId;
  111. if (tenantId == null || tenantId == 0)
  112. entityInfo.SetValue(App.User.FindFirst(ClaimConst.TenantId)?.Value);
  113. }
  114. if (entityInfo.PropertyName == "CreateUserId")
  115. entityInfo.SetValue(App.User.FindFirst(ClaimConst.UserId)?.Value);
  116. if (entityInfo.PropertyName == "CreateOrgId")
  117. entityInfo.SetValue(App.User.FindFirst(ClaimConst.OrgId)?.Value);
  118. }
  119. }
  120. if (entityInfo.OperationType == DataFilterType.UpdateByObject)
  121. {
  122. if (entityInfo.PropertyName == "UpdateTime")
  123. entityInfo.SetValue(DateTime.Now);
  124. if (entityInfo.PropertyName == "UpdateUserId")
  125. entityInfo.SetValue(App.User?.FindFirst(ClaimConst.UserId)?.Value);
  126. }
  127. };
  128. // 超管时排除各种过滤器
  129. if (App.User?.FindFirst(ClaimConst.AccountType)?.Value == ((int)AccountTypeEnum.SuperAdmin).ToString())
  130. return;
  131. // 配置实体假删除过滤器
  132. db.QueryFilter.AddTableFilter<IDeletedFilter>(u => u.IsDelete == false);
  133. // 配置租户过滤器
  134. var tenantId = App.User?.FindFirst(ClaimConst.TenantId)?.Value;
  135. if (!string.IsNullOrWhiteSpace(tenantId))
  136. db.QueryFilter.AddTableFilter<ITenantIdFilter>(u => u.TenantId == long.Parse(tenantId));
  137. // 配置用户机构(数据范围)过滤器
  138. SqlSugarFilter.SetOrgEntityFilter(db);
  139. // 配置自定义过滤器
  140. SqlSugarFilter.SetCustomEntityFilter(db);
  141. }
  142. /// <summary>
  143. /// 开启库表差异化日志
  144. /// </summary>
  145. /// <param name="db"></param>
  146. /// <param name="config"></param>
  147. private static void SetDbDiffLog(SqlSugarScopeProvider db, DbConnectionConfig config)
  148. {
  149. if (!config.EnableDiffLog) return;
  150. db.Aop.OnDiffLogEvent = async u =>
  151. {
  152. var logDiff = new SysLogDiff
  153. {
  154. // 操作后记录(字段描述、列名、值、表名、表描述)
  155. AfterData = JsonConvert.SerializeObject(u.AfterData),
  156. // 操作前记录(字段描述、列名、值、表名、表描述)
  157. BeforeData = JsonConvert.SerializeObject(u.BeforeData),
  158. // 传进来的对象
  159. BusinessData = JsonConvert.SerializeObject(u.BusinessData),
  160. // 枚举(insert、update、delete)
  161. DiffType = u.DiffType.ToString(),
  162. Sql = UtilMethods.GetSqlString(config.DbType, u.Sql, u.Parameters),
  163. Parameters = JsonConvert.SerializeObject(u.Parameters),
  164. Duration = u.Time == null ? 0 : (long)u.Time.Value.TotalMilliseconds
  165. };
  166. await db.Insertable(logDiff).ExecuteCommandAsync();
  167. Console.ForegroundColor = ConsoleColor.Red;
  168. Console.WriteLine(DateTime.Now + $"\r\n*****差异日志开始*****\r\n{Environment.NewLine}{JsonConvert.SerializeObject(logDiff)}{Environment.NewLine}*****差异日志结束*****\r\n");
  169. };
  170. }
  171. /// <summary>
  172. /// 初始化数据库
  173. /// </summary>
  174. /// <param name="db"></param>
  175. /// <param name="config"></param>
  176. private static void InitDatabase(SqlSugarScope db, DbConnectionConfig config)
  177. {
  178. if (!config.EnableInitDb) return;
  179. SqlSugarScopeProvider dbProvider = db.GetConnectionScope(config.ConfigId);
  180. // 创建数据库
  181. if (config.DbType != SqlSugar.DbType.Oracle)
  182. dbProvider.DbMaintenance.CreateDatabase();
  183. // 获取所有实体表-初始化表结构
  184. var entityTypes = App.EffectiveTypes.Where(u => !u.IsInterface && !u.IsAbstract && u.IsClass && u.IsDefined(typeof(SugarTable), false));
  185. if (!entityTypes.Any()) return;
  186. foreach (var entityType in entityTypes)
  187. {
  188. var tAtt = entityType.GetCustomAttribute<TenantAttribute>();
  189. if (tAtt != null && tAtt.configId.ToString() != config.ConfigId) continue;
  190. if (tAtt == null && config.ConfigId != SqlSugarConst.ConfigId) continue;
  191. var splitTable = entityType.GetCustomAttribute<SplitTableAttribute>();
  192. if (splitTable == null)
  193. dbProvider.CodeFirst.InitTables(entityType);
  194. else
  195. dbProvider.CodeFirst.SplitTables().InitTables(entityType);
  196. }
  197. // 获取所有种子配置-初始化数据
  198. var seedDataTypes = App.EffectiveTypes.Where(u => !u.IsInterface && !u.IsAbstract && u.IsClass
  199. && u.GetInterfaces().Any(i => i.HasImplementedRawGeneric(typeof(ISqlSugarEntitySeedData<>))));
  200. if (!seedDataTypes.Any()) return;
  201. foreach (var seedType in seedDataTypes)
  202. {
  203. var instance = Activator.CreateInstance(seedType);
  204. var hasDataMethod = seedType.GetMethod("HasData");
  205. var seedData = ((IEnumerable)hasDataMethod?.Invoke(instance, null))?.Cast<object>();
  206. if (seedData == null) continue;
  207. var entityType = seedType.GetInterfaces().First().GetGenericArguments().First();
  208. var tAtt = entityType.GetCustomAttribute<TenantAttribute>();
  209. if (tAtt != null && tAtt.configId.ToString() != config.ConfigId) continue;
  210. if (tAtt == null && config.ConfigId != SqlSugarConst.ConfigId) continue;
  211. var entityInfo = dbProvider.EntityMaintenance.GetEntityInfo(entityType);
  212. if (entityInfo.Columns.Any(u => u.IsPrimarykey))
  213. {
  214. // 按主键进行批量增加和更新
  215. var storage = dbProvider.StorageableByObject(seedData.ToList()).ToStorage();
  216. storage.AsInsertable.ExecuteCommand();
  217. var ignoreUpdate = hasDataMethod.GetCustomAttribute<IgnoreUpdateAttribute>();
  218. if (ignoreUpdate == null) storage.AsUpdateable.ExecuteCommand();
  219. }
  220. else
  221. {
  222. // 无主键则只进行插入
  223. if (!dbProvider.Queryable(entityInfo.DbTableName, entityInfo.DbTableName).Any())
  224. dbProvider.InsertableByObject(seedData.ToList()).ExecuteCommand();
  225. }
  226. }
  227. }
  228. /// <summary>
  229. /// 初始化租户业务数据库
  230. /// </summary>
  231. /// <param name="itenant"></param>
  232. /// <param name="config"></param>
  233. public static void InitTenantDatabase(ITenant itenant, DbConnectionConfig config)
  234. {
  235. SetDbConfig(config);
  236. itenant.AddConnection(config);
  237. var db = itenant.GetConnectionScope(config.ConfigId);
  238. db.DbMaintenance.CreateDatabase();
  239. // 获取所有实体表-初始化租户业务表
  240. var entityTypes = App.EffectiveTypes.Where(u => !u.IsInterface && !u.IsAbstract && u.IsClass
  241. && u.IsDefined(typeof(SugarTable), false) && !u.IsDefined(typeof(SystemTableAttribute), false));
  242. if (!entityTypes.Any()) return;
  243. foreach (var entityType in entityTypes)
  244. {
  245. var splitTable = entityType.GetCustomAttribute<SplitTableAttribute>();
  246. if (splitTable == null)
  247. db.CodeFirst.InitTables(entityType);
  248. else
  249. db.CodeFirst.SplitTables().InitTables(entityType);
  250. }
  251. }
  252. }