followmetech / fm.consulinterop

a lib for build micro-service

FM.ConsulInterop -a lib for simple build micro service

解决了什么问题

• 解决了什么问题,怎么解决

依赖的技术栈

• dotnet standard 2.0
• gRPC - An RPC library and framework
• consul-Service Discovery and Configuration Made Easy

组件交互图

功能

• 简化grpc-srv注册到consul的交互方式 (简单的配置文件/一个扩展方法)
• 简化grpc-client 消费grpc-srv的交互方式 (简单的配置文件/proxy模式)
• 客户端定时自动发现srv,并自动负载请求到srv
• 客户端中间件(认证/log/timeout..)

let's getting start

如何启动:

simples代码

1. 下载consul, 启动consul命令 (consul agent -dev)
2. 修改samples/下面的appsettings配置文件设置相关的consul地址,和srv-监听地址
3. 启动srv ,启动client

客户端和服务端的配置文件详解

{
  "consul": {
    "service": {  ##给srv用的节点
      "ServiceName": "followme.srv.demo.x",  ##注册到consul中的srv-name
      "ConsulAddress": "http://localhost:8500", ##consul服务地址
      "ServiceAddress": "192.168.*.*:0",  ## 服务启动的IP/Port ,可以填写网段信息,端口为0表示auto-choose
      "ConsulIntegration": "true", ##是否需要把服务信息注册到consul中
      "ConsulTags": "v-1.0.0.1", ##tag ,和go-micro通讯必须要注册tag值
      "TCPInterval": 10  ##consul health check ,这里使用的是TTL模式
    },
    "remotes": {
      "demo": {  #####这里是给客户端使用的节点
        "name": "demo.x",  ####准备遗弃的配置!
        "ServiceName": "followme.srv.demo.x", ####客户端需要消费的服务名(通过这个名字来找到相应的服务提供的地址)
        "FreshInterval": 10000,  #### 客户端需要定时的刷新服务列表,时间毫秒
        "ConsulAddress": "http://localhost:8500", ### consul的地址
        "ConsulIntegration": "true", ### 客户端是否需要从consul获取服务地址
        "ServiceAddress": "" ### 当ConsulIntegration=false的时候, 这里的地址可以配置服务的具体ip:port方式
      }
    }
	}
}

srv启动代码解析

var srvConfig = conf. GetSection("consul").GetSection("service").
Get<ConsulLocalServiceConfig>();
new Server
{
     Services = { FM.Demo.HelloSrv.BindService(new HelloSrvImp()) },
}.StartAndRegisterService(srvConfig).Wait();

//获取配置文件中配置的service节点
//通过使用扩展方法[StartAndRegisterService]来启动grpc-服务
//服务启动之后,查看consulUI中的相关界面信息,发现服务已经注册成功!

client消费srv代码解析

//通过配置文件获取client需要消费的那个srv组(因为srv可以同时启动多个)
var clientConfig = conf.GetSection("consul").GetSection("remotes").GetSection("demo").
                Get<ConsulRemoteServiceConfig>();

//FM.Demo.HelloSrv.HelloSrvClient 是grpc subclass(通过protoc工具生成)
//ClientAgent是封装了所有客户端调用的类
//负责做负载, 自动发现新的服务, 踢掉不能用的服务..
//通过ClientAgent来初始化clientProxy
var client =new ClientAgent<FM.Demo.HelloSrv.HelloSrvClient>(clientConfig);
//Hi是FM.Demo.HelloSrv.HelloSrvClient提供的元方法
client.Proxy.Hi(new FM.Demo.HiRequest());

了解内部log

可以通过如下的代码来查看内部的log细节

FM.ConsulInterop.InnerLogger.ConsulLog += (s, c) =>Console.WriteLine(c.Content);

如何贡献

• issue
• merge request

license

MIT

fm.consulinterop's Issues

建议 使用 System.Threading.Timer 替换 System.Timers.Timer

如： ServiceRegister 中的 Timer.
具体讨论可参考：https://stackoverflow.com/questions/1416803/system-timers-timer-vs-system-threading-timer，clr vir C# 上也有提到。

nuget package

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
发布到nuget.org

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

疑问。

刚刚做了一个高可用测试，发现只要有服务挂掉就一定会出错