Skip to content

Vue 树形懒加载

loadChildren + hasChildren:首屏只给根节点,首次展开某节点时才去取它的子节点,取数期间该节点箭头变 spinner。

  • 同一节点在途只请求一次
  • 返回空数组记为「确实没有子节点」,箭头变叶子且不再请求
  • 失败会回到折叠态,再点一次即重试

使用的 API

ts
type Options = {
  list: T[];  // 首屏根节点
  itemKey: string;  // 行唯一标识字段名
  estimatedSize: number;  // 行预估高度(px)
  // 未加载时靠它判断要不要给箭头,默认读 row.hasChildren
  hasChildren?: (row: T) => boolean;
  loadChildren: (row: T, ctx: { level: number }) => Promise<T[]>;
  onChildrenLoaded?: (row: T, children: T[]) => void;
  onChildrenLoadError?: (row: T, err: unknown) => void;
}

// 实例方法(ref 上调用)
tableRef.value?.loadChildrenFor(rowKey);
tableRef.value?.resetLazyNode(rowKey);  // 清缓存与 children,下次展开重新取数

完整语义(在途去重、失败态回滚、与 defaultExpandAll 的关系)见 Vanilla · 树形懒加载

示例

微应用尚未挂载。

源码

点击查看源码
vue
<template>
  <div class="demo-wrapper">
    <h3 class="demo-title">Vue 树形懒加载</h3>
    <div class="demo-hint">
      首屏只加载 4 个根节点。点箭头展开时才去取子节点(箭头位置显示 spinner),同一节点在途只请求一次;
      返回空数组的节点会变成叶子。
    </div>
    <div class="virt-table-controls">
      <label><input v-model="failNext" type="checkbox" /> 注入故障(下一次展开失败)</label>
      <button type="button" @click="resetNode">重置「工程部」缓存(下次展开重新取数)</button>
      <span class="demo-note">{{ stat }}</span>
    </div>
    <div style="width: 760px; height: 460px" class="demo-container">
      <VirtTableVue ref="tableRef" :columns="columns" :options="options" />
    </div>
    <div
      class="status-text"
      style="margin-top: 12px; white-space: pre-wrap; font-family: ui-monospace, SFMono-Regular, Menlo, monospace"
    >
      {{ logs.slice(0, 6).join('\n') }}
    </div>
  </div>
</template>

<script setup lang="ts">
import { ref } from 'vue';
import { VirtTableVue, type VueTableColumn } from '@virt-table/vue';
import { faker } from '@faker-js/faker';
import type { VirtTableVueInstance } from '../../virt-table-ref';

/**
 * 树形子节点懒加载:`loadChildren` + `hasChildren`。
 *
 * 首屏只给根节点;首次展开某节点时才去取它的子节点,取数期间该节点箭头变 spinner。
 * 同一节点在途只请求一次;返回空数组记为「确实没有子节点」,箭头变叶子且不再请求。
 * 失败会回到折叠态,再点一次即重试。
 */
interface Row extends Record<string, unknown> {
  id: string;
  name: string;
  role: string;
  count: number;
  /** 服务端告知「可能有子节点」,决定未加载时是否显示展开箭头 */
  hasChildren?: boolean;
  children?: Row[];
}

const columns: VueTableColumn<Row>[] = [
  { key: 'name', title: '名称', width: 320, type: 'tree' },
  { key: 'role', title: '类型', width: 160 },
  { key: 'count', title: '数量', width: 120, align: 'right' },
];

// 模拟服务端:按父节点 id 造子节点(3 层,第 3 层为叶子)
const makeChildren = (parent: Row, level: number): Row[] => {
  const count = level >= 3 ? 0 : 3 + ((parent.name.length + level) % 3);
  return Array.from({ length: count }, (_, i) => ({
    id: `${parent.id}-${i + 1}`,
    name: level === 1 ? `${parent.name} / 小组 ${i + 1}` : faker.person.fullName(),
    role: level === 1 ? '小组' : '成员',
    count: faker.number.int({ min: 1, max: 99 }),
    // 第 3 层不再有子节点
    hasChildren: level < 2,
  }));
};

const rootRows: Row[] = ['工程部', '设计部', '市场部', '财务部'].map((d, i) => ({
  id: `d${i + 1}`,
  name: d,
  role: '部门',
  count: faker.number.int({ min: 10, max: 99 }),
  hasChildren: true,
}));

const tableRef = ref<VirtTableVueInstance | null>(null);
const failNext = ref(false);
const stat = ref('');
const logs = ref<string[]>([]);
const log = (msg: string): void => {
  logs.value = [msg, ...logs.value].slice(0, 8);
};

let reqSeq = 0;
let loadedNodes = 0;

const options = {
  list: rootRows,
  itemKey: 'id',
  estimatedSize: 40,
  buffer: 6,
  border: true,
  // 未加载时靠 hasChildren 判断要不要给箭头(默认就是读 row.hasChildren,这里显式写出)
  hasChildren: (row: Record<string, unknown>) => !!(row as Row).hasChildren,
  loadChildren: (row: Record<string, unknown>, ctx: { level: number }) => {
    const seq = ++reqSeq;
    const r = row as Row;
    log(`#${seq} loadChildren(${r.name}) level=${ctx.level}`);
    return new Promise<Row[]>((resolve, reject) => {
      setTimeout(() => {
        if (failNext.value) {
          failNext.value = false;
          log(`#${seq} ✗ 失败(再点一次即重试)`);
          reject(new Error('mock network error'));
          return;
        }
        const kids = makeChildren(r, ctx.level);
        log(`#${seq} ✓ 返回 ${kids.length} 个子节点`);
        resolve(kids);
      }, 500);
    });
  },
  onChildrenLoaded: (row: Record<string, unknown>, children: Record<string, unknown>[]) => {
    loadedNodes += 1;
    stat.value = `已展开取数 ${loadedNodes} 个节点 · 最近:${(row as Row).name}(${children.length} 个子节点)`;
  },
  onChildrenLoadError: (row: Record<string, unknown>, err: unknown) => {
    stat.value = `「${(row as Row).name}」取子节点失败:${(err as Error).message}`;
  },
};

const resetNode = () => {
  tableRef.value?.resetLazyNode('d1');
  log('resetLazyNode(d1):已清缓存与 children');
};
</script>