Salesforce DX Falcon Template 教程

Salesforce DX Falcon Template 教程

sfdx-falcon-templateExtended Salesforce DX project directory template, designed to support complex projects and managed packages.项目地址:https://gitcode.com/gh_mirrors/sf/sfdx-falcon-template

欢迎使用Salesforce DX Falcon Template，这是一个专为Salesforce开发者设计的项目模板，旨在加速你的开发流程，通过遵循最佳实践来构建可维护且高质量的应用。本教程将指导你了解该项目的核心结构、启动机制以及配置方法。

1. 项目目录结构及介绍

Falcon模板采用了一种结构化的方式组织项目，以促进团队协作和代码重用。

• force-app
  这是核心应用模块，包含了所有的Metadata Components（如Apex类、对象定义、页面等）。所有与Salesforce实例直接交互的代码和配置都放在这里。

• scripts
  包含了用于自动化任务的脚本，比如部署、测试或自定义的SFDC操作脚本，利用SFDX CLI命令进行定制化的操作。

• src
  在一些旧版本或者特定用途中可能包含源代码，但随着最新的DX实践推荐，大部分源码应直接置于force-app内。

• package.xml
  定义了要从Salesforce组织中获取或要推送至组织的元数据类型列表，是管理元数据的关键文件。

• sfdx-project.json
  描述了项目的元数据，包括名称、API版本和其他Salesforce DX相关的配置信息。

• README.md
  提供项目的基本信息、安装步骤、快速入门指南等，是你开始之前应该阅读的文件。

• .gitignore
  指定了在Git版本控制中应忽略的文件或目录，通常包含编译后的文件或敏感信息文件。

2. 项目的启动文件介绍

主要脚本文件 - scripts

在scripts目录下，可能会有如deploy.sh, test.sh等脚本文件。这些脚本是用于简化常见的开发操作，例如：

• deploy.sh
  自动化部署元数据到Salesforce环境中的脚本，通常使用SFDX CLI命令实现。

• test.sh
  执行单元测试或集成测试的脚本，确保每次部署前代码的质量。

使用这些脚本可以大大提高效率，减少手动执行相同命令的时间。

3. 项目的配置文件介绍

sfdx-project.json

这是Salesforce DX项目的核心配置文件之一，它定义了项目的基础信息和默认的行为设置：

{
    "namespace": "",
    "sourcePath": "force-app",
    "defaultCodeCoverageThreshold": null,
    "packageDirectories": [
        {
            "path": "force-app",
            "default": true,
            "package": "yourPackageName",
            "versionNumber": "1.0.0.NEXT"
        }
    ],
    "name": "Your Project Name",
    "compatibilityLevel": "49.0",
    "sfdcLoginUrl": "https://login.salesforce.com",
    "sourceApiVersion": "49.0"
}

每个字段都有其特定含义，例如sourcePath指明了元数据的主要位置，packageDirectories定义了包结构和信息，而sourceApiVersion则设置了使用的Salesforce API版本。

package.xml

位于根目录下的package.xml是另一个关键的配置文件，用于指定需要处理的元数据类型：

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>*</members>
        <name>ApexClass</name>
    </types>
    <!-- 更多类型定义 -->
    <version>49.0</version>
</Package>

此文件列出了你想要从Salesforce组织拉取或向其推送的所有元数据类型及其成员，对于管理和迁移元数据至关重要。

---

通过理解这些关键的项目组成部分，你将能够更高效地使用Salesforce DX Falcon Template，迅速上手新项目或扩展现有应用。记得随时参考GitHub仓库的最新更新和官方文档，以获得最准确的信息和最佳实践。

sfdx-falcon-templateExtended Salesforce DX project directory template, designed to support complex projects and managed packages.项目地址:https://gitcode.com/gh_mirrors/sf/sfdx-falcon-template