文档

C# SDK收发消息

更新时间:

本文介绍如何使用C# SDK通过接入点接入云消息队列 Kafka 版并收发消息。

环境配置

您已安装.NET。更多信息,请参见安装.NET

安装C#依赖库

执行以下命令安装C#依赖库。

dotnet add package -v 1.5.2 Confluent.Kafka

准备配置

  1. 可选:下载SSL根证书。如果是SSL接入点,需下载该证书。

  2. 配置producer.csconsumer.cs文件。

    表 1. 配置项说明

    参数

    描述

    BootstrapServers

    SSL接入点。您可在云消息队列 Kafka 版控制台实例详情页面的接入点信息区域获取。

    SslCaLocation

    下载的SSL根证书的路径。仅SSL接入点需要此配置项。

    SaslMechanism

    收发消息使用的安全机制。

    • SSL接入点:取值为SaslMechanism.Plain

    • SASL接入点:PLAIN机制时,取值为SaslMechanism.Plain;SCRAM机制时,取值为SaslMechanism.ScramSha256

    SecurityProtocol

    收发消息使用的安全协议。

    • SSL接入点:取值为SecurityProtocol.SaslSsl

    • SASL接入点:PLAIN机制时,取值为SecurityProtocol.SaslPlaintext;SCRAM机制时,取值为SecurityProtocol.SaslPlaintext

    SaslUsername

    SASL用户名。如果是默认接入点,则无此配置项。

    说明
    • 如果实例未开启ACL,您可以在云消息队列 Kafka 版控制台实例详情页面的配置信息区域获取默认的用户名密码
    • 如果实例已开启ACL,请确保要使用的SASL用户已被授予向云消息队列 Kafka 版实例收发消息的权限。具体操作,请参见SASL用户授权

    SaslPassword

    SASL用户名密码。如果是默认接入点,则无此配置项。

    topic

    Topic名称。您可在云消息队列 Kafka 版控制台Topic 管理页面获取。

    GroupId

    Group名称。您可在云消息队列 Kafka 版控制台Group 管理页面获取。

发送消息

执行以下命令发送消息。

dotnet run producer.cs

消息程序producer.cs示例代码如下:

关于代码中配置项说明,请参见配置项说明

重要

示例代码为SSL接入点的代码。您需要根据实际接入点类型,删除或者修改配置项代码。

using System;
using Confluent.Kafka;

class Producer
{
    public static void Main(string[] args)
    {
        var conf = new ProducerConfig {
            BootstrapServers = "XXX,XXX,XXX",
            SslCaLocation = "XXX/only-4096-ca-cert.pem",
            SaslMechanism = SaslMechanism.Plain,
            SecurityProtocol = SecurityProtocol.SaslSsl,
            SslEndpointIdentificationAlgorithm = SslEndpointIdentificationAlgorithm.None,
            SaslUsername = "XXX",
            SaslPassword = "XXX",
            };

        Action<DeliveryReport<Null, string>> handler = r =>
            Console.WriteLine(!r.Error.IsError
                ? $"Delivered message to {r.TopicPartitionOffset}"
                : $"Delivery Error: {r.Error.Reason}");

        string topic ="XXX";

        using (var p = new ProducerBuilder<Null, string>(conf).Build())
        {
            for (int i=0; i<100; ++i)
            {
                p.Produce(topic, new Message<Null, string> { Value = i.ToString() }, handler);
            }
            p.Flush(TimeSpan.FromSeconds(10));
        }
    }
}

订阅消息

执行以下命令消费消息。

dotnet run consumer.cs

消息程序consumer.cs示例代码如下:

关于代码中配置项说明,请参见配置项说明

重要

示例代码为SSL接入点的代码。您需要根据实际接入点类型,删除或者修改配置项代码。

using System;
using System.Threading;
using Confluent.Kafka;

class Consumer
{
    public static void Main(string[] args)
    {
        var conf = new ConsumerConfig {
            GroupId = "XXX",
            BootstrapServers = "XXX,XXX,XXX",
            SslCaLocation = "XXX/only-4096-ca-cert.pem",
            SaslMechanism = SaslMechanism.Plain,
            SslEndpointIdentificationAlgorithm = SslEndpointIdentificationAlgorithm.None,
            SecurityProtocol = SecurityProtocol.SaslSsl,
            SaslUsername = "XXX",
            SaslPassword = "XXX",
            AutoOffsetReset = AutoOffsetReset.Earliest
        };

        string topic = "XXX";

        using (var c = new ConsumerBuilder<Ignore, string>(conf).Build())
        {
            c.Subscribe(topic);

            CancellationTokenSource cts = new CancellationTokenSource();
            Console.CancelKeyPress += (_, e) => {
                e.Cancel = true;
                cts.Cancel();
            };

            try
            {
                while (true)
                {
                    try
                    {
                        var cr = c.Consume(cts.Token);
                        Console.WriteLine($"Consumed message '{cr.Value}' at: '{cr.TopicPartitionOffset}'.");
                    }
                    catch (ConsumeException e)
                    {
                        Console.WriteLine($"Error occured: {e.Error.Reason}");
                    }
                }
            }
            catch (OperationCanceledException)
            {
                c.Close();
            }
        }
    }
}
  • 本页导读 (1)