生成代码文件介绍

拿到生成代码后,认识每个目录与文件,以及怎么跑起来。

一次生成 = 一套完整可运行的项目:你选的每个后端、每个前端都自带 init.sql、Dockerfile、docker-compose.yml 和 README.md。拿到后先看 README,里面有最直接的运行说明。

生成文件树

顶层结构

项目/
├── {backend}/           ← 你选的每个后端(可多选)
│   ├── init.sql         ← 建表脚本(Docker 自动挂载)
│   ├── README.md        ← 运行向导(环境要求 / 启动 / Docker / 环境变量)
│   ├── Dockerfile       ← 容器镜像
│   └── docker-compose.yml ← 一键编排(后端 + 数据库)
└── {frontend}/          ← 你选的每个前端(Vue / React)
    └── README.md        ← 运行向导(启动 / 构建 / 部署)

选了多个后端就生成多个后端目录,每个都独立完整;前端目录同理。init.sql、Dockerfile、docker-compose.yml、README.md 每个目录都自带,不是只在顶层一份。

后端(按语言,完整目录树)

每个后端都是开箱即跑的最小完整工程:入口、数据层、接口、中间件、配置、容器化一应俱全。

Go(go_backend)

├── main.go                      ← 入口 + 路由
├── db/db.go                     ← 数据库连接
├── middleware/auth.go           ← 认证中间件
├── conf/mapping.go              ← 名称映射(API ↔ DB)
├── utils/
│   ├── filterUtils.go           ← SQL 过滤、排序、引号
│   └── permissionUtils.go       ← 权限工具
├── model/                       ← 数据模型
├── dao/                         ← 数据访问层
├── handler/                     ← HTTP 处理器
├── config/
│   ├── permissions.json         ← 权限配置
│   └── db.json                  ← 数据库配置
├── init.sql                     ← 建表脚本
├── Dockerfile
├── docker-compose.yml
├── README.md
└── go.mod

Python FastAPI(python-backend)

├── main.py                      ← 入口
├── init/dbConnecter.py          ← 数据库连接
├── auth/                        ← 认证模块
├── dao/                         ← 数据访问层
├── routes/                      ← 路由
├── schema/                      ← 模型定义
├── config/                      ← 配置文件
├── init.sql                     ← 建表脚本
├── Dockerfile
├── docker-compose.yml
├── README.md
└── requirements.txt

TypeScript Express(ts-backend)

├── app.ts                       ← 入口
├── init/dbConnecter.ts          ← 数据库连接
├── auth/                        ← 认证模块
├── dao/                         ← 数据访问层
├── routes/                      ← 路由
├── types/                       ← 类型定义
├── validation/                  ← 请求校验
├── config/                      ← 配置文件
├── init.sql                     ← 建表脚本
├── Dockerfile
├── docker-compose.yml
├── README.md
└── package.json

Java Spring Boot(java-backend)

├── pom.xml                      ← Maven 配置(含 mvnw)
├── src/main/resources/
│   ├── application.yml          ← Spring 配置
│   └── permissions.json         ← 权限配置
├── src/main/java/.../
│   ├── Application.java         ← 入口
│   ├── entity/*.java            ← JPA 实体
│   ├── repository/*Repository.java ← 数据访问
│   ├── service/*Service.java    ← 业务逻辑
│   ├── controller/*Controller.java ← REST 控制器
│   └── config/
│       ├── DataSourceConfig.java
│       ├── RequestContextHolder.java
│       ├── UserContextFilter.java
│       ├── PermissionService.java
│       ├── SpecificationBuilder.java
│       └── FieldMaskAdvice.java
├── init.sql                     ← 建表脚本
├── Dockerfile
├── docker-compose.yml
└── README.md

前端(Vue / React)

前端是完整的管理界面工程:每张表一套「列表 + 表单」页面、路由、类型化 API 客户端、双语文案。

src/
├── main.ts / main.tsx           ← 应用入口
├── App.vue / App.tsx
├── router/                      ← 哈希路由(每张表一套列表 + 表单)
├── api/                         ← 类型化 API 客户端(每张表一个)
├── types/                       ← TypeScript 类型(每张表一个)
├── views/
│   └── {entity}/                ← 每张表的 ListView + FormView
└── lib/i18n.ts                  ← 双语(中/英)界面文案

生成的列表页自带分页、筛选,表单页按字段类型生成对应控件——直接在此基础上加业务。

怎么跑起来

最简单:用 Runner 在 VS Code 里点 Runner 一键启动,数据库、依赖、端口都自动处理(见《Runner 用法》。

手动跑(以 TS 后端 + Vue 前端为例)

# 1. 启动后端(自动建库 + 建表)
cd ts_backend
npm install
npm run dev        # 监听在 README 指定端口

# 2. 启动前端
cd ../vue_frontend
npm install
npm run dev        # 代理指向后端端口

容器化一键启动 每个后端目录内执行即可(自动拉起后端 + 数据库):

docker compose up -d --build

其他语言同理:先按 README 的启动命令,或直接用 Docker。每个后端 README 都包含了完整的启动、Docker、环境变量说明。

数据库

  • init.sql 是建表脚本,只包含代码生成所需的表结构定义,不含任何数据
  • Docker 部署时 init.sql 自动挂载到数据库容器的初始化目录
  • Runner 已自动完成建库与初始化;手动部署时自己执行一次即可

局限:init.sql 只覆盖代码生成所需的核心表结构。字符集、DB引擎、视图、触发器、存储过程等对象不包含在内——请在开发时用你自己的完整初始化 SQL 代替。