README.md · ttrr/Demo.MicroServer

# 集成.NET Core+Swagger+Consul+Polly+Ocelot+IdentityServer4+Exceptionless+Apollo的微服务开发框架

## Github源代码地址
https://github.com/PeyShine/Demo.MicroServer

## Apollo配置中心
Apollo（阿波罗）是携程框架部门研发的分布式配置中心，能够集中化管理应用不同环境、不同集群的配置，配置修改后能够实时推送到应用端，并且具备规范的权限、流程治理等特性，适用于微服务配置管理场景。
由于各个项目配置都需要读取基础的配置信息，这边在内网的Centos(101)上部署了Apollo的环境，并为项目添加了一些基础配置信息，配置如图
<img src="https://raw.githubusercontent.com/PeyShine/Demo.MicroServer/master/doc/images/apollo.png" width="900" height="350" />

## Consul
Consul是一种服务网格解决方案，提供具有服务发现，健康检查，Key/Value存储，多数据中心等功能。
在内网101启动Consul服务，这里为了测试，直接在本地将用户服务实例分别在三个端口启动起来，实际生产中这些服务可能部署在不同的机房不同的机器，他们之间组成一个服务的集群，服务提供一个心跳检测的方法，用于consul定时检测服务实例是否健康，启动时在consul中进行一次注册，这个就是经常说的‘服务注册与发现’中的服务注册，三个服务实例截图如下
<img src="https://raw.githubusercontent.com/PeyShine/Demo.MicroServer/master/doc/images/serviceRsg.png" width="900" height="350" /> 
注册完成之后打开consul的ui界面可以看到，列表中存在多出一个用户服务的集群组名称：Demo.MicroServer.UserService，如图
<img src="https://raw.githubusercontent.com/PeyShine/Demo.MicroServer/master/doc/images/consul_main.png" width="900" height="350" /> 
点击Demo.MicroServer.UserService进去之后如图，显示三个服务实例的信息
<img src="https://raw.githubusercontent.com/PeyShine/Demo.MicroServer/master/doc/images/consul_service_instance_list.png" width="900" height="350" />

## Swagger
Swagger提供了一个可视化的UI页面展示描述文件。接口的调用方、测试等都可以在该页面中对相关接口进行查阅和做一些简单的接口请求。当然Swagger的功能远不止这些，项目中已经在服务实例中接入swagger，如图
<img src="https://raw.githubusercontent.com/PeyShine/Demo.MicroServer/master/doc/images/swagger_port_6891.png" width="900" height="350" /> 
<img src="https://raw.githubusercontent.com/PeyShine/Demo.MicroServer/master/doc/images/swagger_port_6892.png" width="900" height="350" /> 
<img src="https://raw.githubusercontent.com/PeyShine/Demo.MicroServer/master/doc/images/swagger_port_6893.png" width="900" height="350" /> 
因为三个服务实例是同样一份代码，所以可以看到打开三个端口的swagger地址，看到的接口信息完全一致。

## Ocelot 网关
Ocelot是一个.NET API网关，它提供了路由,请求聚合,服务发现、鉴权、限流熔断、负载均衡器等一系列强大的功能，而这些功能只需要在配置文件中完成即可使用.
比如上面的swagger，我们在三个服务实例的端口打开都可以看到api相关文档信息，但是我们能否在api网关中直接集成呢，答案是肯定的，这依赖于ocelot强大的路由功能，如图，简单的几行配置，我们便将swagger配置到了网关当中
<img src="https://raw.githubusercontent.com/PeyShine/Demo.MicroServer/master/doc/images/ocelot_config_swagger.png" width="900" height="350" />

网关内置的负载均衡器的使用，如图我在网关中对同一个接口进行了三次调用，可以看到结果分别来自三个不同的端口中，因为我选用了负载均衡器中的轮询策略
<img src="https://raw.githubusercontent.com/PeyShine/Demo.MicroServer/master/doc/images/ocelot_LoadBalancer_6891.png" width="900" height="100" /> 
<img src="https://raw.githubusercontent.com/PeyShine/Demo.MicroServer/master/doc/images/ocelot_LoadBalancer_6892.png" width="900" height="100" /> 
<img src="https://raw.githubusercontent.com/PeyShine/Demo.MicroServer/master/doc/images/ocelot_LoadBalancer_6893.png" width="900" height="100" />

