NetCore服务虚拟化01（集群组件Sodao.Core.Grpc）

一. 起始

去年.netcore2.0的发布，公司决定新项目采用.netcore开发，当作试验。但是问题在于当前公司内部使用的rpc服务为thrift v0.9 + zookeeper版本，经过个性化定制，支持了异步，但也因为如此，这么多年来一直没有去升级，导致迁移工作很复杂（历史遗留项目太多，有各种语言的，目前只有.net体系的开发人员）。另外一点公司本身是做电商服务的，很多东西依赖了阿里的数据，阿里要求数据不能够出聚石塔，我们将所有相关的应用迁移到了聚石塔，随之问题也来了，聚石塔只开放了80端口，这么多的thrift服务需要开放端口，机房与聚石塔之间的交互就很头疼了，如果改成http请求的话，代价以及各类成本较高。经过一段时间的调研，决定采用grpc作为新的rpc服务框架，原因有以下几点：

（1）支持多语言

（2）支持http/2，80端口可用

但是grpc需要做集群支持，也经过一段时间的研究，决定抛弃zookeeper，采用consul来作为注册中心，至于原因，有很多方面。

 

二. 组件sodao.core.grpc

为了让grpc实现集群部署，自行开发了通用组件sodao.core.grpc，其依赖于grpc + consul，代码已开源，详见github 

 

三. 简单介绍使用

1. nuget包引用

• nuget版本：v 1.0.0
• 框架支持： framewok 4.5 - 4.7 / netstandard 2.0

install-package sodao.core.grpc -version 1.0.0

2. 配置信息

（1）服务端配置信息 （netcore / framework）

• netcore配置案例 appsettings.json

{
  "grpcserver": {
    "service": {
      "name": "sodaogrpcserviceapp",                    服务名称使用服务名称去除点
      "host": "service.g.lan",                          专用注册的域名 （可选）
      "hostenv": "serviceaddress",                      环境变量配置（可选，同上）
      "port": 10001,                                    端口：与端田申请
      "consul": {
        "path": "dllconfigs/consulsettings.json"        consul路径，不配置将不注册，为单点项目
      }
    }
  }
}

• framework配置案例 app.config

// 添加section
<configsections>
  <section name="grpcserver" type="sodao.core.grpc.grpcserversection, sodao.core.grpc" />
</configsections>

// 添加节点
<grpcserver>
  <service name="sodaogrpcserviceapp" port="10005" host="专用注册的域名 （可选）" hostenv="环境变量配置（可选，同上）">
    <registry>
      <consul path="dllconfigs/consul.config" />
    </registry>
  </service>
</grpcserver>

（2）客户端配置信息

• netcore
• 命名：[命名空间].dll.json 文件夹(dllconfigs)

 

{
  "grpcclient": {
    "service": {
      "name": "grpcservice",                        服务名称与服务端保持一致
      "maxretry":  0,                               最大可重试次数，默认不重试
      "discovery": {
        "endpoints": [                              单点模式
          {
            "host": "127.0.0.1",
            "port": 10001
          }
        ],
        "consul": {                                 consul 集群
          "path": "dllconfigs/consulsettings.json"
        }
      }
    }
  }
}

 

• framework

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <configsections>
    <section name="grpcclient" type="sodao.core.grpc.grpcclientsection, sodao.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>

 

（3）consul配置文件 

• netcore

{
  "consulserver": {
    "service": {
      "address": "http://consul.g.lan" // 默认8500端口
    }
  }
}

 

• framework

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <configsections>
    <section name="consulserver" type="sodao.core.grpc.consulserversection, sodao.core.grpc"/>
  </configsections>
  <consulserver>
    <service address="http://consul.g.lan"></service>
  </consulserver>
</configuration>

 

 

3. 服务端的使用

（1）netcore

• 强制依赖注入模式

services.addsingleton<grpcexampleservice.grpcexampleservicebase, grpcexampleserviceimpl>();          grpc服务的实现
services.addsingleton<ihostedservice, grpcexamplehostedservice>();                                   grpc服务启动服务类：如下
services.addgrpctracer<consoletracer>();                                                             grpc注入拦截器，继承iservertracer
 
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);
        }
    }
}

• 实现类写法 

// 原因：服务启动的时候是一个单例，那么所有服务之下的全部是单实例，而数据层需要使用多实例

// 只注入 iserviceprovider
iserviceprovider _provider;
public grpcexampleserviceimpl(iserviceprovider provider)
{
    _provider = provider;
}

// 其他利用provider即时获取
using(var scope = _provider.createsocpe())
{
    var _userservice = scope.serviceprovider.getservice<iuserservice>();
}

（2）framework 4.6

• 直接调用grpcservicemanager来启动 

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();
        }
    }
}

 

4. 客户端使用

（1）netcore

• 强制依赖注入模式
• 配置文件默认使用 [命名空间].dll.json 可通过vs.menu工具生成nuget包
• 注入中直接调用如下

// 注入grpc客户端
services.addgrpcclient();

// 自定义配置文件 / 默认使用命名空间.dll.json
services.configure<grpcclientoptions<grpcexampleserviceclient>>((cfg) =>
{
    cfg.jsonfile = "dllconfig/sodao.grpcexample.service.grpc.dll.json";  // 可不传递
});


// 获取注入的对象
igrpcclient<grpcexampleserviceclient> _grpcclient;
public indexmodel(igrpcclient<grpcexampleserviceclient> grpcclient)
{
    _grpcclient = grpcclient;
}


var res = _grpcclient.client.ask(new service.grpc.askrequest() { key = "abc" });

（2）framework

• 客户端代理类，编译在dll中，类似于thriftproxy，源码如下，可忽略

 

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);
        /// <summary>
        /// 单例实例
        /// </summary>
        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<grpcservice.grpcserviceclient>.get(configpath, tracer);
                        }
                        catch (exception ex)
                        {
                            throw new exception($"{ex.innerexception?.innerexception?.message}");
                        }
                    }
                }
                return _client;
            }
        }
    }
}

 

• 使用代理类执行

clientmanager.instance.[method]