1. add coverage test

2. add travis CI
3. remove unnecessary lib
4. fix security problems

Author: antonybi

.travis.yml

@@ -1,4 +1,7 @@
 language: java
 
 jdk:
-  - openjdk8
+  - openjdk8
+
+after_success:
+  - mvn clean test jacoco:report coveralls:report

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>io.github.antonybi</groupId>
     <artifactId>timechannel</artifactId>
-    <version>1.1.0</version>
+    <version>1.1.1</version>
 
     <name>timechannel</name>
     <description>snowflake guid sdk</description>
@@ -33,8 +33,7 @@
     <properties>
         <java.version>8</java.version>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-        <spring-boot.version>2.3.12.RELEASE</spring-boot.version>
-        <junit.version>5.6.2</junit.version>
+        <spring-boot.version>2.6.11</spring-boot.version>
     </properties>
 
     <dependencies>
@@ -45,12 +44,6 @@
         </dependency>
 
         <!-- TOOL -->
-        <dependency>
-            <groupId>org.projectlombok</groupId>
-            <artifactId>lombok</artifactId>
-            <scope>provided</scope>
-        </dependency>
-
         <dependency>
             <groupId>javax.el</groupId>
             <artifactId>javax.el-api</artifactId>
@@ -66,7 +59,7 @@
         <dependency>
             <groupId>redis.clients</groupId>
             <artifactId>jedis</artifactId>
-            <version>4.2.0</version>
+            <version>4.2.3</version>
         </dependency>
 
         <!-- SPRING -->
@@ -98,12 +91,6 @@
                 </exclusion>
             </exclusions>
         </dependency>
-        <dependency>
-            <groupId>org.junit.jupiter</groupId>
-            <artifactId>junit-jupiter-api</artifactId>
-            <version>${junit.version}</version>
-            <scope>test</scope>
-        </dependency>
     </dependencies>
 
     <dependencyManagement>
@@ -137,6 +124,31 @@
                     <target>${java.version}</target>
                 </configuration>
             </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-surefire-plugin</artifactId>
+                <version>2.22.2</version>
+            </plugin>
+            <plugin>
+                <groupId>org.jacoco</groupId>
+                <artifactId>jacoco-maven-plugin</artifactId>
+                <version>0.8.8</version>
+                <executions>
+                    <execution>
+                        <id>prepare-agent</id>
+                        <goals>
+                            <goal>prepare-agent</goal>
+                        </goals>
+                    </execution>
+                    <execution>
+                        <id>generate-code-coverage-report</id>
+                        <phase>test</phase>
+                        <goals>
+                            <goal>report</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
         </plugins>
     </build>
 
@@ -172,17 +184,6 @@
                         </executions>
                     </plugin>
                     <plugin>
-                        <groupId>org.sonatype.plugins</groupId>
-                        <artifactId>nexus-staging-maven-plugin</artifactId>
-                        <version>1.6.7</version>
-                        <extensions>true</extensions>
-                        <configuration>
-                            <serverId>ossrh</serverId>
-                            <nexusUrl>https://s01.oss.sonatype.org/</nexusUrl>
-                            <autoReleaseAfterClose>true</autoReleaseAfterClose>
-                        </configuration>
-                    </plugin>
-                     <plugin>
                         <groupId>org.apache.maven.plugins</groupId>
                         <artifactId>maven-gpg-plugin</artifactId>
                         <version>1.6</version>
@@ -196,6 +197,25 @@
                             </execution>
                         </executions>
                     </plugin>
+                    <plugin>
+                        <groupId>org.eluder.coveralls</groupId>
+                        <artifactId>coveralls-maven-plugin</artifactId>
+                        <version>4.3.0</version>
+                        <configuration>
+                            <repoToken>yavqijXiUmoq93guQTknXuB9JEfpNc8v7</repoToken>
+                        </configuration>
+                    </plugin>
+                    <plugin>
+                        <groupId>org.sonatype.plugins</groupId>
+                        <artifactId>nexus-staging-maven-plugin</artifactId>
+                        <version>1.6.7</version>
+                        <extensions>true</extensions>
+                        <configuration>
+                            <serverId>ossrh</serverId>
+                            <nexusUrl>https://s01.oss.sonatype.org/</nexusUrl>
+                            <autoReleaseAfterClose>true</autoReleaseAfterClose>
+                        </configuration>
+                    </plugin>
                 </plugins>
             </build>
         </profile>

