一.背景说明:
之前分享过一个微服务开发框架, “享一个集成.NET Core+Swagger+Consul+Polly+Ocelot+IdentityServer4+Exceptionless+Apollo+SkyWalking的微服务开发框架”,前两天在Github上收到一个Issues,是想我这边提供下完整的运行文档和配置文件,因为之前想法是弄清楚这几个东西的职责之后,对于运行的先后顺序,和需要的配置key应该都会有了解,所以README编写只是介绍了用到了哪些东西,没有说如何运行,但是既然有人问起,我还是满足一下,就当成是自己回顾了。
二.回顾下项目结构
项目结构比较简单:
- MicroServer.Instance文件夹下面存放的是微服务实例,至于微服务颗粒度的拆分得结合实际的业务情况
- Demo.MicroServer.IdentityServer4 统一鉴权中心
- Demo.MicroServer.Infrastructure 基础设施,可以自行在里面添加内容
- Demo.MicroServer.Ocelot 这一层是Api网关
- Demo.MicroServer.Repository 通用的数据访问层,包含MySQL,Mongo,Redis等,之所以抽离出来,是方便各个服务实例可是直接使用这些通用方法。
而上面说的 ".NET Core+Swagger+Consul+Polly+Ocelot+IdentityServer4+Exceptionless+Apollo+SkyWalking" 中有几个东西还未出现,分别是 Consul,Polly,Exceptionless,Apollo,SkyWalking,这里还是分别介绍下
- Consul是一种服务网格解决方案,提供具有服务发现,健康检查,Key/Value存储,多数据中心等功能。在这里我们主要使用到服务发现,健康检查,启动场景是:微服务实例启动的时候
- Polly是.NET弹性和瞬态故障处理库,与Ocelot天然友好集成,使用也只需要在Ocelot 层添加少数配置即可使用
- Exceptionless是一款开源的实时的日志收集框架,可以使用在线或者本地搭建好的服务(如果只是本地测试建议直接使用在线的很方便),然后在微服务中配置好Url和应用的ApiKey就可以使用。
- Apollo是携程框架部门研发的分布式配置中心,能够集中化管理应用不同环境、不同集群的配置,配置修改后能够实时推送到应用端,并且具备规范的权限、流程治理等特性,适用于微服务配置管理场景,搭建好Apollo服务后,我们代码配置文件就可以变得相当干净了,只用留Apollo的配置就行,其他的配置几乎全部可以放在Apollo里面了。
- SkyWalking 关于SkyWalking 我有一篇文章专门介绍了这个,这里不在赘述,需要了解的可以查看:在微服务框架Demo.MicroServer中添加SkyWalking+SkyApm-dotnet分布式链路追踪系统
三.安装启动微服务周边应用
在运行服务之前,你或许可以先安装或开启以下几个服务
- MySql
- Exceptionless
如果还没安装可以参考:https://github.com/exceptionless/exceptionless/wiki/self-hosting ,建议使用docker安装 - apollo
如果还没安装,可以参考:https://github.com/ApolloAuto/apollo/blob/master/docs/quickstart/apollo_software_installation_guide_cn.md - consul
这个可以直接下载编译好的文件,直接启动就行
./consul agent -dev -data-dir=/data/consul -node=agent-1 -client=0.0.0.0 -bind=10.34.5.101 -datacenter=demo - Skywalking
请参考我之前的文章:在微服务框架Demo.MicroServer中添加SkyWalking+SkyApm-dotnet分布式链路追踪系统
咋一看这么多需要安装启动的是不是感觉很慌?
不用担心,其实如果先排除身份验证连数据库都不用读,可以只用安装consul就可以,至于apollo可以先将配置写在代码的配置文件中,对于将项目跑起来这点来说apollo不是必须的,日志收集也可以暂缓,性能检测也一样,我们可以先将核心的跑起来,再来完善他的周边,秉着这个思路,我们开始运行
四.开始启动
-
启动consul
开发下我们可以这样启动consul服务:
./consul agent -dev -data-dir=/data/consul -node=agent-1 -client=0.0.0.0 -bind=10.34.5.101 -datacenter=demo
-
启动三个微服务实例
dotnet Demo.MicroServer.UserService.dll --urls="http://*:6891" --ip="本机ip" --port=6891
dotnet Demo.MicroServer.UserService.dll --urls="http://*:6892" --ip="本机ip" --port=6892
dotnet Demo.MicroServer.UserService.dll --urls="http://*:6893" --ip="本机ip" --port=6893
这里演示,分别在6891,6892,6893三个端口启动用户的微服务实例,启动之后,consul就开始工作了,如图:
而Consul是如何发现服务的,其实得益于我们在服务里面添加的一个扩展:
public static IApplicationBuilder UseConsul(this IApplicationBuilder app, IConfiguration configuration)
{
ConsulClient _client = new ConsulClient(c =>
{
c.Address = new Uri(configuration["Consul.ServerUrl"]);
c.Datacenter = "Demo.MicroServer";
});
string ip = configuration["ip"];
int port = int.Parse(configuration["port"]);
int weight = string.IsNullOrEmpty(configuration["weight"]) ? 1 : int.Parse(configuration["weight"]);
_client.Agent.ServiceRegister(new AgentServiceRegistration()
{
ID = "UserService-" + Guid.NewGuid(),
Name = "Demo.MicroServer.UserService",
Address = ip,
Port = port,
Tags = new string[] { string.IsNullOrEmpty(configuration["tags"]) ? "" : configuration["tags"] }, //标签
Check = new AgentServiceCheck() //健康检查
{
Interval = TimeSpan.FromSeconds(10), //每隔多久检测一次
HTTP = $"http://{ip}:{port}/api/health/check",
Timeout = TimeSpan.FromSeconds(5),
DeregisterCriticalServiceAfter = TimeSpan.FromSeconds(60) //在遇到异常后关闭自身服务通道
}
});
return app;
}
并在StartUp.cs中使用了他:app.UseConsul(Configuration);
其实到这里,项目就已经跑起来了,并且具备初步的负载均衡功能,我们可以通过这三个端口其中任意一个来调用服务都是可以的。凡是都有但是,难道要人为去配置什么场景使用哪个ip和端口的服务吗,或者说要将我们所有的服务都暴露出去吗,每个服务都加一套登录鉴权机制吗?想想都觉得很可怕,那么怎么解决这个问题呢,答案就是.Net 中常用的APi GateWay之:Ocelot
-
启动网关Ocelot
开始启动Ocelot层:dotnet Demo.MicroServer.Ocelot.dll
网关启动之后就可以通过网关的ip去访问任意被注册过的服务,前提是在网关层中有配置好协议,以下面两个为例子,一个是swagger,一个是用户服务
//swagger
{
"DownstreamPathTemplate": "/doc/Demo.MicroServer.UserService/swagger.json",
"DownstreamScheme": "http",
"ServiceName": "Demo.MicroServer.UserService",
"LoadBalancer": "RoundRobin",
"UseServiceDiscovery": true,
"UpstreamPathTemplate": "/doc/Demo.MicroServer.UserService/swagger.json",
"UpstreamHttpMethod": [ "GET", "POST", "DELETE", "PUT" ]
},
//UserService
{
"DownstreamPathTemplate": "/api/{url}",
"DownstreamScheme": "http",
"UpstreamPathTemplate": "/api/{url}",
"UpstreamHttpMethod": [ "Get", "Post", "DELETE", "PUT" ],
"ServiceName": "Demo.MicroServer.UserService",
"UseServiceDiscovery": true,
"LoadBalancerOptions": {
"Type": "RoundRobin"
},
由于每个服务中都已经配置好了swagger文档,所以这里只需要指定路由协议,一样的可以通过网关来访问swagger
这里可以通过网关的ip和端口访问swagger和userservice服务
截止到这里服务的注册与发现还有网关的上下游配置基本完成,但是围绕在网关层的东西有很多,例如缓存,限流,熔断器,在网关层统一鉴权等等,但是这些不是当前要讨论的,这个具体根据后续反馈再看是否要单独拿出来解释.
五.Apoll配置
上面介绍了运行启动流程,根据需求,这里也贴一下apollo总的配置项,而网关层和用户服务层的配置在appsetting中有配置,代码中已经都有了,这里着重贴下apollo中的配置
- Demo.MicroServer.Ocelot 层在apollo中的配置:
Swagger.ServiceDocNames = Demo.MicroServer.UserService,Demo.MicroServer.ProductService
IdentityService4.Uri = http://localhost:5000
IdentityService4.UseHttps = false
- Demo.MicroServer.UserService 层在apollo中的配置:
MySqlConnections = server=mysql_ip;port=3306;database=demo_microserver;User Id=root;pwd=123456;charset=utf8
Swagger.Name = Demo.MicroServer.UserService
Swagger.Version = v1
Swagger.DocName = Demo.MicroServer.UserService
Swagger.Title = Api interface documentation
Swagger.Description = See below for specific interface
Swagger.Contact.Name = PeyShine
Swagger.Contact.Email = [email protected]
Swagger.XmlFile = Demo.MicroServer.UserService.xml
Exceptionless.ApiKey = LmqMIxSTW0U68pKwJ3xXqrNrLqS6oEociW7OexNt
Exceptionless.ServerUrl = http://exceptionless_ip:5000
Consul.ServerUrl = http://consul_ip:8500
MongoDB.DefaultConnection = mongodb://dev:Aa123456@mongo_ip/demo_db
MongoDB.DefaultDatabase = demo_db
MongoDB.DefaultTable = users
六.总结
本文作为文章"分享一个集成.NET Core+Swagger+Consul+Polly+Ocelot+IdentityServer4+Exceptionless+Apollo+SkyWalking的微服务开发框架"的一个补充扩展,主要是介绍如何一步步启动Demo.MicroServer微服务框架,里面关于网关还有IdentityServer4没有进行深入讨论,想法是只要能先将项目核心部分跑起来,周边应用可以自行添加,后续再根据反馈是否要更加详细的去介绍。
其实理解了几个开源项目自己的职责之后,对运行流程就不难理解了,动手试试吧!
文章代码在Github中的地址:https://github.com/PeyShine/Demo.MicroServer,欢迎star