StrTemplate (hutool 6.0.0-M20 API)

java.lang.Object
- org.dromara.hutool.core.text.placeholder.StrTemplate

Direct Known Subclasses:

NamedPlaceholderStrTemplate, SinglePlaceholderStrTemplate
```
public abstract class StrTemplate
extends Object
```
字符串模板格式化和反解析抽象父类

Since:

6.0.0

Author:

emptypoint

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`StrTemplate.AbstractBuilder<BuilderChild extends StrTemplate.AbstractBuilder<BuilderChild,TemplateChild>,TemplateChild extends StrTemplate>` 抽象Builder
`static class`	`StrTemplate.Feature` 格式化和解析策略同组内的策略是互斥的，一但设置为组内的某个新策略，就会清除之前的同组策略，仅保留新策略

Field Summary

Fields
Modifier and Type	Field and Description
`static char`	`DEFAULT_ESCAPE` 转义符默认值
`protected String`	`defaultValue` 占位符没有找到对应的填充值时使用的默认值，如果没有，则使用 `defaultValueHandler` 提供默认值, 如果也没有，使用 `globalDefaultValueHandler`，还是没有，则抛出异常
`protected UnaryOperator<String>`	`defaultValueHandler` 当前模板的默认值处理器，根据占位变量返回默认值
`protected char`	`escape` 转义符，默认为: `CharPool.BACKSLASH` 转义符如果标记在占位符的开始或者结束之前，则该占位符无效，属于普通字符串的一部分例如，转义符为 '/'，占位符为 "{}"：当字符串模板为 "I am /{}" 时，该模板中没有任何需要替换的占位符，格式化结果为 "I am {}" 如果要打印转义符，使用双转义符即可，例如，转义符为 '/'，占位符为 "{}"：当字符串模板为 "I am //{}" ，格式化参数为 "student", 格式化结果为 "I am /student"
`protected int`	`fixedTextTotalLength` 模板中的固定文本长度，序列化时用于计算最终文本长度
`protected static UnaryOperator<String>`	`globalDefaultValueHandler` 全局默认值处理器，一旦修改，对所有模板对象都生效根据占位符变量返回默认值
`protected static int`	`globalFeatures` 全局默认策略，一旦修改，对所有模板对象都生效该值是每个模板对象创建时的策略初始值，因此，修改全局默认策略，不影响已经创建的模板对象
`protected List<AbstractPlaceholderSegment>`	`placeholderSegments` 所有占位符
`protected List<StrTemplateSegment>`	`segments` 模板中的所有固定文本和占位符

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`StrTemplate(String template, char escape, String defaultValue, UnaryOperator<String> defaultValueHandler, int features)` 构造

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addLiteralSegment(boolean isLastLiteralSegment, List<StrTemplateSegment> list, String newText)` 添加固定文本segment，过滤空字符串并合并相邻的固定文本
`protected void`	`afterInit()` 一些公共的初始化代码由于此时子类还没构造完成，所以只能由子类构造方法调用
`protected String`	`formatBySegment(Function<AbstractPlaceholderSegment,?> valueSupplier)` 根据策略和默认值处理需要序列化的值, 生成格式化字符串依次遍历模板中的占位符，根据占位符返回需要序列化的值
`protected String`	`formatMissingKey(AbstractPlaceholderSegment segment)` 根据策略返回格式化参数中找不到占位符时的默认值例如，map中没有占位符变量这个key；基于下标的参数中，找不到占位符下标对应的列表元素
`protected String`	`formatNullValue(AbstractPlaceholderSegment segment)` 根据策略返回占位符对应的值为 `null` 时的返回值
`String`	`formatRawByKey(Function<String,String> valueSupplier)` 根据原始数据生成格式化字符串依次遍历模板中的占位符，根据占位符返回需要序列化的值不对占位符和参数值做任何处理，由用户抉择
`String`	`formatRawBySegment(Function<AbstractPlaceholderSegment,String> valueSupplier)` 根据原始数据生成格式化字符串依次遍历模板中的占位符，根据占位符返回需要序列化的值不对占位符和参数值做任何处理，由用户抉择
`protected String`	`formatSequence(Iterable<?> iterable)` 按顺序使用迭代器元素替换占位符
`protected String`	`getDefaultValue(AbstractPlaceholderSegment segment)` 根据占位符返回默认值根据定义的默认值、默认值提供者、全局默认值提供者，返回默认值
`int`	`getFeatures()` 获取当前模板的策略值
`protected List<AbstractPlaceholderSegment>`	`getPlaceholderSegments()` 获取模板中的占位符 segment
`List<String>`	`getPlaceholderTexts()` 获取所有占位符的完整文本列表例如，"{}"->"{}"、"{name}"->"{name}"
`List<String>`	`getPlaceholderVariableNames()` 获取所有占位变量名称列表例如，"{}"->"{}"、"{name}"->"name"
`protected List<StrTemplateSegment>`	`getSegments()` 获取模板中所有segment
`String`	`getTemplate()` 获取模板字符串
`protected boolean`	`hasDefaultValue()` 是否有默认值
`boolean`	`isMatches(String str)` 校验传入的字符串是否和模板匹配
`void`	`matchesByKey(String str, BiConsumer<String,String> keyValueConsumer)` 根据策略和默认值获得最终的 value，由消费者处理该 value
`protected void`	`matchesByKey(String str, BiConsumer<String,String> keyValueConsumer, boolean hasDefaultValue, Function<AbstractPlaceholderSegment,String> defaultValueSupplier)` 根据策略和默认值获得最终的 value，由消费者处理该 value
`void`	`matchesRawByKey(String str, BiConsumer<String,String> keyValueConsumer)` 原始数据的解析方法不对占位符和解析得到的值做任何处理，由用户抉择
`void`	`matchesRawBySegment(String str, BiConsumer<AbstractPlaceholderSegment,String> keyValueConsumer)` 原始数据的解析方法不对占位符和解析得到的值做任何处理，由用户抉择
`protected List<String>`	`matchesSequence(String str)` 将占位符位置的值按顺序解析为字符串列表
`static SinglePlaceholderStrTemplate.Builder`	`of(String template)` 创建单占位符模板对象的 Builder 例如，"{}", "?"
`static NamedPlaceholderStrTemplate.Builder`	`ofNamed(String template)` 创建有前缀和后缀的占位符模板对象的 Builder 例如，"{0}", "{name}", "#{name}"
`protected abstract List<StrTemplateSegment>`	`parseSegments(String template)` 将模板解析为 Segment 列表
`static void`	`setGlobalDefaultValue(UnaryOperator<String> globalDefaultValueHandler)` 设置全局默认值处理器，一旦修改，对所有模板对象都生效
`static void`	`setGlobalFeatures(StrTemplate.Feature... globalFeatures)` 设置全局默认策略，一旦修改，对所有模板对象都生效该值是每个模板对象创建时的策略初始值，因此，修改全局默认策略，不影响已经创建的模板对象

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_ESCAPE
```
public static final char DEFAULT_ESCAPE
```
    转义符默认值
    
    See Also:
    
    Constant Field Values
  - globalFeatures
```
protected static int globalFeatures
```
    全局默认策略，一旦修改，对所有模板对象都生效
    该值是每个模板对象创建时的策略初始值，因此，修改全局默认策略，不影响已经创建的模板对象
  - globalDefaultValueHandler
```
protected static UnaryOperator<String> globalDefaultValueHandler
```
    全局默认值处理器，一旦修改，对所有模板对象都生效
    根据占位符变量返回默认值
  - escape
```
protected final char escape
```
    转义符，默认为: CharPool.BACKSLASH
    转义符如果标记在占位符的开始或者结束之前，则该占位符无效，属于普通字符串的一部分
    例如，转义符为 '/'，占位符为 "{}"：
    当字符串模板为 "I am /{}" 时，该模板中没有任何需要替换的占位符，格式化结果为 "I am {}"
    
    如果要打印转义符，使用双转义符即可，例如，转义符为 '/'，占位符为 "{}"：
    当字符串模板为 "I am //{}" ，格式化参数为 "student", 格式化结果为 "I am /student"
  - defaultValue
```
protected final String defaultValue
```
    占位符没有找到对应的填充值时使用的默认值，如果没有，则使用 defaultValueHandler 提供默认值, 如果也没有，使用 globalDefaultValueHandler，还是没有，则抛出异常
  - defaultValueHandler
```
protected final UnaryOperator<String> defaultValueHandler
```
    当前模板的默认值处理器，根据占位变量返回默认值
  - segments
```
protected List<StrTemplateSegment> segments
```
    模板中的所有固定文本和占位符
  - placeholderSegments
```
protected List<AbstractPlaceholderSegment> placeholderSegments
```
    所有占位符
  - fixedTextTotalLength
```
protected int fixedTextTotalLength
```
    模板中的固定文本长度，序列化时用于计算最终文本长度
- Constructor Detail
  - StrTemplate
```
protected StrTemplate(String template,
                      char escape,
                      String defaultValue,
                      UnaryOperator<String> defaultValueHandler,
                      int features)
