SSL存取點PLAIN機制收發訊息 - ApsaraMQ for Kafka

本文以Java SDK為例介紹如何在公網環境下使用SDK接入雲訊息佇列 Kafka 版的SSL存取點並使用PLAIN機制收發訊息。

前提條件

安裝Java依賴庫

在pom.xml中添加以下依賴。

<dependency>
    <groupId>org.apache.kafka</groupId>
    <artifactId>kafka-clients</artifactId>
    <version>2.6.0</version>
</dependency>
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-log4j12</artifactId>
    <version>1.7.6</version>
</dependency>

說明

建議您保持服務端和用戶端版本一致，即保持用戶端庫版本和雲訊息佇列 Kafka 版執行個體的大版本一致。您可以在雲訊息佇列 Kafka 版控制台的实例详情頁面擷取雲訊息佇列 Kafka 版執行個體的大版本。

準備配置

建立Log4j設定檔log4j.properties。

# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements.  See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License.  You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

log4j.rootLogger=INFO, STDOUT

log4j.appender.STDOUT=org.apache.log4j.ConsoleAppender
log4j.appender.STDOUT.layout=org.apache.log4j.PatternLayout
log4j.appender.STDOUT.layout.ConversionPattern=[%d] %p %m (%c)%n

下載SSL根憑證。
建立JAAS設定檔kafka_client_jaas.conf。
```
KafkaClient {
  org.apache.kafka.common.security.plain.PlainLoginModule required
  username="xxxx"
  password="xxxx";
};                       
```
說明
- 如果執行個體未開啟ACL，您可以在雲訊息佇列 Kafka 版控制台的執行個體詳情頁面擷取預設使用者的使用者名稱和密碼。
- 如果執行個體已開啟ACL，請確保要使用的SASL使用者為PLAIN類型且已授權收發訊息的許可權，詳情請參見SASL使用者授權。

建立雲訊息佇列 Kafka 版設定檔kafka.properties。

##SSL存取點，通過控制台擷取。
bootstrap.servers=xxxx
##Topic，通過控制台建立。
topic=xxxx
##Group，通過控制台建立。
group.id=xxxx
##SSL根憑證。
ssl.truststore.location=/xxxx/only.4096.client.truststore.jks
##JAAS設定檔。
java.security.auth.login.config=/xxxx/kafka_client_jaas.conf

建立設定檔載入程式JavaKafkaConfigurer.java。

import java.util.Properties;

public class JavaKafkaConfigurer {

    private static Properties properties;

    public static void configureSasl() {
        //如果用-D或者其它方式設定過，這裡不再設定。
        if (null == System.getProperty("java.security.auth.login.config")) {
            //請注意將XXX修改為自己的路徑。
            //這個路徑必須是一個檔案系統可讀的路徑，不能被打包到JAR中。
            System.setProperty("java.security.auth.login.config", getKafkaProperties().getProperty("java.security.auth.login.config"));
        }
    }

    public synchronized static Properties getKafkaProperties() {
        if (null != properties) {
            return properties;
        }
        //擷取設定檔kafka.properties的內容。
        Properties kafkaProperties = new Properties();
        try {
            kafkaProperties.load(KafkaProducerDemo.class.getClassLoader().getResourceAsStream("kafka.properties"));
        } catch (Exception e) {
            //沒載入到檔案，程式要考慮退出。
            e.printStackTrace();
        }
        properties = kafkaProperties;
        return kafkaProperties;
    }
}

發送訊息

建立發送訊息程式KafkaProducerDemo.java。

import java.util.ArrayList;
import java.util.List;
import java.util.Properties;
import java.util.concurrent.Future;
import org.apache.kafka.clients.CommonClientConfigs;
import org.apache.kafka.clients.producer.KafkaProducer;
import org.apache.kafka.clients.producer.ProducerConfig;
import org.apache.kafka.clients.producer.ProducerRecord;
import org.apache.kafka.clients.producer.RecordMetadata;
import org.apache.kafka.common.config.SaslConfigs;
import org.apache.kafka.common.config.SslConfigs;

public class KafkaProducerDemo {