限流策略，当我们配置启用限流策略，并配置单位时间内访问次数限制时，然后快速刷新接口，超过设置的次数限制，那么可以看到按照错误提示出现
<img src="https://raw.githubusercontent.com/PeyShine/Demo.MicroServer/master/doc/images/ocelot_RateLimit.png" width="900" height="70" />

## Expectationless
Exceptionless 是一个开源的实时的日志收集框架，相信在微服务架构或者分布式应用应该都离不开一个统一的日志收集功能，Exceptionless就是就很好的提供了服务，相信有很多开发者都在使用ELK来完成日志的收集，这里说下Exceptionless底层也是基于ElasticSearch，
Exceptionless提供了两种服务方式，一种是在线的，就是直接在官网注册账户，新建项目，官方会给每个项目分配一个appid，将id配置到项目中即可使用，当然，在线使用是有限制的，对日志收集数量(3000)还有存储时间天数(3天)都有限制，测试或者临时使用应该都没问题，
考虑到后面项目会在生产环境中使用，所以我在内网centos上搭建了一个本地化的Exceptionless环境来收集日志。
我这里调用一下swagger中写的一个异常收集测试的接口
<img src="https://raw.githubusercontent.com/PeyShine/Demo.MicroServer/master/doc/images/swagger_exceptionless_collect.png" width="900" height="350" /> 
发送完成后，到Exceptionless的ui界面来查看收集情况
<img src="https://raw.githubusercontent.com/PeyShine/Demo.MicroServer/master/doc/images/exceptionless_show.png" width="900" height="350" /> 
可以看到界面多出一条发送测试的数据记录

## IdentityServer4统一鉴权中心
之所有将认证授权放在最后，因为没有这个前面的流程也是可以跑通的，测试的时候如果觉得这部分测试麻烦可以先注释掉，流程跑通后再来集成这个，这个东西的用法还是很多的，这里将IdentityServer4集成到api 网关当中来完成统一的认证鉴权。
在identityserver4项目中分别实现以下几个类
<img src="https://raw.githubusercontent.com/PeyShine/Demo.MicroServer/master/doc/images/identityserver4_starup.png" width="900" height="350" /> 
分类来完全几个东西：定义api资源，客户端访问资源范围，校验账户密码过程和数据返回格式
然后在api网关中项目中统一认证，这里需要说明下为什么要将IdentityServer4集成到网关当中而不是在每个服务实例单独去认证，想象一下，如果在一个大型项目中，不同的小组维护着不同的服务实例，势必每个小组都要在各自的代码中完成一套认证逻辑，确实没有必要，
而Ocelot天然对IdentityServer4进行了很好的集成，我们只需要在网关中统一添加认证代码即可，而各个微服务实例只需要关心各自的业务逻辑代码即可。
这个也列举一下使用过程，在客户端没有token时通过网关对api资源进行访问，可以看到如图的返回状态码：401
<img src="https://raw.githubusercontent.com/PeyShine/Demo.MicroServer/master/doc/images/401.png" width="900" height="350" /> 
然后我们到IdentityServer4中请求一个token
<img src="https://raw.githubusercontent.com/PeyShine/Demo.MicroServer/master/doc/images/identityserver4_token.png" width="900" height="350" /> 
拿到token后，带着token再通过网关请求相同的api资源，可以看到正确拿到想要的资源。
<img src="https://raw.githubusercontent.com/PeyShine/Demo.MicroServer/master/doc/images/identityserver4_bearer_token.png" width="900" height="350" />

## 特别说明
上面的所有说明，在代码中均有体现，并开放出来，但是对于一个完整的微服务架构来说还是太简略，只是做了简单的说明，后续会具体拆开来分享一下。
至于为什么要这么做和工具的安装，博客园等地方有很多这方面的对比和教程可以参考，这里着重关注微服务架构的实现 
欢迎大家提出宝贵意见，当然如果对你有帮助也欢迎star. 
随时随地查阅可关注公众号 
<img src="https://raw.githubusercontent.com/PeyShine/Demo.MicroServer/master/doc/images/qrcode.jpg"/>

## 后续更新
后续可能还会加入CAP和APM(已加入)

## 关于运行(更新于2020/07/07)
为了说明运行流程，单独更新了一篇文章用来介绍，可以点击查看：[微服务框架Demo.MicroServer运行手册](http://liuthing.com/2020/07/06/demomicroserver-use/)

ttrr/Demo.MicroServer

简介

发行版

贡献者

近期动态

ttrr/Demo.MicroServer .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

ttrr/Demo.MicroServer