diff --git a/README.md b/README.md index 754ad69..4c2fd63 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,9 @@ 用于生成全局自增序号,跳过的序号可以回收使用。 -***本生成器内部使用transactionTemplate进行事务管理,如果你项目中给使用此生成器的方法或类加了`@Transactional`注解,则需将新建一个Service来专门负责调用此生成器的方法,同时要给新建的类增加`@Transactional`注解,并设置`propagation = Propagation.NOT_SUPPORTED`*** +***本生成器内部使用transactionTemplate进行事务管理,如果你项目中给使用此生成器的方法或类加了`@Transactional` +注解,则需将新建一个Service来专门负责调用此生成器的方法,同时要给新建的类增加`@Transactional` +注解,并设置`propagation = Propagation.NOT_SUPPORTED`*** --- @@ -204,16 +206,16 @@ TableConfig配置项,通过set方法设置(一般不用改,如果已有相 GeneratorConfig配置项,通过set方法设置 -| 配置项 | 类型 | 默认值 | 说明 | -|---------------------|------------------------------------------------------------------|------------------|------------------| -| dataSource | javax.sql.DataSource | null | 数据源 | -| monthZeroFilling | Boolean | true | 月份不足2位时自动补零 | -| dayZeroFilling | Boolean | true | 当前日期不足2位时自动补零 | -| autoCreate | Boolean | true | 开启自动建表 | -| step | Integer | 1 | 序号增加时的步长 | -| type | String | DEFAULT | 默认序号类型 | -| minLength | Integer | 1 | 默认序号格式化后长度,不足的补零 | -| tableConfig | com.yanghuanglin.seq.baseConfig.TableConfig | TableConfig的默认配置 | 表配置 | +| 配置项 | 类型 | 默认值 | 说明 | +|------------------|---------------------------------------------|------------------|------------------| +| dataSource | javax.sql.DataSource | null | 数据源 | +| monthZeroFilling | Boolean | true | 月份不足2位时自动补零 | +| dayZeroFilling | Boolean | true | 当前日期不足2位时自动补零 | +| autoCreate | Boolean | true | 开启自动建表 | +| step | Integer | 1 | 序号增加时的步长 | +| type | String | DEFAULT | 默认序号类型 | +| minLength | Integer | 1 | 默认序号格式化后长度,不足的补零 | +| tableConfig | com.yanghuanglin.seq.baseConfig.TableConfig | TableConfig的默认配置 | 表配置 | --- Generator方法如下: @@ -299,7 +301,7 @@ public interface Generator { /** * 将{@link #generate(String, String, Boolean)}得到的序号对象格式化为补零后的序号字符串,其最小长度通过{@link BaseConfig#getMinLength()}设定。实际上只会用到{@link Sequences#getSeq()}属性 *

- * pattern支持:{@link FormatPlaceholder#YEAR}(当前年份)、{@link FormatPlaceholder#MONTH}}(当前月份)、{@link FormatPlaceholder#DAY}}(当前日期)、{@link FormatPlaceholder#SEQ}}(生成的字符串序号)几个枚举值通过{@link FormatPlaceholder#getPlaceholder()}得到的字符串 + * pattern支持:{@link FormatPlaceholder#YEAR}(当前年份)、{@link FormatPlaceholder#MONTH}(当前月份)、{@link FormatPlaceholder#DAY}(当前日期)、{@link FormatPlaceholder#FIX}(固定字符串)、{@link FormatPlaceholder#SEQ}(生成的字符串序号)几个枚举值通过{@link FormatPlaceholder#getPlaceholder()}得到的字符串 * * @param sequences 生成的序号对象 * @param pattern 格式 @@ -310,7 +312,7 @@ public interface Generator { /** * 将{@link #generate(String, String, Boolean)}得到的序号对象格式化为补零后的序号字符串。实际上只会用到{@link Sequences#getSeq()}属性 *

- * pattern支持:{@link FormatPlaceholder#YEAR}(当前年份)、{@link FormatPlaceholder#MONTH}}(当前月份)、{@link FormatPlaceholder#DAY}}(当前日期)、{@link FormatPlaceholder#SEQ}}(生成的字符串序号)几个枚举值通过{@link FormatPlaceholder#getPlaceholder()}得到的字符串 + * pattern支持:{@link FormatPlaceholder#YEAR}(当前年份)、{@link FormatPlaceholder#MONTH}(当前月份)、{@link FormatPlaceholder#DAY}(当前日期)、{@link FormatPlaceholder#FIX}(固定字符串)、{@link FormatPlaceholder#SEQ}(生成的字符串序号)几个枚举值通过{@link FormatPlaceholder#getPlaceholder()}得到的字符串 * * @param sequences 生成的序号对象 * @param minLength 序号数字最小长度 @@ -322,7 +324,7 @@ public interface Generator { /** * 将生成的序号对象格式化为指定格式,格式化后字符串最小长度为{@link BaseConfig#getMinLength()},不足则补零 *

- * pattern支持:{@link FormatPlaceholder#YEAR#getPlaceholder()}(当前年份)、{@link FormatPlaceholder#MONTH#getPlaceholder()}(当前月份)、{@link FormatPlaceholder#DAY#getPlaceholder()}(当前日期)、{@link FormatPlaceholder#SEQ#getPlaceholder()}(生成的字符串序号)四个变量 + * pattern支持:{@link FormatPlaceholder#YEAR}(当前年份)、{@link FormatPlaceholder#MONTH}(当前月份)、{@link FormatPlaceholder#DAY}(当前日期)、{@link FormatPlaceholder#FIX}(固定字符串)、{@link FormatPlaceholder#SEQ}(生成的字符串序号)几个枚举值通过{@link FormatPlaceholder#getPlaceholder()}得到的字符串 *

* seq为1,pattern为#year##month##day#6#seq#,则会格式化为2022013061。此序号含义如下: *

@@ -337,7 +339,7 @@ public interface Generator { /** * 将生成的序号对象格式化为指定格式 *

- * pattern支持:{@link FormatPlaceholder#YEAR}}(当前年份)、{@link FormatPlaceholder#MONTH}}(当前月份)、{@link FormatPlaceholder#DAY}}(当前日期)、{@link FormatPlaceholder#SEQ}}(生成的字符串序号)几个枚举值通过{@link FormatPlaceholder#getPlaceholder()}得到的字符串 + * pattern支持:{@link FormatPlaceholder#YEAR}(当前年份)、{@link FormatPlaceholder#MONTH}(当前月份)、{@link FormatPlaceholder#DAY}(当前日期)、{@link FormatPlaceholder#FIX}(固定字符串)、{@link FormatPlaceholder#SEQ}(生成的字符串序号)几个枚举值通过{@link FormatPlaceholder#getPlaceholder()}得到的字符串 *

* seq为1,minLength为4,pattern为#year##month##day#6#seq#,则会格式化为2022013060001。此序号含义如下: *

@@ -353,47 +355,47 @@ public interface Generator { /** * 将生成的序号对象格式化为指定格式,格式化后字符串最小长度为{@link BaseConfig#getMinLength()},不足则补零 *

- * pattern支持:{@link FormatPlaceholder#YEAR}(当前年份)、{@link FormatPlaceholder#MONTH}}(当前月份)、{@link FormatPlaceholder#DAY}}(当前日期)、{@link FormatPlaceholder#SEQ}}(生成的字符串序号)几个枚举值通过{@link FormatPlaceholder#getPlaceholder()}得到的字符串 + * pattern支持:{@link FormatPlaceholder#YEAR}(当前年份)、{@link FormatPlaceholder#MONTH}(当前月份)、{@link FormatPlaceholder#DAY}(当前日期)、{@link FormatPlaceholder#FIX}(固定字符串)、{@link FormatPlaceholder#SEQ}(生成的字符串序号)几个枚举值通过{@link FormatPlaceholder#getPlaceholder()}得到的字符串 *

- * seq为1,start为6,minLength为4,pattern为#year##month##day##seq#,则会格式化为2022013061。此序号含义如下: + * seq为1,fix为6,minLength为4,pattern为#year##month##day##seq#,则会格式化为2022013061。此序号含义如下: *

* 序号格式:[年][月][日][固定6开头][序号1,最小位数为{@link BaseConfig#getMinLength()}设置,默认为1,不足则补零] * * @param seq 需要格式化的序号 - * @param start 序号格式化后以什么字符串开头 + * @param fix 序号中的固定字符串 * @param pattern 序号格式 * @return 格式化后的序号字符串 */ - String format(Long seq, String start, String pattern); + String format(Long seq, String fix, String pattern); /** * 将生成的序号对象格式化为指定格式 *

- * pattern支持:{@link FormatPlaceholder#YEAR}(当前年份)、{@link FormatPlaceholder#MONTH}}(当前月份)、{@link FormatPlaceholder#DAY}}(当前日期)、{@link FormatPlaceholder#SEQ}}(生成的字符串序号)几个枚举值通过{@link FormatPlaceholder#getPlaceholder()}得到的字符串 + * pattern支持:{@link FormatPlaceholder#YEAR}(当前年份)、{@link FormatPlaceholder#MONTH}(当前月份)、{@link FormatPlaceholder#DAY}(当前日期)、{@link FormatPlaceholder#FIX}(固定字符串)、{@link FormatPlaceholder#SEQ}(生成的字符串序号)几个枚举值通过{@link FormatPlaceholder#getPlaceholder()}得到的字符串 *

- * seq为1,start为6,minLength为4,pattern为#year##month##day##seq#,则会格式化为2022013060001。此序号含义如下: + * seq为1,fix为6,minLength为4,pattern为#year##month##day##seq#,则会格式化为2022013060001。此序号含义如下: *

* 序号格式:[年][月][日][固定6开头][序号1,最小位数为4位,不足4位则补零] * * @param seq 需要格式化的序号 - * @param start 序号格式化后以什么字符串开头 + * @param fix 序号中的固定字符串 * @param minLength 序号最小长度,不足的会补零 * @param pattern 序号格式 * @return 格式化后的序号字符串 */ - String format(Long seq, String start, Integer minLength, String pattern); + String format(Long seq, String fix, Integer minLength, String pattern); /** * 将生成的序号对象格式化为指定格式 *

- * pattern支持:{@link FormatPlaceholder#YEAR}(当前年份)、{@link FormatPlaceholder#MONTH}}(当前月份)、{@link FormatPlaceholder#DAY}}(当前日期)、{@link FormatPlaceholder#SEQ}}(生成的字符串序号)几个枚举值通过{@link FormatPlaceholder#getPlaceholder()}得到的字符串 + * pattern支持:{@link FormatPlaceholder#YEAR}(当前年份)、{@link FormatPlaceholder#MONTH}(当前月份)、{@link FormatPlaceholder#DAY}(当前日期)、{@link FormatPlaceholder#FIX}(固定字符串)、{@link FormatPlaceholder#SEQ}(生成的字符串序号)几个枚举值通过{@link FormatPlaceholder#getPlaceholder()}得到的字符串 *

- * seq为1,start为6,minLength为4,pattern为#year##month##day##seq#,则会格式化为2022013060001。此序号含义如下: + * seq为1,fix为6,minLength为4,pattern为#year##month##day##seq#,则会格式化为2022013060001。此序号含义如下: *

* 序号格式:[年][月][日][固定6开头][序号1,最小位数为4位,不足4位则补零] * * @param seq 需要格式化的序号 - * @param start 序号格式化后以什么字符串开头 + * @param fix 序号中的固定字符串 * @param minLength 序号最小长度,不足的会补零 * @param pattern 序号格式 * @param year 格式化时使用的年 @@ -401,16 +403,16 @@ public interface Generator { * @param day 格式化时使用的日 * @return 格式化后的序号字符串 */ - String format(Long seq, String start, Integer minLength, String pattern, Integer year, Integer month, Integer day); + String format(Long seq, String fix, Integer minLength, String pattern, Integer year, Integer month, Integer day); /** * 将已格式化的序号解析为序号对象 *

- * pattern支持:{@link FormatPlaceholder#YEAR}(当前年份)、{@link FormatPlaceholder#MONTH}}(当前月份)、{@link FormatPlaceholder#DAY}}(当前日期)、{@link FormatPlaceholder#SEQ}}(生成的字符串序号)几个枚举值通过{@link FormatPlaceholder#getPlaceholder()}得到的字符串 + * pattern支持:{@link FormatPlaceholder#YEAR}(当前年份)、{@link FormatPlaceholder#MONTH}(当前月份)、{@link FormatPlaceholder#DAY}(当前日期)、{@link FormatPlaceholder#FIX}(固定字符串)、{@link FormatPlaceholder#SEQ}(生成的字符串序号)几个枚举值通过{@link FormatPlaceholder#getPlaceholder()}得到的字符串 *

- * 返回的序号对象{@link Sequences#getKey()}为null,{@link Sequences#getType()}为{@link GeneratorConfig#getType()}的默认值,但是临时字段{@link Sequences#getYear()}、{@link Sequences#getMonth()}、{@link Sequences#getDay()}可能有值 + * 返回的序号对象{@link Sequences#getKey()}为null,{@link Sequences#getType()}为{@link GeneratorConfig#getType()}的默认值,但是临时字段{@link Sequences#getYear()}、{@link Sequences#getMonth()}、{@link Sequences#getDay()}、{@link Sequences#getFix()}可能有值 *

- * 如果生成序号时,序号的key在年、月、日上有关联(如每年每月的序号要从1开始),则需要自行用序号字符串与{@link Sequences#getYear()}、{@link Sequences#getMonth()}、{@link Sequences#getDay()}进行组合,进而得到key + * 如果生成序号时,序号的key在年、月、日上有关联(如每年每月的序号要从1开始),则需要自行用序号字符串与{@link Sequences#getYear()}、{@link Sequences#getMonth()}、{@link Sequences#getDay()}、{@link Sequences#getFix()}进行组合,进而得到key *

* 例如:SNT序号每年都从1开始,则key应该是类似SNT2021、SNT2022这种格式,而在配置中,该序号的代码只是SNT,但是由于每年都要从1开始,所有应该每年有一个key,这个key就为SNT+年份,而这个年份就是此处解析后返回的对象中的{@link Sequences#getYear()} *

@@ -422,6 +424,26 @@ public interface Generator { */ Sequences parse(String formatted, String pattern); + /** + * 将已格式化的序号解析为序号对象 + *

+ * pattern支持:{@link FormatPlaceholder#YEAR}(当前年份)、{@link FormatPlaceholder#MONTH}(当前月份)、{@link FormatPlaceholder#DAY}(当前日期)、{@link FormatPlaceholder#FIX}(固定字符串)、{@link FormatPlaceholder#SEQ}(生成的字符串序号)几个枚举值通过{@link FormatPlaceholder#getPlaceholder()}得到的字符串 + *

+ * 返回的序号对象{@link Sequences#getKey()}为null,{@link Sequences#getType()}为{@link GeneratorConfig#getType()}的默认值,但是临时字段{@link Sequences#getYear()}、{@link Sequences#getMonth()}、{@link Sequences#getDay()}、{@link Sequences#getFix()}可能有值 + *

+ * 如果生成序号时,序号的key在年、月、日上有关联(如每年每月的序号要从1开始),则需要自行用序号字符串与{@link Sequences#getYear()}、{@link Sequences#getMonth()}、{@link Sequences#getDay()}、{@link Sequences#getFix()}进行组合,进而得到key + *

+ * 例如:SNT序号每年都从1开始,则key应该是类似SNT2021、SNT2022这种格式,而在配置中,该序号的代码只是SNT,但是由于每年都要从1开始,所有应该每年有一个key,这个key就为SNT+年份,而这个年份就是此处解析后返回的对象中的{@link Sequences#getYear()} + *

+ * 注意:序号格式和格式化后的字符串占位一定要匹配。如:处〔#year#〕#month#10801第#seq#号 对应 处〔2022〕0210801第10001号,而不能对应 处〔2022〕021110801第10001号 + * + * @param formatted 格式化后的序号字符串 + * @param pattern 序号格式 + * @param fixLength 序号中的固定字符串的长度 + * @return 包含了序号字符串对应年(如果有)、月(如果有)、日(如果有)、固定字符串(如果有)、序号的序号对象,其key需要根据情况手动设置,type为{@link GeneratorConfig#getType()}的默认值 + */ + Sequences parse(String formatted, String pattern, Integer fixLength); + /** * 锁定指定序号,在序号生成后,调用该序号的逻辑完成后需要执行此方法 *

@@ -517,5 +539,4 @@ public interface Generator { */ void clearBefore(Date end); } - ``` \ No newline at end of file diff --git a/pom.xml b/pom.xml index c968a3c..f0e108f 100644 --- a/pom.xml +++ b/pom.xml @@ -8,7 +8,7 @@ seq seq - 1.8 + 1.9 diff --git a/src/main/java/com/yanghuanglin/seq/enums/FormatPlaceholder.java b/src/main/java/com/yanghuanglin/seq/enums/FormatPlaceholder.java index 0a1713d..209d0a2 100644 --- a/src/main/java/com/yanghuanglin/seq/enums/FormatPlaceholder.java +++ b/src/main/java/com/yanghuanglin/seq/enums/FormatPlaceholder.java @@ -22,6 +22,11 @@ public enum FormatPlaceholder { */ DAY("#day#"), + /** + * 序号格式字符中的固定字符串 + */ + FIX("#fix#"), + /** * 序号格式字符中的格式化后的序号 */ diff --git a/src/main/java/com/yanghuanglin/seq/generator/Generator.java b/src/main/java/com/yanghuanglin/seq/generator/Generator.java index ab95d13..ad3dbf5 100644 --- a/src/main/java/com/yanghuanglin/seq/generator/Generator.java +++ b/src/main/java/com/yanghuanglin/seq/generator/Generator.java @@ -78,7 +78,7 @@ public interface Generator { /** * 将{@link #generate(String, String, Boolean)}得到的序号对象格式化为补零后的序号字符串,其最小长度通过{@link BaseConfig#getMinLength()}设定。实际上只会用到{@link Sequences#getSeq()}属性 *

- * pattern支持:{@link FormatPlaceholder#YEAR}(当前年份)、{@link FormatPlaceholder#MONTH}(当前月份)、{@link FormatPlaceholder#DAY}(当前日期)、{@link FormatPlaceholder#SEQ}(生成的字符串序号)几个枚举值通过{@link FormatPlaceholder#getPlaceholder()}得到的字符串 + * pattern支持:{@link FormatPlaceholder#YEAR}(当前年份)、{@link FormatPlaceholder#MONTH}(当前月份)、{@link FormatPlaceholder#DAY}(当前日期)、{@link FormatPlaceholder#FIX}(固定字符串)、{@link FormatPlaceholder#SEQ}(生成的字符串序号)几个枚举值通过{@link FormatPlaceholder#getPlaceholder()}得到的字符串 * * @param sequences 生成的序号对象 * @param pattern 格式 @@ -89,7 +89,7 @@ public interface Generator { /** * 将{@link #generate(String, String, Boolean)}得到的序号对象格式化为补零后的序号字符串。实际上只会用到{@link Sequences#getSeq()}属性 *

- * pattern支持:{@link FormatPlaceholder#YEAR}(当前年份)、{@link FormatPlaceholder#MONTH}(当前月份)、{@link FormatPlaceholder#DAY}(当前日期)、{@link FormatPlaceholder#SEQ}(生成的字符串序号)几个枚举值通过{@link FormatPlaceholder#getPlaceholder()}得到的字符串 + * pattern支持:{@link FormatPlaceholder#YEAR}(当前年份)、{@link FormatPlaceholder#MONTH}(当前月份)、{@link FormatPlaceholder#DAY}(当前日期)、{@link FormatPlaceholder#FIX}(固定字符串)、{@link FormatPlaceholder#SEQ}(生成的字符串序号)几个枚举值通过{@link FormatPlaceholder#getPlaceholder()}得到的字符串 * * @param sequences 生成的序号对象 * @param minLength 序号数字最小长度 @@ -101,7 +101,7 @@ public interface Generator { /** * 将生成的序号对象格式化为指定格式,格式化后字符串最小长度为{@link BaseConfig#getMinLength()},不足则补零 *

- * pattern支持:{@link FormatPlaceholder#YEAR#getPlaceholder()}(当前年份)、{@link FormatPlaceholder#MONTH#getPlaceholder()}(当前月份)、{@link FormatPlaceholder#DAY#getPlaceholder()}(当前日期)、{@link FormatPlaceholder#SEQ#getPlaceholder()}(生成的字符串序号)四个变量 + * pattern支持:{@link FormatPlaceholder#YEAR}(当前年份)、{@link FormatPlaceholder#MONTH}(当前月份)、{@link FormatPlaceholder#DAY}(当前日期)、{@link FormatPlaceholder#FIX}(固定字符串)、{@link FormatPlaceholder#SEQ}(生成的字符串序号)几个枚举值通过{@link FormatPlaceholder#getPlaceholder()}得到的字符串 *

* seq为1,pattern为#year##month##day#6#seq#,则会格式化为2022013061。此序号含义如下: *

@@ -116,7 +116,7 @@ public interface Generator { /** * 将生成的序号对象格式化为指定格式 *

- * pattern支持:{@link FormatPlaceholder#YEAR}(当前年份)、{@link FormatPlaceholder#MONTH}(当前月份)、{@link FormatPlaceholder#DAY}(当前日期)、{@link FormatPlaceholder#SEQ}(生成的字符串序号)几个枚举值通过{@link FormatPlaceholder#getPlaceholder()}得到的字符串 + * pattern支持:{@link FormatPlaceholder#YEAR}(当前年份)、{@link FormatPlaceholder#MONTH}(当前月份)、{@link FormatPlaceholder#DAY}(当前日期)、{@link FormatPlaceholder#FIX}(固定字符串)、{@link FormatPlaceholder#SEQ}(生成的字符串序号)几个枚举值通过{@link FormatPlaceholder#getPlaceholder()}得到的字符串 *

* seq为1,minLength为4,pattern为#year##month##day#6#seq#,则会格式化为2022013060001。此序号含义如下: *

@@ -132,47 +132,47 @@ public interface Generator { /** * 将生成的序号对象格式化为指定格式,格式化后字符串最小长度为{@link BaseConfig#getMinLength()},不足则补零 *

- * pattern支持:{@link FormatPlaceholder#YEAR}(当前年份)、{@link FormatPlaceholder#MONTH}(当前月份)、{@link FormatPlaceholder#DAY}(当前日期)、{@link FormatPlaceholder#SEQ}(生成的字符串序号)几个枚举值通过{@link FormatPlaceholder#getPlaceholder()}得到的字符串 + * pattern支持:{@link FormatPlaceholder#YEAR}(当前年份)、{@link FormatPlaceholder#MONTH}(当前月份)、{@link FormatPlaceholder#DAY}(当前日期)、{@link FormatPlaceholder#FIX}(固定字符串)、{@link FormatPlaceholder#SEQ}(生成的字符串序号)几个枚举值通过{@link FormatPlaceholder#getPlaceholder()}得到的字符串 *

- * seq为1,start为6,minLength为4,pattern为#year##month##day##seq#,则会格式化为2022013061。此序号含义如下: + * seq为1,fix为6,minLength为4,pattern为#year##month##day##seq#,则会格式化为2022013061。此序号含义如下: *

* 序号格式:[年][月][日][固定6开头][序号1,最小位数为{@link BaseConfig#getMinLength()}设置,默认为1,不足则补零] * * @param seq 需要格式化的序号 - * @param start 序号格式化后以什么字符串开头 + * @param fix 序号中的固定字符串 * @param pattern 序号格式 * @return 格式化后的序号字符串 */ - String format(Long seq, String start, String pattern); + String format(Long seq, String fix, String pattern); /** * 将生成的序号对象格式化为指定格式 *

- * pattern支持:{@link FormatPlaceholder#YEAR}(当前年份)、{@link FormatPlaceholder#MONTH}(当前月份)、{@link FormatPlaceholder#DAY}(当前日期)、{@link FormatPlaceholder#SEQ}(生成的字符串序号)几个枚举值通过{@link FormatPlaceholder#getPlaceholder()}得到的字符串 + * pattern支持:{@link FormatPlaceholder#YEAR}(当前年份)、{@link FormatPlaceholder#MONTH}(当前月份)、{@link FormatPlaceholder#DAY}(当前日期)、{@link FormatPlaceholder#FIX}(固定字符串)、{@link FormatPlaceholder#SEQ}(生成的字符串序号)几个枚举值通过{@link FormatPlaceholder#getPlaceholder()}得到的字符串 *

- * seq为1,start为6,minLength为4,pattern为#year##month##day##seq#,则会格式化为2022013060001。此序号含义如下: + * seq为1,fix为6,minLength为4,pattern为#year##month##day##seq#,则会格式化为2022013060001。此序号含义如下: *

* 序号格式:[年][月][日][固定6开头][序号1,最小位数为4位,不足4位则补零] * * @param seq 需要格式化的序号 - * @param start 序号格式化后以什么字符串开头 + * @param fix 序号中的固定字符串 * @param minLength 序号最小长度,不足的会补零 * @param pattern 序号格式 * @return 格式化后的序号字符串 */ - String format(Long seq, String start, Integer minLength, String pattern); + String format(Long seq, String fix, Integer minLength, String pattern); /** * 将生成的序号对象格式化为指定格式 *

- * pattern支持:{@link FormatPlaceholder#YEAR}(当前年份)、{@link FormatPlaceholder#MONTH}(当前月份)、{@link FormatPlaceholder#DAY}(当前日期)、{@link FormatPlaceholder#SEQ}(生成的字符串序号)几个枚举值通过{@link FormatPlaceholder#getPlaceholder()}得到的字符串 + * pattern支持:{@link FormatPlaceholder#YEAR}(当前年份)、{@link FormatPlaceholder#MONTH}(当前月份)、{@link FormatPlaceholder#DAY}(当前日期)、{@link FormatPlaceholder#FIX}(固定字符串)、{@link FormatPlaceholder#SEQ}(生成的字符串序号)几个枚举值通过{@link FormatPlaceholder#getPlaceholder()}得到的字符串 *

- * seq为1,start为6,minLength为4,pattern为#year##month##day##seq#,则会格式化为2022013060001。此序号含义如下: + * seq为1,fix为6,minLength为4,pattern为#year##month##day##seq#,则会格式化为2022013060001。此序号含义如下: *

* 序号格式:[年][月][日][固定6开头][序号1,最小位数为4位,不足4位则补零] * * @param seq 需要格式化的序号 - * @param start 序号格式化后以什么字符串开头 + * @param fix 序号中的固定字符串 * @param minLength 序号最小长度,不足的会补零 * @param pattern 序号格式 * @param year 格式化时使用的年 @@ -180,16 +180,16 @@ public interface Generator { * @param day 格式化时使用的日 * @return 格式化后的序号字符串 */ - String format(Long seq, String start, Integer minLength, String pattern, Integer year, Integer month, Integer day); + String format(Long seq, String fix, Integer minLength, String pattern, Integer year, Integer month, Integer day); /** * 将已格式化的序号解析为序号对象 *

- * pattern支持:{@link FormatPlaceholder#YEAR}(当前年份)、{@link FormatPlaceholder#MONTH}(当前月份)、{@link FormatPlaceholder#DAY}(当前日期)、{@link FormatPlaceholder#SEQ}(生成的字符串序号)几个枚举值通过{@link FormatPlaceholder#getPlaceholder()}得到的字符串 + * pattern支持:{@link FormatPlaceholder#YEAR}(当前年份)、{@link FormatPlaceholder#MONTH}(当前月份)、{@link FormatPlaceholder#DAY}(当前日期)、{@link FormatPlaceholder#FIX}(固定字符串)、{@link FormatPlaceholder#SEQ}(生成的字符串序号)几个枚举值通过{@link FormatPlaceholder#getPlaceholder()}得到的字符串 *

- * 返回的序号对象{@link Sequences#getKey()}为null,{@link Sequences#getType()}为{@link GeneratorConfig#getType()}的默认值,但是临时字段{@link Sequences#getYear()}、{@link Sequences#getMonth()}、{@link Sequences#getDay()}可能有值 + * 返回的序号对象{@link Sequences#getKey()}为null,{@link Sequences#getType()}为{@link GeneratorConfig#getType()}的默认值,但是临时字段{@link Sequences#getYear()}、{@link Sequences#getMonth()}、{@link Sequences#getDay()}、{@link Sequences#getFix()}可能有值 *

- * 如果生成序号时,序号的key在年、月、日上有关联(如每年每月的序号要从1开始),则需要自行用序号字符串与{@link Sequences#getYear()}、{@link Sequences#getMonth()}、{@link Sequences#getDay()}进行组合,进而得到key + * 如果生成序号时,序号的key在年、月、日、固定字符串上有关联(如每年每月的序号要从1开始),则需要自行用序号字符串与{@link Sequences#getYear()}、{@link Sequences#getMonth()}、{@link Sequences#getDay()}、{@link Sequences#getFix()}进行组合,进而得到key *

* 例如:SNT序号每年都从1开始,则key应该是类似SNT2021、SNT2022这种格式,而在配置中,该序号的代码只是SNT,但是由于每年都要从1开始,所有应该每年有一个key,这个key就为SNT+年份,而这个年份就是此处解析后返回的对象中的{@link Sequences#getYear()} *

@@ -201,6 +201,26 @@ public interface Generator { */ Sequences parse(String formatted, String pattern); + /** + * 将已格式化的序号解析为序号对象 + *

+ * pattern支持:{@link FormatPlaceholder#YEAR}(当前年份)、{@link FormatPlaceholder#MONTH}(当前月份)、{@link FormatPlaceholder#DAY}(当前日期)、{@link FormatPlaceholder#FIX}(固定字符串)、{@link FormatPlaceholder#SEQ}(生成的字符串序号)几个枚举值通过{@link FormatPlaceholder#getPlaceholder()}得到的字符串 + *

+ * 返回的序号对象{@link Sequences#getKey()}为null,{@link Sequences#getType()}为{@link GeneratorConfig#getType()}的默认值,但是临时字段{@link Sequences#getYear()}、{@link Sequences#getMonth()}、{@link Sequences#getDay()}、{@link Sequences#getFix()}可能有值 + *

+ * 如果生成序号时,序号的key在年、月、日、固定字符串上有关联(如每年每月的序号要从1开始),则需要自行用序号字符串与{@link Sequences#getYear()}、{@link Sequences#getMonth()}、{@link Sequences#getDay()}、{@link Sequences#getFix()}进行组合,进而得到key + *

+ * 例如:SNT序号每年都从1开始,则key应该是类似SNT2021、SNT2022这种格式,而在配置中,该序号的代码只是SNT,但是由于每年都要从1开始,所有应该每年有一个key,这个key就为SNT+年份,而这个年份就是此处解析后返回的对象中的{@link Sequences#getYear()} + *

+ * 注意:序号格式和格式化后的字符串占位一定要匹配。如:处〔#year#〕#month#10801第#seq#号 对应 处〔2022〕0210801第10001号,而不能对应 处〔2022〕021110801第10001号 + * + * @param formatted 格式化后的序号字符串 + * @param pattern 序号格式 + * @param fixLength 序号中的固定字符串的长度 + * @return 包含了序号字符串对应年(如果有)、月(如果有)、日(如果有)、固定字符串(如果有)、序号的序号对象,其key需要根据情况手动设置,type为{@link GeneratorConfig#getType()}的默认值 + */ + Sequences parse(String formatted, String pattern, Integer fixLength); + /** * 锁定指定序号,在序号生成后,调用该序号的逻辑完成后需要执行此方法 *

diff --git a/src/main/java/com/yanghuanglin/seq/generator/impl/SequencesGenerator.java b/src/main/java/com/yanghuanglin/seq/generator/impl/SequencesGenerator.java index b843613..39c97ce 100644 --- a/src/main/java/com/yanghuanglin/seq/generator/impl/SequencesGenerator.java +++ b/src/main/java/com/yanghuanglin/seq/generator/impl/SequencesGenerator.java @@ -170,20 +170,20 @@ public class SequencesGenerator implements Generator { } @Override - public String format(Long seq, String start, String pattern) { - return format(seq, start, minLength, pattern); + public String format(Long seq, String fix, String pattern) { + return format(seq, fix, minLength, pattern); } @Override - public String format(Long seq, String start, Integer minLength, String pattern) { - return format(seq, start, minLength, pattern, null, null, null); + public String format(Long seq, String fix, Integer minLength, String pattern) { + return format(seq, fix, minLength, pattern, null, null, null); } @Override - public String format(Long seq, String start, Integer minLength, String pattern, Integer year, Integer month, Integer day) { - if (start == null) - start = ""; - String seqString = start + new Sequences(seq).format(minLength); + public String format(Long seq, String fix, Integer minLength, String pattern, Integer year, Integer month, Integer day) { + if (fix == null) + fix = ""; + String seqString = new Sequences(seq).format(minLength); Calendar calendar = Calendar.getInstance(); if (year == null) year = calendar.get(Calendar.YEAR); @@ -194,14 +194,24 @@ public class SequencesGenerator implements Generator { pattern = pattern.replaceAll(YEAR.getPlaceholder(), String.valueOf(year)); pattern = pattern.replaceAll(MONTH.getPlaceholder(), monthZeroFilling ? String.format("%02d", month) : String.valueOf(month)); pattern = pattern.replaceAll(DAY.getPlaceholder(), dayZeroFilling ? String.format("%02d", day) : String.valueOf(day)); + pattern = pattern.replaceAll(FIX.getPlaceholder(), fix); pattern = pattern.replaceAll(SEQ.getPlaceholder(), seqString); return pattern; } @Override public Sequences parse(String formatted, String pattern) { + return parse(formatted, pattern, null); + } + + @Override + public Sequences parse(String formatted, String pattern, Integer fixLength) { + //如果解析时的格式中包含了固定字符串的占位符,则其固定字符串占位符的长度必须大于0,否则抛出异常。 + //如果不设置固定字符串的长度,就无法将固定字符串和序号分隔开 + if (pattern.contains(FIX.getPlaceholder()) && (fixLength == null || fixLength == 0)) + throw new NullPointerException("请设置固定字符串的长度,该长度需要大于0,否则无法区分固定字符串和序号。"); //年、月、日、序号分隔特殊符号正则规则 - String splitRegString = "(" + YEAR.getPlaceholder() + "|" + MONTH.getPlaceholder() + "|" + DAY.getPlaceholder() + "|" + SEQ.getPlaceholder() + ")"; + String splitRegString = "(" + YEAR.getPlaceholder() + "|" + MONTH.getPlaceholder() + "|" + DAY.getPlaceholder() + "|" + FIX.getPlaceholder() + "|" + SEQ.getPlaceholder() + ")"; //根据年、月、日、序号的特殊符号,对格式进行分隔,得到排除特殊符号后的字符串数组 String[] split = pattern.split(splitRegString); @@ -211,23 +221,25 @@ public class SequencesGenerator implements Generator { formatted = formatted.replace(splitString, ""); } - //年、月、日的数字匹配正则规则 + //年、月、日、固定字符串 匹配正则规则 String yearRegStr = "\\d{4}"; String monthRegStr = "\\d{2}"; String dayRegStr = "\\d{2}"; + String fixRegStr = (fixLength == null || fixLength == 0) ? null : ".{" + fixLength + "}"; //将序号格式分隔特殊符号字符串转为正则匹配规则 Pattern seqPattern = Pattern.compile(splitRegString); //对序号格式进行匹配 Matcher matcher = seqPattern.matcher(pattern); - //将年、月、日匹配规则字符串转为正则匹配规则 + //将年、月、日、固定字符串 匹配规则字符串转为正则匹配规则 Pattern yearPattern = Pattern.compile(yearRegStr); Pattern monthPattern = Pattern.compile(monthRegStr); Pattern dayPattern = Pattern.compile(dayRegStr); + Pattern fixPattern = StringUtils.hasLength(fixRegStr) ? Pattern.compile(fixRegStr) : null; - //默认的年、月、日均为空字符串 - String year = "", month = "", day = "", seq = ""; + //默认的年、月、日、固定字符串、序号均为空字符串 + String year = "", month = "", day = "", fix = "", seq = ""; //根据序号匹配规则字符串查找字符串分组 while (matcher.find()) { String group = matcher.group(); @@ -241,7 +253,7 @@ public class SequencesGenerator implements Generator { if (yearMatcher.find()) { year = yearMatcher.group(); } - formatted = formatted.replaceFirst(yearRegStr, ""); + formatted = formatted.replaceFirst(yearPattern.pattern(), ""); break; case MONTH: //若分组为月份分组,则将月份正则匹配到的字符串赋值给month,同时把格式化后的序号字符串中,对应月的字符串替换为空字符串 @@ -249,7 +261,7 @@ public class SequencesGenerator implements Generator { if (monthMatcher.find()) { month = monthMatcher.group(); } - formatted = formatted.replaceFirst(monthRegStr, ""); + formatted = formatted.replaceFirst(monthPattern.pattern(), ""); break; case DAY: //若分组为日期分组,则将日期正则匹配到的字符串赋值给day,同时把格式化后的序号字符串中,对应日期的字符串替换为空字符串 @@ -257,7 +269,17 @@ public class SequencesGenerator implements Generator { if (dayMatcher.find()) { day = dayMatcher.group(); } - formatted = formatted.replaceFirst(dayRegStr, ""); + formatted = formatted.replaceFirst(dayPattern.pattern(), ""); + break; + case FIX: + if (fixPattern == null) + break; + //若分组为固定字符串分组,则将固定字符串正则匹配到的字符串赋值给fix,同时把格式化后的序号字符串中,对应固定字符串的字符串替换为空字符串 + Matcher fixMatcher = fixPattern.matcher(formatted); + if (fixMatcher.find()) { + fix = fixMatcher.group(); + } + formatted = formatted.replaceFirst(fixPattern.pattern(), ""); break; } } @@ -270,6 +292,7 @@ public class SequencesGenerator implements Generator { sequences.setYear(StringUtils.hasLength(year) ? Integer.valueOf(year) : null); sequences.setMonth(StringUtils.hasLength(month) ? Integer.valueOf(month) : null); sequences.setDay(StringUtils.hasLength(day) ? Integer.valueOf(day) : null); + sequences.setFix(StringUtils.hasLength(fix) ? fix : null); sequences.setSeq(StringUtils.hasLength(seq) ? Long.parseLong(seq) : 0L); sequences.setWithOutSeq(!StringUtils.hasLength(seq)); sequences.setType(type); diff --git a/src/main/java/com/yanghuanglin/seq/po/Sequences.java b/src/main/java/com/yanghuanglin/seq/po/Sequences.java index bc73037..4ccd225 100644 --- a/src/main/java/com/yanghuanglin/seq/po/Sequences.java +++ b/src/main/java/com/yanghuanglin/seq/po/Sequences.java @@ -42,6 +42,12 @@ public class Sequences { */ private transient Integer day; + /** + * 临时字段,序号对应的固定字符串(A1)。 + * 该字段仅用于解析序号字符串时,解析出对应固定字符,用于合成key(如:序号对应的key为SNT+年份+月份+日期+固定字符串,返回的为其固定字符串) + */ + private transient String fix; + /** * 临时字段,表示序号对象不包含序号 */ @@ -119,6 +125,14 @@ public class Sequences { this.day = day; } + public String getFix() { + return fix; + } + + public void setFix(String fix) { + this.fix = fix; + } + public Boolean getWithOutSeq() { return withOutSeq; } @@ -169,6 +183,7 @@ public class Sequences { ", year=" + year + ", month=" + month + ", day=" + day + + ", fix=" + fix + ", withOutSeq=" + withOutSeq + '}'; } diff --git a/src/test/java/SeqTest.java b/src/test/java/SeqTest.java index 2f1b10d..e75e215 100644 --- a/src/test/java/SeqTest.java +++ b/src/test/java/SeqTest.java @@ -1,14 +1,10 @@ import com.mysql.cj.jdbc.MysqlDataSource; -import com.yanghuanglin.seq.config.BaseConfig; import com.yanghuanglin.seq.config.GeneratorConfig; import com.yanghuanglin.seq.config.TableConfig; import com.yanghuanglin.seq.generator.Generator; import com.yanghuanglin.seq.generator.impl.SequencesGenerator; import com.yanghuanglin.seq.po.Sequences; import org.junit.Test; -import org.springframework.jdbc.datasource.DataSourceTransactionManager; -import org.springframework.transaction.PlatformTransactionManager; -import org.springframework.transaction.support.TransactionTemplate; import java.util.HashSet; import java.util.Set; @@ -51,12 +47,17 @@ public class SeqTest { Set set = new HashSet<>(); ThreadPoolExecutor threadPoolExecutor = new ThreadPoolExecutor(10, 10, 1, TimeUnit.MINUTES, new ArrayBlockingQueue<>(100)); for (int i = 0; i < 5; i++) { + final int finalI = i; threadPoolExecutor.execute(() -> { Sequences sequences = generator.generate("SNT", "MISSION"); - String formattedSeq = generator.format(sequences.getSeq(), "处〔#year#〕10801#seq#"); + String pattern = "处〔#year#〕#fix##seq#"; + String fix = "10801" + finalI; + String formattedSeq = generator.format(sequences.getSeq(), fix, pattern); generator.lock(sequences); set.add(formattedSeq); System.out.println(formattedSeq); + Sequences parse = generator.parse(formattedSeq, pattern, fix.length()); + System.out.println(parse); }); } threadPoolExecutor.shutdown(); @@ -80,10 +81,11 @@ public class SeqTest { @Test public void parseTest() { - String seqPattern = "ZZF#year##month##seq#"; - String formatted = "ZZF20220200008"; + String seqPattern = "ZZF#year##month##fix##seq#"; + String formatted = "ZZF202202A18"; - Sequences sequences = generator.parse(formatted, seqPattern); + //A1视为固定字符串,其长度为2 + Sequences sequences = generator.parse(formatted, seqPattern, 2); String key = "zzfCode" + sequences.getYear();