    public static void main(String args[]) {
        //設定JAAS設定檔的路徑。
        JavaKafkaConfigurer.configureSasl();

        //載入kafka.properties。
        Properties kafkaProperties =  JavaKafkaConfigurer.getKafkaProperties();

        Properties props = new Properties();
        //設定存取點，請通過控制台擷取對應Topic的存取點。
        props.put(ProducerConfig.BOOTSTRAP_SERVERS_CONFIG, kafkaProperties.getProperty("bootstrap.servers"));
        //設定SSL根憑證的路徑，請記得將XXX修改為自己的路徑。
        //與sasl路徑類似，該檔案也不能被打包到jar中。
        props.put(SslConfigs.SSL_TRUSTSTORE_LOCATION_CONFIG, kafkaProperties.getProperty("ssl.truststore.location"));
        //根憑證store的密碼，保持不變。
        props.put(SslConfigs.SSL_TRUSTSTORE_PASSWORD_CONFIG, "KafkaOnsClient");
        //接入協議，目前支援使用SASL_SSL協議接入。
        props.put(CommonClientConfigs.SECURITY_PROTOCOL_CONFIG, "SASL_SSL");
        //SASL鑒權方式，保持不變。
        props.put(SaslConfigs.SASL_MECHANISM, "PLAIN");
        //訊息佇列Kafka版訊息的序列化方式。
        props.put(ProducerConfig.KEY_SERIALIZER_CLASS_CONFIG, "org.apache.kafka.common.serialization.StringSerializer");
        props.put(ProducerConfig.VALUE_SERIALIZER_CLASS_CONFIG, "org.apache.kafka.common.serialization.StringSerializer");
        //請求的最長等待時間。
        props.put(ProducerConfig.MAX_BLOCK_MS_CONFIG, 30 * 1000);
        //設定用戶端內部重試次數。
        props.put(ProducerConfig.RETRIES_CONFIG, 5);
        //設定用戶端內部稍候再試。
        props.put(ProducerConfig.RETRY_BACKOFF_MS_CONFIG, 3000);

        //Hostname校正改成空。
        props.put(SslConfigs.SSL_ENDPOINT_IDENTIFICATION_ALGORITHM_CONFIG, "");

        //構造Producer對象，注意，該對象是安全執行緒的，一般來說，一個進程內一個Producer對象即可。
        //如果想提高效能，可以多構造幾個對象，但不要太多，最好不要超過5個。
        KafkaProducer<String, String> producer = new KafkaProducer<String, String>(props);

        //構造一個訊息佇列Kafka版訊息。
        String topic = kafkaProperties.getProperty("topic"); //訊息所屬的Topic，請在控制台申請之後，填寫在這裡。
        String value = "this is the message's value"; //訊息的內容。

        try {
            //批量擷取 futures 可以加快速度, 但注意，批量不要太大。
            List<Future<RecordMetadata>> futures = new ArrayList<Future<RecordMetadata>>(128);
            for (int i =0; i < 100; i++) {
                //發送訊息，並獲得一個Future對象。
                ProducerRecord<String, String> kafkaMessage =  new ProducerRecord<String, String>(topic, value + ": " + i);
                Future<RecordMetadata> metadataFuture = producer.send(kafkaMessage);
                futures.add(metadataFuture);

            }
            producer.flush();
            for (Future<RecordMetadata> future: futures) {
                //同步獲得Future對象的結果。
                try {
                    RecordMetadata recordMetadata = future.get();
                    System.out.println("Produce ok:" + recordMetadata.toString());
                } catch (Throwable t) {
                    t.printStackTrace();
                }
            }
        } catch (Exception e) {
            //用戶端內部重試之後，仍然發送失敗，業務要應對此類錯誤。
            System.out.println("error occurred");
            e.printStackTrace();
        }
    }
}

編譯並運行KafkaProducerDemo.java發送訊息。

訂閱訊息

選擇以下任意一種方式訂閱訊息。

單Consumer訂閱訊息。

建立單Consumer訂閱訊息程式KafkaConsumerDemo.java。

import java.util.ArrayList;
import java.util.List;
import java.util.Properties;
import org.apache.kafka.clients.CommonClientConfigs;
import org.apache.kafka.clients.consumer.ConsumerConfig;
import org.apache.kafka.clients.consumer.ConsumerRecord;
import org.apache.kafka.clients.consumer.ConsumerRecords;
import org.apache.kafka.clients.consumer.KafkaConsumer;
import org.apache.kafka.clients.producer.ProducerConfig;
import org.apache.kafka.common.config.SaslConfigs;
import org.apache.kafka.common.config.SslConfigs;

public class KafkaConsumerDemo {

