SysLangTextCacheService.cs 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316
  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. /// 【批量翻译获取】<br/>
  69. /// 根据实体、字段和一批主键ID获取对应翻译内容,自动从缓存或数据库获取。<br/>
  70. /// 适用于:SKU、多商品、批量字典等需要高效批量获取的场景。<br/>
  71. ///
  72. /// 【示例】<br/>
  73. /// var dict = await _sysLangTextCacheService.GetTranslations("SKU", "Name", skuIds, "en_US");
  74. /// </summary>
  75. /// <param name="entityName">实体名称</param>
  76. /// <param name="fieldName">字段名称</param>
  77. /// <param name="entityIds">主键ID集合</param>
  78. /// <param name="langCode">语言编码</param>
  79. /// <returns>主键ID到翻译内容的字典</returns>
  80. [NonAction]
  81. public async Task<Dictionary<long, string>> GetTranslations(string entityName, string fieldName, List<long> entityIds, string langCode)
  82. {
  83. var result = new Dictionary<long, string>();
  84. var missingIds = new HashSet<long>(); // 用 HashSet 提高后面 Contains 的性能
  85. foreach (var id in entityIds.Distinct()) // 先去重,防止重复缓存 Key
  86. {
  87. var key = BuildKey(entityName, fieldName, id, langCode);
  88. var value = _sysCacheService.Get<string>(key);
  89. if (!string.IsNullOrWhiteSpace(value))
  90. {
  91. result[id] = value;
  92. }
  93. else
  94. {
  95. missingIds.Add(id);
  96. }
  97. }
  98. if (missingIds.Any())
  99. {
  100. var list = await _sysLangTextRep.AsQueryable()
  101. .Where(u => u.EntityName == entityName &&
  102. u.FieldName == fieldName &&
  103. missingIds.Contains(u.EntityId) &&
  104. u.LangCode == langCode)
  105. .ToListAsync();
  106. foreach (var item in list)
  107. {
  108. if (string.IsNullOrWhiteSpace(item.Content)) continue; // 跳过脏数据
  109. var key = BuildKey(item.EntityName, item.FieldName, item.EntityId, item.LangCode);
  110. _sysCacheService.Set(key, item.Content, expireSeconds);
  111. // 用 TryAdd 防止异常
  112. result[item.EntityId] = item.Content;
  113. }
  114. }
  115. return result;
  116. }
  117. /// <summary>
  118. /// 【列表翻译】<br/>
  119. /// 按配置把同一字段的翻译写回到实体列表中。内部会调用批量翻译接口。<br/>
  120. /// <br/>
  121. /// 【示例】<br/>
  122. /// await _sysLangTextCacheService.TranslateList(products, "Product", "Name", p =&gt; p.Id, (p, val) =&gt; p.Name = val, "zh_CN");
  123. /// </summary>
  124. /// <typeparam name="TEntity">实体类型</typeparam>
  125. /// <param name="list">待翻译的实体列表</param>
  126. /// <param name="entityName">实体名称</param>
  127. /// <param name="fieldName">字段名称</param>
  128. /// <param name="idSelector">用于取出主键ID的表达式</param>
  129. /// <param name="setTranslatedValue">写回翻译值的委托</param>
  130. /// <param name="langCode">语言编码</param>
  131. /// <returns>翻译后的实体列表(引用传递)</returns>
  132. [NonAction]
  133. public async Task<List<TEntity>> TranslateList<TEntity>(List<TEntity> list, string entityName, string fieldName, Func<TEntity, long> idSelector, Action<TEntity, string> setTranslatedValue, string langCode)
  134. {
  135. var ids = list.Select(idSelector).Distinct().ToList();
  136. var dict = await GetTranslations(entityName, fieldName, ids, langCode);
  137. foreach (var item in list)
  138. {
  139. var id = idSelector(item);
  140. if (dict.TryGetValue(id, out var value))
  141. {
  142. setTranslatedValue(item, value);
  143. }
  144. }
  145. return list;
  146. }
  147. /// <summary>
  148. /// 【多字段批量翻译】
  149. /// 对列表中的实体对象,按配置的字段映射进行多字段翻译处理。<br/>
  150. /// 常用于:菜单多语言、商品多语言、SKU多语言等需要多字段翻译的场景。<br/><br/>
  151. /// ✅ 特点:<br/>
  152. /// 1️⃣ 可同时翻译同一实体的多个字段(如 Name、Description、Title 等)<br/>
  153. /// 2️⃣ 内部先尝试从缓存读取,如缓存未命中则批量查询数据库,并自动写回缓存<br/>
  154. /// 3️⃣ 引用传递,直接对原实体对象赋值,无需额外返回<br/><br/>
  155. /// 【使用示例】:<br/>
  156. /// <code>
  157. /// var fields = new List&lt;LangFieldMap&lt;Product&gt;&gt;
  158. /// {
  159. /// new LangFieldMap&lt;Product&gt; {
  160. /// EntityName = "Product",
  161. /// FieldName = "Name",
  162. /// IdSelector = p =&gt; p.Id,
  163. /// SetTranslatedValue = (p, val) =&gt; p.Name = val
  164. /// },
  165. /// new LangFieldMap&lt;Product&gt; {
  166. /// EntityName = "Product",
  167. /// FieldName = "Description",
  168. /// IdSelector = p =&gt; p.Id,
  169. /// SetTranslatedValue = (p, val) =&gt; p.Description = val
  170. /// }
  171. /// };
  172. /// await _sysLangTextCacheService.TranslateMultiFields(products, fields, "zh_CN");
  173. /// </code>
  174. /// </summary>
  175. /// <typeparam name="TEntity">要翻译的实体类型,如 Product/Menu/SKU 等</typeparam>
  176. /// <param name="list">需要翻译的实体对象列表</param>
  177. /// <param name="fields">需要翻译的字段映射集合,支持多个字段</param>
  178. /// <param name="langCode">语言编码,如 "zh_CN"、"en_US"、"it_IT" 等</param>
  179. /// <returns>翻译后的实体列表(引用传递,原对象已直接赋值)</returns>
  180. [NonAction]
  181. public async Task<List<TEntity>> TranslateMultiFields<TEntity>(
  182. List<TEntity> list,
  183. List<LangFieldMap<TEntity>> fields,
  184. string langCode)
  185. {
  186. var keyToField = new Dictionary<string, (TEntity Entity, LangFieldMap<TEntity> FieldMap)>();
  187. var missingKeys = new List<string>();
  188. // 先尝试从缓存读取
  189. foreach (var item in list)
  190. {
  191. foreach (var field in fields)
  192. {
  193. var id = field.IdSelector(item);
  194. var key = BuildKey(field.EntityName, field.FieldName, id, langCode);
  195. var cached = _sysCacheService.Get<string>(key);
  196. if (!string.IsNullOrEmpty(cached))
  197. {
  198. // 命中缓存,直接赋值
  199. field.SetTranslatedValue(item, cached);
  200. }
  201. else
  202. {
  203. // 缓存未命中,加入待查表
  204. keyToField[key] = (item, field);
  205. missingKeys.Add(key);
  206. }
  207. }
  208. }
  209. if (missingKeys.Any())
  210. {
  211. // 把缺失的 keys 拆解成组合实体
  212. var missingTuples = missingKeys
  213. .Select(key =>
  214. {
  215. var parts = key.Split('_');
  216. return new
  217. {
  218. EntityName = parts[1],
  219. FieldName = parts[2],
  220. EntityId = long.Parse(parts[3])
  221. };
  222. })
  223. .ToList();
  224. // 按 EntityName + FieldName 分组
  225. var grouped = missingTuples
  226. .GroupBy(x => new { x.EntityName, x.FieldName })
  227. .ToList();
  228. var result = new List<SysLangText>();
  229. // 分批查询,每组单独查询
  230. const int chunkSize = 500;
  231. foreach (var g in grouped)
  232. {
  233. var allIds = g.Select(x => x.EntityId).Distinct().ToList();
  234. for (int i = 0; i < allIds.Count; i += chunkSize)
  235. {
  236. var chunk = allIds.Skip(i).Take(chunkSize).ToList();
  237. var temp = await _sysLangTextRep.AsQueryable()
  238. .Where(u => u.LangCode == langCode
  239. && u.EntityName == g.Key.EntityName
  240. && u.FieldName == g.Key.FieldName
  241. && chunk.Contains(u.EntityId))
  242. .ToListAsync();
  243. result.AddRange(temp);
  244. }
  245. }
  246. // 遍历查询结果,写回实体和缓存
  247. foreach (var item in result)
  248. {
  249. var key = BuildKey(item.EntityName, item.FieldName, item.EntityId, item.LangCode);
  250. if (keyToField.TryGetValue(key, out var tuple))
  251. {
  252. tuple.FieldMap.SetTranslatedValue(tuple.Entity, item.Content);
  253. _sysCacheService.Set(key, item.Content, expireSeconds);
  254. }
  255. }
  256. }
  257. return list;
  258. }
  259. /// <summary>
  260. /// 删除缓存
  261. /// </summary>
  262. /// <param name="entityName"></param>
  263. /// <param name="fieldName"></param>
  264. /// <param name="entityId"></param>
  265. /// <param name="langCode"></param>
  266. public void DeleteCache(string entityName, string fieldName, long entityId, string langCode)
  267. {
  268. var key = BuildKey(entityName, fieldName, entityId, langCode);
  269. _sysCacheService.Remove(key);
  270. }
  271. /// <summary>
  272. /// 更新缓存
  273. /// </summary>
  274. /// <param name="entityName"></param>
  275. /// <param name="fieldName"></param>
  276. /// <param name="entityId"></param>
  277. /// <param name="langCode"></param>
  278. /// <param name="newValue"></param>
  279. public void UpdateCache(string entityName, string fieldName, long entityId, string langCode, string newValue)
  280. {
  281. var key = BuildKey(entityName, fieldName, entityId, langCode);
  282. _sysCacheService.Set(key, newValue, expireSeconds);
  283. }
  284. }