Skip to content

Commit e8667f9

Browse files
committed
readme add
1 parent f20f46e commit e8667f9

File tree

1 file changed

+127
-0
lines changed

1 file changed

+127
-0
lines changed

README.md

Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
# FlyCloud
2+
FlyClould 微服务实战项目框架,在该框架中,包括了用 Spring Cloud 构建微服务的一系列基本组件和框架,对于后台服务框架的搭建有很大的参考价值,大家可以参考甚至稍加修改可以直接应用于自己的实际的项目开发中
3+
csdn地址:[https://blog.csdn.net/geduo_83/article/details/87866018](https://blog.csdn.net/geduo_83/article/details/87866018)
4+
欢迎点赞加星,评论打call、加群:810970432
5+
6+
在该框架中包括了用 Spring Cloud 构建微服务的一系列基本组件和框架,对于后台服务框架的搭建有很大的参考价值,大家可以参考甚至稍加修改可以直接应用于自己的实际的项目开发中。
7+
8+
### 更新日志:
9+
10+
### [FlyCloud 3.0.0](https://github.com/mxdldev/spring-cloud-flycloud/releases) 2020-03-23
11+
* spring boot + security + oauth2 单一结构体改造
12+
13+
### [FlyCloud 2.2.0](https://github.com/mxdldev/spring-cloud-flycloud/releases) 2020-03-09
14+
* springboot 升级为2.0.5
15+
16+
### [FlyCloud 2.1.0](https://github.com/mxdldev/spring-cloud-flycloud/releases) 2019-07-01
17+
* 相关bug修改
18+
* 代码优化
19+
20+
### [FlyCloud 2.0.0](https://github.com/mxdldev/spring-cloud-flycloud/releases) 2019-06-08
21+
* 业务组件module_news添加
22+
23+
### [FlyCloud 1.0.0](https://github.com/mxdldev/spring-cloud-flycloud/releases) 2019-02-28
24+
初始版本:
25+
* 1.配置组件:注册中心、配置中心、授权中心
26+
* 2.监控组件:聚合监控、熔断监控、路由监控
27+
* 3.其他组件:网关服务、日志服务、公共服务
28+
* 4.业务组件:用户组件,博客组件
29+
30+
### 开发环境:
31+
在该框架中,包括了用 Spring Cloud 构建微服务的一系列基本组件和框架,运行所需要软件如下:
32+
* 开发IDE:IDEA
33+
https://www.jetbrains.com/idea/download/#section=windows
34+
* 数据库:mysql5.7
35+
https://dev.mysql.com/downloads/mysql/
36+
* 组件通信rabbitmq
37+
http://www.rabbitmq.com/download.html
38+
* Erlang环境
39+
http://www.erlang.org/downloads Erlang环境
40+
http://www.cnerlang.com/resource/182.html
41+
该项目没有采用Maven进行项目构建,Maven通过xml进行依赖管理,导致整个配置文件太过臃肿,另外灵活性也不是很强,所以我采用Gradle进行项目构建和依赖管理,在FlyTour项目中我们见证了Gradle的强大,通过简单的一些配置就可以轻松的实现组件化的功能。该项目共有11个Moudle工程。其中10个位微服务工程,这10个微服务工程构成了一个完整的微服务系统,微服务系统包含了8个基础服务,提供了一整套微服务治理功能,他们分别是配置中心module_config、注册中心module_eureka、认证授权中心module_uaa、Turbine聚合监控服务module_monitor、链路追踪服务module_zipken、聚合监控服务module_admin、路由网关服务module_gateway、日志服务module_log。另外还包含了两个资源服务:用户服务module_user和blog服务module_blog,另外还有一个common的Moudle,为资源服务提供一些一本的工具类。
42+
### 工程架构图:
43+
<br>![](https://img-blog.csdnimg.cn/2019061017280996.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9tZW54aW5kaWFvbG9uZy5ibG9nLmNzZG4ubmV0,size_16,color_FFFFFF,t_70)
44+
<br>下面对11个Moudle工程分别进行介绍:
45+
* 1.注册中心:module_eureka
46+
在这个系统中,所有的服务都向注册中心module_eureka进行服务注册。能方便的查看每个服务的服务状况、服务是否可用,以及每个服务都有哪些服务实例
47+
工作流程:
48+
<br>![](https://img-blog.csdnimg.cn/20190222130826167.png)
49+
* 2.配置中心:module_config
50+
配置中心所有服务的配置文件由 config-server 管理,特别说明为了简单起见本框架中配置数据都放在本地并没有从git仓库远程获取
51+
架构图:
52+
<br>![](https://img-blog.csdnimg.cn/20190222132525638.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2dlZHVvXzgz,size_16,color_FFFFFF,t_70)
53+
* 3.网关服务:module_gateway
54+
网关服务使用的是 Zuul 组件, Zuul 组件可以实现智能路由、负载均衡的功能 gateway-service 作为 个边界服务,对外统一暴露 API 接口,其他的服务 API 接口只提供给内部服务调用,不提供给外界直接调用,这就很方便实现统鉴权、安全验证的功能
55+
通过路由网关实现负载均衡:
56+
<br>![](https://img-blog.csdnimg.cn/20190222134903810.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2dlZHVvXzgz,size_16,color_FFFFFF,t_70)
57+
* 4.链路追踪服务:module_zipkin
58+
它可以查看每个请求在微服务系统中的链路关系
59+
* 5.聚合监控服务:module_admin
60+
提供了非常强大的服务监控功能,可以查看每个向注册中心注册服务的健康状态, 日志、注册时间等
61+
* 6.Turbine聚合监控服务:module_monitor
62+
它聚合了 module_user和module_blog的Hystrix Dashboard ,可以查看这两个服务熔断器的监控状况
63+
* 7.认证授权服务:module_uaa
64+
Spring Cloud 0Auth2 由这个服务统一授权并返回Token。其他的应用服务例如module_user和module_blog作为资源服务 API 接口资源受保护的,需要验证Token并鉴后才能访问,我采用的0Auth2+JWT安全认证,需要生成私钥用于加密,公钥用于解密
65+
生成私钥命令:
66+
```
67+
keytool -genkeypair -alias fly-jwt -validity 36500 -keyalg RSA -dname "CN=jwt,OU=jwt,O=jwt,L=haidian,S=beijing,C=CH" -keypass fly123 -keystore fly-jwt.jks -storepass fly123
68+
```
69+
生成公钥命令:
70+
```
71+
keytool -list -rfc --keystore fly-jwt.jks | openssl x509 -inform pem -pubkey
72+
```
73+
JWT认证流程:
74+
<br>![](https://img-blog.csdnimg.cn/20190222140807479.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2dlZHVvXzgz,size_16,color_FFFFFF,t_70)
75+
* 8.用户服务:module_user
76+
作为资源服务,对外暴露用户的API接口资源
77+
* 9.blog服务:module_blog
78+
作为资源服务,对外暴露blog的API接口资源
79+
* 10.日志服务:module_log
80+
作为日志服务, module_user和module_blog服务通过RabbitMQ向module_log发送业务操作日志的消息,最后统一保存在数据库,由它统一持久化操作日志
81+
日志服务架构图:
82+
<br>![](https://img-blog.csdnimg.cn/20190222142641298.png)
83+
### 功能演示:
84+
依次启动 module_eureka, module_config,module_zipkin及其他的微服务,等整个微服务系统完全启动之后,在览器上访问 即:http://localhost:8761,即就是Eureka 可以查看服务注册的情况
85+
![](https://img-blog.csdnimg.cn/20190222112508530.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2dlZHVvXzgz,size_16,color_FFFFFF,t_70)
86+
API 接口文档采用 Swagger2 框架生成在线文档, module_user 工程和 module_blog工程集成了Swagger2 ,集成Swagger2 只需要引入依赖,并做相关的配置,然后在具体的 Controller上写注解,就可以实现 Swagger2的在线文档功能在浏览器输入http://localhost:8762/swagger-ui.html 查看user服务的api文档
87+
![](https://img-blog.csdnimg.cn/20190222112530157.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2dlZHVvXzgz,size_16,color_FFFFFF,t_70)
88+
在浏览器输入http://localhost:8763/swagger-ui.html 查看blog服务的api文档 
89+
![](https://img-blog.csdnimg.cn/20190222112530157.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2dlZHVvXzgz,size_16,color_FFFFFF,t_70)
90+
![](https://img-blog.csdnimg.cn/201902221125490.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2dlZHVvXzgz,size_16,color_FFFFFF,t_70)
91+
 在浏览器上访问 http://localhost :9998 展示了 admin-service 登录界面,admin-service 作为 个综合监控的服务,需要对访问者进行身份认证才能访问它的主页,登录用户名为 dmin 密码为 123456
92+
![](https://img-blog.csdnimg.cn/20190222112614615.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2dlZHVvXzgz,size_16,color_FFFFFF,t_70)
93+
这是登录成功后进入的首页面: 
94+
![](https://img-blog.csdnimg.cn/20190222112628215.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2dlZHVvXzgz,size_16,color_FFFFFF,t_70)
95+
点击TURBINE,这是user服务和blog服务的熔断器监控页面
96+
![](https://img-blog.csdnimg.cn/20190222112644214.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2dlZHVvXzgz,size_16,color_FFFFFF,t_70)
97+
在浏览器上访问 http://localhost :9411查看服务之间相互调用的链路追踪
98+
![](https://img-blog.csdnimg.cn/20190222112657972.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2dlZHVvXzgz,size_16,color_FFFFFF,t_70)
99+
好了,截止到现在整个项目就全部介绍完了,本项目可以直接拿来应用,进行项目开发,本框架代码量较大,所以我就不贴源代码了
100+
### 问题反馈
101+
在使用中有任何问题,请在下方留言,或加入Android、Java开发技术交流群
102+
QQ群:810970432
103+
104+
![](https://img-blog.csdnimg.cn/20190126213618911.png)
105+
### 关于作者
106+
```
107+
var geduo_83 = {
108+
    nickName  : "门心叼龙",
109+
    site : "http://www.weibo.com/geduo83"
110+
}
111+
```
112+
### License
113+
```
114+
Copyright (C) menxindiaolong, FlyCloud Framework Open Source Project
115+
116+
Licensed under the Apache License, Version 2.0 (the "License");
117+
you may not use this file except in compliance with the License.
118+
You may obtain a copy of the License at
119+
120+
http://www.apache.org/licenses/LICENSE-2.0
121+
122+
Unless required by applicable law or agreed to in writing, software
123+
distributed under the License is distributed on an "AS IS" BASIS,
124+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
125+
See the License for the specific language governing permissions and
126+
limitations under the License.
127+
```

0 commit comments

Comments
 (0)