How xgy-c/tlias works
项目类型与目的
• 这是一个基于 Spring Boot 和 MyBatis 的单体 Web 管理系统,提供部门(Dept)和员工(Emp)之类的增删改查接口,并集成了登录校验、操作日志记录、文件上传(Aliyun OSS)等功能。
• 主要面向初学者,示范典型的 MVC 分层架构、AOP 记录日志、Filter/Interceptor 做登录校验、JWT 认证、静态资源托管等常见 Web 开发模块。
文件结构分析
• src/main/java/com/xgy
• controller:HTTP 接口层(DeptController、EmpController、LoginController、UploadController)
• service & service/impl:业务逻辑层
• mapper (+ resources/com/xgy/mapper/*.xml):MyBatis 数据访问层
• pojo:领域模型/DTO
• config:Spring MVC 和静态资源等通用配置
• filter & interceptor:登录校验请求拦截
• anno & aop:自定义 @Log 注解和日志切面 LogAspect,自动记录操作日志到 OperateLogMapper/DeptLogMapper
• utils:JWT 工具类、AliOSS 配置与工具
• exception:全局异常处理器
• src/main/resources
• application.yml:环境配置
• static:HTML 页面(upload.html)
• mapper XML:SQL 映射文件
• pom.xml + mvnw:Maven 构建与依赖管理
如何绘制系统设计图
a. 确定主要参与者和组件
• Client (浏览器或 Postman)
• Spring Boot 内嵌 Tomcat(HTTP 服务器)
• Controller 层:DeptController、EmpController、LoginController、UploadController
• Service 层:DeptService、EmpService、DeptLogService
• DAO 层(MyBatis):DeptMapper、EmpMapper、OperateLogMapper、DeptLogMapper + 对应 XML
• 数据库:MySQL(或其他 RDBMS)
• 外部文件存储:Aliyun OSS
• 横切关注点:
• Filter(LoginCheckFilter)– 请求进入时做 Token 校验
• Interceptor(LoginCheckInterceptor)– MVC 层面再校验
• AOP(LogAspect + @Log)– 在服务/控制器方法执行前后记录操作日志
• 配置与工具:JwtUtils、AliOSSUtils、WebConfig、GlobalExceptionHandler
b. 组件关系与交互流程
1. 客户端发起 HTTP 请求 → Spring Boot (Tomcat)
2. Filter:LoginCheckFilter 拦截检查 JWT token
3. Interceptor:进一步做基于 URL/方法级的权限检查
4. Controller 接收请求,调用对应 Service
5. AOP 切面:在带 @Log 的方法上记录操作日志,调用 OperateLogMapper/DeptLogMapper 持久化
6. Service 层执行业务,调用 Mapper
7. MyBatis Mapper 执行 SQL 操作,访问数据库
8. 若是 UploadController,Service 层会调用 AliOSSUtils 将文件推送到 Aliyun OSS
9. Controller 返回 JSON(包装在 Result/ PageBean 中)给客户端
c. 重要架构模式与设计原则
• 分层架构 (MVC + Service + DAO)
• 依赖注入 (Spring IoC)
• AOP 横切关注点 (日志)
• 责任链 / 拦截器模式 (Filter + HandlerInterceptor)
• 外部化配置 (application.yml)
• RESTful API 设计
d. 关键技术栈
• Spring Boot (Web, AOP, MVC, DI)
• MyBatis (+ XML 映射)
• JWT (JwtUtils)
• Aliyun OSS SDK (AliOSSUtils)
• Maven 构建
• SLF4J/Logback(日志)
• 全局异常处理 (ControllerAdvice)
绘制指南与要点
• 在顶层画出客户端(浏览器 / REST 客户端)和外部服务(MySQL 数据库、Aliyun OSS)。
• 将服务器模块画成一个大容器,内部再细分:
• 入口层:Filter → Interceptor → Controller
• 业务层:Service
• 数据层:Mapper + DB
• 横切关注点:AOP 日志模块独立标注
• 工具/配置:JWT 模块、OSS 模块、Exception Handler
• 用箭头标明调用/数据流向:
• 客户端 → HTTP 接口 → Filter → Interceptor → Controller → Service → Mapper → DB
• UploadController → AliOSSUtils → Aliyun OSS
• LogAspect → Mapper → DB(日志表)
• 使用不同形状/颜色区分:
• 矩形:模块/组件
• 箭头:同步调用/数据流
• 颜色:
– 蓝色:核心业务流(Controller/Service/Mapper/DB)
– 绿色:安全/认证(Filter/Interceptor/JWT)
– 橙色:日志 AOP
– 紫色:外部资源(Aliyun OSS)
• 标注清晰的组件名和交互协议(HTTP、JDBC、OSS SDK)
• 如果需要,也可在旁边补充各层使用的技术(Spring MVC, MyBatis, JWT, AOP)