SysLangTextCacheService.cs 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343
  1. // Admin.NET 项目的版权、商标、专利和其他相关权利均受相应法律法规的保护。使用本项目应遵守相关法律法规和许可证的要求。
  2. //
  3. // 本项目主要遵循 MIT 许可证和 Apache 许可证(版本 2.0)进行分发和使用。许可证位于源代码树根目录中的 LICENSE-MIT 和 LICENSE-APACHE 文件。
  4. //
  5. // 不得利用本项目从事危害国家安全、扰乱社会秩序、侵犯他人合法权益等法律法规禁止的活动!任何基于本项目二次开发而产生的一切法律纠纷和责任,我们不承担任何责任!
  6. namespace Admin.NET.Core.Service;
  7. public class LangFieldMap<TEntity>
  8. {
  9. /// <summary>实体名,如 Product</summary>
  10. public string EntityName { get; set; }
  11. /// <summary>字段名,如 Name/Description</summary>
  12. public string FieldName { get; set; }
  13. /// <summary>如何取主键ID</summary>
  14. public Func<TEntity, long> IdSelector { get; set; }
  15. /// <summary>如何写回翻译值</summary>
  16. public Action<TEntity, string> SetTranslatedValue { get; set; }
  17. }
  18. /// <summary>
  19. /// 翻译缓存服务 🧩
  20. /// </summary>
  21. [ApiDescriptionSettings(Order = 100, Description = "翻译缓存服务")]
  22. public class SysLangTextCacheService : IDynamicApiController, ITransient
  23. {
  24. private readonly SysCacheService _sysCacheService;
  25. private readonly SqlSugarRepository<SysLangText> _sysLangTextRep;
  26. private TimeSpan expireSeconds = TimeSpan.FromHours(1);
  27. public SysLangTextCacheService(
  28. SysCacheService sysCacheService,
  29. SqlSugarRepository<SysLangText> sysLangTextRep)
  30. {
  31. _sysCacheService = sysCacheService;
  32. _sysLangTextRep = sysLangTextRep;
  33. }
  34. private string BuildKey(string entityName, string fieldName, long entityId, string langCode)
  35. {
  36. return $"LangCache_{entityName}_{fieldName}_{entityId}_{langCode}";
  37. }
  38. /// <summary>
  39. /// 【单条翻译获取】
  40. /// 根据实体类型、字段、主键ID 和语言编码获取翻译内容。<br/>
  41. /// 适用于:小表(如菜单、字典),可设置较长缓存时间。<br/>
  42. /// <br/>
  43. /// 【示例】<br/>
  44. /// var content = await _sysLangTextCacheService.GetTranslation("Product", "Name", 123, "en_US");
  45. /// </summary>
  46. /// <param name="entityName">实体名称,如 "Product"</param>
  47. /// <param name="fieldName">字段名称,如 "Name"</param>
  48. /// <param name="entityId">实体主键ID</param>
  49. /// <param name="langCode">语言编码,如 "zh_CN"</param>
  50. /// <returns>翻译后的内容(若无则返回 null 或空)</returns>
  51. [NonAction]
  52. public async Task<string> GetTranslation(string entityName, string fieldName, long entityId, string langCode)
  53. {
  54. var key = BuildKey(entityName, fieldName, entityId, langCode);
  55. var value = _sysCacheService.Get<string>(key);
  56. if (!string.IsNullOrEmpty(value)) return value;
  57. value = await _sysLangTextRep.AsQueryable()
  58. .Where(u => u.EntityName == entityName && u.FieldName == fieldName && u.EntityId == entityId && u.LangCode == langCode)
  59. .Select(u => u.Content)
  60. .FirstAsync();
  61. if (!string.IsNullOrEmpty(value))
  62. {
  63. _sysCacheService.Set(key, value, expireSeconds); // 设置过期
  64. }
  65. return value;
  66. }
  67. /// <summary>
  68. /// 根据实体类型、字段、主键ID 和语言编码获取翻译实体
  69. /// </summary>
  70. /// <param name="entityName">实体名称</param>
  71. /// <param name="fieldName">字段名称</param>
  72. /// <param name="entityId">实体主键ID</param>
  73. /// <param name="langCode">语言编码</param>
  74. /// <returns></returns>
  75. [NonAction]
  76. public async Task<SysLangText> GetTranslationEntity(string entityName, string fieldName, long entityId, string langCode)
  77. {
  78. var key = BuildKey(entityName, fieldName, entityId, langCode) + "_entity";
  79. var value = _sysCacheService.Get<SysLangText>(key);
  80. if (!value.IsNullOrEmpty()) return value;
  81. value = await _sysLangTextRep.AsQueryable()
  82. .Where(u => u.EntityName == entityName && u.FieldName == fieldName && u.EntityId == entityId && u.LangCode == langCode)
  83. .FirstAsync();
  84. if (!value.IsNullOrEmpty())
  85. {
  86. _sysCacheService.Set(key, value, expireSeconds); // 设置过期
  87. }
  88. return value;
  89. }
  90. /// <summary>
  91. /// 【批量翻译获取】<br/>
  92. /// 根据实体、字段和一批主键ID获取对应翻译内容,自动从缓存或数据库获取。<br/>
  93. /// 适用于:SKU、多商品、批量字典等需要高效批量获取的场景。<br/>
  94. ///
  95. /// 【示例】<br/>
  96. /// var dict = await _sysLangTextCacheService.GetTranslations("SKU", "Name", skuIds, "en_US");
  97. /// </summary>
  98. /// <param name="entityName">实体名称</param>
  99. /// <param name="fieldName">字段名称</param>
  100. /// <param name="entityIds">主键ID集合</param>
  101. /// <param name="langCode">语言编码</param>
  102. /// <returns>主键ID到翻译内容的字典</returns>
  103. [NonAction]
  104. public async Task<Dictionary<long, string>> GetTranslations(string entityName, string fieldName, List<long> entityIds, string langCode)
  105. {
  106. var result = new Dictionary<long, string>();
  107. var missingIds = new HashSet<long>(); // 用 HashSet 提高后面 Contains 的性能
  108. foreach (var id in entityIds.Distinct()) // 先去重,防止重复缓存 Key
  109. {
  110. var key = BuildKey(entityName, fieldName, id, langCode);
  111. var value = _sysCacheService.Get<string>(key);
  112. if (!string.IsNullOrWhiteSpace(value))
  113. {
  114. result[id] = value;
  115. }
  116. else
  117. {
  118. missingIds.Add(id);
  119. }
  120. }
  121. if (missingIds.Any())
  122. {
  123. var list = await _sysLangTextRep.AsQueryable()
  124. .Where(u => u.EntityName == entityName &&
  125. u.FieldName == fieldName &&
  126. missingIds.Contains(u.EntityId) &&
  127. u.LangCode == langCode)
  128. .ToListAsync();
  129. foreach (var item in list)
  130. {
  131. if (string.IsNullOrWhiteSpace(item.Content)) continue; // 跳过脏数据
  132. var key = BuildKey(item.EntityName, item.FieldName, item.EntityId, item.LangCode);
  133. _sysCacheService.Set(key, item.Content, expireSeconds);
  134. // 用 TryAdd 防止异常
  135. result[item.EntityId] = item.Content;
  136. }
  137. }
  138. return result;
  139. }
  140. /// <summary>
  141. /// 【列表翻译】<br/>
  142. /// 按配置把同一字段的翻译写回到实体列表中。内部会调用批量翻译接口。<br/>
  143. /// <br/>
  144. /// 【示例】<br/>
  145. /// await _sysLangTextCacheService.TranslateList(products, "Product", "Name", p =&gt; p.Id, (p, val) =&gt; p.Name = val, "zh_CN");
  146. /// </summary>
  147. /// <typeparam name="TEntity">实体类型</typeparam>
  148. /// <param name="list">待翻译的实体列表</param>
  149. /// <param name="entityName">实体名称</param>
  150. /// <param name="fieldName">字段名称</param>
  151. /// <param name="idSelector">用于取出主键ID的表达式</param>
  152. /// <param name="setTranslatedValue">写回翻译值的委托</param>
  153. /// <param name="langCode">语言编码</param>
  154. /// <returns>翻译后的实体列表(引用传递)</returns>
  155. [NonAction]
  156. public async Task<List<TEntity>> TranslateList<TEntity>(List<TEntity> list, string entityName, string fieldName, Func<TEntity, long> idSelector, Action<TEntity, string> setTranslatedValue, string langCode)
  157. {
  158. var ids = list.Select(idSelector).Distinct().ToList();
  159. var dict = await GetTranslations(entityName, fieldName, ids, langCode);
  160. foreach (var item in list)
  161. {
  162. var id = idSelector(item);
  163. if (dict.TryGetValue(id, out var value))
  164. {
  165. setTranslatedValue(item, value);
  166. }
  167. }
  168. return list;
  169. }
  170. /// <summary>
  171. /// 【多字段批量翻译】
  172. /// 对列表中的实体对象,按配置的字段映射进行多字段翻译处理。<br/>
  173. /// 常用于:菜单多语言、商品多语言、SKU多语言等需要多字段翻译的场景。<br/><br/>
  174. /// ✅ 特点:<br/>
  175. /// 1️⃣ 可同时翻译同一实体的多个字段(如 Name、Description、Title 等)<br/>
  176. /// 2️⃣ 内部先尝试从缓存读取,如缓存未命中则批量查询数据库,并自动写回缓存<br/>
  177. /// 3️⃣ 引用传递,直接对原实体对象赋值,无需额外返回<br/><br/>
  178. /// 【使用示例】:<br/>
  179. /// <code>
  180. /// var fields = new List&lt;LangFieldMap&lt;Product&gt;&gt;
  181. /// {
  182. /// new LangFieldMap&lt;Product&gt; {
  183. /// EntityName = "Product",
  184. /// FieldName = "Name",
  185. /// IdSelector = p =&gt; p.Id,
  186. /// SetTranslatedValue = (p, val) =&gt; p.Name = val
  187. /// },
  188. /// new LangFieldMap&lt;Product&gt; {
  189. /// EntityName = "Product",
  190. /// FieldName = "Description",
  191. /// IdSelector = p =&gt; p.Id,
  192. /// SetTranslatedValue = (p, val) =&gt; p.Description = val
  193. /// }
  194. /// };
  195. /// await _sysLangTextCacheService.TranslateMultiFields(products, fields, "zh_CN");
  196. /// </code>
  197. /// </summary>
  198. /// <typeparam name="TEntity">要翻译的实体类型,如 Product/Menu/SKU 等</typeparam>
  199. /// <param name="list">需要翻译的实体对象列表</param>
  200. /// <param name="fields">需要翻译的字段映射集合,支持多个字段</param>
  201. /// <param name="langCode">语言编码,如 "zh_CN"、"en_US"、"it_IT" 等</param>
  202. /// <returns>翻译后的实体列表(引用传递,原对象已直接赋值)</returns>
  203. [NonAction]
  204. public async Task<List<TEntity>> TranslateMultiFields<TEntity>(
  205. List<TEntity> list,
  206. List<LangFieldMap<TEntity>> fields,
  207. string langCode)
  208. {
  209. var keyToField = new Dictionary<string, (TEntity Entity, LangFieldMap<TEntity> FieldMap)>();
  210. var missingKeys = new List<string>();
  211. // 先尝试从缓存读取
  212. foreach (var item in list)
  213. {
  214. foreach (var field in fields)
  215. {
  216. var id = field.IdSelector(item);
  217. var key = BuildKey(field.EntityName, field.FieldName, id, langCode);
  218. var cached = _sysCacheService.Get<string>(key);
  219. if (!string.IsNullOrEmpty(cached))
  220. {
  221. // 命中缓存,直接赋值
  222. field.SetTranslatedValue(item, cached);
  223. }
  224. else
  225. {
  226. // 缓存未命中,加入待查表
  227. keyToField[key] = (item, field);
  228. missingKeys.Add(key);
  229. }
  230. }
  231. }
  232. if (missingKeys.Any())
  233. {
  234. // 把缺失的 keys 拆解成组合实体
  235. var missingTuples = missingKeys
  236. .Select(key =>
  237. {
  238. var parts = key.Split('_');
  239. return new
  240. {
  241. EntityName = parts[1],
  242. FieldName = parts[2],
  243. EntityId = long.Parse(parts[3])
  244. };
  245. })
  246. .ToList();
  247. // 按 EntityName + FieldName 分组
  248. var grouped = missingTuples
  249. .GroupBy(x => new { x.EntityName, x.FieldName })
  250. .ToList();
  251. var result = new List<SysLangText>();
  252. // 分批查询,每组单独查询
  253. const int chunkSize = 500;
  254. foreach (var g in grouped)
  255. {
  256. var allIds = g.Select(x => x.EntityId).Distinct().ToList();
  257. for (int i = 0; i < allIds.Count; i += chunkSize)
  258. {
  259. var chunk = allIds.Skip(i).Take(chunkSize).ToList();
  260. var temp = await _sysLangTextRep.AsQueryable()
  261. .Where(u => u.LangCode == langCode
  262. && u.EntityName == g.Key.EntityName
  263. && u.FieldName == g.Key.FieldName
  264. && chunk.Contains(u.EntityId))
  265. .ToListAsync();
  266. result.AddRange(temp);
  267. }
  268. }
  269. // 遍历查询结果,写回实体和缓存
  270. foreach (var item in result)
  271. {
  272. var key = BuildKey(item.EntityName, item.FieldName, item.EntityId, item.LangCode);
  273. if (keyToField.TryGetValue(key, out var tuple))
  274. {
  275. tuple.FieldMap.SetTranslatedValue(tuple.Entity, item.Content);
  276. _sysCacheService.Set(key, item.Content, expireSeconds);
  277. }
  278. }
  279. }
  280. return list;
  281. }
  282. /// <summary>
  283. /// 删除缓存
  284. /// </summary>
  285. /// <param name="entityName"></param>
  286. /// <param name="fieldName"></param>
  287. /// <param name="entityId"></param>
  288. /// <param name="langCode"></param>
  289. public void DeleteCache(string entityName, string fieldName, long entityId, string langCode)
  290. {
  291. var key = BuildKey(entityName, fieldName, entityId, langCode);
  292. _sysCacheService.Remove(key);
  293. }
  294. /// <summary>
  295. /// 更新缓存
  296. /// </summary>
  297. /// <param name="entityName"></param>
  298. /// <param name="fieldName"></param>
  299. /// <param name="entityId"></param>
  300. /// <param name="langCode"></param>
  301. /// <param name="newValue"></param>
  302. public void UpdateCache(string entityName, string fieldName, long entityId, string langCode, string newValue)
  303. {
  304. var key = BuildKey(entityName, fieldName, entityId, langCode);
  305. _sysCacheService.Set(key, newValue, expireSeconds);
  306. }
  307. }