diff --git a/README.md b/README.md index 6e9f732..63ff007 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,67 @@ -# sczx_store +# 闪充智行门店服务 +> 门店信息相关 -闪充智行-门店服务 \ No newline at end of file +## 工程目录结构 + +### 1. 工程根目录 + +- **.idea/** :IntelliJ IDEA 的项目配置文件目录 +- **logs/** :日志文件存放目录 +- **src/** :源代码目录 +- **target/** :构建输出目录(如编译后的类文件、打包的 JAR/WAR 文件等) +- **.gitignore** :Git 版本控制系统忽略文件配置 +- **Dockerfile** :Docker 镜像构建配置文件 +- **Dockerfile.buildagent** :Docker 构建代理配置文件 +- **Jenkinsfile** :Jenkins 持续集成配置脚本 +- **pom.xml** :Maven 项目的配置文件 +- **README.md** :项目说明文档 +- **settings.xml** :Maven 或其他工具的设置文件 + +### 2. src/main 目录结构 + +#### java 目录 (`com.sczx.**`) +- com.sczx.** +- ├── aspect/ # 切面编程相关类 +- │ ├── FacadeAspect.java +- │ └── WebLogAspect.java +- ├── common/ # 通用组件 +- │ ├── constant/ # 常量定义 +- │ ├── enums/ # 枚举类型定义 +- │ ├── IApiCode.java # API 状态码接口 +- │ └── Result.java # 通用响应结果类 +- ├── config/ # 配置类 +- │ ├── MyBatisPlusConfig.java #mybatis配置 +- │ └── SwaggerConfig.java +- ├── controller/ # 控制器类,处理 HTTP 请求 +- ├── convert/ # 转换器类,用于数据转换 +- ├── dto/ # 数据传输对象 +- ├── exception/ # 自定义异常类 +- ├── mapper/ # MyBatis 映射器接口 +- ├── po/ # 持久化对象 +- ├── repository/ # 数据访问层接口 +- ├── service/ # 服务层 +- │ └── impl/ # 服务实现类 +- ├── thirdpart/ # 第三方服务集成 +- │ ├── dto/ # 第三方服务相关的 DTO +- │ ├── facade/ # 第三方服务的外观模式类 +- │ └── integration/ # 第三方服务的集成类 +- ├── utils/ # 工具类 +- │ ├── ComputerInfo.java +- │ ├── JwtUtil.java +- │ ├── OrderUtil.java +- │ └── RedisUtil.java +- └── Application.java # Spring Boot 应用入口类 + +### 3. resources 目录 +- resources/ +- ├── mapper/ # MyBatis 映射文件 +- │ ├── OrderMainMapper.xml +- │ └── OrderSubMapper.xml +- ├── application.yml # 应用配置文件 +- └── logback.xml # 日志配置文件 + +### 4. src/test 目录 +- test/ +- └── java/ +- └── com.sczx/ # 测试代码 +- │ └── CodeGenerator.java # mybatisPlus代码生成器,直接运行,输入表名回车即可 \ No newline at end of file