Salesforce Aura 项目教程

1. 项目目录结构及介绍

Salesforce Aura 项目的目录结构如下：

aura/
├── aura.js
├── components/
│   ├── component1/
│   │   ├── component1.cmp
│   │   ├── component1Controller.js
│   │   ├── component1Helper.js
│   │   └── component1Renderer.js
│   └── component2/
│       ├── component2.cmp
│       ├── component2Controller.js
│       ├── component2Helper.js
│       └── component2Renderer.js
├── config/
│   ├── project-scratch-def.json
│   └── sfdx-project.json
├── force-app/
│   ├── main/
│   │   └── default/
│   │       ├── aura/
│   │       └── classes/
├── package.json
└── README.md

目录结构介绍

• aura.js: 项目的入口文件，包含了项目的基本配置和初始化代码。
• components/: 存放所有 Aura 组件的目录。每个组件通常包含以下文件：
  • componentName.cmp: 组件的标记文件，定义了组件的结构和样式。
  • componentNameController.js: 组件的控制器文件，处理组件的业务逻辑。
  • componentNameHelper.js: 组件的辅助函数文件，用于封装常用的功能。
  • componentNameRenderer.js: 组件的渲染器文件，处理组件的渲染逻辑。
• config/: 存放项目的配置文件。
  • project-scratch-def.json: 定义了 Scratch Org 的配置。
  • sfdx-project.json: Salesforce DX 项目的配置文件。
• force-app/: 存放 Salesforce DX 项目的源代码。
  • main/default/aura/: 存放 Aura 组件的源代码。
  • main/default/classes/: 存放 Apex 类的源代码。
• package.json: 项目的依赖管理文件，定义了项目所需的 npm 包。
• README.md: 项目的说明文档，包含了项目的介绍、安装和使用说明。

2. 项目的启动文件介绍

项目的启动文件是 aura.js，它包含了项目的基本配置和初始化代码。以下是 aura.js 的主要内容：

// aura.js

// 导入必要的模块
import { LightningElement } from 'lwc';

// 定义主组件
export default class App extends LightningElement {
    // 初始化方法
    connectedCallback() {
        console.log('App initialized');
    }
}

启动文件介绍

• 导入模块: 使用 import 语句导入项目所需的模块，例如 LightningElement。
• 定义主组件: 定义项目的主组件 App，继承自 LightningElement。
• 初始化方法: 在 connectedCallback 方法中进行组件的初始化操作，例如输出日志。

3. 项目的配置文件介绍

项目的配置文件主要存放在 config/ 目录下，包括 project-scratch-def.json 和 sfdx-project.json。

project-scratch-def.json

project-scratch-def.json 文件定义了 Scratch Org 的配置，例如 Salesforce 版本、语言、权限集等。

{
    "orgName": "Demo Company",
    "edition": "Developer",
    "features": ["Communities", "ServiceCloud"],
    "settings": {
        "lightningExperienceSettings": {
            "enableS1DesktopEnabled": true
        },
        "mobileSettings": {
            "enableS1EncryptedStoragePref2": false
        }
    }
}

sfdx-project.json

sfdx-project.json 文件是 Salesforce DX 项目的配置文件，定义了项目的元数据、包依赖等信息。

{
    "packageDirectories": [
        {
            "path": "force-app",
            "default": true
        }
    ],
    "namespace": "",
    "sfdcLoginUrl": "https://login.salesforce.com",
    "sourceApiVersion": "52.0"
}

配置文件介绍

• project-scratch-def.json: 定义了 Scratch Org 的配置，包括组织名称、版本、功能和设置。
• sfdx-project.json: 定义了 Salesforce DX 项目的配置，包括包目录、命名空间、登录 URL 和 API 版本。

通过这些配置文件，可以方便地管理和部署 Salesforce Aura 项目。