Merge branch 'master' of https://github.com/oceanbase/obkv-table-client-java

Author: wangzelin19961202

.secignore

@@ -0,0 +1,35 @@
+##########################################################
+#            OBFlow Secret Scan Ignore List              #
+##########################################################
+# Above the segmentation lines there are suspected privacy information #
+# Please use the file name as the first line and the igored information #
+# should be started with tab. #
+# Under the segmentation lines there are the folders which you need to ignore #
+##########################################################
+**
+  http://license.coscl.org.cn/MulanPSL2
+  https://open.oceanbase.com/
+  https://open.oceanbase.com
+  https://github.com/oceanbase/oceanbase
+  https://github.com/oceanbase/oceanbase/issues
+  https://open.oceanbase.com
+  https://www.contributor-covenant.org/*
+  http://reveng.sourceforge.net/crc-catalogue/17plus.htm
+  http://murmurhash.googlepages.com/
+**/*.cpp
+  http://www.gnu.org/licenses/
+--------------------------------------------------------
+# Should use GLOB wildcard to config and analysis the ignored folder
+# The root patch should start with '/'
+/README.md
+/.git/hooks/fsmonitor-watchman.sample
+/pom.xml
+/example/simple-table-demo/pom.xml
+/example/simple-kv-demo/pom.xml
+/CONTRIBUTING.md
+/src/test/java/com/alipay/oceanbase/rpc/location/model/ObUserAuthTest.java
+/src/main/java/com/alipay/oceanbase/rpc/util/Base64.java
+/.oceanbase-common/**
+/src/main/resources/oceanbase-table-client/log/log4j/**
+--------------------------------------------------------
+# Config the ignored fold to escape the Chinese scan by GLOB wildcard

README.md

@@ -52,7 +52,8 @@ The code demo:
 ```
 **NOTE:**
 1. param_url is generated by ConfigServer (link TODO).
-2. More example [Demo](https://github.com/oceanbase/obkv-table-client-java/tree/master/example) 
+2. More example [Demo](https://github.com/oceanbase/obkv-table-client-java/tree/master/example)
+
 ## Documentation
 
 - English [Coming soon]

src/main/java/com/alipay/oceanbase/rpc/bolt/protocol/ObTablePacket.java

@@ -137,7 +137,6 @@ public ByteBuf getPacketContentBuf() {
      * Release byte buf.
      */
     public void releaseByteBuf() {
-        // http://netty.io/wiki/reference-counted-objects.html
         if (packetContentBuf != null) {
             packetContentBuf.release();
         }

src/main/java/com/alipay/oceanbase/rpc/protocol/payload/impl/ObObjType.java

@@ -885,7 +885,6 @@ public Comparable parseToComparable(Object o, ObCollationType ct)
         }
     },
 
