增加 String format(Sequences sequences, Integer minLength, String pattern)方法

README.md

@@ -8,15 +8,15 @@
 
 使用方法：
 
-+ 在项目中放置jar包的地方把seq-1.0.0.jar、seq-1.0.0-sources.jar、seq-1.0.0-pom.xml复制过去
++ 在项目中放置jar包的地方把seq-1.1.0.jar、seq-1.1.0-sources.jar、seq-1.1.0-pom.xml复制过去
 + 在pom.xml中增加以下内容，然后执行maven命令：mvn clean
 
 ```xml
 
-<build>
+<project>
     <dependencies>
         <dependency>
-            <groupId>com.cdhncy</groupId>
+            <groupId>com.yanghuanglin</groupId>
             <artifactId>seq</artifactId>
             <version>1.0.0</version>
             <exclusions>
@@ -34,6 +34,8 @@
         </dependency>
     </dependencies>
     
+    <build>
+        <plugins>
             <!-- 每次执行mvn clean时，自动安装指定的jar包 -->
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
@@ -48,11 +50,11 @@
                         </goals>
                         <configuration>
                             <!-- ${project.basedir}表示当前项目的根目录 -->
-                    <file>${project.basedir}/lib/seq-1.0.0.jar</file>
+                            <file>${project.basedir}/lib/seq-1.1.0.jar</file>
-                    <pomFile>${pom.basedir}/lib/seq-1.0.0-pom.xml</pomFile>
+                            <pomFile>${pom.basedir}/lib/seq-1.1.0-pom.xml</pomFile>
-                    <sources>${project.basedir}/lib/seq-1.0.0-sources.jar</sources>
+                            <sources>${project.basedir}/lib/seq-1.1.0-sources.jar</sources>
                             <repositoryLayout>default</repositoryLayout>
-                    <groupId>com.cdhncy</groupId>
+                            <groupId>com.yanghuanglin</groupId>
                             <artifactId>seq</artifactId>
                             <version>1.0.0</version>
                             <packaging>jar</packaging>
@@ -61,18 +63,20 @@
                     </execution>
                 </executions>
             </plugin>
+        </plugins>
     </build>
+</project>
 ```
 
 + springboot中配置方式一（优先）：直接注入已有jdbcTemplate和transactionTemplate
 
 ```java
-package com.yang.springseq.config;
+package com.yanghuanglin.springseq.config;
 
-import com.cdhncy.seq.config.GeneratorConfig;
+import com.yanghuanglin.seq.config.GeneratorConfig;
-import com.cdhncy.seq.config.TableConfig;
+import com.yanghuanglin.seq.config.TableConfig;
-import com.cdhncy.seq.generator.Generator;
+import com.yanghuanglin.seq.generator.Generator;
-import com.cdhncy.seq.generator.impl.SequencesGenerator;
+import com.yanghuanglin.seq.generator.impl.SequencesGenerator;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.jdbc.core.JdbcTemplate;
@@ -138,16 +142,14 @@ public class SeqGeneratorConfig {
 + springboot中配置方式二：注入已有的dataSource或自行构建dataSource，通过dataSource自动生成jdbcTemplate和transactionTemplate
 
 ```java
-package com.yang.springseq.config;
+package com.yanghuanglin.springseq.config;
 
-import com.cdhncy.seq.config.GeneratorConfig;
+import com.yanghuanglin.seq.config.GeneratorConfig;
-import com.cdhncy.seq.config.TableConfig;
+import com.yanghuanglin.seq.config.TableConfig;
-import com.cdhncy.seq.generator.Generator;
+import com.yanghuanglin.seq.generator.Generator;
-import com.cdhncy.seq.generator.impl.SequencesGenerator;
+import com.yanghuanglin.seq.generator.impl.SequencesGenerator;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
-import org.springframework.jdbc.core.JdbcTemplate;
-import org.springframework.transaction.support.TransactionTemplate;
 
 import javax.annotation.Resource;
 import javax.sql.DataSource;
