目录结构介绍、快速了解每个文件目录包的意图
# 一、common 通用工具模块
基础通用功能的工具类模块,涵盖广泛,满足各种工具操作。
├─common
│ ├─bin 可执行目录、打包模块
│ ├─src 工程源文件代码目录
│ │ ├─main
│ │ │ ├─java
│ │ │ │ └─com
│ │ │ │ └─jeesite
│ │ │ │ └─common
│ │ │ │ ├─callback 方法回调相关接口
│ │ │ │ ├─codec 解码编码工具
│ │ │ │ ├─collect 集合工具
│ │ │ │ ├─exec 命令行执行工具
│ │ │ │ ├─idgen ID生成工具
│ │ │ │ ├─image 图片处理工具
│ │ │ │ ├─io 文件处理工具
│ │ │ │ ├─lang 字符串等基础数据类型处理工具
│ │ │ │ ├─mapper JSON、XML等处理工具
│ │ │ │ ├─media 视频音频处理
│ │ │ │ ├─msg 邮件短信工具
│ │ │ │ ├─network IP、Mac工具
│ │ │ │ ├─reflect 反射工具、类扫描工具
│ │ │ │ ├─text 文本处理、拼音、差异比较工具
│ │ │ │ ├─ueditor 富文本编辑器
│ │ │ │ ├─utils
│ │ │ │ │ ├─excel Excel导入导出工具
│ │ │ │ │ └─word Word导出工具
│ │ │ │ └─web
│ │ │ │ └─http HTTP、Servlet相关工具
│ │ │ └─resources
│ │ │ └─static 静态文件资源
│ │ │ ├─adminlte AdminLTE UI
│ │ │ ├─bootstrap BootStrap 核心
│ │ │ ├─bootstrap-plugins Bootstrap 插件
│ │ │ ├─common 通用js工具
│ │ │ ├─fonts 字体图标
│ │ │ ├─icheck 复选框单选框美化
│ │ │ ├─jquery jQuery 核心
│ │ │ ├─jquery-plugins jQuery 插件
│ │ │ ├─jquery-ztree zTree 树结构插件
│ │ │ ├─laydate 日期选择插件
│ │ │ ├─layer 弹窗对话框插件
│ │ │ └─select2 下拉框美化
│ │ └─test 单元测试目录
│ └─target 编译结果目录
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# 二、modules 功能模块目录
所有功能模块将放到该目录下如:核心模块、内容管理、业务流程、文件管理等等。
├─modules
1
# 1、core 核心功能模块
├─modules
│ ├─core
│ │ ├─bin 可执行目录、模块打包
│ │ ├─db 数据库模型设计目录
│ │ ├─src 模块源文件代码目录
│ │ │ ├─main
│ │ │ │ ├─java
│ │ │ │ │ └─com
│ │ │ │ │ └─jeesite
│ │ │ │ │ ├─autoconfigure 模块SpringBoot自动配置包
│ │ │ │ │ ├─common
│ │ │ │ │ │ ├─shiro
│ │ │ │ │ │ │ ├─filter Shiro安全过滤器类
│ │ │ │ │ │ │ └─realm Shiro安全身份认证类
│ │ │ │ │ │ └─utils
│ │ │ │ │ │ └─excel
│ │ │ │ │ │ └─fieldtype 核心模块定义的Excel导入导出类型
│ │ │ │ │ └─modules
│ │ │ │ │ ├─config
│ │ │ │ │ │ └─web
│ │ │ │ │ │ └─interceptor SpringMVC拦截器、日志拦截等
│ │ │ │ │ ├─msg 消息模块内部消息
│ │ │ │ │ └─sys 核心功能包
│ │ │ │ │ ├─dao 持久层相关类
│ │ │ │ │ ├─db 数据库初始化配置类
│ │ │ │ │ ├─entity 实体类
│ │ │ │ │ ├─interceptor 接口相关
│ │ │ │ │ ├─service 业务服务类及接口
│ │ │ │ │ │ └─support 业务实现支撑类
│ │ │ │ │ ├─utils 核心模块工具包
│ │ │ │ │ └─web 核心模块控制器包
│ │ │ │ └─resources
│ │ │ │ ├─config 核心功能配置文件
│ │ │ │ ├─db
│ │ │ │ │ ├─create 核心功能数据库初始化SQL脚本
│ │ │ │ │ └─upgrade
│ │ │ │ │ └─core 核心功能的数据库升级SQL脚本
│ │ │ │ ├─i18n
│ │ │ │ │ └─core 国际化核心功能语言包
│ │ │ │ ├─mappings
│ │ │ │ │ └─modules
│ │ │ │ │ ├─msg 消息模块复杂SQL定义
│ │ │ │ │ └─sys 核心功能复杂SQL定义
│ │ │ │ ├─mybatis MyBatis框架个性化配置文件
│ │ │ │ ├─static
│ │ │ │ │ ├─common 通用静态资源目录
│ │ │ │ │ │ └─i18n 通用静态资源国际化语言包
│ │ │ │ │ ├─echarts Echarts图表
│ │ │ │ │ ├─fullcalendar 日历组件
│ │ │ │ │ ├─images 通用图片资源
│ │ │ │ │ ├─jqGrid DataGrid表格组件
│ │ │ │ │ ├─jquery-plugins jQuery的一些插件
│ │ │ │ │ ├─jquery-timeago 时间流逝组件
│ │ │ │ │ ├─jquery-validation 表单验证组件
│ │ │ │ │ ├─modules
│ │ │ │ │ │ └─sys 核心功能js文件
│ │ │ │ │ ├─ueditor 富文本插件
│ │ │ │ │ └─webuploader 文件上传插件
│ │ │ │ ├─templates
│ │ │ │ │ └─modules
│ │ │ │ │ └─gen 代码生成模板
│ │ │ │ │ ├─crud 增删改查模板
│ │ │ │ │ ├─crud_cloud Cloud版的增删改查模板
│ │ │ │ │ ├─module 新增Maven模块的生成模板
│ │ │ │ │ ├─module_cloud Cloud版的新增Maven模块模板
│ │ │ │ │ └─query 仅查询功能的代码生成模板
│ │ │ │ └─views
│ │ │ │ ├─error 错误页面视图
│ │ │ │ ├─include 通用的视图片段
│ │ │ │ │ └─sysIndex 主框架页的视图片段
│ │ │ │ ├─layouts 页面布局框架文件
│ │ │ │ ├─modules
│ │ │ │ │ ├─msg 内置消息视图
│ │ │ │ │ └─sys 核心功能视图
│ │ │ │ └─themes 个性化主题定义视图
│ │ │ │ └─default 默认主题目录
│ │ │ │ ├─include 默认主题的视图片段
│ │ │ │ └─modules 默认主题的模块视图
│ │ │ └─test 单元测试目录
│ │ └─target 编译结果目录
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
# 2、template 工程模板
最初定义是为了方便客户新建模块,直接复制一份,修改下文件名和模块名即可。
在v4.2.2版本的模块管理里新增了 模块代码快速生成。
│ └─template
│ ├─.settings
│ ├─bin 可执行目录、模块打包
│ ├─db 数据库模型设计目录
│ ├─src 模块源文件代码目录
│ │ └─main
│ │ ├─java 源码类目录
│ │ └─resources
│ │ ├─config 模块独立的配置文件
│ │ ├─db
│ │ │ ├─create 模块数据库初始化脚本
│ │ │ └─upgrade 模块数据库更新升级脚本
│ │ └─static
│ │ └─modules
│ │ └─template 模块独立的静态资源
│ └─target 编译结果目录
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
# 三、parent 父级 pom.xml
所有 Maven 最上级的 pom.xml 定义,包含第三方依赖的版本号属性定义、插件定义等。
├─parent
│ └─bin 可执行目录、打包模块
1
2
2
# 四、root 顶级 pom.xml
所有模块间的引用,IDEA 导入的 root pom.xml 功能,统一打包的工程
├─root
│ └─bin 可执行目录、打包全部工程
1
2
2
# 五、web 服务启动工程
系统的入口,模块的引用、参数配置、启动 Web 服务的工程
└─web
├─bin 可执行目录、打包全部工程
│ └─docker Docker 容器部署工具
├─db 数据库模型设计目录
├─src 源代码目录
│ ├─main
│ │ ├─java
│ │ │ └─com
│ │ │ └─jeesite
│ │ │ └─modules
│ │ │ └─test 代码生成功能示例
│ │ │ ├─dao 持久层
│ │ │ ├─db Test示例功能数据库初始化配置类
│ │ │ ├─entity 实体Bean
│ │ │ ├─service 业务逻辑层
│ │ │ └─web 视图控制器
│ │ ├─resources
│ │ │ ├─config 系统配置文件
│ │ │ ├─db
│ │ │ │ └─create Test示例功能数据初始化脚本
│ │ │ ├─mappings
│ │ │ │ └─modules
│ │ │ │ └─test Test示例功能复杂SQL定义
│ │ │ ├─static
│ │ │ │ └─common 通用静态css/js引用文件
│ │ │ └─views
│ │ │ └─modules
│ │ │ ├─demo 一些组件演示示例
│ │ │ └─test Test示例功能视图
│ │ └─webapp
│ │ ├─userfiles 文件上传默认目录,可更改其它目录或其他OSS存储
│ │ │ ├─avatar 用户上传的头像
│ │ │ ├─fileupload 文件上传组件上传的文件
│ │ │ └─system 富文本用户上传目录
│ │ └─WEB-INF
│ │ ├─classes 类及资源编译目录
│ │ └─ureportfiles 报表文件目录
│ └─test 单元测试工具
└─target 工程编译结果目录
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
# 六、模块介绍清单
# 1、JeeSite
JeeSite 模块名 | 说明 |
---|---|
jeesite-common | 研发工具类项目 |
jeesite-module-core | 核心功能模块代码项目 |
jeesite-module-bpm | Flowable 业务流程模块 |
jeesite-module-cms | 内容管理模块、网站、栏目 |
jeesite-module-cms-elasticsearch | 内容管理全文检索服务 |
jeesite-module-cms-pagecache | 内容管理页面缓存静态化服务 |
jeesite-module-swagger | 在线文档外部接口发布包 |
jeesite-module-filemanager | 文件管理、权限、预览、分享 |
jeesite-module-filepreview | 文件预览图片、视频、文档 |
jeesite-module-mybatisplus | MyBatis-Plus集成示例模块 |
jeesite-module-oauth2 | 第三方系统登录模块(支持大多数的 OAuth2 协议客户端) |
jeesite-module-oss-client | OSS 对象存储模块(MinIO、阿里、腾讯、七牛等) |
jeesite-module-weixin | 微信对接接口、公众号绑定、消息推送 |
jeesite-module-elasticsearch | ES 7.x 全文检索解决方案 |
jeesite-module-rabbitmq | MQ 消息队列模块 |
jeesite-module-sharding | 读写分离分库分表解决方案 |
jeesite-module-ureport | 报表图表在线设计器 |
jeesite-module-visual | 可视化数据大屏设计器 |
jeesite-module-app | 手机端功能接口(uni-app、vue) |
jeesite-parent | pom.xml父级项目 |
jeesite-root | pom.xml顶级项目 |
jeesite-web | Web入口项目 |
jeesite-web-pro | Web入口项目(专业版) |
# 2、JeeSite Cloud
JeeSite Cloud 模块名 | 说明 |
---|---|
jeesite-cloud-eureka | 服务治理注册中心 |
jeesite-cloud-config | 统一配置中心微服务 |
jeesite-cloud-nacos | 注册中心与配置中心(替代Eureka和Config) |
jeesite-cloud-gateway | 入口项目(微服务版)、网关路由(Web) |
jeesite-cloud-module-core | 核心项目统一授权认证中心(Web) |
jeesite-cloud-module-core-rest | 核心项目接口发布服务 |
jeesite-cloud-module-core-client | 核心项目客户端接口 |
jeesite-cloud-module-files | 文件处理服务(Web) |
jeesite-cloud-module-test1 | 演示模块1项目(Web) |
jeesite-cloud-module-test1-client | 演示模块1客户端接口 |
jeesite-cloud-module-test2 | 演示模块2项目(Web) |
jeesite-cloud-module-test2-client | 演示模块2客户端接口 |
jeesite-cloud-module-test3 | 演示模块3项目(Web)(完全由工具自动生成的) |
jeesite-cloud-module-test3-client | 演示模块3客户端接口 |
jeesite-cloud-module-bpm | BPM独立服务项目(Web) |
jeesite-cloud-module-bpm-rest | BPM模块接口发布服务 |
jeesite-cloud-module-bpm-client | BPM模块接口调用项目 |
jeesite-cloud-module-seata | Seata分布式事务跨进程事务(Web) |
jeesite-cloud-module-seata-client | Seata分布式事务调用客户端 |
jeesite-cloud-module-extends | 扩展模块服务,根据业务需要再拆分(Web) |
jeesite-cloud-module-msg | 消息推送接受处理服务(Web) |
jeesite-cloud-parent-web | Cloud版Web项目的pom.xml父级项目 |
jeesite-cloud-parent | Cloud版pom.xml父级项目 |
jeesite-cloud-root | Cloud版pom.xml顶级项目 |
jeesite-cloud-sentinel | 流量防卫兵(替代Hystrix) 限流、熔断、降级 |
jeesite-cloud-zipkin | 分布式链路追踪 |