SqlSugarSetup.cs 13 KB

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