如何在 40 秒内创建一个.Net Core Web API？

查看原文

其他

如何在 40 秒内创建一个.Net Core Web API？

Thomas Hansen CSDN 2019-11-27

为什么我们需要自己写代码？为什么计算机无法自动为我们生成这些代码呢？很显然，我们应该可以利用这些共同点，从一个给定的数据库自动化构建系统——这就是“我”创建Magic的初衷。

作者 | Thomas Hansen

译者 | 弯月，责编 | 郭芮

出品 | CSDN（ID：CSDNnews）

以下为译文：

作为一名C#开发人员，我坦白虽然我很喜欢C#，喜欢它的强类型、编译器、泛型、LINQ等等，但有时我也会嫉妒PHP和Python开发人员。Python和PHP在本质上更为动态，而且还可以实现C#几乎不可能完成的任务。大约在一年前，我的一位朋友向我展示了Django，我羞愧地承认.NET没有类似的功能。因此，我决定通过自己的努力创造奇迹，于是我创建了Magic。

CRUD、HTTP和SQL

在软件开发人员眼中，很多问题都可以归结为将JSON从客户端传输到后端。这个问题是如此普遍，所以我们总结出了一个缩写CRUD：创建（Create）、读取（Read）、更新（Update）和删除（Delete）。HTTP请求的类型有post、put、delete和get。SQL拥有insert、update、delete和select。可以说，所有这些操作都基于相同的概念，即CRUD。

因此，很显然我们应该可以利用这些共同点，从一个给定的数据库自动化构建系统。为什么我们需要自己写代码？为什么计算机无法自动为我们生成这些代码呢？

Magic

我创建的Magic能够从数据库架构中读取元信息，并利用这些信息来创建HTTP REST端点的脚手架代码，并对数据库中的每个CRUD操作提供封装。我们的目的是在控制器端点和数据库之间建立一层薄薄的“ Hyperlambda”，你只需轻轻点击一个按钮，就可以创建和公开数据库上所有的CRUD操作。

Hyperlambda是一种动态编程语言，也是一种DSL，它不需要编译，但是它能够快速处理这些类型的操作，因为每个Hyperlambda关键字只不过是C#中的类的封装。

因此，我们很容易创建Hyperlambda“关键字”，并通过这些关键字对客户端进行身份验证和授权、将记录插入到我们的数据库中、读取记录等，所有的操作只需几行代码即可实现。它的语法非常容易理解，而且计算机也很容易理解，这样用户可以通过对关键字的排列来创建代码的脚手架。

演示过程：https://youtu.be/ncH4QRpKvx0

在这段视频中，Magic首先会读取数据库中每个表的数据库架构。然后，创建四个Hyperlambda文件，每个CRUD操作一个文件。这些Hyperlambda文件的路径取决于数据库对象的名称，因此，假设数据库名为“ foo”，表名为“ bar”，那么HTTP GET的路径为“/files/magic/foo/bar.get.hl”，指向包含Hyperlambda文件的磁盘物理路径。

接下来，我通过一个动态路由控制器接受“/magic”下面的“任何” URL。该路由负责解析我的Hyperlambda文件，并根据给出的URL，执行相应的HTTP动词。

那么，现在我可以在运行时自动创建Hyperlambda代码了，这些代码可以封装现有的数据库，却不会中断应用程序的正常使用。此外，我还通过一个路由机制将HTTP请求动态路由到服务器中的文件和文件夹（之前创建的文件）。

对于小规模的简单应用程序来说，整个后端的Web API就这么多，下一步你可以立即开始创建Angular或React的前端了。而复杂的应用程序可能需要上面没有提供的其他功能，但是至少你的后端已有了基本的雏形，接下来你可以随意编写C#代码和.Net控制器。

Magic基本上就相当于“面向.Net Core和C# 的Django”。即使你的应用根本不需要CRUD，但如果你使用MySQL或微软的SQL Server，它仍然可以作为一个出色数据库管理系统，帮助你在生产和开发环境中管理数据库。从这个角度来说，它相当于“面向.Net Core的PHPMyAdmin”。

功能简介

Magic可以自动处理身份验证和授权。例如，可以为每个HTTP端点分配一个“角色”列表（以逗号分隔），客户端必须经过身份验证才能执行端点的代码。这个实现采用了JWT令牌，它会在调用“身份验证” HTTP端点时生成并返回给客户端。

由于Magic本身可以兼容所有的数据库，因此仍需要在这些方面进行一些手工操作。但实际上只是复制/粘贴的工作，你可以根据需要在生产中进行。顺便说一句，有人可能对密码存储感兴趣，我在这里说明一下：密码的存储采用了BlowFish散列（“慢散列”），还支持独立的加盐算法。

