Asp.Net创建控制台程序和WebAPI

Asp.Net创建控制台程序和WebAPI

2024-12-25 11:15

1. 控制台程序

我们将使用一个控制台应用程序，用于整合各种中间件，也是一样的方式。

数据库链接地址和账户密码登不能直接写到代码里面，所以需要添加读取配置文件的支持。

在编辑器中，选择文件以打开它。

将以下配置块添加到元素下方的根元素中。此配置将在项目中包含新文件，并将其复制到输出文件夹。此块中的指令可以确保在应用时将应用配置文件放在输出目录中。

现已添加用于启用读取配置所需的库，我们需要在控制台应用程序中启用该功能。在编辑器中，选择，将文件的内容替换为以下代码。

① 连接

添加对缓存客户端的支持。

接下来，将控制台应用程序配置为使用适用于的客户端。

② 连接

③ 连接

2.

本模块使用。通过在首选命令终端中运行以下命令，确保你已安装：

将显示类似于以下示例的输出：

确保列出了以开头的版本。如果未列出任何版本或未找到命令，请。

① 创建并浏览项目

默认使用保护项目，包含开发证书。该证书是作为首次运行体验的一部分安装的。

例如：会生成以下输出的变体：

安装会将开发证书安装到本地用户证书存储。该证书已安装，但它不受信任。若要信任该证书，请执行一次性步骤，以运行工具：

下面的命令提供有关工具的帮助：

② 执行运行项目。

上述命令：

在当前目录中找到项目文件。
检索并安装此项目所需的任何项目依赖项。
编译项目代码。
使用服务器将托管在和终结点中。

创建项目时，将为选择到端口，为选择到端口。通过编辑项目的文件，可以轻松更改开发过程中使用的端口。本模块使用以开头的安全 URL。

应获得类似于以下内容的输出，用于指示应用正在运行：

如果你是在自己的计算机上运行此应用，可以将浏览器指向输出中显示的链接（在上例中为）以查看生成的页面。请记住此端口，因为在使用的整个模块中将一直使用它。

③ 打开 Web 浏览器并转到：

应会看到类似于这个示例的输出：

④ 使用文件进行测试接口

项目中包含的文件为，该文件用于通过标准格式测试终结点。多个都支持文件，包括以及安装了客户端扩展的内部。

打开文件。

此文件已预配置了变量和调用的 GET 命令，该命令接受。
选择上方的命令，该命令会将请求发送到正在运行的服务。

调用此命令将打开一个响应窗口，其输出与我们在浏览器中看到的以下内容类似：
你创建了一个应用程序，用于提供示例天气预报数据，然后，你使用了与该应用程序交互。

示例方案

假设你是一家名为的披萨公司的员工。经理要求你为披萨库存管理开发一个服务，作为公司店面和移动应用程序的必备组件。该服务必须支持添加、查看、修改和删除披萨类型；谓词的标准化使用方式，也称为创建、读取、更新、删除 ()。

在深入探讨如何编写自己的类之前，让我们先看一下示例中的代码，了解它的工作原理。在本单元中，你将了解如何在几十行代码中使用基类和几个属性来生成正常工作的。了解这些概念后，便可以编写自己的类了。

以下是整个类的代码。如果你还不明白，请不要担心。现在来逐步完成这一过程。
控制器是一个公共类，具有一个或多个称为的公共方法。按照惯例，控制器放在项目根目录的目录中。操作通过路由被公开为终结点。因此，对的 HTTP 请求将执行类的方法。

首先要注意的是，此类继承自基类。这个基类提供了许多用于处理请求的标准功能，让你可以专注于应用程序的特定业务逻辑。

如果你在中开发过或模型-视图-控制器体系结构，那么你已使用过类。不要通过从类派生来创建控制器。派生自，并添加了对视图的支持，因此它用于处理网页，而不是请求。

有两个重要属性应用到了，如以下代码所示：
启用固定行为，使生成更加容易。一些行为包括参数源推理、将属性路由作为一项要求以及模型验证错误处理增强功能。

定义路由模式。令牌替换为用控制器的名称（不区分大小写，无后缀）。此控制器处理对的请求。

路由可能包含静态字符串，如中所示。在此示例中，此控制器将处理对的请求。

包括由属性指定的单个控制器操作。此属性将请求路由到方法。如你所见，在上一个练习中，向发出请求会导致返回天气预报结果。

本模块的后面部分会介绍其他常见操作与执行操作（、、、）的相关联。但控制器只需要实现一个控制器操作。

在本例中，你将获取返回的的完整列表。操作还允许通过传递标识符来检索单个项。在中，可以使用特性检索单个项。在下一练习中将实现该属性。

⑤ 现在，你已了解了控制器的基本组件，现在可以创建自己的类了。

在开始为披萨实现之前，需要添加一个数据存储供你执行操作。

你需要一个类来表示库存中的披萨。模型包含用于表示披萨特征的属性。模型用于在中传递数据，以及在数据存储中保存披萨选项。

在本单元中，该数据存储是一个简单的本地内存中缓存服务。在实际应用程序中，可以考虑将数据库（例如）与结合使用。

1. 创建披萨模型

将以下代码添加到并保存所做的更改。此类定义披萨。

2. 添加数据服务

将以下代码添加到并保存所做的更改。此代码创建内存中披萨数据服务。

默认情况下，此服务提供一个简单的内存中数据缓存服务，其中包含两个披萨。我们的使用该服务进行演示。如果先停止再启动，内存中数据缓存会重置为的构造函数中的两个默认披萨。

