完善注释

kafka-client/src/main/java/com/alibaba/otter/canal/kafka/client/KafkaCanalConnectors.java

@@ -1,5 +1,11 @@
 package com.alibaba.otter.canal.kafka.client;
 
+/**
+ * canal kafka connectors创建工具类
+ *
+ * @author machengyuan @ 2018-6-12
+ * @version 1.0.0
+ */
 public class KafkaCanalConnectors {
     /**
      * 创建kafka客户端链接

kafka-client/src/main/java/com/alibaba/otter/canal/kafka/client/MessageDeserializer.java

@@ -11,6 +11,12 @@ import org.slf4j.LoggerFactory;
 
 import java.util.Map;
 
+/**
+ * Kafka Message类的反序列化
+ *
+ * @author machengyuan @ 2018-6-12
+ * @version 1.0.0
+ */
 public class MessageDeserializer implements Deserializer<Message> {
     private static Logger logger = LoggerFactory.getLogger(MessageDeserializer.class);
 

kafka-client/src/test/java/com/alibaba/otter/canal/kafka/client/running/AbstractKafkaTest.java

@@ -2,6 +2,12 @@ package com.alibaba.otter.canal.kafka.client.running;
 
 import org.junit.Assert;
 
+/**
+ * Kafka 测试基类
+ *
+ * @author machengyuan @ 2018-6-12
+ * @version 1.0.0
+ */
 public abstract class AbstractKafkaTest {
 
     public static String topic = "example";

kafka-client/src/test/java/com/alibaba/otter/canal/kafka/client/running/KafkaCanalClientExample.java → kafka-client/src/test/java/com/alibaba/otter/canal/kafka/client/running/CanalKafkaClientExample.java

@@ -10,8 +10,14 @@ import org.springframework.util.Assert;
 
 import java.util.concurrent.TimeUnit;
 
-public class KafkaCanalClientExample {
-    protected final static Logger logger = LoggerFactory.getLogger(KafkaCanalClientExample.class);
+/**
+ * Kafka client example
+ *
+ * @author machengyuan @ 2018-6-12
+ * @version 1.0.0
+ */
+public class CanalKafkaClientExample {
+    protected final static Logger logger = LoggerFactory.getLogger(CanalKafkaClientExample.class);
 
     private KafkaCanalConnector connector;
 
@@ -25,13 +31,13 @@ public class KafkaCanalClientExample {
         }
     };
 
-    public KafkaCanalClientExample(String servers, String topic, Integer partition, String groupId) {
+    public CanalKafkaClientExample(String servers, String topic, Integer partition, String groupId) {
         connector = KafkaCanalConnectors.newKafkaConnector(servers, topic, partition, groupId);
     }
 
     public static void main(String[] args) {
         try {
-            final KafkaCanalClientExample kafkaCanalClientExample = new KafkaCanalClientExample(AbstractKafkaTest.servers,
+            final CanalKafkaClientExample kafkaCanalClientExample = new CanalKafkaClientExample(AbstractKafkaTest.servers,
                     AbstractKafkaTest.topic, AbstractKafkaTest.partition, AbstractKafkaTest.groupId);
             logger.info("## start the kafka consumer: {}-{}", AbstractKafkaTest.topic, AbstractKafkaTest.groupId);
             kafkaCanalClientExample.start();

kafka-client/src/test/java/com/alibaba/otter/canal/kafka/client/running/ClientRunningTest.java → kafka-client/src/test/java/com/alibaba/otter/canal/kafka/client/running/KafkaClientRunningTest.java

@@ -12,8 +12,14 @@ import java.util.concurrent.ExecutorService;
 import java.util.concurrent.Executors;
 import java.util.concurrent.TimeUnit;
 
-public class ClientRunningTest extends AbstractKafkaTest {
-    private Logger logger = LoggerFactory.getLogger(ClientRunningTest.class);
+/**
+ * Kafka consumer获取Message的测试例子
+ *
+ * @author machengyuan @ 2018-6-12
+ * @version 1.0.0
+ */
+public class KafkaClientRunningTest extends AbstractKafkaTest {
+    private Logger logger = LoggerFactory.getLogger(KafkaClientRunningTest.class);
 
     private boolean running = true;
 

kafka/src/main/java/com/alibaba/otter/canal/kafka/producer/MessageSerializer.java

@@ -10,7 +10,7 @@ import org.springframework.util.CollectionUtils;
 import java.util.Map;
 
 /**
- * Message类的序列化Kafka实现
+ * Kafka Message类的序列化
  *
  * @author machengyuan 2018-6-11 下午05:30:49
  * @version 1.0.0