你还可以通过Magic通知脚手架代码的生成过程，要求将各个端点上的HTTP请求写入日志。默认情况下，Magic使用log4net，但你可以创建自己的日志接口并替换，然后通过依赖注入提供给Magic。实际上，Magic中的所有内容都是基于IoC和依赖注入的。

另外，你可以声明希望它提供支持的CRUD操作。例如，某些数据库表可能是“只读”，在这种情况下你根本不需要删除或更新端点。你只需修改生成脚手架代码过程中的一个简单的复选框。

Magic超级快。首先，每个Hyperlambda文件的大小都很小——大约只有10-20行代码。因此，与执行和处理针对某些数据库的SQL命令的昂贵过程相比，解析和评估Hyperlambda文件几乎没有成本。

因此，这种“微小的Hyperlambda层”几乎没有额外的成本。此外，Hyperlambda的评估过程也已经优化到了极致。Hyperlambda本质上是百分百“异步”，这意味着它在评估Hyperlambda文件时也会使用C#和CLR的异步功能。因此，可以带来巨大的“吞吐量”，并提供了可扩展性功能，以方便应用到任何“纯” C#或.NET的应用程序中。如果你问我的看法，那么我会告诉你一行代码都不用写，难道不够伟大吗？

通过你自己的关键字扩展Hyperlambda就像创建一个简单的C#类一样容易。下面是一个真实的示例，我使用了自己的一个关键字[strings.starts-with]，如果某个字符串以其他字符串开头则返回true。

namespace magic.lambda.strings
{
    [Slot(Name = "strings.starts-with")]
    public class StartsWith : ISlot
    {
        public void Signal(ISignaler signaler, Node input)
        {
            // Sanity checking.
            if (input.Children.Count() != 1)
                throw new ApplicationException("[strings.starts-with] must be given exactly one argument that contains value to look for");
            signaler.Signal("eval", input);
            input.Value = input.GetEx<string>()
                .StartsWith(input.Children.First().GetEx<string>(), StringComparison.InvariantCulture);
        }
    }
}

创建自己的关键字就像向类添加属性和接口一样简单，而且你还有一个新的“ Hyperlambda关键字”。这个功能为编程语言提供了一些极端的“DSL功能”。由此产生的Hyperlambda更方便人类的阅读和理解。

然而，你无需了解Hyperlambda即可使用Magic，因为你的计算机明白如何创建和维护Hyperlambda。因此，Hyperlambda与Magic的关系就相当于CLR代码与C#。

如下示例演示了一个Hyperlambda HTTP端点。请注意，由于Hyperlambda是我自己创建的，因此在DZone甚至在Visual Studio Code中都没有办法高亮显示Hyperlambda，据我所知，Hyperlambda在全球范围内只有不到5个用户。

但是，我有一个基于JavaScript的Hyperlambda编辑器，它是Magic不可或缺的部分，它可以在你的代码中高亮显示Hyperlambda语法，而且也可以自动补齐。

/*
 * Declaration of arguments the endpoint can accept.
 */
.arguments
   limit:long
   offset:long
   order:string
   direction:string
   id:long
   name:string

/*
 * Appending arguments in [slots.signal] below.
 */
add:x:./*/slots.signal/*/args
   get-nodes:x:@.arguments/*

/*
 * Invoking [slots.signal] with "magic.db.mysql.read".
 */
slots.signal:magic.db.mysql.read
   database:magic_auth
   table:roles
   args
   columns
      id
      name

/*
 * Returning the results to caller.
 * This will transform the result to JSON,
 * and return to the client as the HTTP response.
 */
slots.return-nodes:x:@slots.signal/*

注意：Magic是一个全新的项目，可能包含一些bug。它还未能在GitHub上赢得一百万颗星，而且据我所知，目前没有任何纳斯达克上市公司在使用它。因此，如果你想对其进行评估，请耐心等待。我会全力以赴提高代码的质量，并且修改所有发现的bug。将来我会持续维护该项目，但有时可能会出现一些测试版中常见的问题。

你可以通过我的GitHub代码库（https://github.com/polterguy/magic）汇报bug或请求功能。即便你没有可以汇报的bug，我也希望你对该项目提出建议或给予鼓励。

总结

总的来说，Magic可以减轻你一半的工作量，让计算机来承担无聊的工作，而你则可以专注于有趣的工作。这不正是我们发明计算机的初衷吗？希望你能找到Magic带来的快乐。

有关Magic的详细信息如下：