.Net Core 分布式微服务框架介绍 - Jimu

系列文章

 [原文]

1. .Net Core 分布式微服务框架介绍 - Jimu [原文]     
2. .Net Core 分布式微服务框架 - Jimu 添加 Swagger 支持[原文]

[本文]

1. .Net Core 分布式微服务框架介绍 - Jimu    

一、前言

从2019年参加aelf举办的.Net论坛,各路大神推荐使用.netCore开始,伴随着项目的开发,所有工作已经迁移到.netCore平台上。.netCore 跨平台的特点加之近几年微服务热度增加，非常的希望有比较完善的微服务框架能够使用。经过反复的搜寻和查找，找到了大神grissom007  博客地址 开发的微服务框架Jimu  奈何大神太忙，很多资料没有跟上。所以我打算转载大神的使用教程，并添加个人一点微薄的见解在里面。本人在写博客和框架方面比较弱，编写过程中可能出现多多少少的失误，请各路大侠指正批评。

grissom007大神在近些年一直在 .Net 平台做企业应用开发，用过的 .Net 框架不多（具体数量不清，印象深刻的有 Asp.Net MVC，WPF，其他很多都是基于微软开发的框架做些封装而形成新的框架，大都是还没起好名就湮灭在历史长河中），而grissom007开发的框架倒是不少（5 - 8 套吧）， 换框架与换公司成正比（每换一家公司，至少换一套框架），很多都见不得人（当时觉得高大上，后来觉得很low）。 随波逐流从 winform 年代到现在热火朝天的微服务，网上阅读各式各样的博客、新闻、评论、代码，懂了点微服务的概念，结合网上开源代码和思想，grissom007开发出一个全面的微服务框架 - Jimu (中文名：积木)。

Jimu 是一个基于.Net Core 2.0 （现已升级.Net Core 3.1）简单易用的微服务框架，使用了大量的开源库, 支持分布式、高并发和负载均衡， 实现了服务治理和 RPC 调用。Jimu 在持续迭代开发中。正如其中文名 - 积木，希望用她来开发项目像搭积木一样简单快速可控，使项目安全可靠稳定，整体架构可拓展、高并发、分布式。

二、功能技术

• 服务注册：指定服务器地址，或通过扩展支持其他应用（如 consul - 已支持，redis， zookeeper）
• 服务发现：指定服务器地址，或通过扩展支持其他应用（如 consul - 已支持，redis ，zookeeper）
• 服务调用：使用 DotNetty 或 Flurl.Http 实现 RPC 调用
• 服务代理：Microsoft.CodeAnalysis 解析服务接口生成动态代理
• 健康监测：Quartz.Net 定时调度 Socket 任务检查服务器心跳
• 负载均衡：轮询算法（未实现的有： 加权轮询法， 最小连接数法，随机法，加权随机法，源地址哈希法）
• 授权认证：jose-jwt 实现 JWT 授权
• 序 列 化：Json.Net
• 系统日志：log4net、NLog

三、框架简图

如图所示，这里有四种角色：

• Client：各种客户端， 这是抽象的说法，只要访问了 ApiGateway 都属于客户端（手机、电脑 ...， 如果 Service Server1 和 Service Server2 访问了 ApiGateway 也属于客户端）
• ApiGateway： 服务网关，外部要经过它才可访问内部的服务。网关是非常重要的一个角色，他相当于外部和内部服务之间的中介，负责接受和响应外部请求，以及调用内部服务，还有服务治理等功能
• Service Discovery Server：负责保存已注册的服务，相当于服务的花名册， Service Server 注册服务就是向花名册记录自己的名称， ApiGateway 发现服务就是去花名册找有哪些已注册的服务
• Service Server：这就是微服务，所有业务需求都在这里实现

四、如何使用

服务注册与发现， 已经实现了两种方式：

1. 不依赖第三方应用，直接注册到本地服务， 可参看 github 上的 Quick Start
2. 依赖于 consul, 需要先启动 consul，然后服务注册 consul, ApiGateway 访问 consul 发现服务

下面用 consul 作为服务容器，演示怎么用 Jimu 实现一个分布式的微服务

1. 启动 consul

下载安装 consul https://www.consul.io/downloads.html
启动

consul agent -dev

2. 微服务项目

创建一个基于 .Net Core 3.1 的类库项目，并添加 jimu 依赖

Install-Package  Jimu

添加服务，引用空间： using Jimu;

        [Jimu("api/{Service}")]
        public class UserService : IJimuService
        {
            [JimuService(CreatedBy = "grissom")] // 指定服务的元数据, 该服务调用路径为 api/user/getname?id=
            public string GetName(string id)
            {
                return $"user id {id}, name enjoy!";
            }
        }

这样我们就有了一个积木的接口加实现,下一步我们要把接口和实现制作成微服务的服务端

3. 微服务服务端项目

创建一个基于 .Net Core 3.1 的控制台项目， 并添加 Jimu.Server 和 Jimu.Server.Discovery.Consul 依赖

Install-Package  Jimu.Server
Install-Package  Jimu.Server.Discovery.Consul

