项目介绍


Module 模块划分

模块 释义 备注
blog-core 核心业务类模块,提供基本的数据操作、工具处理等 该模块只是作为核心依赖包存在
blog-admin 后台管理模块 该模块作为单独项目打包部署
blog-web 前台模块 该模块作为单独项目打包部署
blog-spider 爬虫相关代码模块 目前仅作为后台管理模块里“文章搬运工”的实现代码库
blog-file 文件上传相关的模块 依赖包

目录简介

项目结构简介

|-- LICENSE                                      - 项目开源协议
|-- README.md                                    - 项目文档
|-- blog-admin                                   - 后台管理模块
|-- blog-core                                    - 核心包
|-- blog-spider                                  - 爬虫模块
|-- blog-web                                     - 前台项目模块
|-- build.sh                                     - 打包脚本
|-- contribution.md                              - 参与贡献代码的说明文档
|-- demo.md                                      - 用作演示的文档
|-- docs                                         - 用来存放项目中一些其他文件
|   |-- db                                         - 项目数据库
|   |   |-- dblog.sql                                - 项目数据库脚本
|   |   `-- update.sql                               - sql更改记录
|   |-- html                                       - html文件
|   |   `-- web                                      - 纯html的前台项目模板文件
|   |-- readme.md                                  - 关于UserAgent工具的特殊声明  
|   `-- yuicompressor                              - 压缩工具
`-- update.md                                    - 项目更新记录(一些小的无关紧要的更新不记录)

blog-core目录结构简介

src
|-- main
|   |-- java
|   |   `-- com
|   |       `-- zyd
|   |           `-- blog
|   |               |-- business                    - 业务相关的代码包
|   |               |   |-- annotation                - 注解类
|   |               |   |-- aspect                    - 切面相关类
|   |               |   |-- consts                    - 常量类
|   |               |   |-- dto                       - DTO
|   |               |   |-- entity                    - 业务实体类
|   |               |   |-- enums                     - 枚举类
|   |               |   |-- service                   - 服务接口类
|   |               |   |   `-- impl                    - 服务实现类
|   |               |   |-- util                      - 业务相关的工具类
|   |               |   `-- vo                        - VO
|   |               |-- framework                   - 核心框架相关的代码包
|   |               |   |-- config                    - 项目配置类
|   |               |   |-- exception                 - 异常类
|   |               |   |-- holder                    - 特殊支持类
|   |               |   |-- object                    - 一些公用类
|   |               |   |-- property                  - Properties
|   |               |   |-- redis                     - redis相关
|   |               |   |-- runner                    - 自定义ApplicationRunner
|   |               |   `-- tag                       - freemarker自定义标签
|   |               |-- persistence                 - 持久化相关的代码包
|   |               |   |-- beans                     - 数据实体类
|   |               |   `-- mapper                    - mapper接口类
|   |               |-- plugin                      - 插件
|   |               `-- util                        - 通用工具类
|   `-- resources                                   - 资源目录
|       `-- mybatis                                 - mapper.xml配置文件
`-- test                                            - 测试类                      

blog-admin目录结构简介

src
|-- main
|   |-- java
|   |   `-- com
|   |       `-- zyd
|   |           `-- blog
|   |               |-- controller               - controller
|   |               `-- core                     - admin模块中一些核心的功能类
|   |                   |-- config               - 配置类
|   |                   |-- interceptor          - 拦截器类 
|   |                   |-- shiro                - shiro相关
|   |                   `-- websocket            - websocket相关
|   `-- resources                                - 资源目录
|       |-- static                               - 静态资源文件(js、css和img)
|       `-- templates                            - 视图模板文件
|           |-- article                          - 文章相关视图                         
|           |-- comment                          - 评论相关视图
|           |-- error                            - 自定义异常页面相关视图
|           |-- include                          - 自定义宏文件
|           |-- layout                           - 布局相关视图模板
|           |   |-- footer.ftl                     - 底部页脚模板
|           |   |-- setting.ftl                    - 顶部页头模板
|           |   `-- sidebar.ftl                    - 左侧菜单工具栏模板
|           |-- link                             - 友情链接相关视图
|           |-- notice                           - 网站通知相关视图
|           |-- remover                          - 文章搬运工相关视图
|           |-- resources                        - 资源文件相关视图(url菜单)
|           |-- role                             - 角色相关视图
|           |-- template                         - 模板相关视图(sitemap、robots等)
|           |-- update                           - 网站更新记录相关视图
|           `-- user                             - 用户管理相关视图
`-- test                                         - 单元测试               

blog-web目录结构简介

src
|-- main
|   |-- java
|   |   `-- com
|   |       `-- zyd
|   |           `-- blog
|   |               |-- controller      - controller
|   |               `-- core            - web模块中一些核心的功能类
|   |                   `-- aspects       - aop切面相关的类
|   `-- resources                       - 资源目录
|       |-- static                      - 静态资源文件(js、css和img)
|       `-- templates                   - 视图模板文件
|           |-- common                  - 一些供公共引用的组件、文件
|           |-- error                   - 自定义异常页面相关视图
|           |-- include                 - 自定义宏文件
|           |-- layout                  - 布局相关视图模板
|           |   |-- footer.ftl            - 底部页脚模板
|           |   |-- header.ftl            - 头部模板(菜单)
|           |   |-- quote.ftl             - 引用相关(css等)
|           |   `-- sidebar.ftl           - 右侧工具栏模板
`-- test                                - 单元测试   

blog-spider目录结构简介

src
|-- main
|   |-- java
|   |   `-- com
|   |       `-- zyd
|   |           `-- blog
|   |               `-- spider
|   |                   |-- model       - model实体
|   |                   |-- processor   - 爬虫核心处理类,负责页面解析
|   |                   `-- util        - 工具类
|   `-- resources                       - 资源文件
`-- test                                - 测试类

blog-file目录结构简介

src
 ├─main
 │  ├─java
 │  │  └─com
 │  │      └─zyd
 │  │          └─blog
 │  │              └─file
 │  │                  ├─alioss         - 阿里云OSS
 │  │                  │  ├─api
 │  │                  │  └─entity
 │  │                  ├─entity         - model实体
 │  │                  ├─exception      - 通用异常类
 │  │                  └─util           - 工具类
 │  └─resources                         - 资源文件
 └─test                                 - 测试类