README.md 12.3 KB
Newer Older
doc_wei's avatar
doc_wei 已提交
1 2
# skyeye

doc_wei's avatar
doc_wei 已提交
3 4
#### 项目介绍

doc_wei's avatar
doc_wei 已提交
5
win10风格的一套系统,前端采用layui作为前端框架,后端采用SpringBoot作为服务框架,采用自封装的xml对所有请求进行参数校验,以保证接口安全性。</br>
doc_wei's avatar
doc_wei 已提交
6

doc_wei's avatar
doc_wei 已提交
7 8 9 10 11 12 13 14 15
|项目|地址|
|-------|-------|
|主项目地址|https://gitee.com/doc_wei01_admin/skyeye|
|APP端接口微服务地址|https://gitee.com/doc_wei01_admin/app-oaserver|
|APP端地址|https://gitee.com/doc_wei01_admin/oa-app|
|小程序端地址|https://gitee.com/doc_wei01_admin/small-pro|

> 该项目遵守MIT许可证,证书见`附件`

doc_wei's avatar
doc_wei 已提交
16 17 18 19
> APP端开始开发,前端采用VUE,后端采用SpringCloud,APP访问地址:[https://gitee.com/doc_wei01_admin/oa-app](https://gitee.com/doc_wei01_admin/oa-app "https://gitee.com/doc_wei01_admin/oa-app")

`项目持续更新,欢迎进群讨论`

doc_wei's avatar
doc_wei 已提交
20
##### 启动方式
doc_wei's avatar
doc_wei 已提交
21 22 23

直接运行com.skyeye.SkyEyeApplication即可,启动完成后,访问http://localhost:8081 即可。
初始化账号密码:`root/123456`
doc_wei's avatar
doc_wei 已提交
24

doc_wei's avatar
doc_wei 已提交
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
### OA主项目结构

- |----skyeye-promote---------------------OA主项目[端口:**8081**]
- - |----skyeye-web---------------------web层项目
- - |----skyeye-service-impl--------------Service服务层
- - |----skyeye-service-------------------ServiceImpl服务层接口
- - |----skyeye-dao----------------------Mapper层接口
- - |----skyeye-common------------------工具层
- - |----skyeye-activiti--------------------工作流
- - |----skyeye-entity---------------------部分操作实体类
- - |----skyeye-guacamole----------------远程控制桌面(开发中)
- - |----skyeye-mq-----------------------ActiveMq消息中间件
- - |----skyeye-quartz--------------------定时任务
- - |----skyeye-redis----------------------redis缓存
- - |----skyeye-websocket-----------------webSocket双工通讯
- - |----skyeye-wx------------------------微信接口层

## 子系统

### OA消息系统项目结构

- |----message-----------------------------消息系统[端口:**8084**]
- - |----message-web---------------------web层项目
- - |----message-service-impl--------------Service服务层
- - |----message-service-------------------ServiceImpl服务层接口
- - |----message-dao----------------------Mapper层接口
- - |----message-common------------------工具层
- - |----message-mq-----------------------ActiveMq消息中间件
- - |----message-quartz--------------------定时任务
- - |----message-redis----------------------redis缓存
- - |----message-websocket-----------------webSocket双工通讯

### OA门户后台管理系统项目结构

- |----gateway-promote---------------------消息系统[端口:**8083**]
- - |----gateway-web---------------------web层项目
- - |----gateway-service-impl--------------Service服务层
- - |----gateway-service-------------------ServiceImpl服务层接口
- - |----gateway-dao----------------------Mapper层接口
- - |----gateway-common------------------工具层
- - |----gateway-entity---------------------部分操作实体类
- - |----gateway-mq-----------------------ActiveMq消息中间件
- - |----gateway-quartz--------------------定时任务
- - |----gateway-redis----------------------redis缓存
- - |----gateway-websocket-----------------webSocket双工通讯

### OA门户展示系统项目结构

- |----gateway-------------------------门户展示系统[端口:**8082**]
- - |----gtw-web---------------------web层项目
- - |----gtw-service-impl--------------Service服务层
- - |----gtw-service-------------------ServiceImpl服务层接口
- - |----gtw-common-----------------工具层
- - |----gtw-redis---------------------redis缓存

doc_wei's avatar
doc_wei 已提交
80
#### 服务器部署注意事项
doc_wei's avatar
doc_wei 已提交
81

doc_wei's avatar
doc_wei 已提交
82 83 84 85 86
1.ActiveMQ链接地址、账号、密码的修改<br />
2.Redis集群的修改<br />
3.MySQL数据库链接地址、账号、密码的修改<br />
4.webSocket的IP地址修改<br />
5.图片资源路径存储的修改<br />
doc_wei's avatar
doc_wei 已提交
87

doc_wei's avatar
doc_wei 已提交
88
#### 本地开发环境搭建
doc_wei's avatar
doc_wei 已提交
89

doc_wei's avatar
doc_wei 已提交
90 91 92 93
- windows搭建nginx负载均衡([下载](https://download.csdn.net/download/doc_wei/11010749)
- windows搭建activemq单机版([下载](https://download.csdn.net/download/doc_wei/11010746)
- windows搭建redis集群([下载](https://download.csdn.net/download/doc_wei/11010741)

doc_wei's avatar
doc_wei 已提交
94
##### 注意事项
doc_wei's avatar
doc_wei 已提交
95 96 97 98

如果是eclipse导入发现pom文件报错。<br />
错误:org.apache.maven.archiver.MavenArchiver.getManifest<br />
解决办法:https://blog.csdn.net/doc_wei/article/details/84936514<br />
doc_wei's avatar
doc_wei 已提交
99

doc_wei's avatar
doc_wei 已提交
100 101
#### 目前功能

doc_wei's avatar
doc_wei 已提交
102 103 104 105 106 107 108 109 110 111 112 113
- 基础功能
- - 菜单管理
- - 员工管理
- - 用户管理
- - 角色管理
- - 权限管理
- - 资源图标
- - 日志管理
- - APP菜单管理
- - 多桌面管理
- - 系统基础设置
- 代码生成器(只能适用于该框架的代码生成器,配置模板即可生成,然后下载压缩包解压复制到项目中即可)
doc_wei's avatar
doc_wei 已提交
114
- 微信小程序、H5手机自适应页面拖拽生成,可自定义配置小程序组件
doc_wei's avatar
doc_wei 已提交
115
- 在线性能监控
doc_wei's avatar
doc_wei 已提交
116
- 项目流程图规划
doc_wei's avatar
doc_wei 已提交
117
- 问卷调查
doc_wei's avatar
doc_wei 已提交
118
- 多桌面任务栏([演示](https://www.bilibili.com/video/av43650484)
doc_wei's avatar
doc_wei 已提交
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134
- 聊天功能([演示](https://www.bilibili.com/video/av43650782))
- 我的日程([演示](https://www.bilibili.com/video/av45854959))
- 自定义桌面菜单
- 多系统集成(可以将多个系统进行应用集成,无需多次登陆,无需记录多个网址)
- 应用商店
- 开发文档
- 工作日志
- 考勤管理
- 轻应用
- 我的笔记
- 报表管理
- 文件管理
- 附件管理
- 邮件管理
- 工作流管理
- APP端(接口:SpringCloud微服务框架;前端:vue)
doc_wei's avatar
doc_wei 已提交
135

doc_wei's avatar
更新  
doc_wei 已提交
136
#### 技术扩展
doc_wei's avatar
doc_wei 已提交
137

doc_wei's avatar
更新  
doc_wei 已提交
138
- webSocket技术扩展
doc_wei's avatar
doc_wei 已提交
139
    ![输入图片说明](https://images.gitee.com/uploads/images/2019/0205/224843_d8055e22_1541735.png "1.png")
doc_wei's avatar
更新  
doc_wei 已提交
140

doc_wei's avatar
doc_wei 已提交
141
#### 版本介绍
doc_wei's avatar
doc_wei 已提交
142 143 144 145 146 147 148 149 150 151

功能|商用版|开源版|功能|商用版|开源版
---|-------|---|---|-------|---
问卷调查|<abbr></abbr>|否|我的日程|<abbr></abbr>|否
我的笔记|<abbr></abbr>|否|自定义快捷方式|<abbr></abbr>|否
多系统集成|<abbr></abbr>|否|应用商店|<abbr></abbr>|否
开发文档|<abbr></abbr>|否|文件管理|<abbr></abbr>|否
附件管理|<abbr></abbr>|否|邮件管理|<abbr></abbr>|否
考勤管理|<abbr></abbr>|否|报表管理|<abbr></abbr>|否
工作日志|<abbr></abbr>|否|工作流管理|<abbr></abbr>|否
doc_wei's avatar
doc_wei 已提交
152

doc_wei's avatar
doc_wei 已提交
153
#### 技术选型
doc_wei's avatar
doc_wei 已提交
154

doc_wei's avatar
doc_wei 已提交
155
##### 后端技术:
doc_wei's avatar
doc_wei 已提交
156

doc_wei's avatar
doc_wei 已提交
157 158
技术|名称|官网
---|---|---
doc_wei's avatar
doc_wei 已提交
159
SpringBoot|核心框架|http://spring.io/projects/spring-boot
doc_wei's avatar
doc_wei 已提交
160 161 162 163 164
MyBatis|ORM框架|http://www.mybatis.org/mybatis-3/zh/index.html
Druid|数据库连接池|https://github.com/alibaba/druid
Maven|项目构建管理|http://maven.apache.org/
redis|key-value存储系统|https://redis.io/
webSocket|浏览器与服务器全双工(full-duplex)通信|http://www.runoob.com/html/html5-websocket.html
doc_wei's avatar
doc_wei 已提交
165 166 167
Activiti|工作流引擎|https://www.activiti.org/
spring mvc|视图框架|http://spring.io/
quartz 2.2.2|定时任务|http://www.quartz-scheduler.org/
doc_wei's avatar
doc_wei 已提交
168
ActiveMQ|消息队列|http://activemq.apache.org/replicated-leveldb-store.html
doc_wei's avatar
doc_wei 已提交
169 170
solr|企业级搜索应用服务器|https://lucene.apache.org/solr/
Spring Cloud|微服务框架(目前用户APP端接口)|https://springcloud.cc/
doc_wei's avatar
doc_wei 已提交
171 172

##### 前端技术:
doc_wei's avatar
doc_wei 已提交
173

doc_wei's avatar
doc_wei 已提交
174 175 176 177 178
技术|名称|官网
---|---|---
jQuery|函式库|http://jquery.com/
zTree|树插件|http://www.treejs.cn/v3/
layui|模块化前端UI|https://www.layui.com/
doc_wei's avatar
doc_wei 已提交
179
winui|win10风格UI|https://gitee.com/doc_wei01_admin/skyeye
doc_wei's avatar
doc_wei 已提交
180 181 182
codemirror|codemirror代码编辑器|https://codemirror.net/
handlebars|js模板引擎|http://www.ghostchina.com/introducing-the-handlebars-js-templating-engine/
webSocket|浏览器与服务器全双工(full-duplex)通信|http://www.runoob.com/html/html5-websocket.html
doc_wei's avatar
doc_wei 已提交
183
G6|流程图开发|https://antv.alipay.com/zh-cn/index.html
doc_wei's avatar
doc_wei 已提交
184
FullCalendar|日历插件|https://blog.csdn.net/qw_xingzhe/article/details/44920943
doc_wei's avatar
doc_wei 已提交
185 186 187

#### 代码描述
##### 前后台接口映射
doc_wei's avatar
doc_wei 已提交
188

doc_wei's avatar
doc_wei 已提交
189 190 191 192 193
```
<url id="前端请求id" path="后台接口" val="备注" allUse="是否需要登录">
	<property id="前端请求key" name="后台接收key" ref="限制条件(参考项目内文档)" var="key含义"/>
</url>
```
doc_wei's avatar
doc_wei 已提交
194

doc_wei's avatar
doc_wei 已提交
195 196 197
##### 后台代码编写规范

###### 控制层
doc_wei's avatar
doc_wei 已提交
198

doc_wei's avatar
doc_wei 已提交
199 200 201 202 203 204 205 206 207
```
@RequestMapping("后台接口")
@ResponseBody
public void 方法名(InputObject inputObject, OutputObject outputObject) throws Exception{
	服务层接口对象.方法名(inputObject, outputObject);
}
```

###### 服务层
doc_wei's avatar
doc_wei 已提交
208

doc_wei's avatar
doc_wei 已提交
209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
```
@Override
public void 方法名(InputObject inputObject, OutputObject outputObject) throws Exception {
	Map<String, Object> map = inputObject.getParams();//接收参数
	Map<String, Object> user = inputObject.getLogParams();//获取当前登录用户信息
	/**
	 * 业务逻辑
	 */
	outputObject.setBean(bean);//返回单个实体Bean
	outputObject.setBeans(beans);//返回集合
	outputObject.settotal(total);//返回数量
	outputObject.setreturnMessage("信息");//返回前端的错误信息
	outputObject.setreturnMessage("信息", 错误码);//返回前端的错误信息,同时抛出异常(不常用)
}
```
doc_wei's avatar
doc_wei 已提交
224 225


A
Able-S 已提交
226

doc_wei's avatar
doc_wei 已提交
227
#### 效果图
doc_wei's avatar
doc_wei 已提交
228 229 230 231 232 233 234 235 236 237 238 239 240 241

|效果图|效果图|
| ------------- | ------------- |
|![](https://s2.ax1x.com/2019/04/16/Avo0c8.png "1.png")|![](https://images.gitee.com/uploads/images/2019/0623/142954_6c8612f2_1541735.png "1.png")|
|![](https://images.gitee.com/uploads/images/2018/1107/104734_d9304e60_1541735.png "2.png")|![](https://images.gitee.com/uploads/images/2018/1107/104903_f244dfde_1541735.png "3.png")|
|![](https://s2.ax1x.com/2019/06/23/ZPS5h4.png)|![](https://images.gitee.com/uploads/images/2018/1118/191634_497ea929_1541735.png "微信图片_20181118191516.png")|
|![](https://images.gitee.com/uploads/images/2018/1118/193301_72d0bb49_1541735.png "微信截图_20181118193254.png")|![](https://s2.ax1x.com/2019/04/16/Av7lee.png "微信截图_20181120154643.png")|
|![](https://images.gitee.com/uploads/images/2018/1121/105120_65de9434_1541735.png "1.png")|![](https://images.gitee.com/uploads/images/2019/0623/145248_4a51c610_1541735.png)|
|![](https://images.gitee.com/uploads/images/2019/0122/113516_b0600e8f_1541735.png "1.png")|![](https://images.gitee.com/uploads/images/2018/1207/123501_3248346e_1541735.png "微信截图_20181207123447.png")|
|![](https://images.gitee.com/uploads/images/2019/0113/114947_1c7fa387_1541735.png "微信截图_20190113114922.png")|![](https://images.gitee.com/uploads/images/2019/0202/130711_7ed57951_1541735.png "3.png")|
|![](https://s2.ax1x.com/2019/06/23/ZPC6cd.png)|![](https://images.gitee.com/uploads/images/2019/0623/145351_dd55da65_1541735.png)|
|![](https://images.gitee.com/uploads/images/2019/0623/143810_e76aec71_1541735.png)|![](https://images.gitee.com/uploads/images/2019/0623/144143_1063782a_1541735.png)|
|![](https://images.gitee.com/uploads/images/2019/0623/144444_73cfd8a1_1541735.png)||

doc_wei's avatar
doc_wei 已提交
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256

#### 环境搭建
##### 开发工具:

- MySql: 数据库</br>
- Tomcat: 应用服务器</br>
- SVN|Git: 版本管理</br>
- Nginx: 反向代理服务器</br>
- Varnish: HTTP加速器</br>
- IntelliJ IDEA|Eclipse: 开发IDE</br>
- Navicat for MySQL: 数据库客户端</br>
- Redis Manager:redis视图工具</br>

#### 资源下载

doc_wei's avatar
doc_wei 已提交
257
- JDK8 https://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html</br>
doc_wei's avatar
doc_wei 已提交
258 259 260 261 262 263
- Maven http://maven.apache.org/download.cgi</br>
- Redis https://redis.io/download</br>
- Nginx http://nginx.org/en/download.html</br>

#### 在线文档

doc_wei's avatar
doc_wei 已提交
264
- [JDK8中文文档](https://blog.fondme.cn/apidoc/jdk-1.8-youdao/)</br>
doc_wei's avatar
doc_wei 已提交
265 266 267 268
- [Spring4.x文档](http://spring.oschina.mopaas.com/)</br>
- [Mybatis3官网](http://www.mybatis.org/mybatis-3/zh/index.html)</br>
- [Nginx中文文档](http://tool.oschina.net/apidocs/apidoc?api=nginx-zh)</br>
- [Git官网中文文档](https://git-scm.com/book/zh/v2)</br>
doc_wei's avatar
doc_wei 已提交
269

doc_wei's avatar
doc_wei 已提交
270 271
#### 项目交流:

doc_wei's avatar
doc_wei 已提交
272
QQ群号:[696070023](http://shang.qq.com/wpa/qunwpa?idkey=e9aace2bf3e05f37ed5f0377c3827c6683d970ac0bcc61b601f70dc861053229)
doc_wei's avatar
doc_wei 已提交
273 274 275 276 277

|QQ群|公众号|
|-------|-------|
|![](https://images.gitee.com/uploads/images/2018/1205/145236_4fce6966_1541735.jpeg "微信图片_20181205145217.jpg")|![](https://images.gitee.com/uploads/images/2018/1207/083137_48330589_1541735.jpeg "qrcode_for_gh_e7f97ff1beda_258.jpg")|

doc_wei's avatar
doc_wei 已提交
278

doc_wei's avatar
doc_wei 已提交
279 280 281 282 283 284 285 286 287
#### 合作公司(保留客户信息):
- 合肥**科技有限责任公司
- 广州**信息有限责任公司

#### 个人购买(保留客户信息):
-*
-*
-*
-*