创建 CAP 项目

Objective

After completing this lesson, you will be able to 生成 SAP Cloud Application Programming Model 项目

使用 SAP Business Application Studio

开发空间和项目向导

如前所述,我们希望使用 SAP Business Application Studio (BAS) 作为开发环境,为 Node.js 运行时创建 CAP 应用程序。BAS 提供了开发所需的所有功能开箱即用的优势。例如,Node.js 以及 CAP 的 CDS 开发工具包已安装,可以使用。

观看视频,了解如何创建开发空间并生成 CAP 项目以使用 BAS 开发应用程序。

命令行接口

也可以使用 npm 包 @sap/cds-dk 创建 CAP 项目。此包包含 CAP 的命令行客户端和开发工具包。

@sap/cds-dk 在 BAS 中开箱即用。可在 BAS 的终端中直接输入相应的命令。要打开新终端,请从 BAS 左上角的汉堡菜单中选择 终端新终端

@sap/cds-dk 为 CAP 开发的各个阶段提供命令,从初始化新项目到将其部署到云。使用 cds help 获取所有命令的概述。使用 cds <helpcommand>cds <命令以获取特定帮助。使用 cds init,可以生成新的 CAP 项目。

配置中的惯例

最低配置

CAP 具有许多需要在其他框架中配置的内容的缺省设置。其目标是让一切尽可能无配置地发挥作用。如果需要,您可以使用特定配置覆盖这些缺省设置。例如,您可以覆盖 package.json 文件中上述文件夹的缺省名称,如下所示:

JSON
123456789
{ ... "cds": { "folders": { "db": "database/", "srv": "services/", "app": "uis/" } } }

注意

我们建议您遵循 CAP 的约定,从立即可用的事务中受益。仅在确实需要时才添加配置或覆盖缺省值。

提示

您可以使用 cds env 命令显示终端中特定密钥或整个当前环境的有效配置。例如,如果在终端中执行 cds env 文件夹,则在未覆盖缺省文件夹名称的情况下将获得以下输出:
JSON
1
{ db: 'db/', srv: 'srv/', app: 'app/' }

本地测试

在终端中执行 cds watch 命令时,将在观察模式下启动 http 服务器。因此,您的项目在本地进行编译和提供。这意味着可以使用提供的服务器从 BAS(或 VS 代码)访问和测试基于 CAP 的应用程序(请参阅"启动 HTTP 服务器"图)。

cds watch 中的"watch"表示 命令持续监控项目的文件是否发生更改。在源文件中检测到更改后,服务器会自动重新启动以反映这些更改。无需在更改后手动停止并重新启动服务器。

服务器在观察模式下运行时,会将日志输出到控制台。这些日志有助于检测问题、了解请求流并解决错误。

注意

实际上,cds watch 只是以下内容的便捷快捷方式:
Code Snippet
1
cds serve all --with-mocks --in-memory?

运行 CDS 服务?以获取有关 cds serve 和可用选项的详细信息。

--内存?选项自动添加临时内存数据库,该数据库将在每个(重新)启动时根据 package.json 中的默认设置或配置进行引导。添加的问号应用更防御的变式,该变式尊重配置的数据库(如果有),并且仅在未配置持久数据库的情况下添加内存数据库。

cds watch 运行时,您可以在浏览器中打开 http://localhost:4004 以查看通用 index.html 页面。此页面主要用于开发和测试目的。在生产场景中,通常不会将其公开或替换为适当的用户界面。

页面提供所有公开服务端点的列表。这使开发人员和测试人员可以直接访问它们。

对于每个 OData 服务,还存在指向其 $metadata 文档的链接。单击将显示服务的元数据,该元数据以 XML 格式描述服务的实体集、类型和其他详细信息。

对于 Node.js 应用程序,每个公开的实体集的 index.html 页面上也有 Fiori 预览链接。此类链接动态提供基于相应实体集的 SAP Fiori 元素列表页面。请注意,这不适用于生产。不应替换适当的 SAP Fiori 元素应用程序。

提示

要终止服务器进程,请在运行应用程序的终端中按 Ctrl+C

演示和练习:创建 Hello World 应用程序

注意

在练习中,在 SAP Business Application Studio 中自行执行以下演示中的分步说明。

您可以从以下 GitHub 资源库的分支 1_hello_world 中的模拟中找到源代码:

https://github.com/SAP-samples/cap-development-learning-journey

有关此资源库内容及其使用方法的详细信息,可在此处找到。

观看视频,了解如何创建 Hello World 应用程序。

现在,我们已了解如何在开发空间中创建 CAP 项目以及如何本地测试 CAP 应用程序,让我们浏览基本 CAP 功能。