src/main/java/timechannel/Guid.java

@@ -1,6 +1,5 @@
 package timechannel;
 
-import lombok.extern.slf4j.Slf4j;
 import org.springframework.stereotype.Component;
 import timechannel.core.Generator;
 
@@ -14,7 +13,6 @@
  * @author antonybi
  * @since 2022/08/18
  */
-@Slf4j
 @Component
 public class Guid {
 

src/main/java/timechannel/core/Allocator.java

@@ -1,7 +1,8 @@
 package timechannel.core;
 
-import lombok.extern.slf4j.Slf4j;
 import org.apache.commons.io.IOUtils;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.stereotype.Component;
 import org.springframework.util.Assert;
@@ -21,9 +22,10 @@
  * @since 2022/08/18
  */
 @Component
-@Slf4j
 public class Allocator {
 
+    private final Logger log = LoggerFactory.getLogger(Allocator.class);
+
     private Jedis jedis;
 
     /**
@@ -99,11 +101,7 @@ private Lease doGrant(int channelQuantity, Duration ttl, String appName) {
             throw new TimeChannelInternalException("no idle channel: " + Arrays.toString(response.toArray()));
         }
 
-        return Lease.builder()
-                .channel(response.get(1))
-                .effectiveTime(response.get(2))
-                .expiryTime(response.get(3))
-                .build();
+        return new Lease(response.get(1), response.get(2), response.get(3));
     }
 
     /**

src/main/java/timechannel/core/Generator.java

@@ -1,10 +1,10 @@
 package timechannel.core;
 
-import lombok.extern.slf4j.Slf4j;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.stereotype.Component;
-import timechannel.exception.TimeChannelConfigException;
-import timechannel.exception.TimeChannelInternalException;
+import org.springframework.util.Assert;
 
 import javax.annotation.PostConstruct;
 import javax.annotation.Resource;
@@ -32,9 +32,10 @@
  * @since 2022/08/18
  */
 @Component
-@Slf4j
 public class Generator {
 
+    private final Logger log = LoggerFactory.getLogger(Generator.class);
+
     /**
      * id生成的锁，此处采用非公平锁以保证性能
      */
@@ -122,13 +123,12 @@ public class Generator {
     @PostConstruct
     public void init() {
         // 配置检查
-        if (groupBits + channelBits + sequenceBits > CONFIGURABLE_BITS) {
-            throw new TimeChannelConfigException("groupBits+channelBits+sequenceBits should be less than " + CONFIGURABLE_BITS);
-        }
+        Assert.isTrue(groupBits + channelBits + sequenceBits <= CONFIGURABLE_BITS,
+                "groupBits+channelBits+sequenceBits should be less than " + CONFIGURABLE_BITS);
+
         int groupRange = (int) Math.pow(2, groupBits);
-        if (groupId < 0 || groupId >= groupRange) {
-            throw new TimeChannelConfigException(String.format("group id %d should be in group range [0, %d)", groupId, groupRange));
-        }
+        Assert.isTrue(groupId >= 0 && groupId < groupRange,
+                String.format("group id %d should be in group range [0, %d)", groupId, groupRange));
 
         // 修正本地时间与lease时间差值
         localEffectiveTime = System.nanoTime();
@@ -140,27 +140,34 @@ public void init() {
         lease = allocator.grant(channelQuantity, ttl, appName);
 
         // 开启异步的续期线程
-        Thread renewThread = new Thread(() -> {
-            while (true) {
-                try {
-                    // 这里线程启动后立刻执行续期，是为了尽早暴露续期的异常
-                    allocator.renew(lease, ttl);
+        Thread renewThread = new Thread(this::renewInLoop, "GUID Renew Thread");
+        renewThread.start();
+    }
 
-                    // 这里需要提前更新，避免到期后更新的等待时间
-                    Thread.sleep(ttl.toMillis() / 2);
-                } catch (InterruptedException e) {
-                    Thread.currentThread().interrupt();
-                } catch (Exception e) {
+    private void renewInLoop() {
+        while (true) {
+            try {
+                // 这里线程启动后立刻执行续期，是为了尽早暴露续期的异常
+                allocator.renew(lease, ttl);
+
+                // 这里需要提前更新，避免到期后更新的等待时间
+                Thread.sleep(ttl.toMillis() / 2);
+            } catch (InterruptedException e) {
+                Thread.currentThread().interrupt();
+            } catch (Exception e) {
+                if (getLocalServerTime() >= lease.getExpiryTime()) {
+                    // 租约已经过期，正常情况有续期异步线程，不应该出现此现象
+                    log.error("lease has expired: {}", lease);
+                } else {
                     log.warn("renew lease failed, retry later", e);
-                    try {
-                        Thread.sleep(ERROR_WAIT);
-                    } catch (InterruptedException ie) {
-                        Thread.currentThread().interrupt();
-                    }
+                }
+                try {
+                    Thread.sleep(ERROR_WAIT);
+                } catch (InterruptedException ie) {
+                    Thread.currentThread().interrupt();
                 }
             }
-        }, "GUID Renew Thread");
-        renewThread.start();
+        }
     }
 
     /**
@@ -195,7 +202,6 @@ private <T> T next(Supplier<T> supplier) {
                     try {
                         Thread.sleep(ERROR_WAIT);
                     } catch (InterruptedException interruptedException) {
-                        log.info("interrupted", e);
                         Thread.currentThread().interrupt();
                     }
                 }
@@ -207,8 +213,7 @@ private <T> T next(Supplier<T> supplier) {
     }
 
     private long fetchSequence() {
-        // 这里需要采用nanoTime单调时钟用于计时，避免本地时钟回拨的问题
-        long localServerTime = (System.nanoTime() - localEffectiveTime) / 1000000 + lease.getEffectiveTime();
+        long localServerTime = getLocalServerTime();
 
         // 时间片过期
         if (localServerTime > lastTimeSlice) {
@@ -232,6 +237,11 @@ private long fetchSequence() {
         return seq++;
     }
 
+    private long getLocalServerTime() {
+        // 这里需要采用nanoTime单调时钟用于计时，避免本地时钟回拨的问题
+        return (System.nanoTime() - localEffectiveTime) / 1000000 + lease.getEffectiveTime();
+    }
+
     public LocalDateTime parseDateTime(long guid) {
         return LocalDateTime.ofInstant(
                 Instant.ofEpochMilli(guid >> (channelBits + sequenceBits)),

src/main/java/timechannel/core/Lease.java

@@ -1,17 +1,10 @@
 package timechannel.core;
 
-import lombok.*;
-
 /**
  * 频道的租约
  * @author antonybi
  * @since 2022/08/18
  */
-@Data
-@Builder
-@NoArgsConstructor
-@AllArgsConstructor
-@ToString
 public class Lease {
 
     /**
@@ -25,8 +18,47 @@ public class Lease {
     private long effectiveTime;
 
     /**
-     * 过期时间（注：这里虽然涉及多线程操作，但是逻辑上既做了提前更新，且含义上读取到旧值不会有任何问题，故没使用并发类）
+     * 过期时间
      */
     private long expiryTime;
 
+    long getChannel() {
+        return channel;
+    }
+
+    void setChannel(long channel) {
+        this.channel = channel;
+    }
+
+    long getEffectiveTime() {
+        return effectiveTime;
+    }
+
+    void setEffectiveTime(long effectiveTime) {
+        this.effectiveTime = effectiveTime;
+    }
+
+    long getExpiryTime() {
+        return expiryTime;
+    }
+
+    void setExpiryTime(long expiryTime) {
+        this.expiryTime = expiryTime;
+    }
+
+    Lease(long channel, long effectiveTime, long expiryTime) {
+        this.channel = channel;
+        this.effectiveTime = effectiveTime;
+        this.expiryTime = expiryTime;
+    }
+
+    @Override
+    public String toString() {
+        return "Lease{" +
+                "channel=" + channel +
+                ", effectiveTime=" + effectiveTime +
+                ", expiryTime=" + expiryTime +
+                '}';
+    }
+
 }