此版本仍在开发中,尚未被视为稳定版本。对于最新的稳定版本,请使用 spring-cloud-bus 4.1.3spring-doc.cn

自定义事件

广播您自己的事件

Bus 可以携带 类型为 的任何事件。默认传输方式为 JSON,反序列化器需要提前知道将使用哪些类型。 要注册新类型,必须将其放入 .RemoteApplicationEventorg.springframework.cloud.bus.eventspring-doc.cn

要自定义事件名称,您可以在自定义类上使用或依赖 默认策略,即使用类的简单名称。@JsonTypeNamespring-doc.cn

生产者和使用者都需要访问类定义。

在自定义包中注册事件

如果您不能或不想将 的分包用于自定义事件,则必须使用注释指定要扫描类型事件的包。包 使用 Include Subpackages 指定。org.springframework.cloud.bus.eventRemoteApplicationEvent@RemoteApplicationEventScan@RemoteApplicationEventScanspring-doc.cn

例如,请考虑以下名为 的自定义事件:MyEventspring-doc.cn

public class MyEvent extends RemoteApplicationEvent {
    ...
}

您可以通过以下方式向 deserializer 注册该事件:spring-doc.cn

@Configuration
@RemoteApplicationEventScan
public class BusConfiguration {
    ...
}

在不指定值的情况下,注册使用的类的包。在此示例中,使用 的软件包注册。@RemoteApplicationEventScancom.acmeBusConfigurationspring-doc.cn

您还可以使用 上的 、 或 属性 显式指定要扫描的包,如 以下示例:valuebasePackagesbasePackageClasses@RemoteApplicationEventScanspring-doc.cn

@Configuration
//@RemoteApplicationEventScan({"com.acme", "foo.bar"})
//@RemoteApplicationEventScan(basePackages = {"com.acme", "foo.bar", "fizz.buzz"})
@RemoteApplicationEventScan(basePackageClasses = BusConfiguration.class)
public class BusConfiguration {
    ...
}

前面的所有示例都是等效的,因为包是通过在 上显式指定包来注册的。@RemoteApplicationEventScancom.acme@RemoteApplicationEventScanspring-doc.cn

您可以指定要扫描的多个基础包。