このトピックでは、ApsaraMQ for Kafka SDKを使用して、インターネット経由でApsaraMQ for KafkaインスタンスのSecure Sockets Layer(SSL)エンドポイントにアクセスし、PLAINメカニズムを使用してメッセージを送受信する方法について説明します。例では、SDK for Javaを使用しています。
前提条件
JDK 1.8以降がインストールされていること。詳細については、「Java SE Downloads」をご参照ください。
Maven 2.5以降がインストールされていること。詳細については、「Download Apache Maven」をご参照ください。
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>クライアントバージョンは、ApsaraMQ for Kafka インスタンスのメジャーバージョンと一致させることをお勧めします。ApsaraMQ for Kafka インスタンスのメジャーバージョンは、ApsaraMQ for Kafka コンソールの インスタンスの詳細 ページで確認できます。
準備
log4j.properties という名前の Log4j 設定ファイルを作成します。
# 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)%nkafka_client_jaas.conf という名前の JAAS 設定ファイルを作成します。
KafkaClient { org.apache.kafka.common.security.plain.PlainLoginModule required username="xxxx" password="xxxx"; };説明インスタンスでアクセス制御リスト(ACL)機能が無効になっている場合、ApsaraMQ for Kafka コンソールの [インスタンスの詳細] ページで、インスタンスのデフォルトのSimple Authentication and Security Layer(SASL)ユーザーのユーザー名とパスワードを取得できます。
インスタンスでACLが有効になっている場合、使用するSASLユーザーがPLAINタイプであり、メッセージの送受信が許可されていることを確認してください。詳細については、「SASLユーザーに権限を付与する」をご参照ください。
ApsaraMQ for Kafka の構成ファイル kafka.properties を作成します。
## SSLエンドポイントを指定します。これは、Message Queue for Apache Kafkaコンソールで取得できます。 bootstrap.servers=xxxx ## トピックを指定します。これは、Message Queue for Apache Kafkaコンソールで作成されます。 topic=xxxx ## コンシューマーグループを指定します。これは、Message Queue for Apache Kafkaコンソールで作成されます。 group.id=xxxx ## SSLルート証明書。 ssl.truststore.location=/xxxx/kafka.client.truststore.jks ## JAAS設定ファイル。 java.security.auth.login.config=/xxxx/kafka_client_jaas.confJavaKafkaConfigurer.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(); // エンドポイントを指定します。Message Queue for Apache Kafkaコンソールで対応するインスタンスのSASLエンドポイントを取得します。 props.put(ProducerConfig.BOOTSTRAP_SERVERS_CONFIG, kafkaProperties.getProperty("bootstrap.servers")); // SSLルート証明書のパスを指定します。XXXを実際のパスに置き換えます。 // 証明書ファイルを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"); // Message Queue for Apache 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); // クライアントの2回連続する再試行の間隔を設定します。 props.put(ProducerConfig.RETRY_BACKOFF_MS_CONFIG, 3000); // ホスト名検証のアルゴリズムを空の値に設定します。 props.put(SslConfigs.SSL_ENDPOINT_IDENTIFICATION_ALGORITHM_CONFIG, ""); // スレッドセーフなプロデューサーオブジェクトを作成します。1つのプロデューサーオブジェクトは1つのプロセスを提供できます。 // パフォーマンスを向上させるために、複数のオブジェクトを作成できます。5つ以下のオブジェクトを作成することをお勧めします。 KafkaProducer<String, String> producer = new KafkaProducer<String, String>(props); // Message Queue for Apache Kafkaメッセージを作成します。 String topic = kafkaProperties.getProperty("topic"); // メッセージのトピック。Message Queue for Apache Kafkaコンソールで作成したトピックを入力します。 String value = "this is the message's value"; // メッセージの内容。 try { // 効率を向上させるために、一度に複数のfutureオブジェクトを取得します。一度に多数のfutureオブジェクトを取得しないでください。 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 をコンパイルして実行し、メッセージを送信します。
メッセージをコンシュームする
次のいずれかの方法でメッセージをコンシュームできます。
単一のコンシューマーを使用してメッセージをコンシュームする
次のコードを含む 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(); // エンドポイントを指定します。Message Queue for Apache Kafkaコンソールで対応するインスタンスのSASLエンドポイントを取得します。 props.put(ProducerConfig.BOOTSTRAP_SERVERS_CONFIG, kafkaProperties.getProperty("bootstrap.servers")); // SSLルート証明書のパスを指定します。XXXを実際のパスに置き換えます。 // 証明書ファイルを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"); // 2回連続するポーリングサイクルの最大間隔を設定します。 // デフォルトの間隔は30秒です。コンシューマーが間隔内にハートビートメッセージを返さない場合、ブローカーはコンシューマーが有効でないと判断します。この場合、ブローカーはコンシューマーをコンシューマーグループから削除し、ロードバランシングをトリガーします。 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); // 一度にポーリングできるメッセージの最大数を設定します。 // このパラメーターを過度に大きな値に設定しないでください。ポーリングされたメッセージが次のポーリングサイクルが始まる前にすべてコンシュームされない場合、ロードバランシングがトリガーされ、パフォーマンスが低下する可能性があります。 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"); // 現在のコンシューマーのコンシューマーグループを設定します。Message Queue for Apache Kafkaコンソールでコンシューマーグループを作成する必要があります。 // コンシューマーグループ内のコンシューマーは、ロードバランシングモードでメッセージをコンシュームします。 props.put(ConsumerConfig.GROUP_ID_CONFIG, kafkaProperties.getProperty("group.id")); // ホスト名検証のアルゴリズムを空の値に設定します。 props.put(SslConfigs.SSL_ENDPOINT_IDENTIFICATION_ALGORITHM_CONFIG, ""); // コンシューマーオブジェクトを作成します。 KafkaConsumer<String, String> consumer = new org.apache.kafka.clients.consumer.KafkaConsumer<String, String>(props); // コンシューマーグループがサブスクライブする1つ以上のトピックを指定します。 // 同じGROUP_ID_CONFIG値を持つコンシューマーを構成して、同じトピックにサブスクライブすることをお勧めします。 List<String> subscribedTopics = new ArrayList<String>(); // 複数のトピックにサブスクライブする場合は、ここにトピックを追加します。 // Message Queue for Apache Kafkaコンソールで事前にトピックを作成する必要があります。 subscribedTopics.add(kafkaProperties.getProperty("topic")); consumer.subscribe(subscribedTopics); // ループでメッセージをコンシュームします。 while (true){ try { ConsumerRecords<String, String> records = consumer.poll(1000); // 次のポーリングサイクルが始まる前に、すべてのメッセージをコンシュームする必要があります。合計期間は、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 をコンパイルして実行し、メッセージをコンシュームします。
複数のコンシューマーを使用してメッセージをコンシュームする
次のコードを含む 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; /** * このチュートリアルでは、1つのプロセスで複数のコンシューマーを使用して同時にメッセージをコンシュームする方法を示します。 * 環境内のコンシューマーの総数が、コンシューマーがサブスクライブするトピックのパーティション数を超えないようにしてください。 */ public class KafkaMultiConsumerDemo { public static void main(String args[]) throws InterruptedException { // JAAS設定ファイルのパスを指定します。 JavaKafkaConfigurer.configureSasl(); // kafka.propertiesファイルをロードします。 Properties kafkaProperties = JavaKafkaConfigurer.getKafkaProperties(); Properties props = new Properties(); // エンドポイントを指定します。Message Queue for Apache Kafkaコンソールで対応するインスタンスのSASLエンドポイントを取得します。 props.put(ProducerConfig.BOOTSTRAP_SERVERS_CONFIG, kafkaProperties.getProperty("bootstrap.servers")); // SSLルート証明書のパスを指定します。XXXを実際のパスに置き換えます。 // 証明書ファイルを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"); // 2回連続するポーリングサイクルの最大間隔を設定します。 // デフォルトの間隔は30秒です。コンシューマーが間隔内にハートビートメッセージを返さない場合、ブローカーはコンシューマーが有効でないと判断します。この場合、ブローカーはコンシューマーをコンシューマーグループから削除し、ロードバランシングをトリガーします。 props.put(ConsumerConfig.SESSION_TIMEOUT_MS_CONFIG, 30000); // 一度にポーリングできるメッセージの最大数を設定します。 // このパラメーターを過度に大きな値に設定しないでください。ポーリングされたメッセージが次のポーリングサイクルが始まる前にすべてコンシュームされない場合、ロードバランシングがトリガーされ、パフォーマンスが低下する可能性があります。 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"); // 現在のコンシューマーのコンシューマーグループを設定します。Message Queue for Apache Kafkaコンソールでコンシューマーグループを作成する必要があります。 // コンシューマーグループ内のコンシューマーは、ロードバランシングモードでメッセージをコンシュームします。 props.put(ConsumerConfig.GROUP_ID_CONFIG, kafkaProperties.getProperty("group.id")); // コンシューマーオブジェクトを作成します。 // ホスト名検証のアルゴリズムを空の値に設定します。 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); // 次のポーリングサイクルが始まる前に、すべてのメッセージをコンシュームする必要があります。合計期間は、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(); } } // 別のスレッドから呼び出すことができるシャットダウンフックを実装します。 public void shutdown() { closed.set(true); consumer.wakeup(); } } }KafkaMultiConsumerDemo.java をコンパイルして実行し、メッセージをコンシュームします。