You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@iotdb.apache.org by ta...@apache.org on 2023/01/05 09:14:29 UTC

[iotdb] branch master updated: [IOTDB-5284] Fix some code smells (#8730)

This is an automated email from the ASF dual-hosted git repository.

tanxinyu pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/iotdb.git


The following commit(s) were added to refs/heads/master by this push:
     new 2f8abb245c [IOTDB-5284] Fix some code smells (#8730)
2f8abb245c is described below

commit 2f8abb245ca7996344cf2bc8cc8ae76ddfa1771b
Author: BUAAserein <65...@users.noreply.github.com>
AuthorDate: Thu Jan 5 17:14:23 2023 +0800

    [IOTDB-5284] Fix some code smells (#8730)
    
    * fix some node-commons code smells
---
 .../iotdb/commons/auth/authorizer/BasicAuthorizer.java  |  2 +-
 .../iotdb/commons/auth/user/BasicUserManager.java       |  2 +-
 .../org/apache/iotdb/commons/conf/CommonConfig.java     |  2 ++
 .../org/apache/iotdb/commons/conf/IoTDBConstant.java    | 17 ++++++++---------
 .../apache/iotdb/commons/partition/DataPartition.java   |  2 +-
 .../org/apache/iotdb/commons/partition/Partition.java   |  2 +-
 .../partition/executor/hash/BKDRHashExecutor.java       |  4 ++--
 .../commons/partition/executor/hash/JSHashExecutor.java |  4 ++--
 .../path/fa/dfa/transition/AbstractDFATransition.java   |  2 +-
 .../commons/security/encrypt/MessageDigestEncrypt.java  |  4 +---
 .../commons/service/AbstractThriftServiceThread.java    |  4 ++--
 .../org/apache/iotdb/commons/sync/pipe/PipeInfo.java    |  4 ++--
 .../iotdb/commons/sync/pipesink/IoTDBPipeSink.java      |  2 +-
 .../org/apache/iotdb/commons/udf/utils/KDTreeUtil.java  | 10 +++++-----
 .../iotdb/commons/udf/utils/MasterRepairUtil.java       |  2 +-
 .../iotdb/commons/utils/BasicStructureSerDeUtil.java    |  4 ++--
 .../java/org/apache/iotdb/commons/utils/FileUtils.java  |  4 ++--
 .../org/apache/iotdb/commons/utils/SerializeUtils.java  | 13 ++++++++++++-
 18 files changed, 47 insertions(+), 37 deletions(-)

diff --git a/node-commons/src/main/java/org/apache/iotdb/commons/auth/authorizer/BasicAuthorizer.java b/node-commons/src/main/java/org/apache/iotdb/commons/auth/authorizer/BasicAuthorizer.java
index e152a82806..5e682da97f 100644
--- a/node-commons/src/main/java/org/apache/iotdb/commons/auth/authorizer/BasicAuthorizer.java
+++ b/node-commons/src/main/java/org/apache/iotdb/commons/auth/authorizer/BasicAuthorizer.java
@@ -439,7 +439,7 @@ public abstract class BasicAuthorizer implements IAuthorizer, IService {
   @Override
   public boolean processTakeSnapshot(File snapshotDir) throws TException, IOException {
     return userManager.processTakeSnapshot(snapshotDir)
-        & roleManager.processTakeSnapshot(snapshotDir);
+        && roleManager.processTakeSnapshot(snapshotDir);
   }
 
   @Override
diff --git a/node-commons/src/main/java/org/apache/iotdb/commons/auth/user/BasicUserManager.java b/node-commons/src/main/java/org/apache/iotdb/commons/auth/user/BasicUserManager.java
index 937eec62b9..787eb560b2 100644
--- a/node-commons/src/main/java/org/apache/iotdb/commons/auth/user/BasicUserManager.java
+++ b/node-commons/src/main/java/org/apache/iotdb/commons/auth/user/BasicUserManager.java
@@ -56,7 +56,7 @@ public abstract class BasicUserManager implements IUserManager {
    * @param accessor user accessor
    * @throws AuthException Authentication Exception
    */
-  public BasicUserManager(IUserAccessor accessor) throws AuthException {
+  protected BasicUserManager(IUserAccessor accessor) throws AuthException {
     this.userMap = new HashMap<>();
     this.accessor = accessor;
     this.lock = new HashLock();
diff --git a/node-commons/src/main/java/org/apache/iotdb/commons/conf/CommonConfig.java b/node-commons/src/main/java/org/apache/iotdb/commons/conf/CommonConfig.java
index 3b3b3359f1..57714b683f 100644
--- a/node-commons/src/main/java/org/apache/iotdb/commons/conf/CommonConfig.java
+++ b/node-commons/src/main/java/org/apache/iotdb/commons/conf/CommonConfig.java
@@ -318,6 +318,8 @@ public class CommonConfig {
         logger.info(
             "Change system status to Removing! The current Node is being removed from cluster!");
         break;
+      default:
+        break;
     }
   }
 
diff --git a/node-commons/src/main/java/org/apache/iotdb/commons/conf/IoTDBConstant.java b/node-commons/src/main/java/org/apache/iotdb/commons/conf/IoTDBConstant.java
index 3edf0ffb16..ca68d8283c 100644
--- a/node-commons/src/main/java/org/apache/iotdb/commons/conf/IoTDBConstant.java
+++ b/node-commons/src/main/java/org/apache/iotdb/commons/conf/IoTDBConstant.java
@@ -113,14 +113,13 @@ public class IoTDBConstant {
   public static final String MIN_TIME = "min_time";
   public static final String LAST_VALUE = "last_value";
   public static final int MIN_SUPPORTED_JDK_VERSION = 8;
-  public static final Set<String> reservedWords =
-      new HashSet<String>() {
-        {
-          add("TIME");
-          add("TIMESTAMP");
-          add("ROOT");
-        }
-      };
+  public static final Set<String> reservedWords = new HashSet<>();
+
+  static {
+    reservedWords.add("TIME");
+    reservedWords.add("TIMESTAMP");
+    reservedWords.add("ROOT");
+  }
 
   // show info
   public static final String COLUMN_ITEM = "                             item";
@@ -204,7 +203,7 @@ public class IoTDBConstant {
               MAX_STRING_LENGTH));
 
   // default base dir, stores all IoTDB runtime files
-  public static final String DEFAULT_BASE_DIR = "data" + File.separator + "datanode";
+  public static final String DEFAULT_BASE_DIR = "data" + File.separator + DN_ROLE;
 
   // data folder name
   public static final String DATA_FOLDER_NAME = "data";
diff --git a/node-commons/src/main/java/org/apache/iotdb/commons/partition/DataPartition.java b/node-commons/src/main/java/org/apache/iotdb/commons/partition/DataPartition.java
index ffdc345e1d..f25f0a928f 100644
--- a/node-commons/src/main/java/org/apache/iotdb/commons/partition/DataPartition.java
+++ b/node-commons/src/main/java/org/apache/iotdb/commons/partition/DataPartition.java
@@ -98,7 +98,7 @@ public class DataPartition extends Partition {
         dataBasePartitionMap.get(seriesPartitionSlot);
     for (TTimePartitionSlot timePartitionSlot : timePartitionSlotList) {
       List<TRegionReplicaSet> targetRegionList = slotReplicaSetMap.get(timePartitionSlot);
-      if (targetRegionList == null || targetRegionList.size() == 0) {
+      if (targetRegionList == null || targetRegionList.isEmpty()) {
         throw new RuntimeException(
             String.format(
                 "targetRegionList is empty. device: %s, timeSlot: %s",
diff --git a/node-commons/src/main/java/org/apache/iotdb/commons/partition/Partition.java b/node-commons/src/main/java/org/apache/iotdb/commons/partition/Partition.java
index b139c22596..25b71eb718 100644
--- a/node-commons/src/main/java/org/apache/iotdb/commons/partition/Partition.java
+++ b/node-commons/src/main/java/org/apache/iotdb/commons/partition/Partition.java
@@ -31,7 +31,7 @@ public abstract class Partition {
   // todo decouple this executor with Partition
   private final SeriesPartitionExecutor executor;
 
-  public Partition(String seriesSlotExecutorName, int seriesPartitionSlotNum) {
+  protected Partition(String seriesSlotExecutorName, int seriesPartitionSlotNum) {
     this.seriesSlotExecutorName = seriesSlotExecutorName;
     this.seriesPartitionSlotNum = seriesPartitionSlotNum;
     executor =
diff --git a/node-commons/src/main/java/org/apache/iotdb/commons/partition/executor/hash/BKDRHashExecutor.java b/node-commons/src/main/java/org/apache/iotdb/commons/partition/executor/hash/BKDRHashExecutor.java
index a1f1e05503..47ec3e91d1 100644
--- a/node-commons/src/main/java/org/apache/iotdb/commons/partition/executor/hash/BKDRHashExecutor.java
+++ b/node-commons/src/main/java/org/apache/iotdb/commons/partition/executor/hash/BKDRHashExecutor.java
@@ -23,7 +23,7 @@ import org.apache.iotdb.commons.partition.executor.SeriesPartitionExecutor;
 
 public class BKDRHashExecutor extends SeriesPartitionExecutor {
 
-  private static final int seed = 131;
+  private static final int SEED = 131;
 
   public BKDRHashExecutor(int deviceGroupCount) {
     super(deviceGroupCount);
@@ -34,7 +34,7 @@ public class BKDRHashExecutor extends SeriesPartitionExecutor {
     int hash = 0;
 
     for (int i = 0; i < device.length(); i++) {
-      hash = hash * seed + (int) device.charAt(i);
+      hash = hash * SEED + (int) device.charAt(i);
     }
     hash &= Integer.MAX_VALUE;
 
diff --git a/node-commons/src/main/java/org/apache/iotdb/commons/partition/executor/hash/JSHashExecutor.java b/node-commons/src/main/java/org/apache/iotdb/commons/partition/executor/hash/JSHashExecutor.java
index 19914eed2d..a22db711c4 100644
--- a/node-commons/src/main/java/org/apache/iotdb/commons/partition/executor/hash/JSHashExecutor.java
+++ b/node-commons/src/main/java/org/apache/iotdb/commons/partition/executor/hash/JSHashExecutor.java
@@ -23,7 +23,7 @@ import org.apache.iotdb.commons.partition.executor.SeriesPartitionExecutor;
 
 public class JSHashExecutor extends SeriesPartitionExecutor {
 
-  private static final int base = 1315423911;
+  private static final int BASE = 1315423911;
 
   public JSHashExecutor(int deviceGroupCount) {
     super(deviceGroupCount);
@@ -31,7 +31,7 @@ public class JSHashExecutor extends SeriesPartitionExecutor {
 
   @Override
   public TSeriesPartitionSlot getSeriesPartitionSlot(String device) {
-    int hash = base;
+    int hash = BASE;
 
     for (int i = 0; i < device.length(); i++) {
       hash ^= ((hash << 5) + (int) device.charAt(i) + (hash >> 2));
diff --git a/node-commons/src/main/java/org/apache/iotdb/commons/path/fa/dfa/transition/AbstractDFATransition.java b/node-commons/src/main/java/org/apache/iotdb/commons/path/fa/dfa/transition/AbstractDFATransition.java
index 5118f8079c..ff2120b77f 100644
--- a/node-commons/src/main/java/org/apache/iotdb/commons/path/fa/dfa/transition/AbstractDFATransition.java
+++ b/node-commons/src/main/java/org/apache/iotdb/commons/path/fa/dfa/transition/AbstractDFATransition.java
@@ -30,7 +30,7 @@ abstract class AbstractDFATransition implements IFATransition {
    */
   private final int id; // only used for hash
 
-  public AbstractDFATransition(int index) {
+  protected AbstractDFATransition(int index) {
     this.id = index;
   }
 
diff --git a/node-commons/src/main/java/org/apache/iotdb/commons/security/encrypt/MessageDigestEncrypt.java b/node-commons/src/main/java/org/apache/iotdb/commons/security/encrypt/MessageDigestEncrypt.java
index 54bc65c4da..63ca50413a 100644
--- a/node-commons/src/main/java/org/apache/iotdb/commons/security/encrypt/MessageDigestEncrypt.java
+++ b/node-commons/src/main/java/org/apache/iotdb/commons/security/encrypt/MessageDigestEncrypt.java
@@ -33,9 +33,7 @@ public class MessageDigestEncrypt implements AsymmetricEncrypt {
   private static final String STRING_ENCODING = "utf-8";
 
   @Override
-  public void init(String providerParameters) {
-    return;
-  }
+  public void init(String providerParameters) {}
 
   @Override
   public String encrypt(String originPassword) {
diff --git a/node-commons/src/main/java/org/apache/iotdb/commons/service/AbstractThriftServiceThread.java b/node-commons/src/main/java/org/apache/iotdb/commons/service/AbstractThriftServiceThread.java
index cbdaa6f081..3e315e4b48 100644
--- a/node-commons/src/main/java/org/apache/iotdb/commons/service/AbstractThriftServiceThread.java
+++ b/node-commons/src/main/java/org/apache/iotdb/commons/service/AbstractThriftServiceThread.java
@@ -101,7 +101,7 @@ public abstract class AbstractThriftServiceThread extends Thread {
 
   /** for asynced ThriftService. */
   @SuppressWarnings("squid:S107")
-  public AbstractThriftServiceThread(
+  protected AbstractThriftServiceThread(
       TBaseAsyncProcessor<?> processor,
       String serviceName,
       String threadsName,
@@ -155,7 +155,7 @@ public abstract class AbstractThriftServiceThread extends Thread {
 
   /** for synced ThriftServiceThread */
   @SuppressWarnings("squid:S107")
-  public AbstractThriftServiceThread(
+  protected AbstractThriftServiceThread(
       TProcessor processor,
       String serviceName,
       String threadsName,
diff --git a/node-commons/src/main/java/org/apache/iotdb/commons/sync/pipe/PipeInfo.java b/node-commons/src/main/java/org/apache/iotdb/commons/sync/pipe/PipeInfo.java
index ad01843c84..ca57907354 100644
--- a/node-commons/src/main/java/org/apache/iotdb/commons/sync/pipe/PipeInfo.java
+++ b/node-commons/src/main/java/org/apache/iotdb/commons/sync/pipe/PipeInfo.java
@@ -44,7 +44,7 @@ public abstract class PipeInfo {
   // only used for serialization
   protected PipeInfo() {}
 
-  public PipeInfo(String pipeName, String pipeSinkName, long createTime) {
+  protected PipeInfo(String pipeName, String pipeSinkName, long createTime) {
     this.pipeName = pipeName;
     this.pipeSinkName = pipeSinkName;
     this.createTime = createTime;
@@ -52,7 +52,7 @@ public abstract class PipeInfo {
     this.messageType = PipeMessage.PipeMessageType.NORMAL;
   }
 
-  public PipeInfo(String pipeName, String pipeSinkName, PipeStatus status, long createTime) {
+  protected PipeInfo(String pipeName, String pipeSinkName, PipeStatus status, long createTime) {
     this.pipeName = pipeName;
     this.pipeSinkName = pipeSinkName;
     this.createTime = createTime;
diff --git a/node-commons/src/main/java/org/apache/iotdb/commons/sync/pipesink/IoTDBPipeSink.java b/node-commons/src/main/java/org/apache/iotdb/commons/sync/pipesink/IoTDBPipeSink.java
index f7dfb35b52..1396a88ac8 100644
--- a/node-commons/src/main/java/org/apache/iotdb/commons/sync/pipesink/IoTDBPipeSink.java
+++ b/node-commons/src/main/java/org/apache/iotdb/commons/sync/pipesink/IoTDBPipeSink.java
@@ -35,7 +35,7 @@ import java.util.Objects;
 import java.util.regex.Pattern;
 
 public class IoTDBPipeSink implements PipeSink {
-  private final PipeSinkType pipeSinkType = PipeSinkType.IoTDB;
+  private static final PipeSinkType pipeSinkType = PipeSinkType.IoTDB;
 
   private String name;
   private String ip;
diff --git a/node-commons/src/main/java/org/apache/iotdb/commons/udf/utils/KDTreeUtil.java b/node-commons/src/main/java/org/apache/iotdb/commons/udf/utils/KDTreeUtil.java
index 4df4e7cf79..25bf56f478 100644
--- a/node-commons/src/main/java/org/apache/iotdb/commons/udf/utils/KDTreeUtil.java
+++ b/node-commons/src/main/java/org/apache/iotdb/commons/udf/utils/KDTreeUtil.java
@@ -49,7 +49,7 @@ public class KDTreeUtil {
   }
 
   private void buildDetail(Node node, ArrayList<ArrayList<Double>> data, int dimensions) {
-    if (data.size() == 0) {
+    if (data.isEmpty()) {
       return;
     }
     if (data.size() == 1) {
@@ -90,7 +90,7 @@ public class KDTreeUtil {
     }
     for (ArrayList<Double> d : data) {
       if (d.get(node.partitionDimension) == node.partitionValue) {
-        if (left.size() == 0) {
+        if (left.isEmpty()) {
           left.add(d);
         } else {
           right.add(d);
@@ -129,7 +129,7 @@ public class KDTreeUtil {
     ArrayList<Double> nearest = null;
     Node node;
     double tdis;
-    while (stack.size() != 0) {
+    while (!stack.isEmpty()) {
       node = stack.pop();
       if (node.isLeaf) {
         tdis = UtilZ.distance(input, node.value, std);
@@ -165,7 +165,7 @@ public class KDTreeUtil {
     ArrayList<ArrayList<Double>> nearest = new ArrayList<>();
     Node node;
     double tdis;
-    while (stack.size() != 0) {
+    while (!stack.isEmpty()) {
       node = stack.pop();
       if (node.isLeaf) {
         tdis = UtilZ.distance(input, node.value, std);
@@ -230,7 +230,7 @@ public class KDTreeUtil {
     for (int i = 0; i < min(k, nearest.size()); i++) {
       kNearest.add(findNearest(input, nearest, std));
     }
-    if (kNearest.size() == 0) {
+    if (kNearest.isEmpty()) {
       kNearest.add(node.value);
     }
     for (ArrayList<Double> doubles : kNearest) {
diff --git a/node-commons/src/main/java/org/apache/iotdb/commons/udf/utils/MasterRepairUtil.java b/node-commons/src/main/java/org/apache/iotdb/commons/udf/utils/MasterRepairUtil.java
index 28ae8bb083..9f99a8671b 100644
--- a/node-commons/src/main/java/org/apache/iotdb/commons/udf/utils/MasterRepairUtil.java
+++ b/node-commons/src/main/java/org/apache/iotdb/commons/udf/utils/MasterRepairUtil.java
@@ -152,7 +152,7 @@ public class MasterRepairUtil {
 
   public ArrayList<ArrayList<Double>> calC(int i, ArrayList<Integer> Wi) {
     ArrayList<ArrayList<Double>> Ci = new ArrayList<>();
-    if (Wi.size() == 0) {
+    if (Wi.isEmpty()) {
       Ci.add(this.kdTreeUtil.query(this.td.get(i), std));
     } else {
       Ci.addAll(this.kdTreeUtil.queryKNN(this.td.get(i), k, std));
diff --git a/node-commons/src/main/java/org/apache/iotdb/commons/utils/BasicStructureSerDeUtil.java b/node-commons/src/main/java/org/apache/iotdb/commons/utils/BasicStructureSerDeUtil.java
index 49669553ab..efb6796b80 100644
--- a/node-commons/src/main/java/org/apache/iotdb/commons/utils/BasicStructureSerDeUtil.java
+++ b/node-commons/src/main/java/org/apache/iotdb/commons/utils/BasicStructureSerDeUtil.java
@@ -116,7 +116,7 @@ public class BasicStructureSerDeUtil {
   }
 
   /**
-   * write a int n to byteBuffer.
+   * write an int n to byteBuffer.
    *
    * @return The number of bytes used to represent n.
    */
@@ -126,7 +126,7 @@ public class BasicStructureSerDeUtil {
   }
 
   /**
-   * write a int n to dataOutputStream.
+   * write an int n to dataOutputStream.
    *
    * @return The number of bytes used to represent n.
    */
diff --git a/node-commons/src/main/java/org/apache/iotdb/commons/utils/FileUtils.java b/node-commons/src/main/java/org/apache/iotdb/commons/utils/FileUtils.java
index b7a2b8b9be..6a5e3e0f6c 100644
--- a/node-commons/src/main/java/org/apache/iotdb/commons/utils/FileUtils.java
+++ b/node-commons/src/main/java/org/apache/iotdb/commons/utils/FileUtils.java
@@ -38,7 +38,7 @@ import java.util.Objects;
 public class FileUtils {
   private static final Logger logger = LoggerFactory.getLogger(FileUtils.class);
 
-  private static final int bufferSize = 1024;
+  private static final int BUFFER_SIZE = 1024;
 
   private FileUtils() {}
 
@@ -104,7 +104,7 @@ public class FileUtils {
         // copy file
         try (BufferedInputStream in = new BufferedInputStream(new FileInputStream(file));
             BufferedOutputStream out = new BufferedOutputStream(new FileOutputStream(targetFile))) {
-          byte[] bytes = new byte[bufferSize];
+          byte[] bytes = new byte[BUFFER_SIZE];
           int size = 0;
           while ((size = in.read(bytes)) > 0) {
             out.write(bytes, 0, size);
diff --git a/node-commons/src/main/java/org/apache/iotdb/commons/utils/SerializeUtils.java b/node-commons/src/main/java/org/apache/iotdb/commons/utils/SerializeUtils.java
index 95fd310c88..39316baa64 100644
--- a/node-commons/src/main/java/org/apache/iotdb/commons/utils/SerializeUtils.java
+++ b/node-commons/src/main/java/org/apache/iotdb/commons/utils/SerializeUtils.java
@@ -206,6 +206,8 @@ public class SerializeUtils {
                 case INT32:
                   values[j] = new TsPrimitiveType.TsInt(buffer.getInt());
                   break;
+                default:
+                  break;
               }
             }
           }
@@ -302,6 +304,9 @@ public class SerializeUtils {
           break;
         case DOUBLE:
           serializeDoubleTVPairs(timeValuePairs, dataOutputStream);
+          break;
+        default:
+          break;
       }
     } catch (IOException ignored) {
       // unreachable
@@ -353,6 +358,9 @@ public class SerializeUtils {
           if (timeValuePair.getTimestamp() != Long.MIN_VALUE) {
             dataOutputStream.writeDouble(timeValuePair.getValue().getDouble());
           }
+          break;
+        default:
+          break;
       }
     } catch (IOException e) {
       // unreachable
@@ -463,6 +471,8 @@ public class SerializeUtils {
       case TEXT:
         deserializeTextTVPairs(buffer, ret, size, dataType);
         break;
+      default:
+        break;
     }
     return ret;
   }
@@ -493,8 +503,9 @@ public class SerializeUtils {
         buffer.get(bytes);
         TsPrimitiveType primitiveType = TsPrimitiveType.getByType(dataType, new Binary(bytes));
         return new TimeValuePair(time, primitiveType);
+      default:
+        return null;
     }
-    return null;
   }
 
   public static ByteBuffer serializeFilter(Filter filter) {