Skip to content

Java System 平台管理

路径:packages/server-java/src/main/java/com/xichen/server/system/
API 前缀:/api/v1/system/*
契约:contracts/openapi/rbac-api.yaml + contracts/openapi/platform-api.yaml

Controller 一览

Controller前缀主要能力
SystemUserController/users用户 CRUD、角色/岗位分配、重置密码、Excel 导入导出
SystemRoleController/roles角色 CRUD、分配权限、分配部门(数据范围)
SystemMenuController/menus菜单树 CRUD
SystemPermissionController/permissions权限码 CRUD(分页 + keyword 搜索)
SystemDeptController/depts部门树 CRUD
SystemPostController/posts岗位 CRUD
SystemDictTypeController/dict/types字典类型
SystemDictDataController/dict/data字典数据(含 GET /type/{dictType} 按类型拉取)
SystemConfigController/configs系统参数(含 GET /key/{configKey}
SystemNoticeController/notices通知公告
SystemFileController/files文件上传、列表、下载、删除
SystemDatabaseController/databasePOST /init 数据库初始化

用户模块要点

端点权限说明
GET /userssystem:user:list分页列表,支持 keyword;受 数据权限 过滤
GET /users/exportsystem:user:exportEasyExcel 导出
POST /users/importsystem:user:importExcel 导入
PUT /users/{id}/rolessystem:user:update分配角色
PUT /users/{id}/postssystem:user:update分配岗位
PUT /users/{id}/reset-passwordsystem:user:resetPwd重置密码

角色模块要点

端点说明
GET /roles/{id}返回 RoleDetailDto,含 deptIdspermissionIds
PUT /roles/{id}/permissions覆盖绑定权限 ID 列表
PUT /roles/{id}/depts自定义数据范围时绑定部门

权限与菜单

  • 权限sys_permission):独立表,角色通过 sys_role_permission 绑定
  • 菜单sys_menu):permission 字段为字符串,与权限码对齐,用于前端路由与入口控制
  • 种子数据:操作日志 / 登录日志 / 定时任务菜单挂在 系统管理 下,路由仍为 /monitor/*

文件模块

  • 上传:POST /files/upload(multipart)
  • 下载:GET /files/download/**Security 白名单,无需登录
  • 存储路径:app.upload.path(默认 ./uploads

字典与参数(分页配置示例)

字典 type用途
sys_page_size分页可选条数:10 / 30 / 50 / 100
参数 key用途
sys.page.defaultSize列表默认每页条数

种子见 DatabaseInitService.seedDictData() / seedConfigs();已有库可执行 contracts/sql/migrations/006_page_settings.sql

数据库初始化

DatabaseInitServicesystem/service/DatabaseInitService.java):

  1. 执行 classpath:db/drop.sql
  2. 执行 classpath:db/schema.sql
  3. 写入种子:部门、admin 用户/角色、全部 permission、菜单、字典、参数、演示定时任务

SystemDatabaseController 暴露为 POST /api/v1/system/database/init

操作审计

@Log 注解的写操作会由 monitor/aspect/OperLogAspect 写入 sys_oper_log(见 Monitor)。

关键 Service

Service职责
SystemUserService用户 CRUD、导入导出、数据权限
SystemRoleService角色、权限/部门分配
SystemMenuService菜单树
SystemPermissionService权限码分页
DataScopeService数据范围 SQL 过滤
DatabaseInitServicedrop + schema + seed

相关文档

Xichen Full Stack 内部文档