```
    构造
    
    Parameters:
    
    template - 字符串模板
    
    escape - 转义符
    
    defaultValue - 默认值
    
    defaultValueHandler - 默认值处理器
    
    features - 策略值
- Method Detail
  - of
```
public static SinglePlaceholderStrTemplate.Builder of(String template)
```
    创建单占位符模板对象的 Builder
    例如，"{}", "?", "$$$"
    
    Parameters:
    
    template - 字符串模板
    
    Returns:
    
    单占位符模板对象的 Builder
  - ofNamed
```
public static NamedPlaceholderStrTemplate.Builder ofNamed(String template)
```
    创建有前缀和后缀的占位符模板对象的 Builder
    例如，"{0}", "{name}", "#{name}"
    
    Parameters:
    
    template - 字符串模板
    
    Returns:
    
    有前缀和后缀的占位符模板对象的 Builder
  - setGlobalFeatures
```
public static void setGlobalFeatures(StrTemplate.Feature... globalFeatures)
```
    设置全局默认策略，一旦修改，对所有模板对象都生效
    该值是每个模板对象创建时的策略初始值，因此，修改全局默认策略，不影响已经创建的模板对象
    
    Parameters:
    
    globalFeatures - 全局默认策略
  - setGlobalDefaultValue
```
public static void setGlobalDefaultValue(UnaryOperator<String> globalDefaultValueHandler)
```
    设置全局默认值处理器，一旦修改，对所有模板对象都生效
    
    Parameters:
    
    globalDefaultValueHandler - 全局默认处理器，根据占位符变量返回默认值
  - getTemplate
```
public String getTemplate()
```
    获取模板字符串
    
    Returns:
    
    模板字符串
  - getFeatures
```
public int getFeatures()
```
    获取当前模板的策略值
    
    Returns:
    
    策略值
  - isMatches
```
public boolean isMatches(String str)
```
    校验传入的字符串是否和模板匹配
    
    Parameters:
    
    str - 校验字符串，应该是由格式化方法生成的字符串
    
    Returns:
    
    是否和模板匹配
  - getPlaceholderVariableNames
```
public List<String> getPlaceholderVariableNames()
```
    获取所有占位变量名称列表
    例如，"{}"->"{}"、"{name}"->"name"
    
    Returns:
    
    所有占位变量名称列表
  - getPlaceholderTexts
```
public List<String> getPlaceholderTexts()
```
    获取所有占位符的完整文本列表
    例如，"{}"->"{}"、"{name}"->"{name}"
    
    Returns:
    
    所有占位符的完整文本列表
  - formatRawByKey
```
public String formatRawByKey(Function<String,String> valueSupplier)
```
    根据原始数据生成格式化字符串
    依次遍历模板中的占位符，根据占位符返回需要序列化的值
    
    不对占位符和参数值做任何处理，由用户抉择
    
    Parameters:
    
    valueSupplier - 根据占位符返回需要序列化的值的字符串形式，例如：
    key -> map.get(key)
    
    Returns:
    
    模板格式化之后的结果
  - formatRawBySegment
```
public String formatRawBySegment(Function<AbstractPlaceholderSegment,String> valueSupplier)
```
    根据原始数据生成格式化字符串
    依次遍历模板中的占位符，根据占位符返回需要序列化的值
    
    不对占位符和参数值做任何处理，由用户抉择
    
    Parameters:
    
    valueSupplier - 根据占位符返回需要序列化的值的字符串形式，例如：
    segment -> map.get(segment.getPlaceholder())
    
    Returns:
    
    模板格式化之后的结果
  - formatSequence
```
protected String formatSequence(Iterable<?> iterable)
```
    按顺序使用迭代器元素替换占位符
    
    Parameters:
    
    iterable - iterable
    
    Returns:
    
    格式化字符串
  - formatBySegment
```
protected String formatBySegment(Function<AbstractPlaceholderSegment,?> valueSupplier)
```
    根据策略和默认值处理需要序列化的值, 生成格式化字符串
    依次遍历模板中的占位符，根据占位符返回需要序列化的值
    
    Parameters:
    
    valueSupplier - 根据占位符返回需要序列化的值，如果返回值不是 String，则使用 StrUtil.utf8Str(Object) 方法转为字符串
    
    Returns:
    
    模板格式化之后的结果
  - formatMissingKey
```
protected String formatMissingKey(AbstractPlaceholderSegment segment)
```
    根据策略返回格式化参数中找不到占位符时的默认值
    例如，map中没有占位符变量这个key；基于下标的参数中，找不到占位符下标对应的列表元素
    
    Parameters:
    
    segment - 占位符
    
    Returns:
    
    参数中找不到占位符时的默认值
  - formatNullValue
```
protected String formatNullValue(AbstractPlaceholderSegment segment)
```
    根据策略返回占位符对应的值为 null 时的返回值
    
    Parameters:
    
    segment - 占位符
    
    Returns:
    
    占位符对应的值为 null 时的返回值
  - matchesRawByKey
```
public void matchesRawByKey(String str,
                            BiConsumer<String,String> keyValueConsumer)