    public static void main(String args[]) {
        //設定JAAS設定檔的路徑。
        JavaKafkaConfigurer.configureSasl();

        //載入kafka.properties。
        Properties kafkaProperties =  JavaKafkaConfigurer.getKafkaProperties();

        Properties props = new Properties();
        //設定存取點，請通過控制台擷取對應Topic的存取點。
        props.put(ProducerConfig.BOOTSTRAP_SERVERS_CONFIG, kafkaProperties.getProperty("bootstrap.servers"));
        //設定SSL根憑證的路徑，請記得將XXX修改為自己的路徑。
        //與SASL路徑類似，該檔案也不能被打包到jar中。
        props.put(SslConfigs.SSL_TRUSTSTORE_LOCATION_CONFIG, kafkaProperties.getProperty("ssl.truststore.location"));
        //根憑證儲存的密碼，保持不變。
        props.put(SslConfigs.SSL_TRUSTSTORE_PASSWORD_CONFIG, "KafkaOnsClient");
        //接入協議，目前支援使用SASL_SSL協議接入。
        props.put(CommonClientConfigs.SECURITY_PROTOCOL_CONFIG, "SASL_SSL");
        //SASL鑒權方式，保持不變。
        props.put(SaslConfigs.SASL_MECHANISM, "PLAIN");
        //兩次Poll之間的最大允許間隔。
        //消費者超過該值沒有返回心跳，服務端判斷消費者處於非存活狀態，服務端將消費者從Group移除並觸發Rebalance，預設30s。
        props.put(ConsumerConfig.SESSION_TIMEOUT_MS_CONFIG, 30000);
        //設定單次拉取的量，走公網訪問時，該參數會有較大影響。
        props.put(ConsumerConfig.MAX_PARTITION_FETCH_BYTES_CONFIG, 32000);
        props.put(ConsumerConfig.FETCH_MAX_BYTES_CONFIG, 32000);
        //每次Poll的最大數量。
        //注意該值不要改得太大，如果Poll太多資料，而不能在下次Poll之前消費完，則會觸發一次負載平衡，產生卡頓。
        props.put(ConsumerConfig.MAX_POLL_RECORDS_CONFIG, 30);
        //訊息的還原序列化方式。
        props.put(ConsumerConfig.KEY_DESERIALIZER_CLASS_CONFIG, "org.apache.kafka.common.serialization.StringDeserializer");
        props.put(ConsumerConfig.VALUE_DESERIALIZER_CLASS_CONFIG, "org.apache.kafka.common.serialization.StringDeserializer");
        //當前消費執行個體所屬的消費組，請在控制台申請之後填寫。
        //屬於同一個組的消費執行個體，會負載消費訊息。
        props.put(ConsumerConfig.GROUP_ID_CONFIG, kafkaProperties.getProperty("group.id"));
        //Hostname校正改成空。
        props.put(SslConfigs.SSL_ENDPOINT_IDENTIFICATION_ALGORITHM_CONFIG, "");

        //構造消費對象，也即產生一個消費執行個體。
        KafkaConsumer<String, String> consumer = new org.apache.kafka.clients.consumer.KafkaConsumer<String, String>(props);
        //設定消費組訂閱的Topic，可以訂閱多個。
        //如果GROUP_ID_CONFIG是一樣，則訂閱的Topic也建議設定成一樣。
        List<String> subscribedTopics =  new ArrayList<String>();
        //如果需要訂閱多個Topic，則在這裡加進去即可。
        //每個Topic需要先在控制台進行建立。
        subscribedTopics.add(kafkaProperties.getProperty("topic"));
        consumer.subscribe(subscribedTopics);

        //迴圈消費訊息。
        while (true){
            try {
                ConsumerRecords<String, String> records = consumer.poll(1000);
                //必須在下次Poll之前消費完這些資料, 且總耗時不得超過SESSION_TIMEOUT_MS_CONFIG。
                //建議開一個單獨的線程池來消費訊息，然後非同步返回結果。
                for (ConsumerRecord<String, String> record : records) {
                    System.out.println(String.format("Consume partition:%d offset:%d", record.partition(), record.offset()));
                }
            } catch (Exception e) {
                try {
                    Thread.sleep(1000);
                } catch (Throwable ignore) {

                }
                e.printStackTrace();
            }
        }
    }
}

編譯並運行KafkaConsumerDemo.java消費訊息。

多Consumer訂閱訊息。

建立多Consumer訂閱訊息程式KafkaMultiConsumerDemo.java。

import java.util.ArrayList;
import java.util.List;
import java.util.Properties;
import java.util.concurrent.atomic.AtomicBoolean;
import org.apache.kafka.clients.CommonClientConfigs;
import org.apache.kafka.clients.consumer.ConsumerConfig;
import org.apache.kafka.clients.consumer.ConsumerRecord;
import org.apache.kafka.clients.consumer.ConsumerRecords;
import org.apache.kafka.clients.consumer.KafkaConsumer;
import org.apache.kafka.clients.producer.ProducerConfig;
import org.apache.kafka.common.config.SaslConfigs;
import org.apache.kafka.common.config.SslConfigs;
import org.apache.kafka.common.errors.WakeupException;

/**
 * 本教程示範如何在一個進程內開啟多個Consumer同時消費Topic。
 * 注意全域Consumer數量不要超過訂閱的Topic總分區數。
 */
public class KafkaMultiConsumerDemo {

