调整 增加固定字符串占位符
调整 解析序列号时，增加根据固定字符串长度解析 Sequences parse(String formatted, String pattern, Integer fixLength);
This commit is contained in:
杨黄林
83
README.md
83
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()}属性
|
||||
* <p/>
|
||||
* 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()}属性
|
||||
* <p/>
|
||||
* 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()}，不足则补零
|
||||
* <p/>
|
||||
* 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()}得到的字符串
|
||||
* <p/>
|
||||
* seq为1，pattern为#year##month##day#6#seq#，则会格式化为2022013061。此序号含义如下：
|
||||
* <p/>
|
||||
@@ -337,7 +339,7 @@ public interface Generator {
|
||||
/**
|
||||
* 将生成的序号对象格式化为指定格式
|
||||
* <p/>
|
||||
* 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()}得到的字符串
|
||||
* <p/>
|
||||
* seq为1，minLength为4，pattern为#year##month##day#6#seq#，则会格式化为2022013060001。此序号含义如下：
|
||||
* <p/>
|
||||
@@ -353,47 +355,47 @@ public interface Generator {
|
||||
/**
|
||||
* 将生成的序号对象格式化为指定格式，格式化后字符串最小长度为{@link BaseConfig#getMinLength()}，不足则补零
|
||||
* <p/>
|
||||
* 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()}得到的字符串
|
||||
* <p/>
|
||||
* seq为1,start为6，minLength为4，pattern为#year##month##day##seq#，则会格式化为2022013061。此序号含义如下：
|
||||
* seq为1,fix为6，minLength为4，pattern为#year##month##day##seq#，则会格式化为2022013061。此序号含义如下：
|
||||
* <p/>
|
||||
* 序号格式：[年][月][日][固定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);
|
||||
|
||||
/**
|
||||
* 将生成的序号对象格式化为指定格式
|
||||
* <p/>
|
||||
* 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()}得到的字符串
|
||||
* <p/>
|
||||
* seq为1,start为6，minLength为4，pattern为#year##month##day##seq#，则会格式化为2022013060001。此序号含义如下：
|
||||
* seq为1,fix为6，minLength为4，pattern为#year##month##day##seq#，则会格式化为2022013060001。此序号含义如下：
|
||||
* <p/>
|
||||
* 序号格式：[年][月][日][固定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);
|
||||
|
||||
/**
|
||||
* 将生成的序号对象格式化为指定格式
|
||||
* <p/>
|
||||
* 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()}得到的字符串
|
||||
* <p/>
|
||||
* seq为1,start为6，minLength为4，pattern为#year##month##day##seq#，则会格式化为2022013060001。此序号含义如下：
|
||||
* seq为1,fix为6，minLength为4，pattern为#year##month##day##seq#，则会格式化为2022013060001。此序号含义如下：
|
||||
* <p/>
|
||||
* 序号格式：[年][月][日][固定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);
|
||||
|
||||
/**
|
||||
* 将已格式化的序号解析为序号对象
|
||||
* <p/>
|
||||
* 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()}得到的字符串
|
||||
* <p/>
|
||||
* 返回的序号对象{@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()}可能有值
|
||||
* <p/>
|
||||
* 如果生成序号时，序号的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
|
||||
* <p/>
|
||||
* 例如：SNT序号每年都从1开始，则key应该是类似SNT2021、SNT2022这种格式，而在配置中，该序号的代码只是SNT，但是由于每年都要从1开始，所有应该每年有一个key，这个key就为SNT+年份，而这个年份就是此处解析后返回的对象中的{@link Sequences#getYear()}
|
||||
* <p/>
|
||||
@@ -422,6 +424,26 @@ public interface Generator {
|
||||
*/
|
||||
Sequences parse(String formatted, String pattern);
|
||||
|
||||
/**
|
||||
* 将已格式化的序号解析为序号对象
|
||||
* <p/>
|
||||
* pattern支持：{@link FormatPlaceholder#YEAR}(当前年份)、{@link FormatPlaceholder#MONTH}(当前月份)、{@link FormatPlaceholder#DAY}(当前日期)、{@link FormatPlaceholder#FIX}(固定字符串)、{@link FormatPlaceholder#SEQ}(生成的字符串序号)几个枚举值通过{@link FormatPlaceholder#getPlaceholder()}得到的字符串
|
||||
* <p/>
|
||||
* 返回的序号对象{@link Sequences#getKey()}为null，{@link Sequences#getType()}为{@link GeneratorConfig#getType()}的默认值，但是临时字段{@link Sequences#getYear()}、{@link Sequences#getMonth()}、{@link Sequences#getDay()}、{@link Sequences#getFix()}可能有值
|
||||
* <p/>
|
||||
* 如果生成序号时，序号的key在年、月、日上有关联（如每年每月的序号要从1开始），则需要自行用序号字符串与{@link Sequences#getYear()}、{@link Sequences#getMonth()}、{@link Sequences#getDay()}、{@link Sequences#getFix()}进行组合，进而得到key
|
||||
* <p/>
|
||||
* 例如：SNT序号每年都从1开始，则key应该是类似SNT2021、SNT2022这种格式，而在配置中，该序号的代码只是SNT，但是由于每年都要从1开始，所有应该每年有一个key，这个key就为SNT+年份，而这个年份就是此处解析后返回的对象中的{@link Sequences#getYear()}
|
||||
* <p/>
|
||||
* 注意：序号格式和格式化后的字符串占位一定要匹配。如：处〔#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);
|
||||
|
||||
/**
|
||||
* 锁定指定序号，在序号生成后，调用该序号的逻辑完成后需要执行此方法
|
||||
* <p/>
|
||||
@@ -517,5 +539,4 @@ public interface Generator {
|
||||
*/
|
||||
void clearBefore(Date end);
|
||||
}
|
||||
|
||||
```
|
||||
Reference in New Issue
Block a user