SqlSugarSetup.cs 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294
  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. SqlServerCodeFirstNvarchar = true // 采用Nvarchar
  62. };
  63. }
  64. /// <summary>
  65. /// 配置Aop
  66. /// </summary>
  67. /// <param name="db"></param>
  68. public static void SetDbAop(SqlSugarScopeProvider db)
  69. {
  70. var config = db.CurrentConnectionConfig;
  71. // 设置超时时间
  72. db.Ado.CommandTimeOut = 30;
  73. // 打印SQL语句
  74. db.Aop.OnLogExecuting = (sql, pars) =>
  75. {
  76. var originColor = Console.ForegroundColor;
  77. if (sql.StartsWith("SELECT", StringComparison.OrdinalIgnoreCase))
  78. Console.ForegroundColor = ConsoleColor.Green;
  79. if (sql.StartsWith("UPDATE", StringComparison.OrdinalIgnoreCase) || sql.StartsWith("INSERT", StringComparison.OrdinalIgnoreCase))
  80. Console.ForegroundColor = ConsoleColor.Yellow;
  81. if (sql.StartsWith("DELETE", StringComparison.OrdinalIgnoreCase))
  82. Console.ForegroundColor = ConsoleColor.Red;
  83. Console.WriteLine("【" + DateTime.Now + "——执行SQL】\r\n" + UtilMethods.GetSqlString(config.DbType, sql, pars) + "\r\n");
  84. Console.ForegroundColor = originColor;
  85. App.PrintToMiniProfiler("SqlSugar", "Info", sql + "\r\n" + db.Utilities.SerializeObject(pars.ToDictionary(it => it.ParameterName, it => it.Value)));
  86. };
  87. db.Aop.OnError = (ex) =>
  88. {
  89. if (ex.Parametres == null) return;
  90. var originColor = Console.ForegroundColor;
  91. Console.ForegroundColor = ConsoleColor.DarkRed;
  92. var pars = db.Utilities.SerializeObject(((SugarParameter[])ex.Parametres).ToDictionary(it => it.ParameterName, it => it.Value));
  93. Console.WriteLine("【" + DateTime.Now + "——错误SQL】\r\n" + UtilMethods.GetSqlString(config.DbType, ex.Sql, (SugarParameter[])ex.Parametres) + "\r\n");
  94. Console.ForegroundColor = originColor;
  95. App.PrintToMiniProfiler("SqlSugar", "Error", $"{ex.Message}{Environment.NewLine}{ex.Sql}{pars}{Environment.NewLine}");
  96. };
  97. // 数据审计
  98. db.Aop.DataExecuting = (oldValue, entityInfo) =>
  99. {
  100. if (entityInfo.OperationType == DataFilterType.InsertByObject)
  101. {
  102. // 主键(long类型)且没有值的---赋值雪花Id
  103. if (entityInfo.EntityColumnInfo.IsPrimarykey && entityInfo.EntityColumnInfo.PropertyInfo.PropertyType == typeof(long))
  104. {
  105. var id = entityInfo.EntityColumnInfo.PropertyInfo.GetValue(entityInfo.EntityValue);
  106. if (id == null || (long)id == 0)
  107. entityInfo.SetValue(YitIdHelper.NextId());
  108. }
  109. if (entityInfo.PropertyName == "CreateTime")
  110. entityInfo.SetValue(DateTime.Now);
  111. if (App.User != null)
  112. {
  113. if (entityInfo.PropertyName == "TenantId")
  114. {
  115. var tenantId = ((dynamic)entityInfo.EntityValue).TenantId;
  116. if (tenantId == null || tenantId == 0)
  117. entityInfo.SetValue(App.User.FindFirst(ClaimConst.TenantId)?.Value);
  118. }
  119. if (entityInfo.PropertyName == "CreateUserId")
  120. {
  121. var createUserId = ((dynamic)entityInfo.EntityValue).CreateUserId;
  122. if (createUserId == 0 || createUserId == null)
  123. entityInfo.SetValue(App.User.FindFirst(ClaimConst.UserId)?.Value);
  124. }
  125. if (entityInfo.PropertyName == "CreateOrgId")
  126. {
  127. var createOrgId = ((dynamic)entityInfo.EntityValue).CreateOrgId;
  128. if (createOrgId == 0 || createOrgId == null)
  129. entityInfo.SetValue(App.User.FindFirst(ClaimConst.OrgId)?.Value);
  130. }
  131. }
  132. }
  133. if (entityInfo.OperationType == DataFilterType.UpdateByObject)
  134. {
  135. if (entityInfo.PropertyName == "UpdateTime")
  136. entityInfo.SetValue(DateTime.Now);
  137. if (entityInfo.PropertyName == "UpdateUserId")
  138. entityInfo.SetValue(App.User?.FindFirst(ClaimConst.UserId)?.Value);
  139. }
  140. };
  141. // 超管时排除各种过滤器
  142. if (App.User?.FindFirst(ClaimConst.AccountType)?.Value == ((int)AccountTypeEnum.SuperAdmin).ToString())
  143. return;
  144. // 配置实体假删除过滤器
  145. db.QueryFilter.AddTableFilter<IDeletedFilter>(u => u.IsDelete == false);
  146. // 配置租户过滤器
  147. var tenantId = App.User?.FindFirst(ClaimConst.TenantId)?.Value;
  148. if (!string.IsNullOrWhiteSpace(tenantId))
  149. db.QueryFilter.AddTableFilter<ITenantIdFilter>(u => u.TenantId == long.Parse(tenantId));
  150. // 配置用户机构(数据范围)过滤器
  151. SqlSugarFilter.SetOrgEntityFilter(db);
  152. // 配置自定义过滤器
  153. SqlSugarFilter.SetCustomEntityFilter(db);
  154. }
  155. /// <summary>
  156. /// 开启库表差异化日志
  157. /// </summary>
  158. /// <param name="db"></param>
  159. /// <param name="config"></param>
  160. private static void SetDbDiffLog(SqlSugarScopeProvider db, DbConnectionConfig config)
  161. {
  162. if (!config.EnableDiffLog) return;
  163. db.Aop.OnDiffLogEvent = async u =>
  164. {
  165. var logDiff = new SysLogDiff
  166. {
  167. // 操作后记录(字段描述、列名、值、表名、表描述)
  168. AfterData = JsonConvert.SerializeObject(u.AfterData),
  169. // 操作前记录(字段描述、列名、值、表名、表描述)
  170. BeforeData = JsonConvert.SerializeObject(u.BeforeData),
  171. // 传进来的对象
  172. BusinessData = JsonConvert.SerializeObject(u.BusinessData),
  173. // 枚举(insert、update、delete)
  174. DiffType = u.DiffType.ToString(),
  175. Sql = UtilMethods.GetSqlString(config.DbType, u.Sql, u.Parameters),
  176. Parameters = JsonConvert.SerializeObject(u.Parameters),
  177. Elapsed = u.Time == null ? 0 : (long)u.Time.Value.TotalMilliseconds
  178. };
  179. await db.Insertable(logDiff).ExecuteCommandAsync();
  180. Console.ForegroundColor = ConsoleColor.Red;
  181. Console.WriteLine(DateTime.Now + $"\r\n*****差异日志开始*****\r\n{Environment.NewLine}{JsonConvert.SerializeObject(logDiff)}{Environment.NewLine}*****差异日志结束*****\r\n");
  182. };
  183. }
  184. /// <summary>
  185. /// 初始化数据库
  186. /// </summary>
  187. /// <param name="db"></param>
  188. /// <param name="config"></param>
  189. private static void InitDatabase(SqlSugarScope db, DbConnectionConfig config)
  190. {
  191. if (!config.EnableInitDb) return;
  192. SqlSugarScopeProvider dbProvider = db.GetConnectionScope(config.ConfigId);
  193. // 创建数据库
  194. if (config.DbType != SqlSugar.DbType.Oracle)
  195. dbProvider.DbMaintenance.CreateDatabase();
  196. // 获取所有实体表-初始化表结构
  197. var entityTypes = App.EffectiveTypes.Where(u => !u.IsInterface && !u.IsAbstract && u.IsClass && u.IsDefined(typeof(SugarTable), false));
  198. if (!entityTypes.Any()) return;
  199. foreach (var entityType in entityTypes)
  200. {
  201. var tAtt = entityType.GetCustomAttribute<TenantAttribute>();
  202. if (tAtt != null && tAtt.configId.ToString() != config.ConfigId) continue;
  203. if (tAtt == null && config.ConfigId != SqlSugarConst.ConfigId) continue;
  204. var splitTable = entityType.GetCustomAttribute<SplitTableAttribute>();
  205. if (splitTable == null)
  206. dbProvider.CodeFirst.InitTables(entityType);
  207. else
  208. dbProvider.CodeFirst.SplitTables().InitTables(entityType);
  209. }
  210. if (!config.EnableInitSeed) return;
  211. // 获取所有种子配置-初始化数据
  212. var seedDataTypes = App.EffectiveTypes.Where(u => !u.IsInterface && !u.IsAbstract && u.IsClass
  213. && u.GetInterfaces().Any(i => i.HasImplementedRawGeneric(typeof(ISqlSugarEntitySeedData<>))));
  214. if (!seedDataTypes.Any()) return;
  215. foreach (var seedType in seedDataTypes)
  216. {
  217. var instance = Activator.CreateInstance(seedType);
  218. var hasDataMethod = seedType.GetMethod("HasData");
  219. var seedData = ((IEnumerable)hasDataMethod?.Invoke(instance, null))?.Cast<object>();
  220. if (seedData == null) continue;
  221. var entityType = seedType.GetInterfaces().First().GetGenericArguments().First();
  222. var tAtt = entityType.GetCustomAttribute<TenantAttribute>();
  223. if (tAtt != null && tAtt.configId.ToString() != config.ConfigId) continue;
  224. if (tAtt == null && config.ConfigId != SqlSugarConst.ConfigId) continue;
  225. var entityInfo = dbProvider.EntityMaintenance.GetEntityInfo(entityType);
  226. if (entityInfo.Columns.Any(u => u.IsPrimarykey))
  227. {
  228. // 按主键进行批量增加和更新
  229. var storage = dbProvider.StorageableByObject(seedData.ToList()).ToStorage();
  230. storage.AsInsertable.ExecuteCommand();
  231. var ignoreUpdate = hasDataMethod.GetCustomAttribute<IgnoreUpdateAttribute>();
  232. if (ignoreUpdate == null) storage.AsUpdateable.ExecuteCommand();
  233. }
  234. else
  235. {
  236. // 无主键则只进行插入
  237. if (!dbProvider.Queryable(entityInfo.DbTableName, entityInfo.DbTableName).Any())
  238. dbProvider.InsertableByObject(seedData.ToList()).ExecuteCommand();
  239. }
  240. }
  241. }
  242. /// <summary>
  243. /// 初始化租户业务数据库
  244. /// </summary>
  245. /// <param name="itenant"></param>
  246. /// <param name="config"></param>
  247. public static void InitTenantDatabase(ITenant itenant, DbConnectionConfig config)
  248. {
  249. SetDbConfig(config);
  250. itenant.AddConnection(config);
  251. var db = itenant.GetConnectionScope(config.ConfigId);
  252. db.DbMaintenance.CreateDatabase();
  253. // 获取所有实体表-初始化租户业务表
  254. var entityTypes = App.EffectiveTypes.Where(u => !u.IsInterface && !u.IsAbstract && u.IsClass
  255. && u.IsDefined(typeof(SugarTable), false) && !u.IsDefined(typeof(SystemTableAttribute), false));
  256. if (!entityTypes.Any()) return;
  257. foreach (var entityType in entityTypes)
  258. {
  259. var splitTable = entityType.GetCustomAttribute<SplitTableAttribute>();
  260. if (splitTable == null)
  261. db.CodeFirst.InitTables(entityType);
  262. else
  263. db.CodeFirst.SplitTables().InitTables(entityType);
  264. }
  265. }
  266. }