Skip to content

Vue 低代码平台的「二次生长」:深入测评 VTJ 四个核心包的 Composition API 模式升级

一个面向 Vue 3 的开源低代码平台,如何将数千行 Options API 代码平稳迁移到 Composition API?本文将从架构设计、双向转换引擎、运行时渲染、可视化编辑器和 AI 生成五个维度,深度解析 VTJ 的 Composition 模式升级之路。


一、背景

2020 年 Vue 3 发布,Composition API 作为其标志性特性登场。四年后的今天,绝大多数 Vue 项目已切换到 <script setup> 语法。但对于低代码平台而言,事情远没有"改写法"那么简单——低代码平台的核心资产是DSL(领域特定语言),它需要在可视化编辑器代码生成器代码解析器运行时渲染器四个模块之间无损流转。

VTJ(Gitee)是一个开源的、AI 驱动的 Vue 3 企业级低代码平台。最近他们完成了一次大规模的 Composition 模式升级,涉及四个核心包:

包名职责升级要点
@vtj/coderDSL → Vue SFC 正向代码生成新建模块化 Composition 解析器
@vtj/parserVue SFC → DSL 反向解析新建镜像式反向转换器
@vtj/rendererDSL 运行时渲染Composition 模式生命周期分流
@vtj/designer可视化编辑器新增 refs/reactives 专属编辑面板

本文将深入拆解这次升级的架构设计和工程细节。


二、架构总览:双向镜像的「编译闭环」

VTJ 的 Composition 模式升级最核心的设计理念可以概括为四个字:双向镜像

整个架构围绕 DSL(BlockSchema JSON)展开:

         @vtj/coder(正向:DSL → Vue SFC)
               ↓  DSL to Composition API
   BlockSchema ─────────────────────────►  Vue <script setup>
   (JSON DSL)  ◄─────────────────────────  (Vue SFC 源码)
               ↑  Vue SFC to DSL
         @vtj/parser(反向:Vue SFC → DSL)

               ↓ runtime execution
         @vtj/renderer(运行时渲染器)

               ↓ design-time integration
         @vtj/designer(可视化设计器)
  • @vtj/coder 负责将 DSL JSON 转换为 Vue <script setup> 源码
  • @vtj/parser 负责将 Vue <script setup> 源码解析回 DSL JSON
  • 两者共享同一份全局 API 映射表(GLOBAL_API_MAP),保证正向和反向转换的精确镜像
  • @vtj/renderer 在运行时根据 DSL 的 apiMode 字段分流,决定以 Composition 还是 Options 方式注册生命周期
  • @vtj/designer 提供 refs、reactives、lifeCycles 等 Composition 专属字段的可视化编辑

关键设计决策:整个升级对 Options API 模式零影响,通过 apiMode: 'composition' | 'options' 字段在 DSL 层面做模式分流。这意味着存量项目可以逐个组件渐进式升级,无需大规模重构。


三、@vtj/coder:符号表驱动的正向转换引擎

@vtj/coder 是这次升级中改动最大的包。它在 parser/composition/ 目录下新建了 16 个模块文件,形成了一个完善的模块化架构。

3.1 符号表:一切转换的基石

转换的核心难题是:DSL 中所有 this.xxx 引用,如何正确转换为 Composition API 的顶层标识符?

js
// DSL 中的引用(抽象语法层面)
this.count → count.value(ref,需 .value 解包)
this.state.title → __state.title(state reactive,直接访问)
this.$router → __router(全局 API,注入式声明)
this.$message → ElMessage(UIAPI,命名空间导入)

VTJ 的解决方案是 SymbolTable(符号表)——一张包含所有可识别标识符分类的「地图」:

