Skip to content

提供给AI的基础框架,便于快速开发小型项目。master是多模块分支,simple是单模块简化分支。

Notifications You must be signed in to change notification settings

mos1128/ai-example-framework

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Project Context

Tech Stack

引入的所有依赖组件都由父级 pom.xml 文件管理,遵循POM中约定的版本,如果对技术文档存在疑问,请查阅对应版本的技术文档。

核心框架

  • Maven - 项目构建和依赖管理
  • Java 17 - 编程语言版本
  • Spring Boot 3.5.7 - 应用框架
  • MySQL 8.x - 数据库
  • Druid 1.2.27 - 数据库连接池,提供监控和SQL防火墙
  • MyBatis Plus 3.5.12 - ORM 框架,简化数据库操作
  • Dynamic DataSource 4.3.1 - 动态多数据源支持
  • Redis - 缓存和会话存储
  • HuTool 5.8.41 - Java工具类库

Project Conventions

代码结构

项目采用多模块架构设计:

base-demo/
├── common/          # 公共模块 - 通用工具类、配置、异常处理等
├── core/           # 核心业务模块 - 业务逻辑层、数据访问层
├── server/         # Web层模块 - 控制器、配置文件、启动类
└── pom.xml         # 父级Maven配置

包命名规范

  • 基础包名: 组织名称.项目名称
  • 公共模块: com.mos.example.common.*
  • 核心模块: com.mos.example.core.*
  • Web模块: com.mos.example.server.*

开发规范

  1. 重要:任何时候都需要保持代码结构清晰
  2. 查看现有的代码中是否存在可复用的代码,在能确保结构清晰的情况下,复用现有代码,减少冗余
  3. 参阅现有代码的风格进行参考,并保持一致(接口写法、命名方式、文档注释风格、代码引用等)。
  4. 本次项目不会对外,且本地运行,无需额外的安全校验或者部署

已有工具

  • 优先使用 EasyBaseMapper 进行数据库批量插入
  • 优先使用 DynamicDataSource 的注解进行多数据源权限控制
  • 优先使用 utils 目录下的工具类,如果没有再新写

About

提供给AI的基础框架,便于快速开发小型项目。master是多模块分支,simple是单模块简化分支。

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages