精通 Salesforce Platform Events：开发人员的实时集成指南

身份：Salesforce 开发人员

背景与应用场景

在现代企业架构中，系统之间的实时通信与解耦变得至关重要。传统的点对点集成（Point-to-Point Integration）模式往往会导致系统间紧密耦合，形成所谓的“意大利面条式架构”，难以维护和扩展。为了解决这一挑战，Event-Driven Architecture (事件驱动架构) 应运而生。它采用发布/订阅（Publish/Subscribe）模型，允许系统以异步、松耦合的方式进行通信。

Salesforce 提供了强大的原生事件驱动解决方案——Platform Events (平台事件)。Platform Events 是一种安全且可扩展的消息传递机制，允许您在 Salesforce 内部或 Salesforce 与外部系统之间传递实时的事件通知。作为一名 Salesforce 开发人员，掌握 Platform Events 是构建响应迅速、可扩展且健壮的应用程序的关键技能。

常见的应用场景包括：

系统解耦 (System Decoupling)：当订单系统创建一个新订单时，它可以发布一个 “Order Created” 事件。库存、发货和财务等多个下游系统可以独立订阅此事件并执行各自的业务逻辑，而无需订单系统直接调用它们。

实时用户界面更新 (Real-Time UI Updates)

外部系统集成 (External System Integration)

突破 Governor Limits

原理说明

要理解 Platform Events，我们需要了解其核心的发布/订阅模型和关键组件：

1. 事件定义 (Event Definition)

Platform Event 的定义类似于一个自定义对象 (Custom Object)，但其 API 名称以 __e 结尾。您可以在 Salesforce Setup 界面中声明式地创建 Platform Event，并为其定义字段（支持文本、数字、日期、复选框等基本数据类型）。这个定义就是事件的“契约”或“模式” (Schema)，规定了事件消息包含哪些数据。

2. 事件发布者 (Event Publisher)

发布者是创建并发送事件消息的源头。在 Salesforce 平台中，您可以通过多种方式发布 Platform Events：

Apex

EventBus.publish()

Flows (流程)

Process Builder (流程构建器)

Salesforce APIs

3. 事件总线 (Event Bus)

事件总线是 Salesforce 平台内部的一个多租户、高可用的消息传递通道。所有发布的事件消息都会被发送到事件总线。它负责临时存储事件消息，并将它们分发给所有活跃的订阅者。事件总线保证了消息的持久性和可靠性。

4. 事件消费者 (Event Consumer / Subscriber)

消费者或订阅者是监听并响应特定事件的应用程序或进程。它们订阅了事件总线上的特定事件类型，一旦有新事件发布，总线就会将消息推送给它们。

主要的订阅方式包括：

Apex Trigger

after insert

Lightning Components (LWC/Aura)

lightning/empApi

Flows (流程)

外部客户端

5. ReplayId

每个发布的事件都会被分配一个唯一的、不透明的 ReplayId。订阅者可以存储最后处理的 ReplayId，以便在断开连接后重新订阅时，能够从上次中断的位置继续接收错过的事件。事件默认在事件总线上保留 24 小时（对于 High-Volume Platform Events 可达 72 小时）。

示例代码

以下代码示例均来自 Salesforce 官方文档，展示了如何定义、发布和订阅一个名为 Cloud_News__e 的 Platform Event。

第一步：定义 Platform Event

首先，在 Salesforce Setup 中创建一个名为 "Cloud News" 的 Platform Event，API 名称为 Cloud_News__e。为其添加两个自定义字段：

Location__c

Urgent__c

第二步：使用 Apex 发布 Platform Event

下面的 Apex 代码创建了多个 Cloud_News__e 事件实例，并通过 EventBus.publish() 方法一次性发布它们。

// Create a list of events to publish
List<Cloud_News__e> newsEvents = new List<Cloud_News__e>();
newsEvents.add(new Cloud_News__e(Location__c='SF', Urgent__c=true));
newsEvents.add(new Cloud_News__e(Location__c='NY', Urgent__c=false));

// Call EventBus.publish to publish the events
List<Database.SaveResult> results = EventBus.publish(newsEvents);

// Inspect publishing results
for (Database.SaveResult sr : results) {
    if (sr.isSuccess()) {
        System.debug('Successfully published event with ID: ' + sr.getId());
    } else {
        for(Database.Error err : sr.getErrors()) {
            System.debug('Error returned: ' +
                        err.getStatusCode() +
                        ' - ' +
                        err.getMessage());
        }
    }
}

代码注释：

第 2-4 行:

Cloud_News__e

第 7 行:

EventBus.publish()

第 10-18 行:

Database.SaveResult

第三步：使用 Apex Trigger 订阅事件

创建一个 Apex 触发器来监听新发布的 Cloud_News__e 事件。注意，Platform Event 触发器总是 after insert 类型。