typescript
// packages/coder/src/parser/composition/symbolTable.ts
export interface SymbolTable {
  refs: Set<string>; // 需要 .value 解包
  reactives: Set<string>; // 直接使用(含 state)
  computed: Set<string>; // 需要 .value 解包
  methods: Set<string>; // 顶层函数
  props: Set<string>; // 通过 props.xxx 访问
  composables: Set<string>; // 顶层变量
  injects: Set<string>; // 顶层变量
  dataSources: Set<string>; // 顶层函数
  effectiveApiMap: Record<string, GlobalApiConfig>; // 全局 API 映射
}

3.2 双上下文转换:script vs template

ref 和 computed 在 <script><template> 中有不同的 .value 规则——Vue 模板会自动解包。VTJ 的 transformer 通过 TransformContext 参数精确处理这一差异:

typescript
// packages/coder/src/parser/composition/transformer.ts
export type TransformContext = 'script' | 'template';

function transformExpression(
  code: string,
  symbols: SymbolTable,
  context: TransformContext
) {
  // 1. 全局 API:this.$router → __router
  for (const [api, cfg] of Object.entries(symbols.effectiveApiMap)) {
    result = result.replace(
      new RegExp(`this\\.${escaped}\\b`, 'g'),
      cfg.replace
    );
  }

  // 2. ref/computed 的 .value 处理
  result = result.replace(
    /this\.([A-Za-z_$][\w$]*)\.value\b/g,
    (match, name) => {
      if (symbols.refs.has(name) || symbols.computed.has(name)) {
        return context === 'script' ? `${name}.value` : name; // 模板自动解包
      }
      return match;
    }
  );

  // 3. state 特殊处理:this.state → __state
  // 4. props 特殊处理:script 中转为 __props.xxx
  // ...
}

3.3 全局 API 映射体系

这是 VTJ 最具特色的设计之一。它建立了一个可扩展的全局 API 映射表,覆盖 Vue 原生、vue-router、vue-i18n、@vtj/renderer 以及 Element Plus / Ant Design Vue 等 UI 库:

typescript
// packages/coder/src/parser/composition/globalApi.ts
export const GLOBAL_API_MAP = {
  $emit: { composable: null, replace: '__emit' },
  $props: { composable: null, replace: '__props' },
  $router: { composable: 'useRouter', replace: '__router' },
  $route: { composable: 'useRoute', replace: '__route' },
  $t: { composable: 'useI18n', replace: '__i18n.t' },
  $message: { composable: 'ElMessage', replace: 'ElMessage' },
  $confirm: { composable: 'ElMessageBox', replace: 'ElMessageBox.confirm' }
  // ... 27 个映射项
};

// UI 库专属映射可叠加
export const UI_GLOBAL_API_MAPS = {
  'element-plus': {
    $loading: { composable: 'ElLoading', replace: 'ElLoading.service' }
  },
  'ant-design-vue': {
    $confirm: { composable: 'Modal', replace: 'Modal.confirm' }
  }
};

这套体系使得 coder 和 parser 共享同一份映射数据,从根本上保证了双向转换的一致性。


四、@vtj/parser:精确镜像的反向转换器

如果说 coder 是正向翻译,parser 就是反向翻译——它需要将 Vue <script setup> 中的顶层标识符还原为 DSL 的 this.xxx 形态。

4.1 反向符号表与安全替换

parser 在 vue/composition/ 目录下实现了三个核心模块:

  • reverseGlobalApi.ts:从 coder 的 GLOBAL_API_MAP 推导反向映射
  • reverseSymbolTable.ts:从 ParseScriptSetupResult 构建反向符号表
  • reverseTransformer.ts:coder transformer 的精确反操作

反向转换的关键挑战是避免字符串字面量中的误替换

typescript
// packages/parser/src/vue/composition/reverseTransformer.ts
function safeReplace(code: string, regex: RegExp, replacement: string): string {
  // 跳过单引号/双引号字符串
  // 但正确处理模板字符串中 ${} 表达式的替换
  // ...
}

4.2 解构字段精确映射

一个值得关注的设计细节是对 composable 解构字段的处理:

javascript
// AI 生成或用户手写的 Vue 代码
const { t, n, d } = useI18n();