```
    原始数据的解析方法
    不对占位符和解析得到的值做任何处理，由用户抉择
    
    Parameters:
    
    str - 待解析的字符串
    
    keyValueConsumer - 消费占位符变量名称和占位符对应的解析得到的字符串值，例如：
    (key, value) -> map.put(key, value)
  - matchesRawBySegment
```
public void matchesRawBySegment(String str,
                                BiConsumer<AbstractPlaceholderSegment,String> keyValueConsumer)
```
    原始数据的解析方法
    不对占位符和解析得到的值做任何处理，由用户抉择
    
    Parameters:
    
    str - 待解析的字符串
    
    keyValueConsumer - 消费占位符和占位符对应的解析得到的字符串值，例如：
    (key, value) -> map.put(key, value)
  - matchesSequence
```
protected List<String> matchesSequence(String str)
```
    将占位符位置的值按顺序解析为字符串列表
    
    Parameters:
    
    str - 待解析的字符串，一般是格式化方法的返回值
    
    Returns:
    
    字符串列表
  - matchesByKey
```
public void matchesByKey(String str,
                         BiConsumer<String,String> keyValueConsumer)
```
    根据策略和默认值获得最终的 value，由消费者处理该 value
    
    Parameters:
    
    str - 待解析的字符串
    
    keyValueConsumer - 按占位符顺序消费占位符变量和最终的value，例如：
    (key, value) -> map.put(key, value)
  - matchesByKey
```
protected void matchesByKey(String str,
                            BiConsumer<String,String> keyValueConsumer,
                            boolean hasDefaultValue,
                            Function<AbstractPlaceholderSegment,String> defaultValueSupplier)
