.NET Core开发实战(定义API的最佳实践)Source Generators版

前言

极客时间上的《.NET Core开发实战》是一门非常好的课程,作者肖伟宇在第31课(https://time.geekbang.org/course/detail/100044601-201165)介绍了定义API的最佳实践

大意如下:

Controller这一层负责与前端用户的交互,它主要的责任就是定义输入和输出,不应该处理业务。 

因此使用中介者模式,将业务逻辑和Controller进行隔离。

示例API的实现代码如下:

[Route("api/[controller]")]
[ApiController]
public class OrderController : ControllerBase
{IMediator _mediator;public OrderController(IMediator mediator){_mediator = mediator;}[HttpPost]public async Task<long> CreateOrder([FromBody]CreateOrderCommand cmd){return await _mediator.Send(cmd, HttpContext.RequestAborted);}[HttpGet]public async Task<List<string>> QueryOrder([FromQuery]MyOrderQuery myOrderQuery){return await _mediator.Send(myOrderQuery);}
}public class CreateOrderCommand : IRequest<long>
{public CreateOrderCommand(int itemCount){ItemCount = itemCount;}public long ItemCount { get; private set; }
}public class MyOrderQuery : IRequest<List<string>>
{public string UserName { get; set; }
}

问题

按照上述的最佳实践去编写Controller,这就意味着,如果有100个命令和查询,就要创建100个同样格式的方法。

这是一项重复并且枯燥的工作,而且还必须保证方法返回值与IRequest<T>的类型一致,很容易出错。

有不有不用写这些代码的简单方式

Source Generators

现在,可以祭出我们的大杀器——Source Generators

上次我们已经使用它实现了AutoMapper,它的主要特点是自动生成源代码并编译到最终输出中。

这次,我们用它来自动生成API代码。

实现原理如下:

  • 遍历所有继承IRequest<T>的类,并用它们名称的第2个单词(例如Order)分组

  • 分组Key作为Controller的名称

  • 在Controller分组中遍历分组下的类,生成对应命令和查询方法

具体实现代码请到https://github.com/feiyun0112/CodesForMy_IO下载。

使用示例

下载课件代码(https://gitee.com/geektime-geekbang/NET-Core),在GeekTime.Ordering.API项目中引用ApiControllerGenerator项目,无需修改任何代码,直接编译,可以看到已经按照最佳实践的规范生成了代码(Controller名称故意加了New以示区别):

运行后Swagger显示正常,成功!

结论

现在,我们只需定义命令和查询,即可实现定义API的最佳实践,是不是很酷!

如果你觉得这篇文章对你有所启发,请关注我的个人公众号”My IO“,记住我!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/299858.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

多年经验的程序员迷失了自己,该怎么办?

多年的程序员迷失了自己&#xff0c;该怎么办&#xff1f; 本文选自《我也能做CTO之程序员职业规划 》一书 我应该朝哪个方向发展&#xff1f;我不做这行还能做什么&#xff1f;当现实情况与理想目标之间的差距越拉越大时&#xff0c;大多数刚入行的IT人员都会提出这样的问题&a…

大神讲解Java for循环的几种用法

本文非常适合初学Java的程序员&#xff0c;主要是来了解一下Java中的几种for循环用法&#xff0c;分析得十分详细&#xff0c;一起来看看。 J2SE 1.5提供了另一种形式的for循环。借助这种形式的for循环&#xff0c;可以用更简单地方式来遍历数组和Collection等类型的对象。本文…

苍天饶过谁?| 今日最佳

全世界只有3.14 % 的人关注了青少年数学之旅&#xff08;图源人民日报&#xff0c;侵权删&#xff09;

快速选择实例

功能&#xff1a;查找集合S中第k个最小元。 快速选择算法修改自快速排序算法&#xff0c;当算法终止时&#xff0c;第k个最小元就在位置k上。这破坏了原来的排序&#xff1b;如果不希望这样&#xff0c;那么需要做一份拷贝。 快速选择函数&#xff1a; /* quick_select.h */#if…

设计模式之桥接

桥接模式的介绍桥接模式就是通过将抽象部分与实现部分分离&#xff0c;把多种可匹配的使用进行组合。其实就是在A类中含有B类接口&#xff0c;通过构造函数传递B类的实现&#xff0c;这个B类就是设计的桥。它是一种结构型设计模式&#xff0c;可将一个大类或一系列紧密相关的类…

去除HTML标签--SQL写法

----Author: Derry--Create date: 2009-07-27--Description: 去除HTML标签--ALTERFUNCTION[dbo].[StripAllTags]( inputVARCHAR(8000))RETURNSVARCHAR(8000)ASBEGINdeclareResultvarchar(8000), startint, endint, lenintsetinputinput<>setResult…

手把手教你用Java的swing制作计算器

其实学到Java这一块很多人会觉得很复杂实际上学会使用方法其实很简单 话不多说直接贴源码,如下&#xff1a; package cn.sjy.calculator;import javax.swing.*; import java.awt.*;/*** 简易计算器* author 石俊熠* 2020.7.13 11:24* 注&#xff1a;仿照某Java大佬的源码改之*…

你们都被电视剧版的 《西游记》给骗了!| 今日趣图

全世界只有3.14 % 的人关注了青少年数学之旅你们都被电视剧版的《西游记》给骗了&#xff01;电视剧里挑担子的是沙僧但其实《西游记》原著中大部分都是二师兄挑担子沙僧也就是打个下手&#xff08;图源名场面All&#xff0c;侵权删&#xff09;如果再有人嘲笑你胖你就把这条涨…

.NET 6 Preview 6 Released

宣布 .NET 6 Preview 6Richard 2021 年 7 月 14 日我们很高兴发布 .NET 6 Preview 6。Preview 6 是我们进入 RC 时期之前的倒数第二个预览版。将有两个 RC 版本。此版本本身相对较小&#xff0c;而 Preview 7 会更大一些。在那之后&#xff0c;我们将进行质量修复&#xff0c;直…

SQL2K数据库开发十五之表操作查看表中的数据

1.可以使用SELECT语句查询表中的数据。如在查询分析器中执行SELECT * FROM Products语句就可以查询Products表中的数据&#xff0c;如下图&#xff1a;2.如在企业管理器中查询表中数据&#xff0c;则要展开sample数据库&#xff0c;在Products表上右击鼠标&#xff0c;在弹出的…

中考新大纲:初中数学无非就这26个考点!孩子吃透,再笨也能考115分!

全世界只有3.14 % 的人关注了青少年数学之旅升入初二、初三后数学难度急速上升&#xff0c;您的孩子是否学得吃力成绩却无法提高&#xff1f;1.总说自己上课都能听懂&#xff0c;可题目稍微一变就不会做&#xff1b;2.连课下时间都在刷题&#xff0c;到头来做的全是无用功&…

程序员(工作2年)立flag,面四家,成三家,最后进了蚂蚁.....

作为一个毕业2年的coder, 最近一直在寻找一个合适的机会能够换一个环境&#xff0c;一是寻找一个更加宽阔的舞台不断的提升自己&#xff0c;二是让自己走出现在的舒适区域&#xff0c;迎接更多的挑战和认识更多的人。当然还有为了获得更加好的一份收入。 这一个月&#xff0c;…

深入分析Volatile的实现原理

2019独角兽企业重金招聘Python工程师标准>>> 术语英文单词 描述 共享变量在多个线程之间能够被共享的变量被称为共享变量。共享变量包括所有的实例变量&#xff0c;静态变量和数组元素。他们都被存放在堆内存中&#xff0c;Volatile只作用于共享变量。内存屏障Memor…

Serilog 最佳实践

Serilog 最佳实践概述Serilog[1]是 Microsoft .NET 的结构化日志记录库&#xff0c;并已成为Checkout.com 上NET 的首选日志记录库。它支持各种日志记录目的地&#xff08;称为接收器[2]&#xff09;包从标准控制台和基于文件的接收器到日志服务&#xff0c;如 Datadog。本指南…

世界上迄今为止最安全的加密算法

全世界只有3.14 % 的人关注了青少年数学之旅一个只能用算力来破解的加密算法1人类的加密史公元前5世纪&#xff0c;古希腊人使用一根叫scytale的棍子来传递加密信息。要加密时&#xff0c;先绕棍子卷一张纸条&#xff0c;把信息沿棒水平方向写&#xff0c;写一个字旋转一下&…

手把手教你java快速过滤关键词

java过滤关键词 敏感词、文字过滤是一个网站必不可少的功能&#xff0c;如何设计一个好的、高效的过滤算法是非常有必要的。前段时间我一个朋友&#xff08;马上毕业&#xff0c;接触编程不久&#xff09;要我帮他看一个文字过滤的东西&#xff0c;它说检索效率非常慢。我把它程…

[Delphi]根据输入日期按年月周日输出日期段

输入变量ADateStart&#xff0c;并为其填写起始日期&#xff0c;变量ADateEnd&#xff0c;计算类型AType&#xff0c;输出变量ADateStart&#xff0c;变量ADateEnd procedureFormatDateByType(AType:Integer; varADateStart, ADateEnd: TDate); var//type0日 1周 2月 3年 …

TIOBE 发布 8 月编程语言榜单:C# 排名如何?

刚刚 TIOBE 官方最新发布了 8 月的编程语言榜单&#xff0c;一起来看本月榜单中有什么值得关注的发展趋势吧&#xff1f;每一种编程语言的兴起从来都离不开它所适用的技术领域&#xff0c;二者之间一直以来都是水涨船高的关系。数据挖掘和人工智能的蓬勃发展也是如此&#xff0…

两年了,你还是那个你 | 今日最佳

全世界只有3.14 % 的人关注了青少年数学之旅&#xff08;图源都市音酱&#xff0c;侵权删&#xff09;

k8s入门你至少需要会哪些

前言相信很多公司都有集成发布pass系统&#xff0c;底层大多数依赖于k8s来进行服务的发布部署/回滚等功能。对于很多业务开发者都是不可见的&#xff0c;在感叹这个东西真好用的同时&#xff0c;想着探一探这背后的原理。今天这篇k8s入门我整理了必会的几个k8s知识点&#xff0…