跳到主要内容

开发者与 AI 导航手册

本手册面向人类开发者与 AI 编码助手(如 Trae、Copilot 等),提供框架能力矩阵、查询地图以及与 AI 协作的上下文,便于快速定位需求并开始编码。

快速启动决策树

不同接入场景对应不同入口,按需求选择:

目标推荐路径
从零开始,快速生成一个完整的后台增删改查项目App Scaffold 脚手架。详见 Scaffold 项目接入指南
现有 Spring Boot 项目,需接入 Geelato 核心能力最小化接入。详见 新项目最小接入
了解框架架构设计、Runtime 与 Designer 的关系阅读架构说明。详见 PlatformWebRuntime
对接单点登录 (SSO) 与认证统一认证方案。详见 统一认证总览

能力速查矩阵

开发过程中需使用特定功能时,可通过下表快速跳转到对应开发指南。

数据与存储

功能意图核心组件 / 技术栈查阅文档
编写后端的增删改查代码MetaFactory、Fluent DSLORM: Fluent DSL
在实体类上配置表名和字段映射@Title@Col@ModelORM: 注解说明
通过 JSON 格式在前端或网关进行复杂查询MQL (Meta Query Language)MQL: 语法与用法
配置或连接多个数据库Dynamic Datasource动态数据源能力

业务与扩展

功能意图核心组件 / 技术栈查阅文档
获取当前登录用户、租户或请求上下文Global Context、SecurityContext平台能力: 全局上下文
拦截数据保存/更新前后的逻辑Entity Events、Event BusORM: 事件特性
扩展平台默认规则(如查询过滤、字段填充)SPI、Spring Bean查询过滤与字段填充 SPI 扩展
开发、加载和卸载业务插件Plugin Mechanism插件机制: 定义与开发

文件与接口

功能意图核心组件 / 技术栈查阅文档
处理附件的上传与下载FileController、OSS 模块文件上传
查询后端提供的 RESTful API 接口契约SrvExplain、OpenAPIAPI 参考

AI 辅助开发上下文

向 AI 编码助手(如 Trae、GitHub Copilot、ChatGPT)提问时,附带以下上下文有助于 AI 准确理解 Geelato 的专有术语并生成符合规范的业务代码。

框架基础认知设定 (System Prompt)

你现在是一个熟练掌握 Geelato 框架的高级 Java 工程师。
Geelato 是一个企业级低代码与全代码混合框架,支持 MySQL、PostgreSQL、Oracle 等多数据库的自适应无缝切换。请在生成代码时严格遵循以下规范:
1. 【ORM 规范】禁止写原生 SQL 或 MyBatis XML,所有的 CRUD 必须使用 `MetaFactory` 的 Fluent DSL。
2. 【API 规范】对外暴露的 Controller 必须使用 `@ApiRestController`,并统一返回 JSON 格式。
3. 【权限规范】所有获取当前登录用户的操作,必须通过注入 `SecurityHelper` 调用其内部方法获取。
4. 【动态查询】在前端发起的多表联合查询,建议优先指导使用 MQL 语法,而不是在后端堆砌接口。

下一步

如初次接触,建议从 快速开始 入手。