在 Main 函数中添加服务器启动代码，引用空间： using Jimu.Server;

static void Main(string[] args)
{
            ApplicationHostServer.Instance.Run();
}

创建配置文件JimuAppServerSettings.json到控制台项目下,文件属性写"如果较新则复制"

{
//Nlog配置
  "JimuNLogOptions": {
    "UseInService": true,
    "EnableConsoleLog": true,
    "EnableFileLog": true,
    "FileLogPath": "log",
    "FileLogLevelMax": "Error",
    "FileLogLevelMin": "Debug",
    "ConsoleLogLevelMax": "Error",
    "ConsoleLogLevelMin": "Debug"
    //"Configuration":  "nlog.config"
  },
//Consul配置
  "ConsulOptions": {
    "Ip": "127.0.0.1", //consul ip 启动consul的那台主机的ip
    "Port": "8500", // consul port  consul默认端口
    "ServiceGroups": "jimu.sample", //服务注册所属的组别
    "ServiceInvokeIp": "127.0.0.1", //这个微服务的地址
    "ServiceInvokePort": "8001"     //这个微服务监听的端口
  },
//这个微服务的配置
  "TransportOptions": {
    "Ip": "127.0.0.1", //当前服务宿主ip
    "Port": 8001, //当前服务宿主端口
    "Protocol": "Netty", //传输协议： Netty, Http
    "ServiceInvokeIp": "127.0.0.1", //当前服务宿主的地址
    "ServiceInvokePort": "8001"
  },
//微服务启动时加载的组件配置
  "ServiceOptions": {
    "Path": "", //服务dll所在路径，默认当前目录
    "LoadFilePattern": "JiMuStartService.dll" //需要加载的服务dll，支持统配符:*.dll,*.txt  写我们刚才创建的类库的生成dll的名称
  }

}

接下来在我们这个项目中把刚才创建的类库项目添加到项目引用,为的是能够在项目启动的时候,把类库项目最新的dll复制到运行目录中

至此我们的微服务创建完毕

4. 微服务客户端（ApiGateway）项目

创建一个基于 .Net Core 3.1 的 Asp.Net Core Web 应用程序（可选择 API 项目模版），并添加 Jimu.Client 和Jimu.Common.Discovery.ConsulIntegration 依赖

Install-Package  Jimu.Client
Install-Package  Jimu.Client.Discovery.Consul
Install-Package  Jimu.Client.ApiGateway.Swagger

修改 Program.cs 类的代码， 以便添加对 jimu 的支持 删除Startup.cs文件

 public class Program
    {
        public static void Main(string[] args)
        {
            Jimu.Client.ApplicationWebClient.Instance.Run(null, (env, app) =>
            //ASP.NET Core 使用app.UseStaticFiles配置静态文件中间件，达到类似IIS中虚拟目录的效果，可访问位于 Web 根目录之外的文件
            app.UseStaticFiles());
        }
    
    }

在apiGateWay项目中新增JimuAppClientSettings.json文件

{
  "SwaggerOptions": {
    "Title": "FirstJiMuService",
    "Version": "v0.1"
     ]
  },
  //log4net配置
  "JimuLog4netOptions": {
    "EnableConsoleLog": true, //是否打开Console输出
    "EnableFileLog": true, //是否输出到文件
    "FileLogPath": "log", //文件地址
    "FileLogLevelMax": "Error", //
    "FileLogLevelMin": "Debug",
    "ConsoleLogLevelMax": "Error",
    "ConsoleLogLevelMin": "Debug"
  },
  //Consul配置
  "ConsulOptions": {
    "Ip": "127.0.0.1", //consul ip
    "Port": 8500, // consul port
    "ServiceGroups": "jimu.sample" //服务注册所属的组别
  },
  "DiscoveryOptions": {
    "UpdateJobIntervalMinute": 1 //单位分钟，1分钟刷新一次
  },
  "FaultTolerantOptions": {
    "RetryTimes": 0 //服务调用失败重试次数
  },
  "HealthCheckOptions": {
    "IntervalMinute": 1 //心跳监测时间间隔，单位分钟
  },
  "LoadBalanceOptions": {
    "LoadBalance": "Polling" //负载均衡算法: Polling - 轮询
  },
  "TransportOptions": {
    "Protocol": "Netty" //传输协议： Netty 
  }
 


}

5. 同时启动 服务端 和 客户端

然后在浏览器访问： https://localhost:44367/swagger/index.html  注意端口号

至此您使用jimu框架搭建的第一款微服务应用完成

6.  demo

grissom007Demo更多强悍的功能使用，请自己看 demo 领悟，由于时间有限，这里就不一一详解了，如果大家有兴趣，日后或者会有多篇幅和文档来介绍。
请下载 Jimu 源码, 或者下载项目 jimu.demo

 

本文Demo

CSDN:https://download.csdn.net/download/zhengjian1996/14933919

GitHub: https://github.com/ZhengJian1996/JiMuFristDemo

五、源码

请到 github pull 源码，包含有“巨量” demo