java模板字符串優(yōu)雅解析(占位符解析)

項目中常常需要解析字符串模板,比如user:{userId}:{userType}用于redis的key等,比較常見的做法就是使用String.format("user:%s:%s", 1, 1)方法,但個人感覺那樣的模板不夠明了,而使用模板解析器可更好地有助于解析此類字符串??墒褂胢ap用于解析,也可使用對象進行解析,也可使用類似String.format可變參數(shù)進行解析,多樣化解析對象值。有點類似于js的模板字符串${}。
也可自定義前綴后綴進行解析。如PlaceholderResolver.getResolver("{", "}")該對象可解析{}該類型的占位符.

性能方面:

PlaceholderResolve解析結(jié)果

String.format解析結(jié)果

解析100w次,占位符解析比String.format平均都會快個0.4~0.5s,so 性能應該問題不大。最主要的是不需要調(diào)用太多的對象方法,自動解析,方便快捷。

源代碼如下:

/**
 * 占位符解析器
 *
 * @author meilin.huang
 * @version 1.0
 * @date 2018-11-13 1:42 PM
 */
public class PlaceholderResolver {
    /**
     * 默認前綴占位符
     */
    public static final String DEFAULT_PLACEHOLDER_PREFIX = "${";

    /**
     * 默認后綴占位符
     */
    public static final String DEFAULT_PLACEHOLDER_SUFFIX = "}";

    /**
     * 默認單例解析器
     */
    private static PlaceholderResolver defaultResolver = new PlaceholderResolver();

    /**
     * 占位符前綴
     */
    private String placeholderPrefix = DEFAULT_PLACEHOLDER_PREFIX;

    /**
     * 占位符后綴
     */
    private String placeholderSuffix = DEFAULT_PLACEHOLDER_SUFFIX;


    private PlaceholderResolver(){}

    private PlaceholderResolver(String placeholderPrefix, String placeholderSuffix) {
        this.placeholderPrefix = placeholderPrefix;
        this.placeholderSuffix = placeholderSuffix;
    }

    /**
     * 獲取默認的占位符解析器,即占位符前綴為"${", 后綴為"}"
     * @return
     */
    public static PlaceholderResolver getDefaultResolver() {
        return defaultResolver;
    }

    public static PlaceholderResolver getResolver(String placeholderPrefix, String placeholderSuffix) {
        return new PlaceholderResolver(placeholderPrefix, placeholderSuffix);
    }

    /**
     * 解析帶有指定占位符的模板字符串,默認占位符為前綴:${  后綴:}<br/><br/>
     * 如:template = category:${}:product:${}<br/>
     * values = {"1", "2"}<br/>
     * 返回 category:1:product:2<br/>
     *
     * @param content 要解析的帶有占位符的模板字符串
     * @param values   按照模板占位符索引位置設(shè)置對應的值
     * @return
     */
    public String resolve(String content, String... values) {
        int start = content.indexOf(this.placeholderPrefix);
        if (start == -1) {
            return content;
        }
        //值索引
        int valueIndex = 0;
        StringBuilder result = new StringBuilder(content);
        while (start != -1) {
            int end = result.indexOf(this.placeholderSuffix);
            String replaceContent = values[valueIndex++];
            result.replace(start, end + this.placeholderSuffix.length(), replaceContent);
            start = result.indexOf(this.placeholderPrefix, start + replaceContent.length());
        }
        return result.toString();
    }

    /**
     * 解析帶有指定占位符的模板字符串,默認占位符為前綴:${  后綴:}<br/><br/>
     * 如:template = category:${}:product:${}<br/>
     * values = {"1", "2"}<br/>
     * 返回 category:1:product:2<br/>
     *
     * @param content 要解析的帶有占位符的模板字符串
     * @param values   按照模板占位符索引位置設(shè)置對應的值
     * @return
     */
    public String resolve(String content, Object[] values) {
        return resolve(content, Stream.of(values).map(String::valueOf).toArray(String[]::new));
    }

    /**
     * 根據(jù)替換規(guī)則來替換指定模板中的占位符值
     * @param content  要解析的字符串
     * @param rule  解析規(guī)則回調(diào)
     * @return
     */
    public String resolveByRule(String content, Function<String, String> rule) {
        int start = content.indexOf(this.placeholderPrefix);
        if (start == -1) {
            return content;
        }
        StringBuilder result = new StringBuilder(content);
        while (start != -1) {
            int end = result.indexOf(this.placeholderSuffix, start);
            //獲取占位符屬性值,如${id}, 即獲取id
            String placeholder = result.substring(start + this.placeholderPrefix.length(), end);
            //替換整個占位符內(nèi)容,即將${id}值替換為替換規(guī)則回調(diào)中的內(nèi)容
            String replaceContent = placeholder.trim().isEmpty() ? "" : rule.apply(placeholder);
            result.replace(start, end + this.placeholderSuffix.length(), replaceContent);
            start = result.indexOf(this.placeholderPrefix, start + replaceContent.length());
        }
        return result.toString();
    }

    /**
     * 替換模板中占位符內(nèi)容,占位符的內(nèi)容即為map key對應的值,key為占位符中的內(nèi)容。<br/><br/>
     * 如:content = product:${id}:detail:${did}<br/>
     *    valueMap = id -> 1; pid -> 2<br/>
     *    經(jīng)過解析返回 product:1:detail:2<br/>
     *
     * @param content  模板內(nèi)容。
     * @param valueMap 值映射
     * @return   替換完成后的字符串。
     */
    public String resolveByMap(String content, final Map<String, Object> valueMap) {
        return resolveByRule(content, placeholderValue -> String.valueOf(valueMap.get(placeholderValue)));
    }

    /**
     * 根據(jù)properties文件替換占位符內(nèi)容
     * @param content
     * @param properties
     * @return
     */
    public String resolveByProperties(String content, final Properties properties) {
        return resolveByRule(content, placeholderValue -> properties.getProperty(placeholderValue));
    }

    /**
     * 根據(jù)對象中字段路徑(即類似js訪問對象屬性值)替換模板中的占位符 <br/><br/>
     * 如 content = product:${id}:detail:${detail.id} <br/>
     *    obj = Product.builder().id(1).detail(Detail.builder().id(2).build()).build(); <br/>
     *    經(jīng)過解析返回 product:1:detail:2 <br/>
     *
     * @param content  要解析的內(nèi)容
     * @param obj   填充解析內(nèi)容的對象(如果是基本類型,則所有占位符替換為相同的值)
     * @return
     */
    public String resolveByObject(String content, final Object obj) {
        if (obj instanceof Map) {
            return resolveByMap(content, (Map)obj);
        }
        return resolveByRule(content, placeholderValue -> String.valueOf(ReflectionUtils.getValueByFieldPath(obj, placeholderValue)));
    }
}
由于代碼還有一些工具類的調(diào)用因為篇幅問題沒有貼,如有需要可以去 https://gitee.com/objs/mayfly 該項目中獲取
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務。

友情鏈接更多精彩內(nèi)容