通过Dapr实现一个简单的基于.net的微服务电商系统(十五)—

　　之前有小伙伴在评论区留言说如何集成swagger，最开始没有想透给了对方一个似是而非的回答。实际上后来下来想了一下，用.NET5 提供的Source Generator其实可以很方便的实现接口集成。今天就分享一下集中式接口文档的方案

　　源码生成器（Source Generator）是 C# Roslyn 代码分析器的一个新特性。与.net5同一时间发布了GA版本。开发者可以使用编译器生成的元数据检查用户代码，并生成附加的源文件，与程序的其他部分一起编译。通过这个特性我们可以很容易的在编译阶段静态织入各种代码实现相应功能。所以集中式接口文档实现思路就是在编译阶段通过反射获取到我们的remote/iapplicationservice下的接口类型，通过解析类型和方法生成对应的controller/action代码并织入到程序进程中。这样生成后的应用在启动时swagger组件即可检查到对应的控制器，从而生成相应文档。首先来看看成品：

　　相关代码已经更新至gthub,重新拉取并生成后即可通过 http://swagger.dapreshop.com:30882/swagger/index.html 访问，下面我们讲讲怎么实现的。首先我们需要通过vs2019创建一个空的webapi应用，并勾选“启用OpenApi支持”，这样创建的模板即可自带swagger。接着我们创建一个.net的类库项目，并让webapi引用它。同时注意webapi.csproj需要申明OutputItemType="Analyzer" ReferenceOutputAssembly="false"表示该项目用于代码编译器分析。

    <ProjectReference Include="..\ApiSourceGenerator\ApiSourceGenerator.csproj" OutputItemType="Analyzer" ReferenceOutputAssembly="false" />

　　接着类库项目需要引入nuget：Microsoft.CodeAnalysis.CSharp。这个包就是Generator的本体了。然后我们创建对应的Generator实现类，并继承ISourceGenerator接口。通过这个接口的两个方法我们即可实现代码的分析+织入。在Execute方法里，我们从IApplicationService程序集反射获取我们的所有接口和方法，并通过字符串的形式生成对应的代码文件。最后通过GeneratorExecutionContext的AddSource注入文件并随其他代码一同编译。具体的细节大家有兴趣的可以看看Services\ApiDocument下的代码，实现相对比较简单，这里就不再赘述。api文档生成后调用链也比较简单，其实就是充当了一个反向代理。通过api文档生成的action发起http请求扔给apigateway。和我们在静态页面上调接口是一个模式。

通过Dapr实现一个简单的基于.net的微服务电商系统(十五)——集中式接口文档实现的更多相关文章

通过Dapr实现一个简单的基于.net的微服务电商系统(十六)——dapr+sentinel中间件实现服务保护
dapr目前更新到了1.2版本,在之前4月份的时候来自阿里的开发工程师发起了一个dapr集成Alibaba Sentinel的提案,很快被社区加入到了1.2的里程碑中并且在1.2 release 相关 ...
通过Dapr实现一个简单的基于.net的微服务电商系统(十九)——分布式事务之Saga模式
在之前的系列文章中聊过分布式事务的一种实现方案,即通过在集群中暴露actor服务来实现分布式事务的本地原子化.但是actor服务本身有其特殊性,场景上并不通用.所以今天来讲讲分布式事务实现方案之sag ...
通过Dapr实现一个简单的基于.net的微服务电商系统(十八)——服务保护之多级缓存
很久没有更新dapr系列了.今天带来的是一个小的组件集成,通过多级缓存框架来实现对服务的缓存保护,依旧是一个简易的演示以及对其设计原理思路的讲解,欢迎大家转发留言和star 目录:一.通过Dapr实现 ...
通过Dapr实现一个简单的基于.net的微服务电商系统(十)——一步一步教你如何撸Dapr之绑定
如果说Actor是dapr有状态服务的内部体现的话,那绑定应该是dapr对serverless这部分的体现了.我们可以通过绑定极大的扩展应用的能力,甚至未来会成为serverless的基础.最开始接触 ...
通过Dapr实现一个简单的基于.net的微服务电商系统(十二)——istio+dapr构建多运行时服务网格
多运行时是一个非常新的概念.在 2020 年,Bilgin Ibryam 提出了 Multi-Runtime(多运行时)的理念,对基于 Sidecar 模式的各种产品形态进行了实践总结和理论升华.那到 ...
通过Dapr实现一个简单的基于.net的微服务电商系统(十四)——开发环境容器调试小技巧
之前有很多同学提到如何做容器调试,特别是k8s环境下的容器调试,今天就讲讲我是如何调试的.大家都知道在vs自带的创建项目模板里勾选docker即可通过F5启动docker容器调试.但是对于启动在k8s ...
通过Dapr实现一个简单的基于.net的微服务电商系统(十七)——服务保护之动态配置与热重载
在上一篇文章里,我们通过注入sentinel component到apigateway实现了对下游服务的保护,不过受限于目前变更component需要人工的重新注入配置以及重启应用更新componen ...
通过Dapr实现一个简单的基于.net的微服务电商系统(二十)——Saga框架实现思路分享
今天这篇博文的主要目的是分享一下我设计Saga的实现思路来抛砖引玉,其实Saga本身非常的类似于一个简单的工作流体系,相比工作流不一样的部分在于它没有工作流的复杂逻辑处理机制(比如会签),没有条件分支 ...
通过Dapr实现一个简单的基于.net的微服务电商系统(十一)——一步一步教你如何撸Dapr之自动扩/缩容
上一篇我们讲到了dapr提供的bindings,通过绑定可以让我们的程序轻装上阵,在极端情况下几乎不需要集成任何sdk,仅需要通过httpclient+text.json即可完成对外部组件的调用,这样 ...