@@ -203,10 +205,10 @@ public class SeqGeneratorConfig {
 + 使用：
 
 ```java
-package com.yang.springseq.config;
+package com.yanghuanglin.springseq.config;
 
-import com.cdhncy.seq.generator.Generator;
+import com.yanghuanglin.seq.generator.Generator;
-import com.cdhncy.seq.po.Sequences;
+import com.yanghuanglin.seq.po.Sequences;
 import org.springframework.stereotype.Component;
 import org.springframework.stereotype.Service;
 
@@ -277,7 +279,7 @@ GeneratorConfig配置项，通过set方法设置
 | transactionManager  | org.springframework.jdbc.datasource.DataSourceTransactionManager | null             | 事务管理器    |
 | autoCreate          | Boolean                                                          | true             | 开启自动建表   |
 | step                | Integer                                                          | 1                | 序号增加时的步长 |
-| tableConfig         | com.cdhncy.seq.config.TableConfig                                | TableConfig的默认配置 | 表配置      |
+| tableConfig         | com.yanghuanglin.seq.config.TableConfig                                | TableConfig的默认配置 | 表配置      |
 
 以上配置中，jdbcTemplate和transactionTemplate优先级最高，如果jdbcTemplate、transactionTemplate、dataSource、transactionManager同时配置，则dataSource和transactionManager无效；
 进行这几种组合：dataSource+autoCreate+step+tableConfig，jdbcTemplate+transactionTemplate+autoCreate+step+tableConfig，jdbcTemplate+transactionManager+autoCreate+step+tableConfig
@@ -286,11 +288,11 @@ GeneratorConfig配置项，通过set方法设置
 Generator方法如下：
 
 ```java
-package com.cdhncy.seq.generator;
+package com.yanghuanglin.seq.generator;
 
-import com.cdhncy.seq.po.Sequences;
+import com.yanghuanglin.seq.po.Sequences;
-import com.cdhncy.seq.po.SequencesUnlock;
+import com.yanghuanglin.seq.po.SequencesUnlock;
-import com.cdhncy.seq.po.SequencesUnused;
+import com.yanghuanglin.seq.po.SequencesUnused;
 
 import java.util.Date;
 

pom.xml

@@ -2,9 +2,9 @@
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
-    <groupId>com.cdhncy</groupId>
+    <groupId>com.yanghuanglin</groupId>
     <artifactId>seq</artifactId>
-    <version>1.0.0</version>
+    <version>1.1.0</version>
     <name>seq</name>
     <description>seq</description>
     <properties>
@@ -34,6 +34,7 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-compiler-plugin</artifactId>
+                <version>3.1</version>
                 <configuration>
                     <source>8</source>
                     <target>8</target>

src/main/java/com/yanghuanglin/seq/config/GeneratorConfig.java

@@ -1,4 +1,4 @@
-package com.cdhncy.seq.config;
+package com.yanghuanglin.seq.config;
 
 import org.springframework.jdbc.core.JdbcTemplate;
 import org.springframework.jdbc.datasource.DataSourceTransactionManager;

src/main/java/com/yanghuanglin/seq/config/TableConfig.java

@@ -1,4 +1,4 @@
-package com.cdhncy.seq.config;
+package com.yanghuanglin.seq.config;
 
 /**
  * 生成器对应的数据库表和字段配置

src/main/java/com/yanghuanglin/seq/dao/SequencesDao.java

@@ -1,6 +1,6 @@
-package com.cdhncy.seq.dao;
+package com.yanghuanglin.seq.dao;
 
-import com.cdhncy.seq.po.Sequences;
+import com.yanghuanglin.seq.po.Sequences;
 
 /**
  * @author yanghuanglin

src/main/java/com/yanghuanglin/seq/dao/SequencesUnlockDao.java

@@ -1,6 +1,6 @@
-package com.cdhncy.seq.dao;
+package com.yanghuanglin.seq.dao;
 
-import com.cdhncy.seq.po.SequencesUnlock;
+import com.yanghuanglin.seq.po.SequencesUnlock;
 
 import java.util.Date;
 import java.util.List;

src/main/java/com/yanghuanglin/seq/dao/SequencesUnusedDao.java

@@ -1,6 +1,6 @@
-package com.cdhncy.seq.dao;
+package com.yanghuanglin.seq.dao;
 
-import com.cdhncy.seq.po.SequencesUnused;
+import com.yanghuanglin.seq.po.SequencesUnused;
 
 import java.util.List;
 
@@ -25,6 +25,11 @@ public interface SequencesUnusedDao {
      */
     boolean delete(SequencesUnused sequencesUnused);
 
+    /**
+     * 保存空闲序号
+     */
+    boolean save(SequencesUnused sequencesUnused);
+
     /**
      * 批量保存空闲序号
      */

src/main/java/com/yanghuanglin/seq/dao/impl/SequencesDaoImpl.java

@@ -1,8 +1,8 @@
-package com.cdhncy.seq.dao.impl;
+package com.yanghuanglin.seq.dao.impl;
 
-import com.cdhncy.seq.config.TableConfig;
+import com.yanghuanglin.seq.config.TableConfig;
-import com.cdhncy.seq.dao.SequencesDao;
+import com.yanghuanglin.seq.dao.SequencesDao;
-import com.cdhncy.seq.po.Sequences;
+import com.yanghuanglin.seq.po.Sequences;
 import org.springframework.dao.EmptyResultDataAccessException;
 import org.springframework.jdbc.core.JdbcTemplate;
 
@@ -11,6 +11,7 @@ import org.springframework.jdbc.core.JdbcTemplate;
  * @author yanghuanglin
  * @since 2022/1/28
  */
+@SuppressWarnings("SqlResolve")
 public class SequencesDaoImpl implements SequencesDao {
     private final JdbcTemplate jdbcTemplate;
     private final TableConfig tableConfig;

src/main/java/com/yanghuanglin/seq/dao/impl/SequencesUnlockDaoImpl.java

@@ -1,8 +1,8 @@
-package com.cdhncy.seq.dao.impl;
+package com.yanghuanglin.seq.dao.impl;
 
-import com.cdhncy.seq.config.TableConfig;
+import com.yanghuanglin.seq.config.TableConfig;
-import com.cdhncy.seq.dao.SequencesUnlockDao;
+import com.yanghuanglin.seq.dao.SequencesUnlockDao;
-import com.cdhncy.seq.po.SequencesUnlock;
+import com.yanghuanglin.seq.po.SequencesUnlock;
 import org.springframework.jdbc.core.JdbcTemplate;
 import org.springframework.jdbc.core.RowMapper;
 
@@ -13,6 +13,7 @@ import java.util.List;
  * @author yanghuanglin
  * @since 2022/1/28
  */
+@SuppressWarnings("SqlResolve")
 public class SequencesUnlockDaoImpl implements SequencesUnlockDao {
     private final JdbcTemplate jdbcTemplate;
     private final TableConfig tableConfig;

src/main/java/com/yanghuanglin/seq/dao/impl/SequencesUnusedDaoImpl.java

@@ -1,8 +1,8 @@
-package com.cdhncy.seq.dao.impl;
+package com.yanghuanglin.seq.dao.impl;
 
-import com.cdhncy.seq.config.TableConfig;
+import com.yanghuanglin.seq.config.TableConfig;
-import com.cdhncy.seq.dao.SequencesUnusedDao;
+import com.yanghuanglin.seq.dao.SequencesUnusedDao;
-import com.cdhncy.seq.po.SequencesUnused;
+import com.yanghuanglin.seq.po.SequencesUnused;
 import org.springframework.dao.EmptyResultDataAccessException;
 import org.springframework.jdbc.core.BatchPreparedStatementSetter;
 import org.springframework.jdbc.core.JdbcTemplate;
@@ -16,6 +16,7 @@ import java.util.List;
  * @author yanghuanglin
  * @since 2022/1/28
  */
+@SuppressWarnings("SqlResolve")
 public class SequencesUnusedDaoImpl implements SequencesUnusedDao {
     private final JdbcTemplate jdbcTemplate;
     private final TableConfig tableConfig;
@@ -55,6 +56,14 @@ public class SequencesUnusedDaoImpl implements SequencesUnusedDao {
         return result != 0;
     }
 
+    @Override
+    public boolean save(SequencesUnused sequencesUnused) {
+        String sql = "insert into `%s_ununsed`(`%s`,`%s`,`%s`) values(?,?,?)";
+        sql = String.format(sql, tableConfig.getTable(), tableConfig.getKeyColumn(), tableConfig.getTypeColumn(), tableConfig.getSeqColumn());
+        int result = this.jdbcTemplate.update(sql, sequencesUnused.getKey(), sequencesUnused.getType(), sequencesUnused.getSeq());
+        return result != 0;
+    }
+
     @Override
     public boolean saveBatch(List<SequencesUnused> sequencesUnusedList) {
         String sql = "insert into `%s_ununsed`(`%s`,`%s`,`%s`) values(?,?,?)";

src/main/java/com/yanghuanglin/seq/generator/Generator.java

@@ -1,8 +1,8 @@
-package com.cdhncy.seq.generator;
+package com.yanghuanglin.seq.generator;
 
-import com.cdhncy.seq.po.Sequences;
+import com.yanghuanglin.seq.po.Sequences;
-import com.cdhncy.seq.po.SequencesUnlock;
+import com.yanghuanglin.seq.po.SequencesUnlock;
-import com.cdhncy.seq.po.SequencesUnused;
+import com.yanghuanglin.seq.po.SequencesUnused;
 
 import java.util.Date;
 
@@ -50,6 +50,16 @@ public interface Generator {
      */
     String generate(String key, String type, Integer minLength);
 
+    /**
+     * 将{@link #generate(String, String)}得到的序号对象格式化为补零后的序号字符串。实际上只会用到{@link Sequences#getSeq()}属性
+     *
+     * @param sequences 生成的序号对象
+     * @param minLength 序号数字最小长度
+     * @param pattern   格式
+     * @return 格式化后的字符串
+     */
+    String format(Sequences sequences, Integer minLength, String pattern);
+
     /**
      * 将生成的序号对象格式化为指定格式
      * <p/>
@@ -111,4 +121,11 @@ public interface Generator {
      * @param end   结束时间
      */
     void release(Date begin, Date end);
+
+    /**
+     * 释放指定序号。一般用于业务对象删除后，对应序号需要回收使用时。
+     *
+     * @param sequences 需要释放的序号。一般是一个通过{@link Sequences#setKey(String)}、{@link Sequences#setType(String)}、{@link Sequences#setSeq(Long)}三方法一起手动构建或通过{@link Sequences#Sequences(String, String, Long)}构造方法构建的实例对象
+     */
+    void release(Sequences sequences);
 }

src/main/java/com/yanghuanglin/seq/generator/impl/SequencesGenerator.java

@@ -1,23 +1,26 @@
-package com.cdhncy.seq.generator.impl;
+package com.yanghuanglin.seq.generator.impl;
 
-import com.cdhncy.seq.config.GeneratorConfig;
+import com.yanghuanglin.seq.config.GeneratorConfig;
-import com.cdhncy.seq.dao.SequencesDao;
+import com.yanghuanglin.seq.dao.SequencesDao;
-import com.cdhncy.seq.dao.SequencesUnusedDao;
+import com.yanghuanglin.seq.dao.SequencesUnlockDao;
-import com.cdhncy.seq.dao.SequencesUnlockDao;
+import com.yanghuanglin.seq.dao.SequencesUnusedDao;
-import com.cdhncy.seq.dao.impl.SequencesDaoImpl;
+import com.yanghuanglin.seq.dao.impl.SequencesDaoImpl;
-import com.cdhncy.seq.dao.impl.SequencesUnusedDaoImpl;
+import com.yanghuanglin.seq.dao.impl.SequencesUnlockDaoImpl;
-import com.cdhncy.seq.dao.impl.SequencesUnlockDaoImpl;
+import com.yanghuanglin.seq.dao.impl.SequencesUnusedDaoImpl;
-import com.cdhncy.seq.po.Sequences;
+import com.yanghuanglin.seq.generator.Generator;
-import com.cdhncy.seq.po.SequencesUnused;
+import com.yanghuanglin.seq.po.Sequences;
-import com.cdhncy.seq.po.SequencesUnlock;
+import com.yanghuanglin.seq.po.SequencesUnlock;
-import com.cdhncy.seq.generator.Generator;
+import com.yanghuanglin.seq.po.SequencesUnused;
 import org.springframework.jdbc.core.JdbcTemplate;
 import org.springframework.jdbc.datasource.DataSourceTransactionManager;
 import org.springframework.jdbc.support.JdbcTransactionManager;
 import org.springframework.transaction.support.TransactionTemplate;
 
 import javax.sql.DataSource;
-import java.util.*;
+import java.util.ArrayList;
+import java.util.Calendar;
+import java.util.Date;
+import java.util.List;
 
 public class SequencesGenerator implements Generator {
     private final TransactionTemplate transactionTemplate;
@@ -129,6 +132,11 @@ public class SequencesGenerator implements Generator {
         return sequences.format(minLength);
     }
 
+    @Override
+    public String format(Sequences sequences, Integer minLength, String pattern) {
+        return format(sequences.getSeq(), minLength, pattern);
+    }
+
     @Override
     public String format(Long seq, Integer minLength, String pattern) {
         return format(seq, null, minLength, pattern);
@@ -185,4 +193,10 @@ public class SequencesGenerator implements Generator {
         //删除指定时间段内使用中表的数据
         sequencesUnlockDao.deleteByDate(begin, end);
     }
+
+    @Override
+    public void release(Sequences sequences) {
+        sequencesUnlockDao.delete(new SequencesUnlock(sequences));
+        sequencesUnusedDao.save(new SequencesUnused(sequences));
+    }
 }

src/main/java/com/yanghuanglin/seq/po/Sequences.java

@@ -1,4 +1,4 @@
-package com.cdhncy.seq.po;
+package com.yanghuanglin.seq.po;
 
 
 /**
@@ -35,6 +35,12 @@ public class Sequences {
         this.type = type;
     }
 
+    public Sequences(String key, String type, Long seq) {
+        this.key = key;
+        this.type = type;
+        this.seq = seq;
+    }
+
     public Sequences(SequencesUnused sequencesUnused) {
         this.key = sequencesUnused.getKey();
         this.type = sequencesUnused.getType();

src/main/java/com/yanghuanglin/seq/po/SequencesUnlock.java

@@ -1,4 +1,4 @@
-package com.cdhncy.seq.po;
+package com.yanghuanglin.seq.po;
 
 
 import java.util.Date;

src/main/java/com/yanghuanglin/seq/po/SequencesUnused.java

@@ -1,4 +1,4 @@
-package com.cdhncy.seq.po;
+package com.yanghuanglin.seq.po;
 
 
 /**

src/test/java/SeqTest.java

@@ -1,8 +1,8 @@
-import com.cdhncy.seq.config.GeneratorConfig;
+import com.yanghuanglin.seq.config.GeneratorConfig;
-import com.cdhncy.seq.config.TableConfig;
+import com.yanghuanglin.seq.config.TableConfig;
-import com.cdhncy.seq.po.Sequences;
+import com.yanghuanglin.seq.po.Sequences;
-import com.cdhncy.seq.generator.Generator;
+import com.yanghuanglin.seq.generator.Generator;
-import com.cdhncy.seq.generator.impl.SequencesGenerator;
+import com.yanghuanglin.seq.generator.impl.SequencesGenerator;
 import com.mysql.cj.jdbc.MysqlDataSource;
 import org.junit.Test;