parser 通过 buildComposableMemberMap 精确识别 t → $tn → $n 的映射关系,而非简单地通过变量名匹配:

typescript
// packages/parser/src/vue/composition/reverseGlobalApi.ts
export function buildComposableMemberMap(uiPackage?: string) {
  const map = {};
  for (const [api, cfg] of Object.entries(apiMap)) {
    if (!cfg.composable || !cfg.replace.includes('.')) continue;
    const prop = cfg.replace.substring(cfg.replace.lastIndexOf('.') + 1);
    map[cfg.composable][prop] = api;
    // { useI18n: { t: '$t', n: '$n', d: '$d', ... } }
  }
}

五、@vtj/renderer:运行时的模式感知执行

renderer 是 DSL 在运行时被"激活"的关键。它的改造相对优雅——通过 apiMode 字段在 setup() 内做分流:

typescript
// packages/renderer/src/render/block.ts(简化)
async setup(props) {
  const isComposition = dsl.value.apiMode === 'composition';

  // 模式无关的基础创建
  context.state = createState(Vue, dsl.value.state);
  const computed = createComputed(Vue, dsl.value.computed, context);
  const methods = createMethods(dsl.value.methods, context);

  if (isComposition) {
    // Composition 模式独特逻辑
    const refs = createRefs(Vue, dsl.value.refs, context);
    const reactives = createReactives(Vue, dsl.value.reactives, context);
    const composableResults = createComposables(dsl.value.composables, context);

    // 生命周期在 setup 内以 onXxx 注册
    await createCompositionLifeCycles(Vue, dsl.value.lifeCycles, context);
    if (dsl.value.setup) {
      await setupFn(); // 执行 setup 函数
    }
    createProvide(Vue, dsl.value.provide, context);
  }

  // Options 模式:生命周期以 Options 风格注册
  return { ...refs, ...reactives, ...computed, ...methods };
}

值得注意的是,renderer 还处理了 Composition 模式下 ref 字符串绑定同步 Vue Ref value 的兼容性问题——这在设计器中通过 $refs[ref] 访问时至关重要。


六、@vtj/designer:可视化编辑的完整配套

设计器的 Scripts 面板为 Composition 模式提供了独立的可视化编辑工具

widgets/scripts/ 目录下包含 10 个编辑面板

面板Composition 模式Options 模式
refs.vue — 响应式 ref✅ 条件显示
reactives.vue — 响应式 reactive✅ 条件显示
state.vue — 状态数据
computed.vue — 计算属性
methods.vue — 组件方法
lifeCycles.vue — 生命周期(双模式切换)✅(onXxx)✅(Options 命名)
watch.vue — 侦听器
setup.vue — 初始化函数

核心实现可以看出对细节的用心:

vue
<!-- packages/designer/src/components/widgets/scripts/index.vue -->
<Refs v-if="isComposition" />
<Reactives v-if="isComposition" />
<State />
<Computed />
<Methods />
<LifeCycles />
<Watch />

lifeCycles.vue 中的模式感知下拉选项,更是体现了对开发体验的打磨——Composition 模式下展示 onMountedonBeforeUnmount 等,Options 模式下展示 mountedbeforeUnmount 等,且 uniapp 平台额外适配 onLoadonShow 等 18 个页面生命周期钩子。


七、AI 生成能力:提示词工程驱动的代码工厂

VTJ 的 AI 生成能力建立在上述双向转换引擎之上,形成了一套完整的「AI 代码工厂」流水线:

7.1 提示词体系