随机推荐

C/C++中的字符串相关姿势
这是我在<程序设计实习>课程上作的pre,目标是对C/C++中字符串的相关内容作一个尽量完整的介绍.(对于OIer可能不太实用) 课件链接: https://files.cnblogs.c ...
NOI2020游记
我今年高一,这是我第一年作为正选参加NOI. 去年NOI没写游记,结果前两天想要复盘NOI2019的时候发现只能回想起一些模糊的记忆了.为了防止明年再遇到这种情况(其实我更希望没有明年),就有了这篇游 ...
Nest 中处理 XML 类型的请求与响应
公众号及小程序的微信接口是通过 xml 格式进行数据交换的. 比如接收普通消息的接口: 当普通微信用户向公众账号发消息时,微信服务器将 POST 消息的 XML 数据包到开发者填写的 URL 上. - ...
什么是JWT？原理是什么？
什么是JWT JWT 是Json Web Tokens的简称.用百度上面的解释讲,是目前流行的跨域认证解决方案,一种基于JSON的.用于在网络上声明某种主张的令牌(token). JTW原理 jwt验 ...
软件调研——GoodNotes 5与Notability
项目内容这个作业属于哪个课程 2021春季软件工程(罗杰任健) 这个作业的要求在哪里作业要求我在这个课程的目标是积累软件开发经验,提高工程能力这个作业在哪个具体方面帮助我实现目标深入调 ...
Linux连接Windows服务器以及文件传输方法
Ubantu系统上连接Windows服务器,操作步骤安装rdesktop sudo apt-get install rdesktop 连接命令 rdesktop -f IP -r disk:mydi ...
关于height:100%
要想高度百分比起作用,一般来说,要满足两个条件:其一,父标签有高度可寻,就是向上遍历父标签要找到一个定值高度(body,html另外讨论),如果中途有个height为auto或是没有设置height属 ...
Android NDK工程的编译和链接以及使用gdb进行调试
前提条件:已经安装了JDK 6.0.android SDK.NDK r9和eclipsele4.2开发环境. 推荐下载Android开发的综合套件adt-bundle-windows-x86,再下载A ...
DexHunter的原理分析和使用说明（一）
本文博客地址:http://blog.csdn.net/qq1084283172/article/details/53710357 Android通用脱壳工具DexHunter是2015年下半年,大牛 ...
Cookie、Session和Token认证
目录 Cookie Session认证机制 Session的一些安全配置 Token认证机制 Token预防CSRF Session认证和Token认证的区别前言:HTTP是一种无状态的协议,为了分 ...

通过Dapr实现一个简单的基于.net的微服务电商系统(十五)——集中式接口文档实现

通过Dapr实现一个简单的基于.net的微服务电商系统(十五)——集中式接口文档实现的更多相关文章

随机推荐

热门专题