本篇将介绍如何扩展 Ocelot 中间件实现自定义网关，并使用 2 种不同数据库来演示 Ocelot 配置信息存储和动态更新功能，内容也是从实际设计出发来编写我们自己的中间件，本文内容涵盖设计思想内容和代码内容，我希望园友们最好跟着我这个文章的思路先理解好后再看源代码，这样有利于融会贯通，本篇的文档及源码将会在 GitHub 上开源，每篇的源代码我将用分支的方式管理，本篇使用的分支为course1。

附文档及源码下载地址：[https://github.com/jinyancao/CtrAuthPlatform/tree/course1]

一、数据库设计

上一篇中我们介绍了 Ocelot 中要满足我们需求，我们需要把配置信息转到数据库存储，今天我们就从数据库设计开始，数据库设计我采用的是PowerDesigner,首先打开软件，新建一个概念模型。根据 Ocelot 的配置文件，我们可以发现，配置信息由全局配置信息和路由信息组成，这时候我们可以设计表结构如下，为了满足后续多个路由的切换，增加了网关和路由多对多关系，以后我们可以随时根据不同规则切换，详细的表字段可以自行根据 Ocelot 配置文档和设计文档对照查看，这里我移除了限流的字段，因为我们后续需要自定义限流，用不上原来的方法。

生成物理模型
数据库设计好后，我们需要把概念模型转成物理模型，使用Ctrl+Shift+P快捷键，我们默认使用 MSSQL2008R2 实现配置存储，所有在弹出的对话框中选择，然后点击确认后会自动生成 MSSQL2008R2 的物理模型，可以看到数据类型和表之间的关连关系都生成好了，奈斯，一切都是那么完美，如果主键为自增类型，手动标记下即可。

现在我们需要生成我们创建数据库的 SQL 脚本了，别忘了保存下刚才生成的物理模型，因为以后还需要用到。

生成数据库脚本

如图所示，可以使用快捷键Ctrl+G生成数据库脚本，点击确认生成并保存，然后把生成的脚本在我们新建的数据库里执行，这样我们的数据库就设计完成了。

二、搭建并测试中间件

我们使用VS2017新建一个.NETCORE2.1项目,然后新建一个类库来实现我们Ocelot 定制版中间件，建好后项目结构如下，现在开始我们第一个AhphOcelot定制中间件编写。

首先我们回顾下【.NET Core 项目实战-统一认证平台】第二章网关篇-重构 Ocelot 来满足需求的源码解析，关于配置信息的读取如下，我们只需要重写下CreateConfiguration方法实现从数据库里取就可以了，既然有思路了，

public static async Task<IApplicationBuilder> UseOcelot(this IApplicationBuilder builder, OcelotPipelineConfiguration pipelineConfiguration){  
    //创建配置信息
    var configuration = await CreateConfiguration(builder);
    ConfigureDiagnosticListener(builder);    return CreateOcelotPipeline(builder, pipelineConfiguration);
}

那就开始改造吧，我们新建一个Ctr.AhphOcelot类库，来实现这个中间件，首先新建自定义中间件扩展，这个扩展是在原有的Ocelot的基础上进行改造，所以需要先在Nuget中安装Ocelot，这系列课程我们以最新的Ocelot 12.0.1版本进行扩展。

首先我们要了解，Ocelot的配置信息是怎么加载进来的呢？

查看源码后发现是是从OcelotBuilder加载的配置文件,也就是最早的AddOcelot()方法时注入的。

现在我们要实现从数据库提取配置信息，可以查看下Ocelot是否给我们提供了相关扩展接口，通过Ctrl+F查找FileConfiguration实体在哪些地方可以返回，IFileConfigurationRepository接口一眼就能认出，配置文件仓储类，我们可以重写这个接口实现即可完成配置文件从数据库提取，果然 Ocelot 是为定制而生，其实如果没有这个接口问题也不大，我们自己去定义和实现这个接口也一样可以完成。

我们看看这个接口是否有默认实现，DiskFileConfigurationRepository方法实现了这个接口，通过名称就知道是直接从配置文件提取配置信息，再看下这个接口应用到哪里，继续Ctrl+F找到，FileConfigurationPoller和FileAndInternalConfigurationSetter两个地方用到了这个接口，其中FileConfigurationPoller实现了IHostedService后台任务，我们不难看出，这个是一个定时更新任务，实际我们配置信息变更，肯定由管理员自己修改测试无误后发起，这里我们用不上，但是实现思路可以了解下。FileAndInternalConfigurationSetter是配置文件更新方法，这里我们如果使用数据库存储，更新肯定由我们自己管理界面更新，所以也用不上，这时有人会问，那如果配置文件发生变更了，我们怎么去更新。这时候我们需要了解配置信息在哪里使用，是否使用了缓存。其实上面也给出了答案，就是IInternalConfiguration.

// now create the configvar internalConfigCreator = builder.ApplicationServices.GetService<IInternalConfigurationCreator>();var internalConfig = await internalConfigCreator.Create(fileConfig.CurrentValue);

现在问题都梳理清楚了，现在我们实现的思路就是，首先通过数据库实现IFileConfigurationRepository接口内容（更新不需要实现，前面说过了），然后再我们数据库里修改了配置，更新IInternalConfiguration配置信息，即可完成我们的自定义任何地方的存储。

开发的思路就是顶层开始一步一步往下实现，最后完成我们的扩展。现在回到我们自己的代码，修改配置信息代码如下，是不是精简很多了，但是有 2 个问题未解决，一是需要实现IFileConfigurationRepository，二是还没实现动态更新。

1、实现 IFileConfigurationRepository 接口

本系列所有课程都是基于轻量级的ORM框架dapper实现

首先需要NuGet包里添加Dapper,然后我们需要把设计的表生成实体，至于如何生成这里就不介绍了，实现方式很多，相关的帖子很多。使用 Dapper 时，我们需要知道知道连接方式，这时需要在中间件的基础上扩充一个配置文件接收配置数据，这样我们才能使用配置的信息内容。

现在可以实现接口了，详细代码如下,代码很简单，就是从数据库查询出录入的内容，使用 dapper 实现。

现在又延伸出两个问题.第一个是AhphOcelotConfiguration这个信息从哪读取的？第二是SqlServerFileConfigurationRepository在哪注入。

其实读过我前面中间件源码解析的同学可能已经知道了，就是在AddOcelot里注入的，现在我们就可以使用相同的方式实现自己的扩展。添加自己的ServiceCollectionExtensions扩展。

有木有很简单呢？到这里从数据库中提取配置信息都完成啦，现在我们开始来测试下，看是否满足了我们的需求。

新建一个Ctr.AuthPlatform.Gateway网关项目，添加我们的中间件项目引用，修改Startup.cs代码如下

就实现了自定义的网关，是不是很优雅呢？但是是否达到了我们预期的网关效果了，我们来直接从数据库里插入测试数据，并新建一个测试项目。测试数据脚本如下

测试项目结构如下，就是默认的一个 api 项目，修改下启动端口为 9000。

为了方便调试.NETCORE 项目，我建议使用dotnet run方式，分别启动网关(7777 端口)和测试服务(9999 端口)。优先启动网关项目，想一想还有点小激动呢，开始运行项目，纳尼，尽然报错，而且是熟悉的未将对象引用到实例化错误，根据异常内容可以看到是在验证的时候报错，我们可以查看下 Ocelot 对应的源代码，发现问题所在了。

我们在一些未定义的配置项目使用了为空的赋值。而 Ocleot 里面对于不少配置项目未做非空验证。比如RateLimitOptionsCreator对于FileGlobalConfiguration未做非空验证，类似这样的地方还有不少，我希望下次 Ocelot 更新时最好增加这类非空验证，这样便于自定义扩展，而 Ocelot 内部实现了默认实例化，所以我们之前从数据库取值赋值时写法需要改进，修改后的代码如下。

然后重新运行，网关启动成功。

接着我们启动我们测试的服务，然后浏览器先访问http://localhost:9000/api/values地址，测试地址正常访问。

然后使用测试网关路由地址访问http://localhost:7777/ctr/values,显示内容和本地访问一样，证明网关路由生效，是不是有点小激动呢？我们完成了从配置信息中取网关路由信息扩展。

三、下篇预告

最后我们回顾下这篇内容，我是从设计到实现一步一步讲解和实现的，而且实现过程是根据需求慢慢剖析再局部实现的，我发现现在很多人在平时学习基本都是结果未导向，很少去关心中间的实现过程，久而久之基本就会丧失解决问题的思路，写的这么详细，也是希望给大家一个解决问题的思路，目前我们实现了从数据库中提取配置信息并在网关中生效，但是还未实现动态更新和扩展其他数据库存储，大家也可以先自己尝试如何实现。

下一篇我们将会实现网关路由的动态更新，会提供几种更新思路，根据实际情况择优选择。然后在使用 Mysql 数据库来存储配置信息，并扩展此网关实现很优雅的配置，为什么使用 mysql 扩展实现呢？因为.netcore 已经跨平台啦，后期我们准备在 Centos 下实现容器化部署，这时我们就准备以 mysql 为例进行讲解，本网关所有内容源码都会实现 sqlserver 和 mysql 两种方式，其他存储方式可自行扩展即可。

最后项目所有的文档在源码的文档目录，文档按照课程源码文件夹区分，本文的文档标识course1

相关文章：

• AspNetCore 中使用 Ocelot 之 IdentityServer4

• Ocelot-基于.NET Core 的开源网关实现

• .NET Core 微服务之基于 Ocelot+IdentityServer 实现统一验证与授权

• Swagger 如何访问 Ocelot 中带权限验证的 API

• Ocelot.JwtAuthorize：一个基于网关的 Jwt 验证包

• .NET Core 微服务之基于 Ocelot 实现 API 网关服务

• .NET Core 微服务之基于 Ocelot 实现 API 网关服务（续）

• .NET 微服务体系结构中为什么使用 Ocelot 实现 API 网关

• Ocelot 简易教程（一）之 Ocelot 是什么

• Ocelot 简易教程（二）之快速开始 1

• Ocelot 简易教程（二）之快速开始 2

• Ocelot 简易教程（三）之主要特性及路由详解

• Ocelot 简易教程（四）之请求聚合以及服务发现

• Ocelot 简易教程（五）之集成 IdentityServer 认证以及授权

• Ocelot 简易教程（六）之重写配置文件存储方式并优化响应数据

• Ocelot 简易教程（七）之配置文件数据库存储插件源码解析

• ASP.NET Core 中 Ocelot 的使用：API 网关的应用

• ASP.NET Core 中 Ocelot 的使用：基于 Spring Cloud Netflix Eureka 的动态路由

• ASP.NET Core 中 Ocelot 的使用：基于服务发现的负载均衡

• 【.NET Core 项目实战-统一认证平台】第一章 功能及架构分析

• 定制 Ocelot 来满足需求

原文地址: https://www.cnblogs.com/jackcao/p/9942561.html

.NET 社区新闻，深度好文，欢迎访问公众号文章汇总 http://www.csharpkit.com