use-viewed-row.ts 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476
  1. import type {VxeGridProps as VxeTableGridProps} from 'vxe-table';
  2. import type {
  3. ViewedRowOptions,
  4. ViewedRowPersistOptions,
  5. ViewedRowStorageAdapter,
  6. } from './types';
  7. import {isRef, shallowRef, toRaw, triggerRef, watch} from 'vue';
  8. import {isBoolean, isFunction} from '@vben/utils';
  9. import {
  10. IndexedDBDriver,
  11. LocalStorageDriver,
  12. StorageManager,
  13. } from '@vben-core/shared/cache';
  14. import {useDebounceFn} from '@vueuse/core';
  15. const DEFAULT_VIEWED_CLASS = 'vxe-row--viewed';
  16. // ========== 持久化策略 ==========
  17. /**
  18. * localStorage / sessionStorage 适配器
  19. * 整体存储:key → [1, 2, 3]
  20. */
  21. function createWebStorageAdapter(
  22. storageType: 'localStorage' | 'sessionStorage',
  23. key: string,
  24. ttl?: number,
  25. ): ViewedRowStorageAdapter {
  26. const manager = new StorageManager({
  27. driver: new LocalStorageDriver({storageType}),
  28. });
  29. return {
  30. async getKeys() {
  31. const stored = await manager.getItem<Array<number | string>>(key);
  32. return stored ?? [];
  33. },
  34. async removeKeys() {
  35. await manager.removeItem(key);
  36. },
  37. async setKeys(keys) {
  38. await manager.setItem(key, keys, ttl);
  39. },
  40. };
  41. }
  42. /**
  43. * IndexedDB 适配器
  44. * 单条存储:prefix:1 → { expiry, value: 1 }
  45. */
  46. function createIndexedDBAdapter(
  47. opts: Extract<ViewedRowPersistOptions, { type: 'indexedDB' }>,
  48. ): ViewedRowStorageAdapter {
  49. const prefix = opts.key;
  50. const manager = new StorageManager({
  51. driver: new IndexedDBDriver({
  52. dbName: opts.dbName || 'viewed-table-db',
  53. dbVersion: opts.dbVersion || 1,
  54. storeName: opts.storeName || 'viewed-table-row',
  55. }),
  56. prefix,
  57. });
  58. return {
  59. async getKeys() {
  60. try {
  61. // 通过 StorageManager 获取当前前缀下所有 key,再逐条读取(自动过滤过期)
  62. const shortKeys = await manager.keys();
  63. const results: Array<number | string> = [];
  64. for (const shortKey of shortKeys) {
  65. const value = await manager.getItem<number | string>(shortKey);
  66. if (value !== null) {
  67. results.push(value);
  68. }
  69. }
  70. return results;
  71. } catch (error) {
  72. console.error('[viewedRow] indexedDB restore failed:', error);
  73. return [];
  74. }
  75. },
  76. async removeKeys() {
  77. try {
  78. await manager.clear();
  79. } catch (error) {
  80. console.error('[viewedRow] indexedDB clear failed:', error);
  81. }
  82. },
  83. async setKeys(keys) {
  84. try {
  85. // 先清除旧数据,再逐条写入
  86. await manager.clear();
  87. await Promise.all(
  88. keys.map((key) => manager.setItem(String(key), key, opts.ttl)),
  89. );
  90. } catch (error) {
  91. console.error('[viewedRow] indexedDB persist failed:', error);
  92. }
  93. },
  94. };
  95. }
  96. /**
  97. * 根据 persist 配置创建存储适配器
  98. */
  99. function createStorageAdapter(
  100. persist?: string | ViewedRowPersistOptions,
  101. ): null | ViewedRowStorageAdapter {
  102. if (!persist) return null;
  103. // 简写模式:string → localStorage
  104. if (typeof persist === 'string') {
  105. return createWebStorageAdapter('localStorage', persist);
  106. }
  107. switch (persist.type) {
  108. case 'custom': {
  109. // 用户自定义适配器,解除 Vue 响应式代理
  110. return toRaw(persist.storage);
  111. }
  112. case 'indexedDB': {
  113. return createIndexedDBAdapter(persist);
  114. }
  115. case 'localStorage': {
  116. return createWebStorageAdapter('localStorage', persist.key, persist.ttl);
  117. }
  118. case 'memory': {
  119. return null;
  120. }
  121. case 'sessionStorage': {
  122. return createWebStorageAdapter(
  123. 'sessionStorage',
  124. persist.key,
  125. persist.ttl,
  126. );
  127. }
  128. default: {
  129. return null;
  130. }
  131. }
  132. }
  133. // ========== maxSize 淘汰 ==========
  134. /**
  135. * 强制执行 maxSize 限制,超出时淘汰最早插入的 key(FIFO)
  136. */
  137. function enforceMaxSize(set: Set<number | string>, maxSize: number): void {
  138. if (maxSize > 0 && set.size > maxSize) {
  139. const iterator = set.values();
  140. while (set.size > maxSize) {
  141. const oldest = iterator.next().value;
  142. if (oldest !== undefined) {
  143. set.delete(oldest);
  144. }
  145. }
  146. }
  147. }
  148. // ========== 核心 composable ==========
  149. export function useViewedRow<T = any>(
  150. options: ViewedRowOptions<T> & { keyField: string },
  151. ) {
  152. // ========== 解析持久化配置 ==========
  153. const persistOpts: null | ViewedRowPersistOptions = options.persist
  154. ? (typeof options.persist === 'string'
  155. ? {key: options.persist, type: 'localStorage'}
  156. : options.persist)
  157. : null;
  158. const adapter = createStorageAdapter(options.persist);
  159. const maxSize = persistOpts?.maxSize ?? 100;
  160. // ========== 初始化已读集合 ==========
  161. const viewedSet = shallowRef<Set<number | string>>(new Set());
  162. // ========== 持久化(防抖) ==========
  163. function persistImmediate() {
  164. if (!adapter) return;
  165. adapter.setKeys([...viewedSet.value]).catch((error) => {
  166. console.error('[viewedRow] persist failed:', error);
  167. });
  168. }
  169. const persist = useDebounceFn(persistImmediate, 300);
  170. // ========== 从存储恢复 ==========
  171. function restoreFromStorage() {
  172. if (!adapter) return;
  173. adapter
  174. .getKeys()
  175. .then((stored) => {
  176. if (stored && stored.length > 0) {
  177. for (const key of stored) {
  178. viewedSet.value.add(key);
  179. }
  180. if (maxSize > 0) {
  181. enforceMaxSize(viewedSet.value, maxSize);
  182. }
  183. triggerRef(viewedSet);
  184. }
  185. })
  186. .catch((error) => {
  187. console.error('[viewedRow] restore failed:', error);
  188. });
  189. }
  190. restoreFromStorage();
  191. // 合并外部传入的 viewedKeys
  192. if (options.viewedKeys) {
  193. const keys = isRef(options.viewedKeys)
  194. ? options.viewedKeys.value
  195. : options.viewedKeys;
  196. for (const key of keys) {
  197. viewedSet.value.add(key);
  198. }
  199. }
  200. // ========== 更新 viewedSet 的统一入口 ==========
  201. function updateViewedSet(updater: (set: Set<number | string>) => boolean) {
  202. const changed = updater(viewedSet.value);
  203. if (changed) {
  204. if (maxSize > 0) {
  205. enforceMaxSize(viewedSet.value, maxSize);
  206. }
  207. triggerRef(viewedSet);
  208. persist();
  209. }
  210. }
  211. // ========== 监听外部 viewedKeys 变化(如果是 Ref) ==========
  212. if (isRef(options.viewedKeys)) {
  213. watch(options.viewedKeys, (newKeys) => {
  214. updateViewedSet((set) => {
  215. let changed = false;
  216. for (const key of newKeys) {
  217. if (!set.has(key)) {
  218. set.add(key);
  219. changed = true;
  220. }
  221. }
  222. return changed;
  223. });
  224. });
  225. }
  226. // ========== 标记已读 ==========
  227. function markAsViewed(record: T) {
  228. const key = (record as Record<string, any>)[options.keyField] as
  229. | number
  230. | string;
  231. if (key === null || key === undefined) return;
  232. updateViewedSet((set) => {
  233. if (set.has(key)) return false;
  234. set.add(key);
  235. return true;
  236. });
  237. }
  238. function markKeysAsViewed(keys: Array<number | string>) {
  239. updateViewedSet((set) => {
  240. let changed = false;
  241. for (const key of keys) {
  242. if (!set.has(key)) {
  243. set.add(key);
  244. changed = true;
  245. }
  246. }
  247. return changed;
  248. });
  249. }
  250. // ========== 查询 ==========
  251. function isViewed(record: T): boolean {
  252. const key = (record as Record<string, any>)[options.keyField] as
  253. | number
  254. | string;
  255. return viewedSet.value.has(key);
  256. }
  257. // ========== 清除 ==========
  258. function clearViewed() {
  259. const hadData = viewedSet.value.size > 0;
  260. viewedSet.value.clear();
  261. if (hadData) {
  262. triggerRef(viewedSet);
  263. }
  264. if (adapter) {
  265. adapter.removeKeys().catch((error) => {
  266. console.error('[viewedRow] clear persist failed:', error);
  267. });
  268. }
  269. }
  270. // ========== 移除指定 keys ==========
  271. function removeKeys(keys: Array<number | string>) {
  272. updateViewedSet((set) => {
  273. let changed = false;
  274. for (const key of keys) {
  275. if (set.has(key)) {
  276. set.delete(key);
  277. changed = true;
  278. }
  279. }
  280. return changed;
  281. });
  282. }
  283. // ========== rowClassName 函数 ==========
  284. function getRowClassName(params: any): string {
  285. if (!isViewed(params.row)) return '';
  286. const {rowClassName} = options;
  287. if (rowClassName === undefined || rowClassName === null) {
  288. return DEFAULT_VIEWED_CLASS;
  289. }
  290. if (typeof rowClassName === 'string') {
  291. return rowClassName;
  292. }
  293. if (isFunction(rowClassName)) {
  294. return normalizeClassName(rowClassName(params));
  295. }
  296. return DEFAULT_VIEWED_CLASS;
  297. }
  298. // ========== rowStyle 函数 ==========
  299. function getRowStyle(params: any): any {
  300. if (!isViewed(params.row)) return undefined;
  301. const {rowStyle} = options;
  302. if (rowStyle === undefined || rowStyle === null) {
  303. return undefined;
  304. }
  305. if (isFunction(rowStyle)) {
  306. return rowStyle(params);
  307. }
  308. return rowStyle;
  309. }
  310. return {
  311. clearViewed,
  312. getRowClassName,
  313. getRowStyle,
  314. isViewed,
  315. markAsViewed,
  316. markKeysAsViewed,
  317. removeKeys,
  318. viewedSet,
  319. };
  320. }
  321. // ========== 工具函数 ==========
  322. function normalizeClassName(value: any): string {
  323. if (!value) return '';
  324. if (typeof value === 'string') return value;
  325. if (typeof value === 'object') {
  326. return Object.entries(value)
  327. .filter(([, v]) => v)
  328. .map(([k]) => k)
  329. .join(' ');
  330. }
  331. return '';
  332. }
  333. function mergeClassNames(...classNames: any[]): string {
  334. return classNames
  335. .map((c) => normalizeClassName(c))
  336. .filter(Boolean)
  337. .join(' ');
  338. }
  339. /**
  340. * 包装 columns,拦截 CellOperation 的 onClick,根据 actionCodes 自动标记已读
  341. * 注意:columns 每次都是 cloneDeep 后的新对象,不存在重复包装问题
  342. */
  343. function wrapColumnsForViewedRow(
  344. columns: any[],
  345. actionCodes: string[],
  346. markAsViewed: (record: any) => void,
  347. ): any[] {
  348. return columns.map((column) => {
  349. if (!column || typeof column !== 'object') return column;
  350. const nextColumn = {...column};
  351. if (nextColumn.cellRender?.name === 'CellOperation') {
  352. const cellRender = {...nextColumn.cellRender};
  353. const attrs = {...cellRender.attrs};
  354. const originalOnClick = attrs.onClick;
  355. attrs.onClick = (params: { code: string; row: any }) => {
  356. originalOnClick?.(params);
  357. if (actionCodes.includes(params.code)) {
  358. markAsViewed(params.row);
  359. }
  360. };
  361. cellRender.attrs = attrs;
  362. nextColumn.cellRender = cellRender;
  363. }
  364. if (Array.isArray(nextColumn.children)) {
  365. nextColumn.children = wrapColumnsForViewedRow(
  366. nextColumn.children,
  367. actionCodes,
  368. markAsViewed,
  369. );
  370. }
  371. return nextColumn;
  372. });
  373. }
  374. /**
  375. * 将 viewedRow 配置应用到 mergedOptions 上
  376. * 注入 rowClassName、rowStyle、columns 拦截
  377. */
  378. export function applyViewedRowOptions(
  379. mergedOptions: VxeTableGridProps,
  380. viewedRowConfig: boolean | ViewedRowOptions,
  381. helper: ReturnType<typeof useViewedRow>,
  382. ) {
  383. // 注入 rowClassName
  384. const originalRowClassName = mergedOptions.rowClassName;
  385. mergedOptions.rowClassName = (params: any) => {
  386. return mergeClassNames(
  387. isFunction(originalRowClassName)
  388. ? originalRowClassName(params)
  389. : originalRowClassName,
  390. helper.getRowClassName(params),
  391. );
  392. };
  393. // 注入 rowStyle
  394. const originalRowStyle = mergedOptions.rowStyle;
  395. mergedOptions.rowStyle = (params: any) => {
  396. const viewedStyle = helper.getRowStyle(params);
  397. const originalStyle = isFunction(originalRowStyle)
  398. ? originalRowStyle(params)
  399. : originalRowStyle;
  400. if (!viewedStyle && !originalStyle) return undefined;
  401. if (!originalStyle) return viewedStyle;
  402. if (!viewedStyle) return originalStyle;
  403. return {...originalStyle, ...viewedStyle};
  404. };
  405. // 拦截 CellOperation columns
  406. const actionCodes =
  407. !isBoolean(viewedRowConfig) && viewedRowConfig.actionCodes
  408. ? (Array.isArray(viewedRowConfig.actionCodes)
  409. ? viewedRowConfig.actionCodes
  410. : [viewedRowConfig.actionCodes])
  411. : [];
  412. if (actionCodes.length > 0 && Array.isArray(mergedOptions.columns)) {
  413. mergedOptions.columns = wrapColumnsForViewedRow(
  414. mergedOptions.columns,
  415. actionCodes,
  416. helper.markAsViewed,
  417. );
  418. }
  419. }