CAP 3.0 版本发布通告

前言

大家好，我们很高兴宣布 CAP 发布了 3.0 版本正式版。

自从上次 CAP 2.6 版本发布以来，已经过去了几个月的时间，关注的朋友可能知道，在这几个月的时间里，也发布了几个预览版的 3.0 版本的NuGet包。

3.0 是一个主要版本，在这个版本中我们对代码进行了大量重构，重构的目的是为了让代码保持清洁并且逻辑更加清晰易读，并且接口更加合理。作为一个主要版本并进行大量重构的前提下避免不了会带来一些破坏性更新，但这些都是值得的。

简介

可能有些人还不知道 CAP 是什么，老规矩来一个简介。

CAP 是一个用来解决微服务或者分布式系统中分布式事务问题的一个开源项目解决方案（https://github.com/dotnetcore/CAP）同样可以用来作为EventBus使用，目前已经3岁了，目前已经应用到了很多的公司和项目中，

想对 CAP 更多了解的同学可以看下官方文档。

本次在 CAP 3.0 版本中我们主要带来了以下破坏性改变和新特性：

破坏性改变：

消息协议和存储
接口改动
分离 Dashboard 项目

新特性：

新的发布Api
新的序列化接口
全新的 Diagnostics 事件和结构
新的Kafka Transport配置项
其他改进

下面我们就来逐一看一下吧。

破坏性改变

本次版本我们带来了一个破坏性的改变，这导致我们的 3.0 版本是不和 2.0 版本的消息兼容的，所以大家在升级的时候注意一下。

消息协议和存储

在过去，消息是被CAP经过了一次包装然后序列化为json发送到消息队列中，并且消费端也是由CAP进行解包然后反序列化为需要的对象。这样有什么问题呢？这会导致一是无法对消息进行自定义序列化，二会导致用户在和其他客户端发送到消息队列的消息进行对接的时候需要进行额外的适配工作。

基于以上原因，我们调整了发送和消费的数据结构和存储方式。使用更加原生的方式来实现。你发送的消息将会被直接序列化后传递到消息队列的 Body 中，元数据信息将被传递到消息队列的 Header 中。

数据库的数据结构我们在新版本并没有调整，在升级的过程中需要注意的是消息都已经被消费完成了，这样就不会读到旧的消息从而出现失败的问题。

接口改动

我们重构了一些接口，大部分情况下如果你是按照推荐的方式在使用CAP那么不会对你有影响

，如果你在升级新版本的过程遇到问题，可以参考最新代码进行调整。

分离 Dashboard 项目

在这个版本中，我们将 Dashboard 相关代码分离了出去形成了一个新的项目，如果你需要使用到 Dashbaord 相关功能，可以从 NuGet 安装它。

PM> Install-Package DotNetCore.CAP.Dashboard

新的发布Api

我们在 ICapPublisher 接口新增了一个Api 用于发送带有头信息的消息。

Task PublishAsync<T>(string name, T contentObj, IDictionary<string, string> headers);

头将被直接发送的消息队列支持的消息头进行传输，通常你可以传递和消息体相关的元数据信息在里面。

默认情况下，我们发送了消息Id，消息名称，消息类型，发送时间等，利用此接口你可以添加更多信息到头数据中。

在消费者这边，你可以通过 [FromCap] 标签来从 CapHeader 中读取头信息，下面展示了如何在消费者方法中读取发送的头信息。

[CapSubscribe("sample.rabbitmq.mysql")]

public void Subscriber2(DateTime p, [FromCap]CapHeader header)

{

    // header["my-header"]

}

新的序列化接口

新增了 ISerializer 序列化接口，以支持对发往消息队列的消息体进行自定义序列化，你可以通过自定义实现此接口来使用你喜爱的序列化器。

默认情况下，我们使用的是 json 来对消息进行序列化，我们推荐使用此方式。因为这样你可以在 RabbitMQ Management 控制台来测试发送消息更加的方便。

全新的 Diagnostics 事件和结构

我们改进了 Diagnostics 事件和数据结构，提供对最新事件的追踪。并且我们优化了数据结构，现在可以过的更新运行时的状态信息。

我们已经针对 Skywalking 提交了 PR 已支持最新的 CAP 事件的追踪，新的追踪支持从 Controller 到消息发布，消息消费等全链路的跟踪。

新的Kafka Transport配置项

我们在 Kafka 配置项中增加了 CustomHeaders，如果你需要在消费者方法中记录当前 Kafka 消费的 Offset 或者 Partition 等信息，可以利用此扩展来添加自定义 header。

你可以在这里找到关于如何使用它。

其他改进

支持重命名表名称, 参考 issue #435。
Bug修复，具体可以查看这里的 release 日志了解更多。
依赖的 NuGet 包更新

总结

以上，就是本版本中支持的一些新特性，感谢大家的支持，我们很开心能够帮助到大家

。大家在使用的过程中遇到问题希望也能够积极的反馈，帮助CAP变得越来越好。