trigger CloudNewsTrigger on Cloud_News__e (after insert) {
    // List to hold cases to be created
    List<Case> cases = new List<Case>();

    // Iterate through the list of events
    for (Cloud_News__e event : Trigger.New) {
        System.debug('Received cloud news event: ' + event);

        // Create a case for each urgent event
        if (event.Urgent__c == true) {
            Case cs = new Case();
            cs.Subject = 'Urgent news from ' + event.Location__c;
            cs.Priority = 'High';
            cs.Status = 'New';
            cases.add(cs);
        }
    }

    // Insert all cases in a single DML operation
    if (!cases.isEmpty()) {
        insert cases;
    }
}

代码注释：

第 1 行:

Cloud_News__e

after insert

第 5 行:

Trigger.New

第 8-15 行:

Urgent__c

第 19-21 行:

第四步：使用 LWC 订阅事件

在前端，我们可以使用 lightning/empApi 模块来实时接收事件通知。

HTML: (newsSubscriber.html)

<template>
    <lightning-card title="Real-Time Cloud News" icon-name="custom:custom14">
        <div class="slds-m-around_medium">
            <p>Waiting for news...</p>
            <p><b>Latest News:</b> {latestNews}</p>
        </div>
    </lightning-card>
</template>

JavaScript: (newsSubscriber.js)

import { LightningElement, track } from 'lwc';
import { subscribe, unsubscribe, onError, isEmpEnabled } from 'lightning/empApi';

export default class NewsSubscriber extends LightningElement {
    channelName = '/event/Cloud_News__e';
    isSubscribed = false;
    subscription = {};

    @track latestNews = 'No news yet';

    // Initializes the component
    connectedCallback() {
        // Register error listener
        this.registerErrorListener();
        // Call subscribe method
        this.handleSubscribe();
    }

    disconnectedCallback() {
        // Unsubscribe from the channel
        this.handleUnsubscribe();
    }

    handleSubscribe() {
        // Callback function that is invoked when a new event is received
        const messageCallback = (response) => {
            console.log('New message received: ', JSON.stringify(response));
            // Extract payload
            const location = response.data.payload.Location__c;
            const urgent = response.data.payload.Urgent__c;
            this.latestNews = `Location: ${location}, Urgent: ${urgent}`;
        };

        // Invoke subscribe method of empApi
        subscribe(this.channelName, -1, messageCallback).then(response => {
            // Response contains the subscription information on successful subscribe
            console.log('Successfully subscribed to : ', JSON.stringify(response.channel));
            this.subscription = response;
        });
    }

    handleUnsubscribe() {
        // Invoke unsubscribe method of empApi
        unsubscribe(this.subscription, response => {
            console.log('unsubscribe() response: ', JSON.stringify(response));
        });
    }

    registerErrorListener() {
        onError(error => {
            console.log('Received error from server: ', JSON.stringify(error));
        });
    }
}

代码注释：

第 2 行:

lightning/empApi

第 6 行:

/event/API_NAME__e

第 13 行:

第 18 行:

第 22-30 行:

messageCallback

第 33-37 行:

subscribe()

-1

注意事项

作为开发者，在使用 Platform Events 时必须考虑以下几点：

权限 (Permissions)

Governor Limits

发布限制

订阅者限制

事务边界 (Transaction Boundaries)

错误处理 (Error Handling)

发布时

EventBus.publish()

Database.SaveResult

订阅时

try-catch

无保证的订阅者执行顺序 (No Guaranteed Order)

总结与最佳实践

Platform Events 是 Salesforce 平台上实现事件驱动架构的基石。它为开发人员提供了一个强大、可扩展且可靠的工具，用于构建解耦的、实时的应用程序。

最佳实践：

设计精简的事件负载 (Lean Event Payload): 只在事件消息中包含必要的标识符和关键信息，而不是整个 SObject 记录。订阅者可以根据需要使用 ID 查询更多信息。这可以减少事件大小并提高性能。
定义清晰的事件契约 (Clear Event Contract): 仔细设计您的事件字段，并提供清晰的文档。事件一旦被多个系统使用，修改其结构将变得非常困难。
为失败做好准备 (Design for Failure): 订阅者逻辑可能会失败。确保您的订阅者是幂等的（即多次处理同一个事件不会产生副作用），并考虑实现一个健壮的错误处理和重试策略。
选择正确的事件类型 (Choose the Right Event Type): 对于内部流程或低流量场景，Standard-Volume Events 足够。对于需要与外部系统进行大规模集成的场景，或者需要绕过同步事务限制时，应优先选择 High-Volume Events。
利用 ReplayId 实现持久订阅: 对于需要保证消息处理的外部系统，利用 ReplayId 机制来构建一个可以从中断处恢复的健壮客户端。

通过遵循这些原则和实践，您可以充分利用 Salesforce Platform Events 的强大功能，构建出能够适应未来业务变化的现代化应用程序。

Salesforce Einstein AI 编程实践：开发者视角下的智能预测

九月 15, 2025

阅读全文

Salesforce中文网