说明
本章对tysite-service
项目的目录结构进行详细说明。前两节主要是介绍项目根目录和maven工程目录的基本说明,第三节重点介绍tysite-scrvice
项目 spring mvc 规范下的目录规划。
一. 项目目录详解
本节我们来简单说下tysite-service
项目的主要目录。
- src :代码存放目录,包含项目的源代码、测试用例等
- .gitignore:文件记录git不参与提交的文件或目录
- build.gradle:gradle的主配置文件
二. maven工程目录
本节简单介绍maven的标准目录结构,在src目录下,将java源代码
、配置文件
以及测试代码
分开管理,便于项目打包和发版
|- src
|- main # 存放项目源代码
|- java # java源代码
|- resources # 配置文件及其他静态文件信息
|- test # 存放项目测试类
|- java # 单元测试
|- test # 测试用到的配置文件
三. java 目录规划
本节就 java源代码
进行详细的项目划分规划,图例中的文件目录起始于src/main/java/org/tysite/tyservice
。
- ServletInitializer.java 是springboot servlet的初始化入口文件。
- TysiteServiceApplication.java 是本项目的启动文件主入库,springboot的自动装配和全局配置均设定在此文件中。
- common :公共信息文件夹,存放全局公共配置,包括
静态常量
、过滤
器、工具类
、基础配置
等. - module : 模块文件夹,按照项目模块存放不同业务模块代码。
- example :示例文件夹,存放非功能性演示代码。
详细目录规划,参考下图:
|- ServletInitializer.java
|- TysiteServiceApplication.java
|- common //全系统公共使用的内容,作为基础类库存在
|- aspect //AOP
|- constant //静态常量
|- configuration //基础配置类
|- exception //异常处理类
|- filter //过滤器
|- utils //常用工具类
|- zip //zip处理
|- excel //excel处理
|- module
|- authority //系统权限管理模块
|- permission //权限管理
|- role //角色管理
|- authorize //授权管理
|- organization //组织机构管理
|- group //组织
|- user //用户
|- controller // 存放所有controller接口
|- entity // 存放持久层对象
|- dto // 存放数据传输对象
|- service // 存放服务接口和实现类
|- impl
|- mapper // 存放数据库映射文件
|- 其他功能模块
|- example //博客中springboot功能使用示例代码