如有疑问可直接加QQ：2292709323，微信：yaofengv，联系
Overt.Core.Grpc v1.0.6
基于Google的Grpc.Core驱动，适用于Console服务场景，基于TCP长连接实现微服务场景
|-Config 配置模型
|
|-Client 客户端功能实现，服务发现
|
|-dllconfigs 配置文件保存
|
|-Intercept 拦截器
|-|-IServerTracer 服务端拦截器接口
|-|-IClientTracer 客户端拦截器接口
|
|-Manager 启动、客户端调用类
|-|-GrpcServiceManager.cs 服务端启动类
|-|-GrpcClientManager.cs 客户端获取Client类
|
|-Service 服务端
|
|-GrpcServiceCollectionExtensions.cs netcore注入
- Nuget版本：v1.0.6
- 框架支持： Framewok 4.5 - 4.6 / NetStandard 2.0
- NetStandard 2.0
Consul 0.7.2.6
Google.Protobuf 3.8.0
Grpc 1.21.0
Microsoft.Extensions.Configuration.Json 2.0.0
Microsoft.Extensions.Options.ConfigurationExtensions 2.0.0
- Framwork 4.5 - 4.7
Consul 0.7.2.6
Google.Protobuf 3.8.0
Grpc 1.21.0Install-Package Overt.Core.Grpc -Version 1.0.6优先级：{第三方配置中心} > 环境变量 > Host内部配置 > 自动取IP内网
- 支持默认配置文件appsettings.json [Consul节点可不要，如无则不是集群]
{
"GrpcServer": {
"Service": {
"Name": "OvertGrpcServiceApp", // 服务名称使用服务名称去除点：OvertGrpcServiceApp
"Host": "service.g.lan", // 专用注册的域名 （可选）格式：ip[:port=default]
"HostEnv": "serviceaddress", // 获取注册地址的环境变量名字（可选，优先）环境变量值格式：ip[:port=default]
"Port": 10001, // 端口自定义
"Consul": {
"Path": "dllconfigs/consulsettings.json" // Consul路径
}
}
}
}// 添加section
<configSections>
<section name="grpcServer" type="Overt.Core.Grpc.GrpcServerSection, Overt.Core.Grpc" />
</configSections>
// 添加节点
<grpcServer>
<service name="OvertGrpcServiceApp" port="10005" host="专用注册的域名（可选）格式：ip[:port=default]" hostEnv="获取注册地址的环境变量名字（可选）环境变量值格式：ip[:port=default]">
<registry>
<consul path="dllconfigs/Consul.config" />
</registry>
</service>
</grpcServer>
- 命名：[命名空间].dll.json 文件夹(dllconfigs)
{
"GrpcClient": {
"Service": {
"Name": "grpcservice", // 服务名称与服务端保持一致
"MaxRetry": 0, // 最大可重试次数，默认不重试
"Discovery": {
"EndPoints": [ // 单点模式
{
"Host": "127.0.0.1",
"Port": 10001
}
],
"Consul": { // Consul集群,集群优先原则
"Path": "dllconfigs/consulsettings.json"
}
}
}
}
}<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<configSections>
<section name="grpcClient" type="Overt.Core.Grpc.GrpcClientSection, Overt.Core.Grpc"/>
</configSections>
<grpcClient>
<service name="" maxRetry="0">
<discovery>
<server>
<endpoint host="" port=""></endpoint>
<endpoint host="" port=""></endpoint>
</server>
<consul path="dllconfigs/Consul.config"></consul>
</discovery>
</service>
</grpcClient>
</configuration>
- 命名：consulsettings.json 不要改动
{
"ConsulServer": {
"Service": {
"Address": "http://consul.g.lan" // 默认8500端口
}
}
}<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<configSections>
<section name="consulServer" type="Overt.Core.Grpc.ConsulServerSection, Overt.Core.Grpc"/>
</configSections>
<consulServer>
<service address="http://consul.g.lan"></service>
</consulServer>
</configuration>
- 强制依赖注入模式
services.AddSingleton<GrpcExampleService.GrpcExampleServiceBase, GrpcExampleServiceImpl>(); // Grpc服务的实现
services.AddSingleton<IHostedService, GrpcExampleHostedService>(); // Grpc服务启动服务类：如下
services.AddGrpcTracer<ConsoleTracer>(); // Grpc注入拦截器，继承IServerTracer（可选）
// 使用第三方配置
services.AddGrpcConfig(config =>
{
// 以配置中心apollo为例
config.AddApollo(context.Configuration.GetSection("apollo")).AddDefault();
});using Microsoft.Extensions.Hosting;
using Overt.Core.Grpc;
using Overt.GrpcExample.Service.Grpc;
using System.Threading;
using System.Threading.Tasks;
namespace Overt.GrpcService.App
{
public class GrpcService : IHostedService
{
GrpcExampleService.GrpcExampleServiceBase _grpcServiceBase;
IServerTracer _tracer;
public GrpcService(GrpcExampleService.GrpcExampleServiceBase serviceBase, IServerTracer tracer) // 依赖注入Grpc服务基础类
{
_serviceBase = serviceBase;
_tracer = tracer;
}
public Task StartAsync(CancellationToken cancellationToken)
{
return Task.Factory.StartNew(() =>
{
GrpcServiceManager.Start(GrpcExampleService.BindService(_serviceBase), _tracer);
}, cancellationToken);
}
public Task StopAsync(CancellationToken cancellationToken)
{
return Task.Factory.StartNew(() =>
{
GrpcServiceManager.Stop();
}, cancellationToken);
}
}
}
- 实现类写法
原因：服务启动的时候是一个单例，那么所有服务之下的全部是单实例，而数据层需要使用多实例
// 只注入 IServiceProvider
IServiceProvider _provider;
public GrpcExampleServiceImpl(IServiceProvider provider)
{
_provider = provider;
}
// 其他利用provider即时获取
using(var scope = _provider.CreateSocpe())
{
var _userService = scope.ServiceProvider.GetService<IUserService>();
}
- 直接调用GrpcServiceManager来启动
using Grpc.Core;
using Overt.Core.Grpc;
using Overt.Log;
using System;
namespace Overt.GrpcService
{
public class MainService
{
public MainService()
{
}
public void Start(string serviceName) // 启动服务
{
GrpcServiceManager.Start(Library.GrpcService.BindService(new GrpcServiceImpl()), tracer: new ConsoleTracer(), whenException: (ex) =>
{
LogHelper.Info("", ex);
});
}
public void Stop(string serviceName) // 停止服务
{
GrpcServiceManager.Stop();
}
public void ShutDown(string serviceName)
{
GrpcServiceManager.Stop();
}
}
}
- 强制依赖注入模式
- 配置文件默认使用 [命名空间].dll.json 可通过vs.menu工具生成nuget包
- 注入中直接调用如下
// 注入Grpc客户端
services.AddGrpcClient();
// 自定义配置文件 / 默认使用命名空间.dll.json
services.Configure<GrpcClientOptions<GrpcExampleServiceClient>>((cfg) =>
{
cfg.ConfigPath = "dllconfig/Overt.GrpcExample.Service.Grpc.dll.json"; // 可不传递
});
// 使用第三方配置
services.AddGrpcConfig(config =>
{
// 以配置中心apollo为例
config.AddApollo(context.Configuration.GetSection("apollo")).AddDefault();
});
// 获取注入的对象
IGrpcClient<GrpcExampleServiceClient> _grpcClient;
public IndexModel(IGrpcClient<GrpcExampleServiceClient> grpcClient)
{
_grpcClient = grpcClient;
}
var res = _grpcClient.Client.Ask(new Service.Grpc.AskRequest() { Key = "abc" });
- 客户端代理类，编译在Dll中，源码如下，可忽略
using Grpc.Core;
using Overt.Core.Grpc;
using Overt.Core.Grpc.Intercept;
using System;
using System.Collections.Concurrent;
using System.IO;
using __GrpcService = Overt.GrpcExample.Service.Grpc.GrpcExampleService;
namespace Overt.GrpcExample.Service.Grpc
{
#if NET45 || NET46 || NET47
public class ClientManager
{
public static IClientTracer Tracer { get; set; } = default(IClientTracer);
private static string DefaultConfigPath { get; set; } = "dllconfigs/Overt.GrpcExample.Service.Grpc.dll.config";
public static __GrpcService.GrpcExampleServiceClient Instance
{
get
{
return ClientManager<__GrpcService.GrpcExampleServiceClient>.Instance;
}
}
private static readonly ConcurrentDictionary<Type, string> configMap = new ConcurrentDictionary<Type, string>();
public static void Configure<T>(string configPath) { configMap.AddOrUpdate(typeof(T), configPath, (t, s) => configPath); }
public static string GetConfigure<T>() { if (configMap.TryGetValue(typeof(T), out string configPath)) return configPath; return DefaultConfigPath; }
}
public class ClientManager<T> : ClientManager where T : ClientBase
{
public static new T Instance
{
get
{
var configPath = GetConfigure<T>();
var abConfigPath = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, configPath);
return GrpcClientManager<T>.Get(abConfigPath, Tracer);
}
}
}
#endif
}
- 使用代理类执行
// 自定义配置文件 / 默认使用命名空间.dll.json / 在主进程入口进行配置T为服务Client
ClientManger.Configure<T>("dllconfig/abc.config");
ClientManager.Instance.[Method]
// T为服务Client
ClientManager<T>.Instance.[Method]
- 2024-07-22 v1.0.9
- consul支持Token
- 2022-04-06 v1.0.8
- 升级底层驱动为最新版本
- Grpc => 2.40.0
- 2021-07-01 v1.0.7
- 升级底层驱动为最新版本
- Google.Protobuf => 3.17.3
- 2021-03-31 v1.0.6
- 重构GrpcClientOptions
- 升级驱动为最新版本
- 2021-03-30 v1.0.5
- Tracer提供修改Channel Target能力，可供外部自定义选择节点；
- 升级底层驱动为最新版本
- 增加自定义Interceptor的注入
- 调整ServiceStart的参数配置，使用GrpcOptions进行承接
- 增加invokers的自定义获取，增加ServiceId的获取
- 支持framework版本的自定义invoker获取策略
- 2021-02-25 v1.0.4.1
- 增加第三方配置的支持，比如apollo，可使用services.AddGrpcConfig进行扩展(目前仅支持dotnetcore)
- 2019-11-28 v1.0.3.1
- 优化对Consul新版本的支持
- 2019-11-28 v1.0.3
- 注册中心监听到变动后，忽略黑名单，本地连接全部重置
- 2019-09-29 v1.0.2
- 客户端使用Consul注册中心，支持单服务变动监听，新注册服务或者服务挂掉，更加实时
- 2019-08-16 v1.0.1
- 支持多服务模式
- 2019-08-01 v1.0.0
- 修改命名空间，更新nuget包为Overt.Core.Grpc 更新默认版本为1.0.0
- 2019-06-05 v1.0.0.1
- 客户端优化连接服务失败的情况下，拉入黑名单，导致节点不存在的问题
Overt.Core.Grpc.H2 v2.0.1
用于>= netcoreapp3.0版本，用于http2协议，依赖微软的grpc.net，适用于Web服务场景，基于http2实现微服务场景
|-Config 配置模型
|
|-Client 客户端功能实现，服务发现
|
|-dllconfigs 配置文件保存
|
|-Service 服务端
|
|-GrpcServiceCollectionExtensions.cs netcore注入
- Nuget版本：V 2.0.1
- 框架支持： netstandard2.1 / netcoreapp3.0 / net5.0 / net6.0
Consul 1.6.10.7
Google.Protobuf 3.21.5
Grpc.Net.Client 2.47.0
Microsoft.Extensions.Configuration.Json 5.0.0
Microsoft.Extensions.Options.ConfigurationExtensions 5.0.0Install-Package Overt.Core.Grpc.H2 -Version 2.1.0优先级：{第三方配置中心} > 环境变量 > Host内部配置 > 自动取IP+启动端口内网
- 支持默认配置文件appsettings.json [Consul节点可不要，如无则不是集群]
{
"GrpcServer": {
"Service": {
"Name": "OvertGrpcServiceApp", // 服务名称使用服务名称去除点：OvertGrpcServiceApp
"Host": "service.g.lan", // 专用注册的域名 （可选）格式：ip[:port=default]
"HostEnv": "serviceaddress", // 获取注册地址的环境变量名字（可选，优先）环境变量值格式：ip[:port=default]
"Port": 10001, // 端口自定义
"Consul": {
"Path": "dllconfigs/consulsettings.json" // Consul路径
}
}
}
}
- 命名：[命名空间].dll.json 文件夹(dllconfigs)
{
"GrpcClient": {
"Service": {
"Name": "grpcservice", // 服务名称与服务端保持一致
"Scheme": "http", // foraddress 协议 http/https
"Discovery": {
"EndPoints": [ // 单点模式
{
"Host": "127.0.0.1",
"Port": 10001
}
],
"Consul": { // Consul集群,集群优先原则
"Path": "dllconfigs/consulsettings.json"
}
}
}
}
}
- 命名：consulsettings.json 不要改动
{
"ConsulServer": {
"Service": {
"Address": "http://consul.g.lan" // 默认8500端口
}
}
}
- 注册Consul
public void ConfigureServices(IServiceCollection services)
{
...
// 其他
...
services.AddGrpcService(); // 应用关闭时，节点可自动移除
// 按需使用第三方配置
services.AddGrpcConfig(config =>
{
// 以配置中心apollo为例
config.AddApollo(context.Configuration.GetSection("apollo")).AddDefault();
});
}
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
...
// 其他
...
app.UseGrpcRegister();
}
- 强制依赖注入模式
- 配置文件默认使用 [命名空间].dll.json 可通过vs.menu工具生成nuget包
- 注入中直接调用如下
// 注入Grpc客户端
services.AddGrpcClient();
// 自定义配置文件 / 默认使用命名空间.dll.json
services.Configure<GrpcClientOptions<GrpcExampleServiceClient>>((cfg) =>
{
cfg.ConfigPath = "dllconfig/Overt.GrpcExample.Service.Grpc.dll.json"; // 可不传递
});
// 使用第三方配置
services.AddGrpcConfig(config =>
{
// 以配置中心apollo为例
config.AddApollo(context.Configuration.GetSection("apollo")).AddDefault();
});
// 获取注入的对象
IGrpcClient<GrpcExampleServiceClient> _grpcClient;
public IndexModel(IGrpcClient<GrpcExampleServiceClient> grpcClient)
{
_grpcClient = grpcClient;
}
var res = _grpcClient.Client.Ask(new Service.Grpc.AskRequest() { Key = "abc" });- 2022-08-24 v2.0.1
1.NET5_0_OR_GREATER支持subchannel，支持Resolver以及LoadBalancer，支持自定义
- 2021-12-30 v1.0.5
- 支持apollo等外部配置中心
- 2021-03-31 v1.0.4
- 支持代码更改文件配置
- 增加HostedService
- 2021-03-30 v1.0.1
- 第一个版本，依赖微软的驱动grpc.net，适应net5.0