⑥ 运行以生成应用：生成成功，且没有任何警告。如果生成失败，请检查输出以获取故障排除信息。

控制器是一个公共类，具有一个或多个称为的公共方法。按照惯例，控制器放在项目根目录的目录中。这些操作在控制器内公开为终结点。

添加控制器

在中选择文件夹，并添加名为的新文件。

如前文所述，此类派生自，后者是中用于处理请求的基类。它还包含你已经了解的两个标准属性，即和。如前文所述，属性定义了到令牌的映射。由于此控制器类名为，因此该控制器处理对的请求。

获取所有披萨

需要实现的第一个谓词是，使用该谓词，客户端可以从获取所有披萨。可使用内置属性来定义从服务返回披萨的方法。

将中的注释替换为以下代码：

上一个操作：

仅响应 HTTP 谓词，如属性所示。
返回类型为的实例。类型是中所有操作结果的基类。
查询服务以获取所有披萨，并通过的值自动返回数据。

3. 检索单种披萨

客户端可能还需要请求获取特定披萨而非整个列表的相关信息。你可以实现另一个操作，此操作需要参数。可使用内置属性来定义从服务返回披萨的方法。路由逻辑将（没有）和（具有）注册为两个不同的路由。然后，你可以编写一个单独的操作来检索单个项。

将中的注释替换为以下代码：

上一个操作：

仅响应 HTTP 谓词，如属性所示。
要求之后的 URL 段中包含参数的值。请记住，控制器级别的属性定义了模式。
查询数据库以获取与所提供的参数匹配的披萨。

上述操作中使用的每个实例都映射到下表中对应的状态代码：

操作结果状态代码说明为隐式200内存中缓存中存在与所提供的参数匹配的产品。该产品包含在由请求标头中所定义的媒体类型（默认情况下为）的响应正文中。404内存中缓存中不存在与所提供的参数匹配的产品。

4. 生成并运行新控制器

运行以下命令，生成并启动：

5. 使用文件测试控制器

打开
添加新的以在 ### 分隔符下调用终结点：

我们的披萨服务支持对披萨列表执行操作。这些操作是通过谓词执行的，它们通过属性进行映射。正如你所了解的，谓词用于从服务检索一个或多个项。此类操作使用属性进行批注。

下表显示了你为披萨服务实现的四个操作的映射：

操作谓词操作属性读取创建Update删除

你已经了解了操作的工作原理。让我们来详细了解一下、和操作。

POST

为了使用户能够将新项添加到终结点，必须通过使用属性来实现操作。将项（在此示例中是披萨）作为参数传递入方法时，会自动将发送到终结点的任何转换为填充的对象。

以下是方法的方法签名，你将在下一节中实现该方法：

属性使用方法映射发送到的 HTTP 请求。此方法并不像我们在方法中看到的那样返回披萨列表，而是返回响应。

可让客户端知道请求是否成功，并提供新创建的披萨的。使用标准状态代码，因此，无论客户端使用哪种语言或者在哪个平台上运行，它都能轻松地与客户端集成。

操作结果状态代码说明201已将披萨添加到内存中缓存。该披萨包含在由请求标头中所定义的媒体类型（默认情况下为）的响应正文中。为隐式400请求正文的对象无效。

幸运的是，具有一些实用工具方法，它们可为你创建适当的响应代码和消息。

PUT

修改或更新库存中的披萨类似于我们实现的方法，但它使用属性并接受参数以及需要更新的对象：

上述操作中使用的每个实例都映射到下表中对应的状态代码：

展开表

操作结果状态代码说明204已在内存中缓存中更新了披萨。400请求正文的值与路由的值不匹配。为隐式400请求正文的对象无效。

DELETE

可实现的一种更简单的操作是操作，该操作只接受要从内存中缓存中删除的披萨的参数：

上述操作中使用的每个实例都映射到下表中对应的状态代码：

操作结果状态代码说明204已从内存中缓存中删除了披萨。404内存中缓存中不存在与所提供的参数匹配的披萨。

我们来继续扩展控制器，添加在库存中创建 ()、更新 () 和删除 () 披萨的功能。

添加披萨

让我们使用方法通过添加披萨。

使用以下代码替换中的注释：

上一个操作：

仅响应 HTTP 谓词，如属性所示。
将请求正文的对象插入到内存中缓存。

由于控制器使用属性进行批注，因此意味着将在请求正文中找到参数。

方法调用中的第一个参数表示操作名称。关键字用于避免对操作名称进行硬编码。使用操作名称来生成响应标头，该标头包含新创建的披萨的。

修改披萨

现在，让我们使用方法通过更新披萨。

使用以下代码替换中的注释：

上一个操作：

仅响应 HTTP PUT 谓词，如属性所示。
要求之后的 URL 段中包含参数的值。
返回，因为在运行时之前，返回类型未知。、和方法分别返回、和类型。

由于控制器批注通过属性进行，因此暗示着将在请求正文中找到参数。

删除披萨

最后，让我们使用方法通过 Web API 移除披萨。

使用以下代码替换中的注释：

上一个操作：

仅响应 HTTP 谓词，如属性所示。
要求之后的 URL 段中包含参数的值。
返回，因为在运行时之前，返回类型未知。和方法分别返回和类型。
查询内存中缓存以获取与所提供的参数匹配的披萨。

在继续操作之前，请记得保存文件。

运行以下命令，生成并启动：

最后测试文档如下：