Apex 示例

简介

Apex 示例是一个简洁、有意义的代码示例库，用于常见用例并采用最佳实践。这些示例反映了可用于实际解决方案的企业模式，适用于各个技能水平的开发人员。代码旨在在保持简洁的同时体现清晰性。有关安装选项，请参阅目录。我们建议使用 Salesforce CLI 和临时环境进行初始部署。

<div> <img src="https://yellow-cdn.veclightyear.com/0a4dffa0/96f2f97c-afb1-4cd8-ab50-1f5661ff4db5.png" align="left" alt="Trailhead 徽章" height="40px" width="40px"/> <p>通过完成 <a href="https://trailhead.salesforce.com/content/learn/projects/quick-start-explore-the-apex-recipes-sample-app">快速入门：探索 Apex 示例样例应用</a> Trailhead 项目或观看这个<a href="https://www.youtube.com/watch?v=Fd0m1Cyaq4Q&list=PLgIMQe2PKPSJcuCwM61dEc4jFG_jHqV2t&index=5">简短演示视频</a>来了解更多关于此应用的信息。</p> </div>

使用临时环境安装 Apex 示例：这是推荐的安装选项。如果你是想体验应用和代码的开发人员，请使用此选项。
使用未锁定包安装 Apex 示例：此选项允许任何人在不安装本地开发环境的情况下体验样例应用。
使用开发者版组织或 Trailhead Playground 通过 Salesforce CLI 安装 Apex 示例：在完成 Trailhead 徽章任务时很有用，或者如果你想将应用部署到比临时环境更持久的环境中。
可选安装说明

使用临时环境安装应用

设置你的环境。按照快速入门：Lightning Web 组件 Trailhead 项目中的步骤操作。这些步骤包括：
- 在你的 Trailhead Playground 中启用开发者中心
- 安装 Salesforce CLI
- 安装 Visual Studio Code
- 安装 Visual Studio Code Salesforce 扩展
如果你还没有这样做，请授权你的中心组织并为其提供别名（下面命令中的 myhuborg）：
```
sf org login web -d -a myhuborg
```

克隆 apex-recipes 仓库：

git clone https://github.com/trailheadapps/apex-recipes
cd apex-recipes

创建一个临时环境并为其提供别名（下面命令中的 apex-recipes）：
```
sf org create scratch -d -f config/project-scratch-def.json -a apex-recipes
```
将应用推送到你的临时环境：
```
sf project deploy start
```
将 Apex_Recipes 权限集分配给默认用户：
```
sf org assign permset -n Apex_Recipes
```
将 Walkthroughs 权限集分配给默认用户：
```
sf org assign permset -n Walkthroughs
```

导入示例数据

sf data tree import -p ./data/data-plan.json
sf data tree import -p ./data/data-plan2.json

执行匿名 Apex 设置脚本
```
sf apex run --file data/setup.apex
```
打开临时环境：
```
sf org open
```
在应用程序启动器中，选择 Apex Recipes 应用。

使用未锁定包安装应用

如果你想将应用部署到比临时环境更持久的环境中，或者不想安装本地开发工具，请按照这组说明操作。你可以使用非源代码跟踪的组织，如免费的开发者版组织或 Trailhead Playground。

确保从全新环境开始，以避免与你之前可能完成的工作产生冲突。

登录你的组织
转到设置，在平台缓存下，点击"请求试用容量"按钮。请求平台缓存试用
点击此链接在你的组织中安装 Apex Recipes 未锁定包。
选择为所有用户安装
安装完成后：
（可选）添加额外的数据示例。在数据文件夹中有可以通过 dataloader.io 或导入数据向导使用的示例 CSV 文件。
（可选）加载示例连接对象数据：
- 点击设置齿轮图标
- 点击开发者控制台
- 点击调试
- 点击打开执行匿名窗口
- 输入：DataFactoryForPackageInstalls.generateData();
- 点击执行
将 Apex Recipes 权限集添加到你的用户：
- 转到设置 > 用户 > 权限集。
- 点击 Apex_Recipes。
- 点击管理分配。
- 选中你的用户并点击添加分配。
在应用程序启动器中，选择 Apex Recipes 应用。
- 如果应用未加载，请再次检查 Apex Recipes 权限集是否在你的用户上处于活动状态。

使用开发者版组织或 Trailhead Playground 通过 Salesforce CLI 安装应用

如果你想将应用部署到比临时环境更持久的环境中，请按照这组说明操作。这包括非源代码跟踪的组织，如免费开发者版组织或 Trailhead Playground。

确保从全新环境开始，以避免与你之前可能完成的工作产生冲突。

克隆此仓库：

git clone https://github.com/trailheadapps/apex-recipes
cd apex-recipes

授权你的 Trailhead Playground 或开发者版组织，并为其提供别名（下面命令中的 mydevorg）：
```
sf org login web -s -a mydevorg
```
如果你正在设置开发者版：转到设置，在平台缓存下，点击"请求试用容量"按钮。请求平台缓存试用
在终端中运行此命令以部署应用。
```
sf project deploy start -d force-app
```
将 Apex_Recipes 权限集分配给默认用户。
```
sf org assign permset -n Apex_Recipes
```
导入示例数据

sf data tree import -p ./data/data-plan.json
sf data tree import -p ./data/data-plan2.json

执行匿名Apex设置脚本
```
sf apex run --file data/setup.apex
```
如果你的组织尚未打开，现在打开它：
```
sf org open -o mydevorg
```
在应用程序启动器中，选择 Apex Recipes 应用程序。
- 如果应用程序无法加载，请再次确认 Apex Recipes 权限集已在你的用户上激活。

可选安装说明

如果你想将现代Web开发工具集成到你的Salesforce开发流程中，或者集成到你的持续集成/持续部署流程中，本仓库包含几个相关文件。

代码格式化

Prettier 是一个用于确保代码库中一致格式的代码格式化工具。要在Visual Studio Code中使用Prettier，请从Visual Studio Code市场安装此扩展。本仓库提供了 .prettierignore 和 .prettierrc 文件来控制Prettier格式化器的行为。

警告当前的Apex Prettier插件版本要求你安装Java 11或更高版本。

代码检查

ESLint 是一个流行的JavaScript代码检查工具，用于识别风格错误和错误构造。要在Visual Studio Code中使用ESLint，请从Visual Studio Code市场安装此扩展。本仓库提供了 .eslintignore 文件，用于在Lightning Web Components开发环境中排除特定文件的检查过程。

Apex文档

ApexDocs 是一个用于从本仓库的类生成Markdown (.md) 文件的NPM包。本仓库的package.json文件包含了一个用于生成这些Apex文档的npm脚本。执行 npm run apexdocs 生成最新文档。这些文档作为静态资源的一部分提供，可以通过Apex Recipes应用程序在你的组织中访问。导航到任何类并点击其对应的文档标签。