com.iohao.game.common.kit.StrKit Maven / Gradle / Ivy

Go to download
/*
 * # iohao.com . 渔民小镇
 * Copyright (C) 2021 - 2022 double joker （[email protected]） . All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.iohao.game.common.kit;

import cn.hutool.core.util.StrUtil;
import lombok.experimental.UtilityClass;

import java.util.Map;

/**
 * @author 渔民小镇
 * @date 2022-05-28
 */
@UtilityClass
public class StrKit {

    /**
     * 格式化文本，使用 {varName} 占位

     * map = {a: "aValue", b: "bValue"} format("{a} and {b}", map) ---=》 aValue and bValue
     *
     * @param template 文本模板，被替换的部分用 {key} 表示
     * @param map      参数值对
     * @return 格式化后的文本
     */
    public static String format(CharSequence template, Map map) {
        return StrUtil.format(template, map);
    }

    /**
     * 格式化文本, {} 表示占位符

     * 此方法只是简单将占位符 {} 按照顺序替换为参数

     * 如果想输出 {} 使用 \\转义 { 即可，如果想输出 {} 之前的 \ 使用双转义符 \\\\ 即可

     * 例：

     * 通常使用：format("this is {} for {}", "a", "b") =》 this is a for b

     * 转义{}： format("this is \\{} for {}", "a", "b") =》 this is {} for a

     * 转义\： format("this is \\\\{} for {}", "a", "b") =》 this is \a for b

     *
     * @param template 文本模板，被替换的部分用 {} 表示，如果模板为null，返回"null"
     * @param params   参数值
     * @return 格式化后的文本，如果模板为null，返回"null"
     */
    public static String format(CharSequence template, Object... params) {
        return StrUtil.format(template, params);
    }

    /**
     * 字符串是否为空，空的定义如下：
     * 
     *     {@code null}
     *     空字符串：{@code ""}
     * 
     *
     * 例：
     * 
     *     {@code StrKit.isEmpty(null)     // true}
     *     {@code StrKit.isEmpty("")       // true}
     *     {@code StrKit.isEmpty(" \t\n")  // false}
     *     {@code StrKit.isEmpty("abc")    // false}
     * 
     *
     * 建议：
     * 
     *     该方法建议用于工具类或任何可以预期的方法参数的校验中。
     * 
     *
     * @param str 被检测的字符串
     * @return 是否为空
     */
    public static boolean isEmpty(CharSequence str) {
        return str == null || str.length() == 0;
    }


    /**
     * 字符串是否为非空白，非空白的定义如下： 
     * 
     *     不为 {@code null}
     *     不为空字符串：{@code ""}
     * 
     *
     * 例：
     * 
     *     {@code StrKit.isNotEmpty(null)     // false}
     *     {@code StrKit.isNotEmpty("")       // false}
     *     {@code StrKit.isNotEmpty(" \t\n")  // true}
     *     {@code StrKit.isNotEmpty("abc")    // true}
     * 
     *
     * 建议：该方法建议用于工具类或任何可以预期的方法参数的校验中。
     *
     * @param str 被检测的字符串
     * @return 是否为非空
     * @see #isEmpty(CharSequence)
     */
    public static boolean isNotEmpty(CharSequence str) {
        return !isEmpty(str);
    }
}