# 项目架构

项目采用前后台分离架构

---


## 1、项目技术栈

- 数据库：`推荐 mysql 5.7`
- 后端框架：`mysql 5.7`、`springboot`、`mybatis-plus`、`druid`、`pagehelper插件`、`redis`、`sa-token`、`lombok`、`hutool`、`fastjson` 等等 
- 前端框架：`sa-admin`、`vue.js`、`element-ui`、`wangEditor`、`jquery`、`layer`、`swiper`、`echarts` 等等 
- 接口文档：`sa-doc`



## 2、后端代码介绍

##### 各包说明 

> - com.pj 	主包
> 	- `current`		  存放有关全局行为的一些包
> 	- `project`		  项目模块总包
> 	- `project4sp`	  sa-plus 内置的模块总包
> 	- `utils`		  工具类包 
> 	- `SpServerApplication.java`		  启动类


##### 详细说明  

``` java
├─current			存放有关全局行为的一些包
│  ├─ config				项目配置类	（ yml 里 spring.myconfig 的相关配置会映射到MyConfig.java类属性中 ）
│  ├─ global				项目全局行为 (全局日志与全局异常处理)
│  ├─ mybatis			mybatis 相关配置（mapper.xml文件热刷新配置）
│  ├─ satoken			sa-token 相关配置 
│  │  CorsFilter.java		解决跨域问题的过滤器
│  │  SaFastPrint.java		sa-plus启动打印字符画
│  │ 
├─project		项目模块包，按表分包 
│  │ 
├─project4sp		sa-plus内置模块包 ，按表分包 
│  │ 
├─utils				工具类包 
│   ├─sg				sa-plus内置工具类包 
│   │       AjaxError.java		异常判断工具类 
│   │       AjaxJson.java		全局controller返回值工具类
│   │       NbUtil.java			一些常见util方法
│   │       SoMap.java			Map类优化
│   │       WebNbUtil.java		有关web的一些工具类 
│   │  JHttpUtil.java		java访问http服务工具类 
│   │  LogUtil.java			log打印工具类 
│   │  Ttime.java			计时器工具类 
│   
├── SpServerApplication.java		启动类 

```


## 3、前端代码介绍 

``` java 
├─sa-html			项目模块代码存放路径
├─sa-html-sp		sa-plus内置模块存放路径 
├─sa-resources		sa-admin 资源文件存放路径 
│  │  menu-list-sp.js		sa-plus 内置菜单文件 
│  │  menu-list.js			自定义菜单文件 
│  │  sa-code.js			sa-admin初始化代码文件 
│  
├─static			静态文件存放路径
│   │  sa.css			全局样式存放路径
│   │  sa.js			全局js存放路径，包含一系列工具类
│ 
│ index.html		首页
│ login.html		登录页
│ main.html		首屏页
```

## 4、接口文档代码介绍

``` java 
├─project		文档存放路径 
│      xxx.md	
├─sa-lib		sa-doc 相关资源 
│  index.html	首页 
│  _sidebar.md	目录树定义文件 
│
```