docs/llms/ 下存放着 16 份面向 AI 的提示词文档(约 9000 行),其中 **coder.md(729 行)**是最核心的一份,它严格定义了 AI 生成 Vue 代码时必须遵守的规范:

  • 强制 <script setup> + Composition API
  • 变量命名硬约束:__state__props__emit__router__i18n
  • 全局 API 替代写法表(27 个 DSL this.$xxx → Composition 等价物)
  • 数据源规范(__provider.apis['xxx'] / __provider.createMock
  • 模板指令使用规范和禁止事项清单

7.2 工具调用(Function Calling)体系

设计器中注册了 42+ 个可调用工具,覆盖页面管理、区块管理、API 管理、依赖管理、环境变量、国际化等场景。AI 可以通过多轮对话协作的方式操作设计器:

P:(计划)→ A:(执行)→ O:(结果)

例如 AI 可以先创建页面(createPage),然后生成代码(```vue),解析为 DSL,再应用到当前页面——整个过程全自动。

7.3 错误反馈闭环

AI 生成 Vue SFC → @vtj/parser 解析为 DSL
     ↓ 解析失败
标记 Error → 收集错误信息 → 反馈给 AI → AI 迭代修正

如果 AI 生成的代码触犯了 parser 的解析规则(如使用了禁止的变量名、游离顶层语句等),错误信息会被整理后回传给 AI,驱动下一轮修正。这种闭环纠错机制使得 AI 输出的质量在对话过程中持续提升。


八、工程亮点与设计哲学

8.1 Options 零影响

所有改造通过 apiMode 字段分流,存量项目零侵入。这是低代码平台升级的黄金法则——你不能强迫用户一次性迁移所有组件。

8.2 跨包一致性保障

@vtj/coder 导出 GLOBAL_API_MAP@vtj/parser 直接复用。这个看似简单的设计决策,从根本上消除了双向转换中的"信息不对称"问题。

8.3 变量命名标准化

Composition 模式中大量使用 __ 双下划线前缀变量(__state__provider__props__emit__router 等),避免与用户自定义变量冲突。这一设计贯穿 coder → parser → renderer → designer 全链路。

8.4 多 UI 框架适配

Element Plus 的 $message → ElMessage 和 Ant Design Vue 的 $message → message 差异化映射,以及 uniapp 的 18 个专用生命周期钩子——对生态的广泛兼容体现了务实的设计态度。

8.5 增量更新与降级

AI 生成支持 ````diff增量格式,通过codeIncrementalUpdater` 实现局部修改;失败时降级为全量生成,保证开发体验流畅。


九、可以改进的方向

没有完美的架构,以下是一些可以继续打磨的方向:

  1. parser 错误反馈粒度:当前只区分 Success/Error,可以引入结构化错误类型(如 VARIABLE_NAMINGFORBIDDEN_APIFREE_STATEMENT),让 AI 更精准地自我修正

  2. composables 识别扩展:当前依赖 useXxx 命名规范来识别 composable,对于不遵循此规范的第三方库可能需要更灵活的配置

  3. 设计器面板组织:10 个编辑面板目前线性堆叠,未来可以按功能域折叠/分组,或提供搜索能力

  4. AI 上下文管理:多轮对话中每次都会重新生成完整的 Vue 源码作为上下文,随着对话深入,token 消耗较大,可以考虑更智能的上下文剪枝策略


十、总结

VTJ 的 Composition 模式升级是一次数量级可控、质量级可靠的大型重构。它的成功不仅仅在于"让四包支持 Composition API",更在于建立了一套可验证、可镜像、可扩展的双向转换体系。

维度评分亮点
架构设计★★★★★符号表 + 双向镜像 + 全局 API 映射
工程质量★★★★★完整测试套件,Options 零影响
可视化编辑★★★★10 个编辑面板,模式感知分流
AI 生成★★★★16 份提示词文档 + 42+ 工具 + 闭环纠错
生态兼容★★★★★Vue 原生 + vue-router + i18n + Element Plus + AntdV + uniapp

对于正在考虑低代码平台选型,或希望为自己的低代码引擎引入 Composition API 支持的团队,VTJ 这次升级提供了很好的参考样本——双向镜像转换 + 符号表驱动 + 提示词工程的组合策略,值得借鉴。


项目地址https://gitee.com/newgateway/vtj

本文基于 VTJ v0.18.0 版本分析


本文由 VTJ 项目深度分析撰写,所有代码片段均来自项目源码。