Skip to content

框架层 ​

返回体、鉴权、租户、联表、缓存、锁、Excel 都在 yudao-framework,不在某个业务 Controller 里各写一套。目录先看 项目结构,再对照本页看一次 /admin-api 怎么穿过 Starter。

默认端口 48080,前缀 /admin-api。整机位置见 开发指南。工程启动见 快速开始。

框架在整机中的位置 ​

yudao-server 几乎不直接列 Starter。它引入 yudao-module-*-server,模块再传递 yudao-spring-boot-starter-*。yudao-common 是 POJO、错误码、FlowBillService 这类契约;带 biz 的 Starter 是租户、数据权限、IP 库。

系统架构

系统架构:最下一层就是本页要讲的 Starter。业务模块接到这些组件和 yudao-common,不要在 Controller 里自造返回码或分页。

单据回写抽象在 yudao-common 的 FlowBillService。发布和办理仍在 BPM。框架自己没有审批菜单,也没有 processDefinitionKey。

不要用目录名当流程 key

用车是 oa_car_apply_bill。FlowBillService 只按各模块枚举找实现,不要在 Starter 里编 key。

一次请求怎么走 ​

管理端请求进 TokenAuthenticationFilter,再落到 @PreAuthorize。租户上下文写入后,MyBatis 拦截器给 SQL 拼 tenant_id。列表再套 @DataPermission。返回统一 CommonResult,业务失败走 ServiceException。

示意图:类在 yudao-framework 对应 Starter。文件客户端、验证码开关不在这条链上。

名称说明仓库路径
前缀与扫描adminApi 默认 /admin-api,扫 **.controller.admin.**yudao-spring-boot-starter-web WebProperties
认证Token 过滤器TokenAuthenticationFilter
租户默认 yudao.tenant.enable: trueyudao-spring-boot-starter-biz-tenant
功能权限@PreAuthorizeyudao-spring-boot-starter-security
数据权限@DataPermissionyudao-spring-boot-starter-biz-data-permission
持久化BaseMapperX / 联表yudao-spring-boot-starter-mybatis
返回 / 分页CommonResult / PageParamyudao-common

横切怎么落地 ​

多数框架能力没有自己的业务表。能看见的入口在系统 / 基建菜单:角色数据范围、租户、文件配置、WebSocket 演示。

示意图:权限字写在菜单上,不是框架另开一张权限表。敏感词台账在 IM,不在 framework 模块。

名称说明仓库路径
工程五篇目录、热加载、改包、迁移、删除项目结构 起
VOConvert / BeanUtils / @TransVO 对象转换
异常ServiceException + 全局处理异常处理
权限功能 + 数据范围功能与数据权限
MyBatisBaseMapperX / 联表MyBatis
租户字段隔离拦截器SaaS 多租户
校验 / 分页注解与 PageParam参数校验、分页排序
文件配置和列表在基建文件存储
缓存 / 锁Redis + @Lock4jRedis 与本地缓存、分布式锁
ExcelFastExcel @ExcelPropertyExcel 导入导出
保护幂等、限流、加解密幂等与限流、HTTP 加解密
其它异步、验证码、脱敏、WebSocket、工具侧栏「框架」组

前后端代码 ​

名称说明仓库路径
聚合各 Starterruoyi-office/yudao-framework/
公共类型CommonResult / ErrorCode / PageParamyudao-common/
单体直接依赖protection、rpcruoyi-office/yudao-server/pom.xml
其余 Starter由 system / infra 等模块传递各 yudao-module-*-server/pom.xml
双模式单体或微服务两种部署方式技术架构

角色数据权限按钮 1064。验证码无菜单,本地常关 yudao.captcha.enable。

菜单与权限

本系统截图:系统管理 → 菜单管理。功能权限字写在菜单上。

文件配置

本系统截图:基础设施 → 文件配置。存储器枚举在 infra,Starter 不提供 FileClient。

功能开启 ​

没有「框架开关」页。启动 YudaoServerApplication 后,被模块引入的 Starter 就会装配。租户默认打开。

客户默认包 ruoyi-office-db/dump/latest/ 带系统 / 基建表和菜单。以后改表走 ruoyi-office-db/update/。库结构说明见 数据库文档。

示意图:先跑起来,再按篇改注解和 yaml。

旧文 框架功能开启 已并入本页,请收藏本篇。

相关篇 ​

联系我们

获取报价、演示和二开方案

微信咨询二维码

微信咨询

17156169080

添加时备注「RuoYi Office」

在线体验商业版