-    // https://dev.mysql.com/doc/refman/5.7/en/datetime.html
     // The DATETIME type is used for values that contain both date and time parts.
     // MySQL retrieves and displays DATETIME values in 'YYYY-MM-DD HH:MM:SS' format. The supported range is '1000-01-01 00:00:00' to '9999-12-31 23:59:59'.
     ObDateTimeType(17) {
@@ -940,7 +939,6 @@ public Timestamp parseToComparable(Object o, ObCollationType ct)
          */
         @Override
         public byte[] encode(Object obj) {
-            // TODO 为什么是 Long
             return Serialization.encodeVi64(((Date) obj).getTime() * 1000L);
         }
 
@@ -987,7 +985,6 @@ public Timestamp parseToComparable(Object o, ObCollationType ct)
          */
         @Override
         public byte[] encode(Object obj) {
-            // TODO 为什么是 Int
             return Serialization.encodeVi32((int) ((Date) obj).getTime());
         }
 

src/main/java/com/alipay/oceanbase/rpc/protocol/payload/impl/execute/ObTableOperation.java

@@ -35,7 +35,7 @@
 public class ObTableOperation extends AbstractPayload {
 
     private ObTableOperationType operationType;
-    private ObITableEntity       entity;       // TODO 我是如何知道类型的？
+    private ObITableEntity       entity;
 
     /*
      * Encode.

src/main/java/com/alipay/oceanbase/rpc/table/ObTable.java

@@ -566,9 +566,9 @@ public ObTable build() throws Exception {
      * consistency, while each thread call invokeSync for data access, ensuring the sequential consistency.
      * <p>
      * Thread safety:
-     * （1） init and close require external synchronization or locking, which should be called only once.
-     * （2） getConnection from the pool is synchronized, thus thread-safe, .
-     * （3） ObTableConnection is shared and thread-safe, granted by underlying library.
+     * (1) init and close require external synchronization or locking, which should be called only once.
+     * (2) getConnection from the pool is synchronized, thus thread-safe, .
+     * (3) ObTableConnection is shared and thread-safe, granted by underlying library.
      */
     private static class ObTableConnectionPool {
         private final int                    obTableConnectionPoolSize;

src/main/java/com/alipay/oceanbase/rpc/util/CRC64.java

@@ -31,7 +31,6 @@ public class CRC64 implements Checksum {
      *
      * poly=0x42f0e1eba9ea3693 init=0x0 refin=false refout=false xorout=0x0
      *
-     * @url http://en.wikipedia.org/wiki/Cyclic_redundancy_check
      * @url http://reveng.sourceforge.net/crc-catalogue/17plus.htm
      */
     private static final long[] CRC_TABLE = new long[] { 0x0000000000000000L, 0x42F0E1EBA9EA3693L,

src/main/java/com/alipay/oceanbase/rpc/util/NamePattern.java

@@ -116,8 +116,7 @@ public String wrapValue(int value) {
             secondValue = value % valueRangeSecond;
         }
 
-        // 技术上没必要控制得如此严格
-        // 但是为了统一 DB 层库表分布的元数据，需要控制一下
+        // 统一 DB 层库表分布的元数据
         if (value < minValue || value > maxValue) {
             throw new IllegalArgumentException("NamePattern value out of bound. value: " + value
                                                + ", minValue: " + minValue + ", maxValue: "

src/main/java/com/alipay/oceanbase/rpc/util/hash/ObHashSortUtf8mb4.java

@@ -2914,7 +2914,6 @@ private static boolean enoughBytesRemaining(ObMbContext ctx, int n) {
     }
 
     /*
-     * Please refer to : https://en.wikipedia.org/wiki/UTF-8
      * The following table shows how the Unicode code points map to UTF-8 multi-byte byte sequences,
      * and their equivalent binary values.
      * <p>
@@ -2926,8 +2925,8 @@ private static boolean enoughBytesRemaining(ObMbContext ctx, int n) {
      * U+010000-U+10FFFF    000zzzzz yyyyyyyy xxxxxxxx    11110zzz 10zzyyyy 10yyyyxx 10xxxxxx
      * <p>
      * The basic rules are as follows:
-     * （1） If a byte starts with a 0 bit, it's a single byte value less than 128.
-     * （2） If it starts with 11, it's the first byte of a multi-byte sequence
+     * (1) If a byte starts with a 0 bit, it's a single byte value less than 128.
+     * (2) If it starts with 11, it's the first byte of a multi-byte sequence
      * and the number of 1 bits at the start indicates how many bytes there are in total,
      * eg., 110xxxxx has two bytes, 1110xxxx has three and 11110xxx has four.
      * (3) If it starts with 10, it's a continuation byte.

src/test/java/com/alipay/oceanbase/rpc/hbase/ObHTableOperationRequest.java

@@ -123,7 +123,7 @@ public ObTableAbstractOperationRequest obTableOperationRequest() {
                     ObTableOperationType.INSERT, new Object[] { rowKey, qualifierName, timestamp },
                     V_COLUMNS, new Object[] { value }, 10 * 1000);
                 break;
-            case DEL: // TODO 如何 DEL？
+            case DEL:
                 request = ObTableOperationRequest.getInstance(getTargetTableName(),
                     ObTableOperationType.DEL, new Object[] { rowKey, qualifierName, timestamp },
                     null, null, 10 * 1000);