```
    根据策略和默认值获得最终的 value，由消费者处理该 value
    
    Parameters:
    
    str - 待解析的字符串
    
    keyValueConsumer - 按占位符顺序消费占位符变量和最终的value，例如：
    (key, value) -> map.put(key, value)
    
    hasDefaultValue - 是否有默认值
    
    defaultValueSupplier - 默认值提供者，根据占位符返回默认值
  - hasDefaultValue
```
protected boolean hasDefaultValue()
```
    是否有默认值
    
    Returns:
    
    是否有默认值
  - getDefaultValue
```
protected String getDefaultValue(AbstractPlaceholderSegment segment)
```
    根据占位符返回默认值
    根据定义的默认值、默认值提供者、全局默认值提供者，返回默认值
    
    Parameters:
    
    segment - 占位符
    
    Returns:
    
    默认值
  - afterInit
```
protected void afterInit()
```
    一些公共的初始化代码
    由于此时子类还没构造完成，所以只能由子类构造方法调用
  - addLiteralSegment
```
protected void addLiteralSegment(boolean isLastLiteralSegment,
                                 List<StrTemplateSegment> list,
                                 String newText)
```
    添加固定文本segment，过滤空字符串并合并相邻的固定文本
    
    Parameters:
    
    isLastLiteralSegment - 上一个新增的segment是否是固定文本
    
    list - 已保存的segment列表
    
    newText - 新的固定文本
  - parseSegments
```
protected abstract List<StrTemplateSegment> parseSegments(String template)
```
    将模板解析为 Segment 列表
    
    Parameters:
    
    template - 字符串模板
    
    Returns:
    
    Segment列表
  - getSegments
```
protected List<StrTemplateSegment> getSegments()
```
    获取模板中所有segment
    
    Returns:
    
    segment列表
  - getPlaceholderSegments
```
protected List<AbstractPlaceholderSegment> getPlaceholderSegments()
```
    获取模板中的占位符 segment
    
    Returns:
    
    占位符列表

Class StrTemplate

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_ESCAPE

globalFeatures

globalDefaultValueHandler

escape

defaultValue

defaultValueHandler

segments

placeholderSegments

fixedTextTotalLength

Constructor Detail

StrTemplate

Method Detail

of

ofNamed

setGlobalFeatures

setGlobalDefaultValue

getTemplate

getFeatures

isMatches

getPlaceholderVariableNames

getPlaceholderTexts

formatRawByKey

formatRawBySegment

formatSequence

formatBySegment

formatMissingKey

formatNullValue

matchesRawByKey

matchesRawBySegment

matchesSequence

matchesByKey

matchesByKey

hasDefaultValue

getDefaultValue

afterInit

addLiteralSegment

parseSegments

getSegments

getPlaceholderSegments