    public static void main(String args[]) throws InterruptedException {
        //設定JAAS設定檔的路徑。
        JavaKafkaConfigurer.configureSasl();

        //載入kafka.properties。
        Properties kafkaProperties = JavaKafkaConfigurer.getKafkaProperties();

        Properties props = new Properties();
        //設定存取點，請通過控制台擷取對應Topic的存取點。
        props.put(ProducerConfig.BOOTSTRAP_SERVERS_CONFIG, kafkaProperties.getProperty("bootstrap.servers"));
        //設定SSL根憑證的路徑，請記得將XXX修改為自己的路徑。
        //與SASL路徑類似，該檔案也不能被打包到JAR中。
        props.put(SslConfigs.SSL_TRUSTSTORE_LOCATION_CONFIG, kafkaProperties.getProperty("ssl.truststore.location"));
        //根憑證儲存的密碼，保持不變。
        props.put(SslConfigs.SSL_TRUSTSTORE_PASSWORD_CONFIG, "KafkaOnsClient");
        //接入協議，目前支援使用SASL_SSL協議接入。
        props.put(CommonClientConfigs.SECURITY_PROTOCOL_CONFIG, "SASL_SSL");
        //SASL鑒權方式，保持不變。
        props.put(SaslConfigs.SASL_MECHANISM, "PLAIN");
        //兩次Poll之間的最大允許間隔。
        //消費者超過該值沒有返回心跳，服務端判斷消費者處於非存活狀態，服務端將消費者從Group移除並觸發Rebalance，預設30s。
        props.put(ConsumerConfig.SESSION_TIMEOUT_MS_CONFIG, 30000);
        //每次Poll的最大數量。
        //注意該值不要改得太大，如果Poll太多資料，而不能在下次Poll之前消費完，則會觸發一次負載平衡，產生卡頓。
        props.put(ConsumerConfig.MAX_POLL_RECORDS_CONFIG, 30);
        //訊息的還原序列化方式。
        props.put(ConsumerConfig.KEY_DESERIALIZER_CLASS_CONFIG, "org.apache.kafka.common.serialization.StringDeserializer");
        props.put(ConsumerConfig.VALUE_DESERIALIZER_CLASS_CONFIG, "org.apache.kafka.common.serialization.StringDeserializer");
        //當前消費執行個體所屬的消費組，請在控制台申請之後填寫。
        //屬於同一個組的消費執行個體，會負載消費訊息。
        props.put(ConsumerConfig.GROUP_ID_CONFIG, kafkaProperties.getProperty("group.id"));
        //構造消費對象，也即產生一個消費執行個體。

        //Hostname校正改成空。
        props.put(SslConfigs.SSL_ENDPOINT_IDENTIFICATION_ALGORITHM_CONFIG, "");

        int consumerNum = 2;
        Thread[] consumerThreads = new Thread[consumerNum];
        for (int i = 0; i < consumerNum; i++) {
            KafkaConsumer<String, String> consumer = new KafkaConsumer<String, String>(props);

            List<String> subscribedTopics = new ArrayList<String>();
            subscribedTopics.add(kafkaProperties.getProperty("topic"));
            consumer.subscribe(subscribedTopics);

            KafkaConsumerRunner kafkaConsumerRunner = new KafkaConsumerRunner(consumer);
            consumerThreads[i] = new Thread(kafkaConsumerRunner);
        }

        for (int i = 0; i < consumerNum; i++) {
            consumerThreads[i].start();
        }

        for (int i = 0; i < consumerNum; i++) {
            consumerThreads[i].join();
        }
    }

    static class KafkaConsumerRunner implements Runnable {
        private final AtomicBoolean closed = new AtomicBoolean(false);
        private final KafkaConsumer consumer;

        KafkaConsumerRunner(KafkaConsumer consumer) {
            this.consumer = consumer;
        }

        @Override
        public void run() {
            try {
                while (!closed.get()) {
                    try {
                        ConsumerRecords<String, String> records = consumer.poll(1000);
                        //必須在下次Poll之前消費完這些資料, 且總耗時不得超過SESSION_TIMEOUT_MS_CONFIG。
                        for (ConsumerRecord<String, String> record : records) {
                            System.out.println(String.format("Thread:%s Consume partition:%d offset:%d", Thread.currentThread().getName(), record.partition(), record.offset()));
                        }
                    } catch (Exception e) {
                        try {
                            Thread.sleep(1000);
                        } catch (Throwable ignore) {

                        }
                        e.printStackTrace();
                    }
                }
            } catch (WakeupException e) {
                //如果關閉則忽略異常。
                if (!closed.get()) {
                    throw e;
                }
            } finally {
                consumer.close();
            }
        }

        //可以被另一個線程調用的關閉Hook。
        public void shutdown() {
            closed.set(true);
            consumer.wakeup();
        }
    }
}

編譯並運行KafkaMultiConsumerDemo.java消費訊息。