# core-grpc
**Repository Path**: arthur9119/core-grpc
## Basic Information
- **Project Name**: core-grpc
- **Description**: Grpc驱动封装,使用Consul实现服务发现,支持DotnetCore Framework,可快速实现基于Grpc的微服务,内部有完整案例,包含服务端Server 客户端 Client
- **Primary Language**: C#
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 46
- **Created**: 2019-06-02
- **Last Updated**: 2020-12-19
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# Sodao.Core.Grpc
### [](#4lctkm)项目层次说明
> Sodao.Core.Grpc v1.0.9.1
#### [](#ihwcmc)1. 项目目录
```
|-Config 配置模型
|
|-Client 客户端功能实现,服务发现
|
|-dllconfigs 配置文件保存
|
|-Intercept 拦截器
|-|-IServerTracer 服务端拦截器接口
|-|-IClientTracer 客户端拦截器接口
|
|-Manager 启动、客户端调用类
|-|-GrpcServiceManager.cs 服务端启动类
|-|-GrpcClientManager.cs 客户端获取Client类
|
|-Server 服务端
|
|-GrpcServiceCollectionExtensions.cs netcore注入
```
#### [](#bzwnno)2. 版本及支持
> - Nuget版本:V 1.0.9.1
> - 框架支持: Framewok 4.5 - 4.7 / NetStandard 2.0
#### [](#q8zoqr)3. 项目依赖
> - NetStandard 2.0
```csharp
Consul 0.7.2.6
Google.Protobuf 3.6.1
Grpc 1.19.0
Microsoft.Extensions.Configuration.Json 2.0.0
Microsoft.Extensions.Options.ConfigurationExtensions 2.0.0
```
> - Framwork 4.5 - 4.7
```csharp
Consul 0.7.2.6
Google.Protobuf 3.6.1
Grpc 1.19.0
```
### [](#m947ei)使用
#### [](#5cglzl)1. Nuget包引用
```csharp
Install-Package Sodao.Core.Grpc -Version 1.0.9.1
```
#### [](#dhmwfy)2. 配置信息
优先级:环境变量 > Host内部配置 > 自动取IP
##### [](#6vgvrv)(1)服务端配置信息
> - 支持默认配置文件appsettings.json [Consul节点可不要,如无则不是集群]
```json
{
"GrpcServer": {
"Service": {
"Name": "SodaoGrpcServiceApp", // 服务名称使用服务名称去除点:SodaoGrpcServiceApp
"Host": "service.g.lan", // 专用注册的域名 (可选)
"HostEnv": "serviceaddress", // 环境变量配置(可选,同上)
"Port": 10001, // 端口:与端田申请
"Consul": {
"Path": "dllconfigs/consulsettings.json" // Consul路径
}
}
}
}
```
```xml
// 添加section
// 添加节点
```
##### [](#qqukmp)(2)客户端配置信息
> - 命名:[命名空间].dll.json 文件夹(dllconfigs)
```json
{
"GrpcClient": {
"Service": {
"Name": "grpcservice", // 服务名称与服务端保持一致
"MaxRetry": 0, // 最大可重试次数,默认不重试
"Discovery": {
"EndPoints": [ // 单点模式
{
"Host": "127.0.0.1",
"Port": 10001
}
],
"Consul": { // Consul集群,集群优先原则
"Path": "dllconfigs/consulsettings.json"
}
}
}
}
}
```
```xml
```
##### [](#wt0bso)(3)Consul配置文件
> - 命名:consulsettings.json 不要改动
```json
{
"ConsulServer": {
"Service": {
"Address": "http://consul.g.lan" // 默认8500端口
}
}
}
```
```xml
```
#### [](#meoyxy)3. 服务端的使用
#### [](#4n4nah)(1)NetCore
> - 强制依赖注入模式
```csharp
services.AddSingleton(); // Grpc服务的实现
services.AddSingleton(); // Grpc服务启动服务类:如下
services.AddGrpcTracer(); // Grpc注入拦截器,继承IServerTracer
```
```csharp
using Microsoft.Extensions.Hosting;
using Sodao.Core.Grpc;
using Sodao.GrpcExample.Service.Grpc;
using System.Threading;
using System.Threading.Tasks;
namespace Sodao.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);
}
}
}
```
> - 实现类写法
```csharp
原因:服务启动的时候是一个单例,那么所有服务之下的全部是单实例,而数据层需要使用多实例
// 只注入 IServiceProvider
IServiceProvider _provider;
public GrpcExampleServiceImpl(IServiceProvider provider)
{
_provider = provider;
}
// 其他利用provider即时获取
using(var scope = _provider.CreateSocpe())
{
var _userService = scope.ServiceProvider.GetService();
}
```
#### [](#q9v0og)(2)Framework 4.6
> - 直接调用GrpcServiceManager来启动
```csharp
using Grpc.Core;
using Sodao.Core.Grpc;
using Sodao.Log;
using System;
namespace Sodao.GrpcService
{
public class MainService
{
public MainService()
{
}
public void Start(string serviceName) // 启动服务
{
GrpcServiceManager.Start(Library.GrpcService.BindService(new GrpcServiceImpl()), new ConsoleTracer(), (ex) =>
{
LogHelper.Info("", ex);
});
}
public void Stop(string serviceName) // 停止服务
{
GrpcServiceManager.Stop();
}
public void ShutDown(string serviceName)
{
GrpcServiceManager.Stop();
}
}
}
```
#### [](#zxcgny)4. 客户端使用
#### [](#egbtce)(1)NetCore
> - 强制依赖注入模式
> - 配置文件默认使用 [命名空间].dll.json 可通过vs.menu工具生成nuget包
> - 注入中直接调用如下
```csharp
// 注入Grpc客户端
services.AddGrpcClient();
// 自定义配置文件 / 默认使用命名空间.dll.json
services.Configure>((cfg) =>
{
cfg.JsonFile = "dllconfig/Sodao.GrpcExample.Service.Grpc.dll.json"; // 可不传递
});
// 获取注入的对象
IGrpcClient _grpcClient;
public IndexModel(IGrpcClient grpcClient)
{
_grpcClient = grpcClient;
}
var res = _grpcClient.Client.Ask(new Service.Grpc.AskRequest() { Key = "abc" });
```
#### [](#4tuqar)(2)Framework
> - 客户端代理类,编译在Dll中,类似于ThriftProxy,源码如下,可忽略
```csharp
using Sodao.Core.Grpc;
using System;
using System.IO;
namespace Sodao.GrpcService.Generate
{
public class ClientManager
{
private volatile static GrpcService.GrpcServiceClient _Client = null;
private static readonly object lockHelper = new object();
public static IClientTracer Tracer { get; set; } = default(IClientTracer);
///
/// 单例实例
///
public static GrpcService.GrpcServiceClient Instance
{
get
{
if (_Client == null)
{
lock (lockHelper)
{
try
{
var configPath = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "dllconfigs/Sodao.GrpcService.Library.dll.config");
_Client = GrpcClientManager.Get(configPath, Tracer);
}
catch (Exception ex)
{
throw new Exception($"{ex.InnerException?.InnerException?.Message}");
}
}
}
return _Client;
}
}
}
}
```
> - 使用代理类执行
```
ClientManager.Instance.[Method]
```
#### [](#ut52ry)5. 更新说明
- 2019-03-06 v 1.0.9
> 1. 升级Grpc版本为 1.19.0
> 1. Consul节点默认Passing
> 1. ConsulSettings添加环境变量支持
- 2019-01-29 v 1.0.8
> 1. 升级Grpc版本为 1.18.0
> 2. 其他一系列升级以及Bug修复
- 2018-11-13 v 1.0.6.10 (****)
> 1. 添加IServerTracer作为服务端拦截器接口,实现即可拦截
> 2. 添加IClientTracer作为客户端拦截器接口,实现即可拦截
> 3. 升级Google.Protobuf v 3.6.1
> 4. **重要**[下载地址](http://10.0.60.89:8082/)
```csharp
Sodao.Core.Grpc.dll
Consul.dll
Grpc.Core.dll
Google.Protobuf.dll
runtime/*
libgrpc_*
grpc_csharp_*
App.config/Web.config
```
- 2018-11-10 v 1.0.6.9
> 1. 升级Grpc v1.16.0 支持Intercept
- 2018-09-07 v 1.0.6.6
> 1. 影响服务端驱动
> 2. 更改ServciceHost获取以环境变量优先
- 2018-08-24 v 1.0.6.5
> 1. 影响客户端驱动
> 2. 修复发布过程中异常加入黑名单后,连接全部丢失问题
- 2018-08-21 v 1.0.6.4
> 1. 添加服务与Consul自检功能,升级Consul v0.7.2.6 / Grpc v1.14.1.0
> 2. 升级该版本需要同时发布**以下内容**
```csharp
Sodao.Core.Grpc.dll
Consul.dll
Grpc.Core.dll
Google.Protobuf.dll
runtime/*
libgrpc_*
grpc_csharp_*
App.config/Web.config
```
---