cn.hutool.core.text.CharSequenceUtil Maven / Gradle / Ivy
package cn.hutool.core.text;
import cn.hutool.core.collection.CollUtil;
import cn.hutool.core.comparator.VersionComparator;
import cn.hutool.core.convert.Convert;
import cn.hutool.core.lang.Assert;
import cn.hutool.core.lang.Filter;
import cn.hutool.core.lang.Matcher;
import cn.hutool.core.lang.func.Func1;
import cn.hutool.core.text.finder.CharFinder;
import cn.hutool.core.text.finder.Finder;
import cn.hutool.core.text.finder.StrFinder;
import cn.hutool.core.util.ArrayUtil;
import cn.hutool.core.util.CharUtil;
import cn.hutool.core.util.CharsetUtil;
import cn.hutool.core.util.DesensitizedUtil;
import cn.hutool.core.util.NumberUtil;
import cn.hutool.core.util.ReUtil;
import cn.hutool.core.util.StrUtil;
import java.nio.ByteBuffer;
import java.nio.charset.Charset;
import java.text.MessageFormat;
import java.text.Normalizer;
import java.util.HashSet;
import java.util.LinkedList;
import java.util.List;
import java.util.Set;
import java.util.function.Function;
import java.util.function.Predicate;
/**
* {@link CharSequence} 相关工具类封装
*
* @author looly
* @since 5.5.3
*/
public class CharSequenceUtil {
public static final int INDEX_NOT_FOUND = Finder.INDEX_NOT_FOUND;
/**
* 字符串常量：{@code "null"}
* 注意：{@code "null" != null}
*/
public static final String NULL = "null";
/**
* 字符串常量：空字符串 {@code ""}
*/
public static final String EMPTY = "";
/**
* 字符串常量：空格符 {@code " "}
*/
public static final String SPACE = " ";
/**
* 字符串是否为空白，空白的定义如下：
*
* - {@code null}
* - 空字符串：{@code ""}
* - 空格、全角空格、制表符、换行符，等不可见字符
*
*
* 例：
*
* - {@code StrUtil.isBlank(null) // true}
* - {@code StrUtil.isBlank("") // true}
* - {@code StrUtil.isBlank(" \t\n") // true}
* - {@code StrUtil.isBlank("abc") // false}
*
*
* 注意：该方法与 {@link #isEmpty(CharSequence)} 的区别是：
* 该方法会校验空白字符，且性能相对于 {@link #isEmpty(CharSequence)} 略慢。
*
*
* 建议：
*
* - 该方法建议仅对于客户端（或第三方接口）传入的参数使用该方法。
* - 需要同时校验多个字符串时，建议采用 {@link #hasBlank(CharSequence...)} 或 {@link #isAllBlank(CharSequence...)}
*
*
* @param str 被检测的字符串
* @return 若为空白，则返回 true
* @see #isEmpty(CharSequence)
*/
public static boolean isBlank(CharSequence str) {
final int length;
if ((str == null) || ((length = str.length()) == 0)) {
return true;
}
for (int i = 0; i < length; i++) {
// 只要有一个非空字符即为非空字符串
if (false == CharUtil.isBlankChar(str.charAt(i))) {
return false;
}
}
return true;
}
/**
* 字符串是否为非空白，非空白的定义如下：
*
* - 不为 {@code null}
* - 不为空字符串：{@code ""}
* - 不为空格、全角空格、制表符、换行符，等不可见字符
*
*
* 例：
*
* - {@code StrUtil.isNotBlank(null) // false}
* - {@code StrUtil.isNotBlank("") // false}
* - {@code StrUtil.isNotBlank(" \t\n") // false}
* - {@code StrUtil.isNotBlank("abc") // true}
*
*
* 注意：该方法与 {@link #isNotEmpty(CharSequence)} 的区别是：
* 该方法会校验空白字符，且性能相对于 {@link #isNotEmpty(CharSequence)} 略慢。
* 建议：仅对于客户端（或第三方接口）传入的参数使用该方法。
*
* @param str 被检测的字符串
* @return 是否为非空
* @see #isBlank(CharSequence)
*/
public static boolean isNotBlank(CharSequence str) {
return !isBlank(str);
}
/**
* 指定字符串数组中，是否包含空字符串。
* 如果指定的字符串数组的长度为 0，或者其中的任意一个元素是空字符串，则返回 true。
*
*
* 例：
*
* - {@code StrUtil.hasBlank() // true}
* - {@code StrUtil.hasBlank("", null, " ") // true}
* - {@code StrUtil.hasBlank("123", " ") // true}
* - {@code StrUtil.hasBlank("123", "abc") // false}
*
*
* 注意：该方法与 {@link #isAllBlank(CharSequence...)} 的区别在于：
*
* - hasBlank(CharSequence...) 等价于 {@code isBlank(...) || isBlank(...) || ...}
* - {@link #isAllBlank(CharSequence...)} 等价于 {@code isBlank(...) && isBlank(...) && ...}
*
*
* @param strs 字符串列表
* @return 是否包含空字符串
*/
public static boolean hasBlank(CharSequence... strs) {
if (ArrayUtil.isEmpty(strs)) {
return true;
}
for (CharSequence str : strs) {
if (isBlank(str)) {
return true;
}
}
return false;
}
/**
* 指定字符串数组中的元素，是否全部为空字符串。
* 如果指定的字符串数组的长度为 0，或者所有元素都是空字符串，则返回 true。
*
*
* 例：
*
* - {@code StrUtil.isAllBlank() // true}
* - {@code StrUtil.isAllBlank("", null, " ") // true}
* - {@code StrUtil.isAllBlank("123", " ") // false}
* - {@code StrUtil.isAllBlank("123", "abc") // false}
*
*
* 注意：该方法与 {@link #hasBlank(CharSequence...)} 的区别在于：
*
* - {@link #hasBlank(CharSequence...)} 等价于 {@code isBlank(...) || isBlank(...) || ...}
* - isAllBlank(CharSequence...) 等价于 {@code isBlank(...) && isBlank(...) && ...}
*
*
* @param strs 字符串列表
* @return 所有字符串是否为空白
*/
public static boolean isAllBlank(CharSequence... strs) {
if (ArrayUtil.isEmpty(strs)) {
return true;
}
for (CharSequence str : strs) {
if (isNotBlank(str)) {
return false;
}
}
return true;
}
/**
* 字符串是否为空，空的定义如下：
*
* - {@code null}
* - 空字符串：{@code ""}
*
*
* 例：
*
* - {@code StrUtil.isEmpty(null) // true}
* - {@code StrUtil.isEmpty("") // true}
* - {@code StrUtil.isEmpty(" \t\n") // false}
* - {@code StrUtil.isEmpty("abc") // false}
*
*
* 注意：该方法与 {@link #isBlank(CharSequence)} 的区别是：该方法不校验空白字符。
* 建议：
*
* - 该方法建议用于工具类或任何可以预期的方法参数的校验中。
* - 需要同时校验多个字符串时，建议采用 {@link #hasEmpty(CharSequence...)} 或 {@link #isAllEmpty(CharSequence...)}
*
*
* @param str 被检测的字符串
* @return 是否为空
* @see #isBlank(CharSequence)
*/
public static boolean isEmpty(CharSequence str) {
return str == null || str.length() == 0;
}
/**
* 字符串是否为非空白，非空白的定义如下：
*
* - 不为 {@code null}
* - 不为空字符串：{@code ""}
*
*
* 例：
*
* - {@code StrUtil.isNotEmpty(null) // false}
* - {@code StrUtil.isNotEmpty("") // false}
* - {@code StrUtil.isNotEmpty(" \t\n") // true}
* - {@code StrUtil.isNotEmpty("abc") // true}
*
*
* 注意：该方法与 {@link #isNotBlank(CharSequence)} 的区别是：该方法不校验空白字符。
* 建议：该方法建议用于工具类或任何可以预期的方法参数的校验中。
*
* @param str 被检测的字符串
* @return 是否为非空
* @see #isEmpty(CharSequence)
*/
public static boolean isNotEmpty(CharSequence str) {
return !isEmpty(str);
}
/**
* 当给定字符串为null时，转换为Empty
*
* @param str 被检查的字符串
* @return 原字符串或者空串
* @see #nullToEmpty(CharSequence)
* @since 4.6.3
*/
public static String emptyIfNull(CharSequence str) {
return nullToEmpty(str);
}
/**
* 当给定字符串为null时，转换为Empty
*
* @param str 被转换的字符串
* @return 转换后的字符串
*/
public static String nullToEmpty(CharSequence str) {
return nullToDefault(str, EMPTY);
}
/**
* 如果字符串是 {@code null}，则返回指定默认字符串，否则返回字符串本身。
*
*
* nullToDefault(null, "default") = "default"
* nullToDefault("", "default") = ""
* nullToDefault(" ", "default") = " "
* nullToDefault("bat", "default") = "bat"
*
*
* @param str 要转换的字符串
* @param defaultStr 默认字符串
* @return 字符串本身或指定的默认字符串
*/
public static String nullToDefault(CharSequence str, String defaultStr) {
return (str == null) ? defaultStr : str.toString();
}
/**
* 如果字符串是{@code null}或者""，则返回指定默认字符串，否则返回字符串本身。
*
*
* emptyToDefault(null, "default") = "default"
* emptyToDefault("", "default") = "default"
* emptyToDefault(" ", "default") = " "
* emptyToDefault("bat", "default") = "bat"
*
*
* @param str 要转换的字符串
* @param defaultStr 默认字符串
* @return 字符串本身或指定的默认字符串
* @since 4.1.0
*/
public static String emptyToDefault(CharSequence str, String defaultStr) {
return isEmpty(str) ? defaultStr : str.toString();
}
/**
* 如果字符串是{@code null}或者""或者空白，则返回指定默认字符串，否则返回字符串本身。
*
*
* blankToDefault(null, "default") = "default"
* blankToDefault("", "default") = "default"
* blankToDefault(" ", "default") = "default"
* blankToDefault("bat", "default") = "bat"
*
*
* @param str 要转换的字符串
* @param defaultStr 默认字符串
* @return 字符串本身或指定的默认字符串
* @since 4.1.0
*/
public static String blankToDefault(CharSequence str, String defaultStr) {
return isBlank(str) ? defaultStr : str.toString();
}
/**
* 当给定字符串为空字符串时，转换为{@code null}
*
* @param str 被转换的字符串
* @return 转换后的字符串
*/
public static String emptyToNull(CharSequence str) {
return isEmpty(str) ? null : str.toString();
}
/**
* 是否包含空字符串。
* 如果指定的字符串数组的长度为 0，或者其中的任意一个元素是空字符串，则返回 true。
*
*
* 例：
*
* - {@code StrUtil.hasEmpty() // true}
* - {@code StrUtil.hasEmpty("", null) // true}
* - {@code StrUtil.hasEmpty("123", "") // true}
* - {@code StrUtil.hasEmpty("123", "abc") // false}
* - {@code StrUtil.hasEmpty(" ", "\t", "\n") // false}
*
*
* 注意：该方法与 {@link #isAllEmpty(CharSequence...)} 的区别在于：
*
* - hasEmpty(CharSequence...) 等价于 {@code isEmpty(...) || isEmpty(...) || ...}
* - {@link #isAllEmpty(CharSequence...)} 等价于 {@code isEmpty(...) && isEmpty(...) && ...}
*
*
* @param strs 字符串列表
* @return 是否包含空字符串
*/
public static boolean hasEmpty(CharSequence... strs) {
if (ArrayUtil.isEmpty(strs)) {
return true;
}
for (CharSequence str : strs) {
if (isEmpty(str)) {
return true;
}
}
return false;
}
/**
* 指定字符串数组中的元素，是否全部为空字符串。
* 如果指定的字符串数组的长度为 0，或者所有元素都是空字符串，则返回 true。
*
*
* 例：
*
* - {@code StrUtil.isAllEmpty() // true}
* - {@code StrUtil.isAllEmpty("", null) // true}
* - {@code StrUtil.isAllEmpty("123", "") // false}
* - {@code StrUtil.isAllEmpty("123", "abc") // false}
* - {@code StrUtil.isAllEmpty(" ", "\t", "\n") // false}
*
*
* 注意：该方法与 {@link #hasEmpty(CharSequence...)} 的区别在于：
*
* - {@link #hasEmpty(CharSequence...)} 等价于 {@code isEmpty(...) || isEmpty(...) || ...}
* - isAllEmpty(CharSequence...) 等价于 {@code isEmpty(...) && isEmpty(...) && ...}
*
*
* @param strs 字符串列表
* @return 所有字符串是否为空白
*/
public static boolean isAllEmpty(CharSequence... strs) {
if (ArrayUtil.isEmpty(strs)) {
return true;
}
for (CharSequence str : strs) {
if (isNotEmpty(str)) {
return false;
}
}
return true;
}
/**
* 指定字符串数组中的元素，是否都不为空字符串。
* 如果指定的字符串数组的长度不为 0，或者所有元素都不是空字符串，则返回 true。
*
*
* 例：
*
* - {@code StrUtil.isAllNotEmpty() // false}
* - {@code StrUtil.isAllNotEmpty("", null) // false}
* - {@code StrUtil.isAllNotEmpty("123", "") // false}
* - {@code StrUtil.isAllNotEmpty("123", "abc") // true}
* - {@code StrUtil.isAllNotEmpty(" ", "\t", "\n") // true}
*
*
* 注意：该方法与 {@link #isAllEmpty(CharSequence...)} 的区别在于：
*
* - {@link #isAllEmpty(CharSequence...)} 等价于 {@code isEmpty(...) && isEmpty(...) && ...}
* - isAllNotEmpty(CharSequence...) 等价于 {@code !isEmpty(...) && !isEmpty(...) && ...}
*
*
* @param args 字符串数组
* @return 所有字符串是否都不为为空白
* @since 5.3.6
*/
public static boolean isAllNotEmpty(CharSequence... args) {
return false == hasEmpty(args);
}
/**
* 是否存都不为{@code null}或空对象或空白符的对象，通过{@link #hasBlank(CharSequence...)} 判断元素
*
* @param args 被检查的对象,一个或者多个
* @return 是否都不为空
* @since 5.3.6
*/
public static boolean isAllNotBlank(CharSequence... args) {
return false == hasBlank(args);
}
/**
* 检查字符串是否为null、“null”、“undefined”
*
* @param str 被检查的字符串
* @return 是否为null、“null”、“undefined”
* @since 4.0.10
*/
public static boolean isNullOrUndefined(CharSequence str) {
if (null == str) {
return true;
}
return isNullOrUndefinedStr(str);
}
/**
* 检查字符串是否为null、“”、“null”、“undefined”
*
* @param str 被检查的字符串
* @return 是否为null、“”、“null”、“undefined”
* @since 4.0.10
*/
public static boolean isEmptyOrUndefined(CharSequence str) {
if (isEmpty(str)) {
return true;
}
return isNullOrUndefinedStr(str);
}
/**
* 检查字符串是否为null、空白串、“null”、“undefined”
*
* @param str 被检查的字符串
* @return 是否为null、空白串、“null”、“undefined”
* @since 4.0.10
*/
public static boolean isBlankOrUndefined(CharSequence str) {
if (isBlank(str)) {
return true;
}
return isNullOrUndefinedStr(str);
}
/**
* 是否为“null”、“undefined”，不做空指针检查
*
* @param str 字符串
* @return 是否为“null”、“undefined”
*/
private static boolean isNullOrUndefinedStr(CharSequence str) {
String strString = str.toString().trim();
return NULL.equals(strString) || "undefined".equals(strString);
}
// ------------------------------------------------------------------------ Trim
/**
* 除去字符串头尾部的空白，如果字符串是{@code null}，依然返回{@code null}。
*
*
* 注意，和{@link String#trim()}不同，此方法使用{@link CharUtil#isBlankChar(char)} 来判定空白， 因而可以除去英文字符集之外的其它空白，如中文空格。
*
*
* trim(null) = null
* trim("") = ""
* trim(" ") = ""
* trim("abc") = "abc"
* trim(" abc ") = "abc"
*
*
* @param str 要处理的字符串
* @return 除去头尾空白的字符串，如果原字串为{@code null}，则返回{@code null}
*/
public static String trim(CharSequence str) {
return (null == str) ? null : trim(str, 0);
}
/**
* 除去字符串头尾部的空白，如果字符串是{@code null}，返回{@code ""}。
*
*
* StrUtil.trimToEmpty(null) = ""
* StrUtil.trimToEmpty("") = ""
* StrUtil.trimToEmpty(" ") = ""
* StrUtil.trimToEmpty("abc") = "abc"
* StrUtil.trimToEmpty(" abc ") = "abc"
*
*
* @param str 字符串
* @return 去除两边空白符后的字符串, 如果为null返回""
* @since 3.1.1
*/
public static String trimToEmpty(CharSequence str) {
return str == null ? EMPTY : trim(str);
}
/**
* 除去字符串头尾部的空白，如果字符串是{@code null}或者""，返回{@code null}。
*
*
* StrUtil.trimToNull(null) = null
* StrUtil.trimToNull("") = null
* StrUtil.trimToNull(" ") = null
* StrUtil.trimToNull("abc") = "abc"
* StrUtil.trimToEmpty(" abc ") = "abc"
*
*
* @param str 字符串
* @return 去除两边空白符后的字符串, 如果为空返回null
* @since 3.2.1
*/
public static String trimToNull(CharSequence str) {
final String trimStr = trim(str);
return EMPTY.equals(trimStr) ? null : trimStr;
}
/**
* 除去字符串头部的空白，如果字符串是{@code null}，则返回{@code null}。
*
*
* 注意，和{@link String#trim()}不同，此方法使用{@link CharUtil#isBlankChar(char)} 来判定空白， 因而可以除去英文字符集之外的其它空白，如中文空格。
*
*
* trimStart(null) = null
* trimStart("") = ""
* trimStart("abc") = "abc"
* trimStart(" abc") = "abc"
* trimStart("abc ") = "abc "
* trimStart(" abc ") = "abc "
*
*
* @param str 要处理的字符串
* @return 除去空白的字符串，如果原字串为{@code null}或结果字符串为{@code ""}，则返回 {@code null}
*/
public static String trimStart(CharSequence str) {
return trim(str, -1);
}
/**
* 除去字符串尾部的空白，如果字符串是{@code null}，则返回{@code null}。
*
*
* 注意，和{@link String#trim()}不同，此方法使用{@link CharUtil#isBlankChar(char)} 来判定空白， 因而可以除去英文字符集之外的其它空白，如中文空格。
*
*
* trimEnd(null) = null
* trimEnd("") = ""
* trimEnd("abc") = "abc"
* trimEnd(" abc") = " abc"
* trimEnd("abc ") = "abc"
* trimEnd(" abc ") = " abc"
*
*
* @param str 要处理的字符串
* @return 除去空白的字符串，如果原字串为{@code null}或结果字符串为{@code ""}，则返回 {@code null}
*/
public static String trimEnd(CharSequence str) {
return trim(str, 1);
}
/**
* 除去字符串头尾部的空白符，如果字符串是{@code null}，依然返回{@code null}。
*
* @param str 要处理的字符串
* @param mode {@code -1}表示trimStart，{@code 0}表示trim全部， {@code 1}表示trimEnd
* @return 除去指定字符后的的字符串，如果原字串为{@code null}，则返回{@code null}
*/
public static String trim(CharSequence str, int mode) {
return trim(str, mode, CharUtil::isBlankChar);
}
/**
* 按照断言，除去字符串头尾部的断言为真的字符，如果字符串是{@code null}，依然返回{@code null}。
*
* @param str 要处理的字符串
* @param mode {@code -1}表示trimStart，{@code 0}表示trim全部， {@code 1}表示trimEnd
* @param predicate 断言是否过掉字符，返回{@code true}表述过滤掉，{@code false}表示不过滤
* @return 除去指定字符后的的字符串，如果原字串为{@code null}，则返回{@code null}
* @since 5.7.4
*/
public static String trim(CharSequence str, int mode, Predicate predicate) {
String result;
if (str == null) {
result = null;
} else {
int length = str.length();
int start = 0;
int end = length;// 扫描字符串头部
if (mode <= 0) {
while ((start < end) && (predicate.test(str.charAt(start)))) {
start++;
}
}// 扫描字符串尾部
if (mode >= 0) {
while ((start < end) && (predicate.test(str.charAt(end - 1)))) {
end--;
}
}
if ((start > 0) || (end < length)) {
result = str.toString().substring(start, end);
} else {
result = str.toString();
}
}
return result;
}
// ------------------------------------------------------------------------ startWith
/**
* 字符串是否以给定字符开始
*
* @param str 字符串
* @param c 字符
* @return 是否开始
*/
public static boolean startWith(CharSequence str, char c) {
if (isEmpty(str)) {
return false;
}
return c == str.charAt(0);
}
/**
* 是否以指定字符串开头
* 如果给定的字符串和开头字符串都为null则返回true，否则任意一个值为null返回false
*
* @param str 被监测字符串
* @param prefix 开头字符串
* @param ignoreCase 是否忽略大小写
* @return 是否以指定字符串开头
* @since 5.4.3
*/
public static boolean startWith(CharSequence str, CharSequence prefix, boolean ignoreCase) {
return startWith(str, prefix, ignoreCase, false);
}
/**
* 是否以指定字符串开头
* 如果给定的字符串和开头字符串都为null则返回true，否则任意一个值为null返回false
*
* CharSequenceUtil.startWith("123", "123", false, true); -- false
* CharSequenceUtil.startWith("ABCDEF", "abc", true, true); -- true
* CharSequenceUtil.startWith("abc", "abc", true, true); -- false
*
*
* @param str 被监测字符串
* @param prefix 开头字符串
* @param ignoreCase 是否忽略大小写
* @param ignoreEquals 是否忽略字符串相等的情况
* @return 是否以指定字符串开头
* @since 5.4.3
*/
public static boolean startWith(CharSequence str, CharSequence prefix, boolean ignoreCase, boolean ignoreEquals) {
if (null == str || null == prefix) {
if (ignoreEquals) {
return false;
}
return null == str && null == prefix;
}
boolean isStartWith = str.toString()
.regionMatches(ignoreCase, 0, prefix.toString(), 0, prefix.length());
if (isStartWith) {
return (false == ignoreEquals) || (false == equals(str, prefix, ignoreCase));
}
return false;
}
/**
* 是否以指定字符串开头
*
* @param str 被监测字符串
* @param prefix 开头字符串
* @return 是否以指定字符串开头
*/
public static boolean startWith(CharSequence str, CharSequence prefix) {
return startWith(str, prefix, false);
}
/**
* 是否以指定字符串开头，忽略相等字符串的情况
*
* @param str 被监测字符串
* @param prefix 开头字符串
* @return 是否以指定字符串开头并且两个字符串不相等
*/
public static boolean startWithIgnoreEquals(CharSequence str, CharSequence prefix) {
return startWith(str, prefix, false, true);
}
/**
* 是否以指定字符串开头，忽略大小写
*
* @param str 被监测字符串
* @param prefix 开头字符串
* @return 是否以指定字符串开头
*/
public static boolean startWithIgnoreCase(CharSequence str, CharSequence prefix) {
return startWith(str, prefix, true);
}
/**
* 给定字符串是否以任何一个字符串开始
* 给定字符串和数组为空都返回false
*
* @param str 给定字符串
* @param prefixes 需要检测的开始字符串
* @return 给定字符串是否以任何一个字符串开始
* @since 3.0.6
*/
public static boolean startWithAny(CharSequence str, CharSequence... prefixes) {
if (isEmpty(str) || ArrayUtil.isEmpty(prefixes)) {
return false;
}
for (CharSequence suffix : prefixes) {
if (startWith(str, suffix, false)) {
return true;
}
}
return false;
}
/**
* 给定字符串是否以任何一个字符串开始（忽略大小写）
* 给定字符串和数组为空都返回false
*
* @param str 给定字符串
* @param suffixes 需要检测的开始字符串
* @return 给定字符串是否以任何一个字符串开始
* @since 5.8.1
*/
public static boolean startWithAnyIgnoreCase(final CharSequence str, final CharSequence... suffixes) {
if (isEmpty(str) || ArrayUtil.isEmpty(suffixes)) {
return false;
}
for (final CharSequence suffix : suffixes) {
if (startWith(str, suffix, true)) {
return true;
}
}
return false;
}
// ------------------------------------------------------------------------ endWith
/**
* 字符串是否以给定字符结尾
*
* @param str 字符串
* @param c 字符
* @return 是否结尾
*/
public static boolean endWith(CharSequence str, char c) {
if (isEmpty(str)) {
return false;
}
return c == str.charAt(str.length() - 1);
}
/**
* 是否以指定字符串结尾
* 如果给定的字符串和开头字符串都为null则返回true，否则任意一个值为null返回false
*
* @param str 被监测字符串
* @param suffix 结尾字符串
* @param ignoreCase 是否忽略大小写
* @return 是否以指定字符串结尾
*/
public static boolean endWith(CharSequence str, CharSequence suffix, boolean ignoreCase) {
return endWith(str, suffix, ignoreCase, false);
}
/**
* 是否以指定字符串结尾
* 如果给定的字符串和开头字符串都为null则返回true，否则任意一个值为null返回false
*
* @param str 被监测字符串
* @param suffix 结尾字符串
* @param ignoreCase 是否忽略大小写
* @param ignoreEquals 是否忽略字符串相等的情况
* @return 是否以指定字符串结尾
* @since 5.8.0
*/
public static boolean endWith(CharSequence str, CharSequence suffix, boolean ignoreCase, boolean ignoreEquals) {
if (null == str || null == suffix) {
if (ignoreEquals) {
return false;
}
return null == str && null == suffix;
}
final int strOffset = str.length() - suffix.length();
boolean isEndWith = str.toString()
.regionMatches(ignoreCase, strOffset, suffix.toString(), 0, suffix.length());
if (isEndWith) {
return (false == ignoreEquals) || (false == equals(str, suffix, ignoreCase));
}
return false;
}
/**
* 是否以指定字符串结尾
*
* @param str 被监测字符串
* @param suffix 结尾字符串
* @return 是否以指定字符串结尾
*/
public static boolean endWith(CharSequence str, CharSequence suffix) {
return endWith(str, suffix, false);
}
/**
* 是否以指定字符串结尾，忽略大小写
*
* @param str 被监测字符串
* @param suffix 结尾字符串
* @return 是否以指定字符串结尾
*/
public static boolean endWithIgnoreCase(CharSequence str, CharSequence suffix) {
return endWith(str, suffix, true);
}
/**
* 给定字符串是否以任何一个字符串结尾
* 给定字符串和数组为空都返回false
*
* @param str 给定字符串
* @param suffixes 需要检测的结尾字符串
* @return 给定字符串是否以任何一个字符串结尾
* @since 3.0.6
*/
public static boolean endWithAny(CharSequence str, CharSequence... suffixes) {
if (isEmpty(str) || ArrayUtil.isEmpty(suffixes)) {
return false;
}
for (CharSequence suffix : suffixes) {
if (endWith(str, suffix, false)) {
return true;
}
}
return false;
}
/**
* 给定字符串是否以任何一个字符串结尾（忽略大小写）
* 给定字符串和数组为空都返回false
*
* @param str 给定字符串
* @param suffixes 需要检测的结尾字符串
* @return 给定字符串是否以任何一个字符串结尾
* @since 5.5.9
*/
public static boolean endWithAnyIgnoreCase(CharSequence str, CharSequence... suffixes) {
if (isEmpty(str) || ArrayUtil.isEmpty(suffixes)) {
return false;
}
for (CharSequence suffix : suffixes) {
if (endWith(str, suffix, true)) {
return true;
}
}
return false;
}
// ------------------------------------------------------------------------ contains
/**
* 指定字符是否在字符串中出现过
*
* @param str 字符串
* @param searchChar 被查找的字符
* @return 是否包含
* @since 3.1.2
*/
public static boolean contains(CharSequence str, char searchChar) {
return indexOf(str, searchChar) > -1;
}
/**
* 指定字符串是否在字符串中出现过
*
* @param str 字符串
* @param searchStr 被查找的字符串
* @return 是否包含
* @since 5.1.1
*/
public static boolean contains(CharSequence str, CharSequence searchStr) {
if (null == str || null == searchStr) {
return false;
}
return str.toString().contains(searchStr);
}
/**
* 查找指定字符串是否包含指定字符串列表中的任意一个字符串
*
* @param str 指定字符串
* @param testStrs 需要检查的字符串数组
* @return 是否包含任意一个字符串
* @since 3.2.0
*/
public static boolean containsAny(CharSequence str, CharSequence... testStrs) {
return null != getContainsStr(str, testStrs);
}
/**
* 查找指定字符串是否包含指定字符列表中的任意一个字符
*
* @param str 指定字符串
* @param testChars 需要检查的字符数组
* @return 是否包含任意一个字符
* @since 4.1.11
*/
public static boolean containsAny(CharSequence str, char... testChars) {
if (false == isEmpty(str)) {
int len = str.length();
for (int i = 0; i < len; i++) {
if (ArrayUtil.contains(testChars, str.charAt(i))) {
return true;
}
}
}
return false;
}
/**
* 检查指定字符串中是否只包含给定的字符
*
* @param str 字符串
* @param testChars 检查的字符
* @return 字符串含有非检查的字符，返回false
* @since 4.4.1
*/
public static boolean containsOnly(CharSequence str, char... testChars) {
if (false == isEmpty(str)) {
int len = str.length();
for (int i = 0; i < len; i++) {
if (false == ArrayUtil.contains(testChars, str.charAt(i))) {
return false;
}
}
}
return true;
}
/**
* 检查指定字符串中是否含给定的所有字符串
*
* @param str 字符串
* @param testChars 检查的字符
* @return 字符串含有非检查的字符，返回false
* @since 4.4.1
*/
public static boolean containsAll(CharSequence str, CharSequence... testChars) {
if (isBlank(str) || ArrayUtil.isEmpty(testChars)) {
return false;
}
for (CharSequence testChar : testChars) {
if (false == contains(str, testChar)) {
return false;
}
}
return true;
}
/**
* 给定字符串是否包含空白符（空白符包括空格、制表符、全角空格和不间断空格）
* 如果给定字符串为null或者""，则返回false
*
* @param str 字符串
* @return 是否包含空白符
* @since 4.0.8
*/
public static boolean containsBlank(CharSequence str) {
if (null == str) {
return false;
}
final int length = str.length();
if (0 == length) {
return false;
}
for (int i = 0; i < length; i += 1) {
if (CharUtil.isBlankChar(str.charAt(i))) {
return true;
}
}
return false;
}
/**
* 查找指定字符串是否包含指定字符串列表中的任意一个字符串，如果包含返回找到的第一个字符串
*
* @param str 指定字符串
* @param testStrs 需要检查的字符串数组
* @return 被包含的第一个字符串
* @since 3.2.0
*/
public static String getContainsStr(CharSequence str, CharSequence... testStrs) {
if (isEmpty(str) || ArrayUtil.isEmpty(testStrs)) {
return null;
}
for (CharSequence checkStr : testStrs) {
if (str.toString().contains(checkStr)) {
return checkStr.toString();
}
}
return null;
}
/**
* 是否包含特定字符，忽略大小写，如果给定两个参数都为{@code null}，返回true
*
* @param str 被检测字符串
* @param testStr 被测试是否包含的字符串
* @return 是否包含
*/
public static boolean containsIgnoreCase(CharSequence str, CharSequence testStr) {
if (null == str) {
// 如果被监测字符串和
return null == testStr;
}
return indexOfIgnoreCase(str, testStr) > -1;
}
/**
* 查找指定字符串是否包含指定字符串列表中的任意一个字符串
* 忽略大小写
*
* @param str 指定字符串
* @param testStrs 需要检查的字符串数组
* @return 是否包含任意一个字符串
* @since 3.2.0
*/
public static boolean containsAnyIgnoreCase(CharSequence str, CharSequence... testStrs) {
return null != getContainsStrIgnoreCase(str, testStrs);
}
/**
* 查找指定字符串是否包含指定字符串列表中的任意一个字符串，如果包含返回找到的第一个字符串
* 忽略大小写
*
* @param str 指定字符串
* @param testStrs 需要检查的字符串数组
* @return 被包含的第一个字符串
* @since 3.2.0
*/
public static String getContainsStrIgnoreCase(CharSequence str, CharSequence... testStrs) {
if (isEmpty(str) || ArrayUtil.isEmpty(testStrs)) {
return null;
}
for (CharSequence testStr : testStrs) {
if (containsIgnoreCase(str, testStr)) {
return testStr.toString();
}
}
return null;
}
// ------------------------------------------------------------------------ indexOf
/**
* 指定范围内查找指定字符
*
* @param str 字符串
* @param searchChar 被查找的字符
* @return 位置
*/
public static int indexOf(CharSequence str, char searchChar) {
return indexOf(str, searchChar, 0);
}
/**
* 指定范围内查找指定字符
*
* @param str 字符串
* @param searchChar 被查找的字符
* @param start 起始位置，如果小于0，从0开始查找
* @return 位置
*/
public static int indexOf(CharSequence str, char searchChar, int start) {
if (str instanceof String) {
return ((String) str).indexOf(searchChar, start);
} else {
return indexOf(str, searchChar, start, -1);
}
}
/**
* 指定范围内查找指定字符
*
* @param text 字符串
* @param searchChar 被查找的字符
* @param start 起始位置，如果小于0，从0开始查找
* @param end 终止位置，如果超过str.length()则默认查找到字符串末尾
* @return 位置
*/
public static int indexOf(CharSequence text, char searchChar, int start, int end) {
if (isEmpty(text)) {
return INDEX_NOT_FOUND;
}
return new CharFinder(searchChar).setText(text).setEndIndex(end).start(start);
}
/**
* 指定范围内查找字符串，忽略大小写
*
*
* StrUtil.indexOfIgnoreCase(null, *, *) = -1
* StrUtil.indexOfIgnoreCase(*, null, *) = -1
* StrUtil.indexOfIgnoreCase("", "", 0) = 0
* StrUtil.indexOfIgnoreCase("aabaabaa", "A", 0) = 0
* StrUtil.indexOfIgnoreCase("aabaabaa", "B", 0) = 2
* StrUtil.indexOfIgnoreCase("aabaabaa", "AB", 0) = 1
* StrUtil.indexOfIgnoreCase("aabaabaa", "B", 3) = 5
* StrUtil.indexOfIgnoreCase("aabaabaa", "B", 9) = -1
* StrUtil.indexOfIgnoreCase("aabaabaa", "B", -1) = 2
* StrUtil.indexOfIgnoreCase("aabaabaa", "", 2) = 2
* StrUtil.indexOfIgnoreCase("abc", "", 9) = -1
*
*
* @param str 字符串
* @param searchStr 需要查找位置的字符串
* @return 位置
* @since 3.2.1
*/
public static int indexOfIgnoreCase(final CharSequence str, final CharSequence searchStr) {
return indexOfIgnoreCase(str, searchStr, 0);
}
/**
* 指定范围内查找字符串
*
*
* StrUtil.indexOfIgnoreCase(null, *, *) = -1
* StrUtil.indexOfIgnoreCase(*, null, *) = -1
* StrUtil.indexOfIgnoreCase("", "", 0) = 0
* StrUtil.indexOfIgnoreCase("aabaabaa", "A", 0) = 0
* StrUtil.indexOfIgnoreCase("aabaabaa", "B", 0) = 2
* StrUtil.indexOfIgnoreCase("aabaabaa", "AB", 0) = 1
* StrUtil.indexOfIgnoreCase("aabaabaa", "B", 3) = 5
* StrUtil.indexOfIgnoreCase("aabaabaa", "B", 9) = -1
* StrUtil.indexOfIgnoreCase("aabaabaa", "B", -1) = 2
* StrUtil.indexOfIgnoreCase("aabaabaa", "", 2) = 2
* StrUtil.indexOfIgnoreCase("abc", "", 9) = -1
*
*
* @param str 字符串
* @param searchStr 需要查找位置的字符串
* @param fromIndex 起始位置
* @return 位置
* @since 3.2.1
*/
public static int indexOfIgnoreCase(final CharSequence str, final CharSequence searchStr, int fromIndex) {
return indexOf(str, searchStr, fromIndex, true);
}
/**
* 指定范围内查找字符串
*
* @param text 字符串，空则返回-1
* @param searchStr 需要查找位置的字符串，空则返回-1
* @param from 起始位置（包含）
* @param ignoreCase 是否忽略大小写
* @return 位置
* @since 3.2.1
*/
public static int indexOf(CharSequence text, CharSequence searchStr, int from, boolean ignoreCase) {
if (isEmpty(text) || isEmpty(searchStr)) {
if (StrUtil.equals(text, searchStr)) {
return 0;
} else {
return INDEX_NOT_FOUND;
}
}
return new StrFinder(searchStr, ignoreCase).setText(text).start(from);
}
/**
* 指定范围内查找字符串，忽略大小写
*
* @param str 字符串
* @param searchStr 需要查找位置的字符串
* @return 位置
* @since 3.2.1
*/
public static int lastIndexOfIgnoreCase(CharSequence str, CharSequence searchStr) {
return lastIndexOfIgnoreCase(str, searchStr, str.length());
}
/**
* 指定范围内查找字符串，忽略大小写
* fromIndex 为搜索起始位置，从后往前计数
*
* @param str 字符串
* @param searchStr 需要查找位置的字符串
* @param fromIndex 起始位置，从后往前计数
* @return 位置
* @since 3.2.1
*/
public static int lastIndexOfIgnoreCase(CharSequence str, CharSequence searchStr, int fromIndex) {
return lastIndexOf(str, searchStr, fromIndex, true);
}
/**
* 指定范围内查找字符串
* fromIndex 为搜索起始位置，从后往前计数
*
* @param text 字符串
* @param searchStr 需要查找位置的字符串
* @param from 起始位置，从后往前计数
* @param ignoreCase 是否忽略大小写
* @return 位置
* @since 3.2.1
*/
public static int lastIndexOf(CharSequence text, CharSequence searchStr, int from, boolean ignoreCase) {
if (isEmpty(text) || isEmpty(searchStr)) {
if (StrUtil.equals(text, searchStr)) {
return 0;
} else {
return INDEX_NOT_FOUND;
}
}
return new StrFinder(searchStr, ignoreCase)
.setText(text).setNegative(true).start(from);
}
/**
* 返回字符串 searchStr 在字符串 str 中第 ordinal 次出现的位置。
*
*
* 如果 str=null 或 searchStr=null 或 ordinal≥0 则返回-1
* 此方法来自：Apache-Commons-Lang
*
* 例子（*代表任意字符）：
*
*
* StrUtil.ordinalIndexOf(null, *, *) = -1
* StrUtil.ordinalIndexOf(*, null, *) = -1
* StrUtil.ordinalIndexOf("", "", *) = 0
* StrUtil.ordinalIndexOf("aabaabaa", "a", 1) = 0
* StrUtil.ordinalIndexOf("aabaabaa", "a", 2) = 1
* StrUtil.ordinalIndexOf("aabaabaa", "b", 1) = 2
* StrUtil.ordinalIndexOf("aabaabaa", "b", 2) = 5
* StrUtil.ordinalIndexOf("aabaabaa", "ab", 1) = 1
* StrUtil.ordinalIndexOf("aabaabaa", "ab", 2) = 4
* StrUtil.ordinalIndexOf("aabaabaa", "", 1) = 0
* StrUtil.ordinalIndexOf("aabaabaa", "", 2) = 0
*
*
* @param str 被检查的字符串，可以为null
* @param searchStr 被查找的字符串，可以为null
* @param ordinal 第几次出现的位置
* @return 查找到的位置
* @since 3.2.3
*/
public static int ordinalIndexOf(CharSequence str, CharSequence searchStr, int ordinal) {
if (str == null || searchStr == null || ordinal <= 0) {
return INDEX_NOT_FOUND;
}
if (searchStr.length() == 0) {
return 0;
}
int found = 0;
int index = INDEX_NOT_FOUND;
do {
index = indexOf(str, searchStr, index + 1, false);
if (index < 0) {
return index;
}
found++;
} while (found < ordinal);
return index;
}
// ------------------------------------------------------------------------ remove
/**
* 移除字符串中所有给定字符串
* 例：removeAll("aa-bb-cc-dd", "-") =》 aabbccdd
*
* @param str 字符串
* @param strToRemove 被移除的字符串
* @return 移除后的字符串
*/
public static String removeAll(CharSequence str, CharSequence strToRemove) {
// strToRemove如果为空， 也不用继续后面的逻辑
if (isEmpty(str) || isEmpty(strToRemove)) {
return str(str);
}
return str.toString().replace(strToRemove, EMPTY);
}
/**
* 移除字符串中所有给定字符串，当某个字符串出现多次，则全部移除
* 例：removeAny("aa-bb-cc-dd", "a", "b") =》 --cc-dd
*
* @param str 字符串
* @param strsToRemove 被移除的字符串
* @return 移除后的字符串
* @since 5.3.8
*/
public static String removeAny(CharSequence str, CharSequence... strsToRemove) {
String result = str(str);
if (isNotEmpty(str)) {
for (CharSequence strToRemove : strsToRemove) {
result = removeAll(result, strToRemove);
}
}
return result;
}
/**
* 去除字符串中指定的多个字符，如有多个则全部去除
*
* @param str 字符串
* @param chars 字符列表
* @return 去除后的字符
* @since 4.2.2
*/
public static String removeAll(CharSequence str, char... chars) {
if (null == str || ArrayUtil.isEmpty(chars)) {
return str(str);
}
final int len = str.length();
if (0 == len) {
return str(str);
}
final StringBuilder builder = new StringBuilder(len);
char c;
for (int i = 0; i < len; i++) {
c = str.charAt(i);
if (false == ArrayUtil.contains(chars, c)) {
builder.append(c);
}
}
return builder.toString();
}
/**
* 去除所有换行符，包括：
*
*
* 1. \r
* 1. \n
*
*
* @param str 字符串
* @return 处理后的字符串
* @since 4.2.2
*/
public static String removeAllLineBreaks(CharSequence str) {
return removeAll(str, CharUtil.CR, CharUtil.LF);
}
/**
* 去掉首部指定长度的字符串并将剩余字符串首字母小写
* 例如：str=setName, preLength=3 =》 return name
*
* @param str 被处理的字符串
* @param preLength 去掉的长度
* @return 处理后的字符串，不符合规范返回null
*/
public static String removePreAndLowerFirst(CharSequence str, int preLength) {
if (str == null) {
return null;
}
if (str.length() > preLength) {
char first = Character.toLowerCase(str.charAt(preLength));
if (str.length() > preLength + 1) {
return first + str.toString().substring(preLength + 1);
}
return String.valueOf(first);
} else {
return str.toString();
}
}
/**
* 去掉首部指定长度的字符串并将剩余字符串首字母小写
* 例如：str=setName, prefix=set =》 return name
*
* @param str 被处理的字符串
* @param prefix 前缀
* @return 处理后的字符串，不符合规范返回null
*/
public static String removePreAndLowerFirst(CharSequence str, CharSequence prefix) {
return lowerFirst(removePrefix(str, prefix));
}
/**
* 去掉指定前缀
*
* @param str 字符串
* @param prefix 前缀
* @return 切掉后的字符串，若前缀不是 preffix， 返回原字符串
*/
public static String removePrefix(CharSequence str, CharSequence prefix) {
if (isEmpty(str) || isEmpty(prefix)) {
return str(str);
}
final String str2 = str.toString();
if (str2.startsWith(prefix.toString())) {
return subSuf(str2, prefix.length());// 截取后半段
}
return str2;
}
/**
* 忽略大小写去掉指定前缀
*
* @param str 字符串
* @param prefix 前缀
* @return 切掉后的字符串，若前缀不是 prefix， 返回原字符串
*/
public static String removePrefixIgnoreCase(CharSequence str, CharSequence prefix) {
if (isEmpty(str) || isEmpty(prefix)) {
return str(str);
}
final String str2 = str.toString();
if (startWithIgnoreCase(str, prefix)) {
return subSuf(str2, prefix.length());// 截取后半段
}
return str2;
}
/**
* 去掉指定后缀
*
* @param str 字符串
* @param suffix 后缀
* @return 切掉后的字符串，若后缀不是 suffix， 返回原字符串
*/
public static String removeSuffix(CharSequence str, CharSequence suffix) {
if (isEmpty(str) || isEmpty(suffix)) {
return str(str);
}
final String str2 = str.toString();
if (str2.endsWith(suffix.toString())) {
return subPre(str2, str2.length() - suffix.length());// 截取前半段
}
return str2;
}
/**
* 去掉指定后缀，并小写首字母
*
* @param str 字符串
* @param suffix 后缀
* @return 切掉后的字符串，若后缀不是 suffix， 返回原字符串
*/
public static String removeSufAndLowerFirst(CharSequence str, CharSequence suffix) {
return lowerFirst(removeSuffix(str, suffix));
}
/**
* 忽略大小写去掉指定后缀
*
* @param str 字符串
* @param suffix 后缀
* @return 切掉后的字符串，若后缀不是 suffix， 返回原字符串
*/
public static String removeSuffixIgnoreCase(CharSequence str, CharSequence suffix) {
if (isEmpty(str) || isEmpty(suffix)) {
return str(str);
}
final String str2 = str.toString();
if (endWithIgnoreCase(str, suffix)) {
return subPre(str2, str2.length() - suffix.length());
}
return str2;
}
/**
* 清理空白字符
*
* @param str 被清理的字符串
* @return 清理后的字符串
*/
public static String cleanBlank(CharSequence str) {
return filter(str, c -> false == CharUtil.isBlankChar(c));
}
// ------------------------------------------------------------------------ strip
/**
* 去除两边的指定字符串
*
* @param str 被处理的字符串
* @param prefixOrSuffix 前缀或后缀
* @return 处理后的字符串
* @since 3.1.2
*/
public static String strip(CharSequence str, CharSequence prefixOrSuffix) {
if (equals(str, prefixOrSuffix)) {
// 对于去除相同字符的情况单独处理
return EMPTY;
}
return strip(str, prefixOrSuffix, prefixOrSuffix);
}
/**
* 去除两边的指定字符串
*
* @param str 被处理的字符串
* @param prefix 前缀
* @param suffix 后缀
* @return 处理后的字符串
* @since 3.1.2
*/
public static String strip(CharSequence str, CharSequence prefix, CharSequence suffix) {
if (isEmpty(str)) {
return str(str);
}
int from = 0;
int to = str.length();
String str2 = str.toString();
if (startWith(str2, prefix)) {
from = prefix.length();
}
if (endWith(str2, suffix)) {
to -= suffix.length();
}
return str2.substring(Math.min(from, to), Math.max(from, to));
}
/**
* 去除两边的指定字符串，忽略大小写
*
* @param str 被处理的字符串
* @param prefixOrSuffix 前缀或后缀
* @return 处理后的字符串
* @since 3.1.2
*/
public static String stripIgnoreCase(CharSequence str, CharSequence prefixOrSuffix) {
return stripIgnoreCase(str, prefixOrSuffix, prefixOrSuffix);
}
/**
* 去除两边的指定字符串，忽略大小写
*
* @param str 被处理的字符串
* @param prefix 前缀
* @param suffix 后缀
* @return 处理后的字符串
* @since 3.1.2
*/
public static String stripIgnoreCase(CharSequence str, CharSequence prefix, CharSequence suffix) {
if (isEmpty(str)) {
return str(str);
}
int from = 0;
int to = str.length();
String str2 = str.toString();
if (startWithIgnoreCase(str2, prefix)) {
from = prefix.length();
}
if (endWithIgnoreCase(str2, suffix)) {
to -= suffix.length();
}
return str2.substring(from, to);
}
// ------------------------------------------------------------------------ add
/**
* 如果给定字符串不是以prefix开头的，在开头补充 prefix
*
* @param str 字符串
* @param prefix 前缀
* @return 补充后的字符串
* @see #prependIfMissing(CharSequence, CharSequence, CharSequence...)
*/
public static String addPrefixIfNot(CharSequence str, CharSequence prefix) {
return prependIfMissing(str, prefix, prefix);
}
/**
* 如果给定字符串不是以suffix结尾的，在尾部补充 suffix
*
* @param str 字符串
* @param suffix 后缀
* @return 补充后的字符串
* @see #appendIfMissing(CharSequence, CharSequence, CharSequence...)
*/
public static String addSuffixIfNot(CharSequence str, CharSequence suffix) {
return appendIfMissing(str, suffix, suffix);
}
// ------------------------------------------------------------------------ split
/**
* 切分字符串为long数组
*
* @param str 被切分的字符串
* @param separator 分隔符
* @return 切分后long数组
* @since 4.0.6
*/
public static long[] splitToLong(CharSequence str, char separator) {
return Convert.convert(long[].class, splitTrim(str, separator));
}
/**
* 切分字符串为long数组
*
* @param str 被切分的字符串
* @param separator 分隔符字符串
* @return 切分后long数组
* @since 4.0.6
*/
public static long[] splitToLong(CharSequence str, CharSequence separator) {
return Convert.convert(long[].class, splitTrim(str, separator));
}
/**
* 切分字符串为int数组
*
* @param str 被切分的字符串
* @param separator 分隔符
* @return 切分后long数组
* @since 4.0.6
*/
public static int[] splitToInt(CharSequence str, char separator) {
return Convert.convert(int[].class, splitTrim(str, separator));
}
/**
* 切分字符串为int数组
*
* @param str 被切分的字符串
* @param separator 分隔符字符串
* @return 切分后long数组
* @since 4.0.6
*/
public static int[] splitToInt(CharSequence str, CharSequence separator) {
return Convert.convert(int[].class, splitTrim(str, separator));
}
/**
* 切分字符串
* a#b#c =》 [a,b,c]
* a##b#c =》 [a,"",b,c]
*
* @param str 被切分的字符串
* @param separator 分隔符字符
* @return 切分后的集合
*/
public static List split(CharSequence str, char separator) {
return split(str, separator, 0);
}
/**
* 切分字符串，如果分隔符不存在则返回原字符串
*
* @param str 被切分的字符串
* @param separator 分隔符
* @return 字符串
* @since 5.6.7
*/
public static String[] splitToArray(CharSequence str, CharSequence separator) {
if (str == null) {
return new String[]{};
}
return StrSplitter.splitToArray(str.toString(), str(separator), 0, false, false);
}
/**
* 切分字符串
*
* @param str 被切分的字符串
* @param separator 分隔符字符
* @return 切分后的数组
*/
public static String[] splitToArray(CharSequence str, char separator) {
return splitToArray(str, separator, 0);
}
/**
* 切分字符串
*
* @param text 被切分的字符串
* @param separator 分隔符字符
* @param limit 限制分片数
* @return 切分后的数组
*/
public static String[] splitToArray(CharSequence text, char separator, int limit) {
Assert.notNull(text, "Text must be not null!");
return StrSplitter.splitToArray(text.toString(), separator, limit, false, false);
}
/**
* 切分字符串，不去除切分后每个元素两边的空白符，不去除空白项
*
* @param str 被切分的字符串
* @param separator 分隔符字符
* @param limit 限制分片数，-1不限制
* @return 切分后的集合
*/
public static List split(CharSequence str, char separator, int limit) {
return split(str, separator, limit, false, false);
}
/**
* 切分字符串，去除切分后每个元素两边的空白符，去除空白项
*
* @param str 被切分的字符串
* @param separator 分隔符字符
* @return 切分后的集合
* @since 3.1.2
*/
public static List splitTrim(CharSequence str, char separator) {
return splitTrim(str, separator, -1);
}
/**
* 切分字符串，去除切分后每个元素两边的空白符，去除空白项
*
* @param str 被切分的字符串
* @param separator 分隔符字符
* @return 切分后的集合
* @since 3.2.0
*/
public static List splitTrim(CharSequence str, CharSequence separator) {
return splitTrim(str, separator, -1);
}
/**
* 切分字符串，去除切分后每个元素两边的空白符，去除空白项
*
* @param str 被切分的字符串
* @param separator 分隔符字符
* @param limit 限制分片数，-1不限制
* @return 切分后的集合
* @since 3.1.0
*/
public static List splitTrim(CharSequence str, char separator, int limit) {
return split(str, separator, limit, true, true);
}
/**
* 切分字符串，去除切分后每个元素两边的空白符，去除空白项
*
* @param str 被切分的字符串
* @param separator 分隔符字符
* @param limit 限制分片数，-1不限制
* @return 切分后的集合
* @since 3.2.0
*/
public static List splitTrim(CharSequence str, CharSequence separator, int limit) {
return split(str, separator, limit, true, true);
}
/**
* 切分字符串，不限制分片数量
*
* @param str 被切分的字符串
* @param separator 分隔符字符
* @param isTrim 是否去除切分字符串后每个元素两边的空格
* @param ignoreEmpty 是否忽略空串
* @return 切分后的集合
* @since 3.0.8
*/
public static List split(CharSequence str, char separator, boolean isTrim, boolean ignoreEmpty) {
return split(str, separator, 0, isTrim, ignoreEmpty);
}
/**
* 切分字符串
*
* @param str 被切分的字符串
* @param separator 分隔符字符
* @param limit 限制分片数，-1不限制
* @param isTrim 是否去除切分字符串后每个元素两边的空格
* @param ignoreEmpty 是否忽略空串
* @return 切分后的集合
* @since 3.0.8
*/
public static List split(CharSequence str, char separator, int limit, boolean isTrim, boolean ignoreEmpty) {
return StrSplitter.split(str, separator, limit, isTrim, ignoreEmpty);
}
/**
* 切分字符串
*
* @param 切分后元素类型
* @param str 被切分的字符串
* @param separator 分隔符字符
* @param limit 限制分片数，-1不限制
* @param ignoreEmpty 是否忽略空串
* @param mapping 切分后的字符串元素的转换方法
* @return 切分后的集合，元素类型是经过 mapping 转换后的
* @since 5.7.14
*/
public static List split(CharSequence str, char separator, int limit, boolean ignoreEmpty, Function mapping) {
return StrSplitter.split(str, separator, limit, ignoreEmpty, mapping);
}
/**
* 切分字符串，如果分隔符不存在则返回原字符串
*
* @param str 被切分的字符串
* @param separator 分隔符
* @return 字符串
* @since 5.7.1
*/
public static List split(CharSequence str, CharSequence separator) {
return split(str, separator, false, false);
}
/**
* 切分字符串
*
* @param str 被切分的字符串
* @param separator 分隔符字符
* @param isTrim 是否去除切分字符串后每个元素两边的空格
* @param ignoreEmpty 是否忽略空串
* @return 切分后的集合
* @since 5.6.7
*/
public static List split(CharSequence str, CharSequence separator, boolean isTrim, boolean ignoreEmpty) {
return split(str, separator, 0, isTrim, ignoreEmpty);
}
/**
* 切分字符串
*
* @param str 被切分的字符串
* @param separator 分隔符字符
* @param limit 限制分片数，-1不限制
* @param isTrim 是否去除切分字符串后每个元素两边的空格
* @param ignoreEmpty 是否忽略空串
* @return 切分后的集合
* @since 3.2.0
*/
public static List split(CharSequence str, CharSequence separator, int limit, boolean isTrim, boolean ignoreEmpty) {
final String separatorStr = (null == separator) ? null : separator.toString();
return StrSplitter.split(str, separatorStr, limit, isTrim, ignoreEmpty);
}
/**
* 根据给定长度，将给定字符串截取为多个部分
*
* @param str 字符串
* @param len 每一个小节的长度
* @return 截取后的字符串数组
* @see StrSplitter#splitByLength(CharSequence, int)
*/
public static String[] split(CharSequence str, int len) {
return StrSplitter.splitByLength(str, len);
}
/**
* 将字符串切分为N等份
*
* @param str 字符串
* @param partLength 每等份的长度
* @return 切分后的数组
* @since 3.0.6
*/
public static String[] cut(CharSequence str, int partLength) {
if (null == str) {
return null;
}
int len = str.length();
if (len < partLength) {
return new String[]{str.toString()};
}
int part = NumberUtil.count(len, partLength);
final String[] array = new String[part];
final String str2 = str.toString();
for (int i = 0; i < part; i++) {
array[i] = str2.substring(i * partLength, (i == part - 1) ? len : (partLength + i * partLength));
}
return array;
}
// ------------------------------------------------------------------------ sub
/**
* 改进JDK subString
* index从0开始计算，最后一个字符为-1
* 如果from和to位置一样，返回 ""
* 如果from或to为负数，则按照length从后向前数位置，如果绝对值大于字符串长度，则from归到0，to归到length
* 如果经过修正的index中from大于to，则互换from和to example:
* abcdefgh 2 3 =》 c
* abcdefgh 2 -3 =》 cde
*
* @param str String
* @param fromIndexInclude 开始的index（包括）
* @param toIndexExclude 结束的index（不包括）
* @return 字串
*/
public static String sub(CharSequence str, int fromIndexInclude, int toIndexExclude) {
if (isEmpty(str)) {
return str(str);
}
int len = str.length();
if (fromIndexInclude < 0) {
fromIndexInclude = len + fromIndexInclude;
if (fromIndexInclude < 0) {
fromIndexInclude = 0;
}
} else if (fromIndexInclude > len) {
fromIndexInclude = len;
}
if (toIndexExclude < 0) {
toIndexExclude = len + toIndexExclude;
if (toIndexExclude < 0) {
toIndexExclude = len;
}
} else if (toIndexExclude > len) {
toIndexExclude = len;
}
if (toIndexExclude < fromIndexInclude) {
int tmp = fromIndexInclude;
fromIndexInclude = toIndexExclude;
toIndexExclude = tmp;
}
if (fromIndexInclude == toIndexExclude) {
return EMPTY;
}
return str.toString().substring(fromIndexInclude, toIndexExclude);
}
/**
* 通过CodePoint截取字符串，可以截断Emoji
*
* @param str String
* @param fromIndex 开始的index（包括）
* @param toIndex 结束的index（不包括）
* @return 字串
*/
public static String subByCodePoint(CharSequence str, int fromIndex, int toIndex) {
if (isEmpty(str)) {
return str(str);
}
if (fromIndex < 0 || fromIndex > toIndex) {
throw new IllegalArgumentException();
}
if (fromIndex == toIndex) {
return EMPTY;
}
final StringBuilder sb = new StringBuilder();
final int subLen = toIndex - fromIndex;
str.toString().codePoints().skip(fromIndex).limit(subLen).forEach(v -> sb.append(Character.toChars(v)));
return sb.toString();
}
/**
* 截取部分字符串，这里一个汉字的长度认为是2
*
* @param str 字符串
* @param len bytes切割到的位置（包含）
* @param suffix 切割后加上后缀
* @return 切割后的字符串
* @since 3.1.1
*/
public static String subPreGbk(CharSequence str, int len, CharSequence suffix) {
return subPreGbk(str, len, true) + suffix;
}
/**
* 截取部分字符串，这里一个汉字的长度认为是2
* 可以自定义halfUp，如len为10，如果截取后最后一个字符是半个字符，{@code true}表示保留，则长度是11，否则长度9
*
* @param str 字符串
* @param len bytes切割到的位置（包含）
* @param halfUp 遇到截取一半的GBK字符，是否保留。
* @return 切割后的字符串
* @since 5.7.17
*/
public static String subPreGbk(CharSequence str, int len, boolean halfUp) {
if (isEmpty(str)) {
return str(str);
}
int counterOfDoubleByte = 0;
final byte[] b = bytes(str, CharsetUtil.CHARSET_GBK);
if (b.length <= len) {
return str.toString();
}
for (int i = 0; i < len; i++) {
if (b[i] < 0) {
counterOfDoubleByte++;
}
}
if (counterOfDoubleByte % 2 != 0) {
if (halfUp) {
len += 1;
} else {
len -= 1;
}
}
return new String(b, 0, len, CharsetUtil.CHARSET_GBK);
}
/**
* 切割指定位置之前部分的字符串
*
* @param string 字符串
* @param toIndexExclude 切割到的位置（不包括）
* @return 切割后的剩余的前半部分字符串
*/
public static String subPre(CharSequence string, int toIndexExclude) {
return sub(string, 0, toIndexExclude);
}
/**
* 切割指定位置之后部分的字符串
*
* @param string 字符串
* @param fromIndex 切割开始的位置（包括）
* @return 切割后后剩余的后半部分字符串
*/
public static String subSuf(CharSequence string, int fromIndex) {
if (isEmpty(string)) {
return null;
}
return sub(string, fromIndex, string.length());
}
/**
* 切割指定长度的后部分的字符串
*
*
* StrUtil.subSufByLength("abcde", 3) = "cde"
* StrUtil.subSufByLength("abcde", 0) = ""
* StrUtil.subSufByLength("abcde", -5) = ""
* StrUtil.subSufByLength("abcde", -1) = ""
* StrUtil.subSufByLength("abcde", 5) = "abcde"
* StrUtil.subSufByLength("abcde", 10) = "abcde"
* StrUtil.subSufByLength(null, 3) = null
*
*
* @param string 字符串
* @param length 切割长度
* @return 切割后后剩余的后半部分字符串
* @since 4.0.1
*/
public static String subSufByLength(CharSequence string, int length) {
if (isEmpty(string)) {
return null;
}
if (length <= 0) {
return EMPTY;
}
return sub(string, -length, string.length());
}
/**
* 截取字符串,从指定位置开始,截取指定长度的字符串
* 如果fromIndex为正数，则向后截取指定length长度，如果为负数，则向前截取length长度。
*
* @param input 原始字符串
* @param fromIndex 开始的index,包括
* @param length 要截取的长度
* @return 截取后的字符串
* @author weibaohui
*/
public static String subWithLength(String input, int fromIndex, int length) {
final int toIndex;
if (fromIndex < 0) {
toIndex = fromIndex - length;
} else {
toIndex = fromIndex + length;
}
return sub(input, fromIndex, toIndex);
}
/**
* 截取分隔字符串之前的字符串，不包括分隔字符串
* 如果给定的字符串为空串（null或""）或者分隔字符串为null，返回原字符串
* 如果分隔字符串为空串""，则返回空串，如果分隔字符串未找到，返回原字符串，举例如下：
*
*
* StrUtil.subBefore(null, *, false) = null
* StrUtil.subBefore("", *, false) = ""
* StrUtil.subBefore("abc", "a", false) = ""
* StrUtil.subBefore("abcba", "b", false) = "a"
* StrUtil.subBefore("abc", "c", false) = "ab"
* StrUtil.subBefore("abc", "d", false) = "abc"
* StrUtil.subBefore("abc", "", false) = ""
* StrUtil.subBefore("abc", null, false) = "abc"
*
*
* @param string 被查找的字符串
* @param separator 分隔字符串（不包括）
* @param isLastSeparator 是否查找最后一个分隔字符串（多次出现分隔字符串时选取最后一个），true为选取最后一个
* @return 切割后的字符串
* @since 3.1.1
*/
public static String subBefore(CharSequence string, CharSequence separator, boolean isLastSeparator) {
if (isEmpty(string) || separator == null) {
return null == string ? null : string.toString();
}
final String str = string.toString();
final String sep = separator.toString();
if (sep.isEmpty()) {
return EMPTY;
}
final int pos = isLastSeparator ? str.lastIndexOf(sep) : str.indexOf(sep);
if (INDEX_NOT_FOUND == pos) {
return str;
}
if (0 == pos) {
return EMPTY;
}
return str.substring(0, pos);
}
/**
* 截取分隔字符串之前的字符串，不包括分隔字符串
* 如果给定的字符串为空串（null或""）或者分隔字符串为null，返回原字符串
* 如果分隔字符串未找到，返回原字符串，举例如下：
*
*
* StrUtil.subBefore(null, *, false) = null
* StrUtil.subBefore("", *, false) = ""
* StrUtil.subBefore("abc", 'a', false) = ""
* StrUtil.subBefore("abcba", 'b', false) = "a"
* StrUtil.subBefore("abc", 'c', false) = "ab"
* StrUtil.subBefore("abc", 'd', false) = "abc"
*
*
* @param string 被查找的字符串
* @param separator 分隔字符串（不包括）
* @param isLastSeparator 是否查找最后一个分隔字符串（多次出现分隔字符串时选取最后一个），true为选取最后一个
* @return 切割后的字符串
* @since 4.1.15
*/
public static String subBefore(CharSequence string, char separator, boolean isLastSeparator) {
if (isEmpty(string)) {
return null == string ? null : EMPTY;
}
final String str = string.toString();
final int pos = isLastSeparator ? str.lastIndexOf(separator) : str.indexOf(separator);
if (INDEX_NOT_FOUND == pos) {
return str;
}
if (0 == pos) {
return EMPTY;
}
return str.substring(0, pos);
}
/**
* 截取分隔字符串之后的字符串，不包括分隔字符串
* 如果给定的字符串为空串（null或""），返回原字符串
* 如果分隔字符串为空串（null或""），则返回空串，如果分隔字符串未找到，返回空串，举例如下：
*
*
* StrUtil.subAfter(null, *, false) = null
* StrUtil.subAfter("", *, false) = ""
* StrUtil.subAfter(*, null, false) = ""
* StrUtil.subAfter("abc", "a", false) = "bc"
* StrUtil.subAfter("abcba", "b", false) = "cba"
* StrUtil.subAfter("abc", "c", false) = ""
* StrUtil.subAfter("abc", "d", false) = ""
* StrUtil.subAfter("abc", "", false) = "abc"
*
*
* @param string 被查找的字符串
* @param separator 分隔字符串（不包括）
* @param isLastSeparator 是否查找最后一个分隔字符串（多次出现分隔字符串时选取最后一个），true为选取最后一个
* @return 切割后的字符串
* @since 3.1.1
*/
public static String subAfter(CharSequence string, CharSequence separator, boolean isLastSeparator) {
if (isEmpty(string)) {
return null == string ? null : EMPTY;
}
if (separator == null) {
return EMPTY;
}
final String str = string.toString();
final String sep = separator.toString();
final int pos = isLastSeparator ? str.lastIndexOf(sep) : str.indexOf(sep);
if (INDEX_NOT_FOUND == pos || (string.length() - 1) == pos) {
return EMPTY;
}
return str.substring(pos + separator.length());
}
/**
* 截取分隔字符串之后的字符串，不包括分隔字符串
* 如果给定的字符串为空串（null或""），返回原字符串
* 如果分隔字符串为空串（null或""），则返回空串，如果分隔字符串未找到，返回空串，举例如下：
*
*
* StrUtil.subAfter(null, *, false) = null
* StrUtil.subAfter("", *, false) = ""
* StrUtil.subAfter("abc", 'a', false) = "bc"
* StrUtil.subAfter("abcba", 'b', false) = "cba"
* StrUtil.subAfter("abc", 'c', false) = ""
* StrUtil.subAfter("abc", 'd', false) = ""
*
*
* @param string 被查找的字符串
* @param separator 分隔字符串（不包括）
* @param isLastSeparator 是否查找最后一个分隔字符串（多次出现分隔字符串时选取最后一个），true为选取最后一个
* @return 切割后的字符串
* @since 4.1.15
*/
public static String subAfter(CharSequence string, char separator, boolean isLastSeparator) {
if (isEmpty(string)) {
return null == string ? null : EMPTY;
}
final String str = string.toString();
final int pos = isLastSeparator ? str.lastIndexOf(separator) : str.indexOf(separator);
if (INDEX_NOT_FOUND == pos) {
return EMPTY;
}
return str.substring(pos + 1);
}
/**
* 截取指定字符串中间部分，不包括标识字符串
*
* 栗子：
*
*
* StrUtil.subBetween("wx[b]yz", "[", "]") = "b"
* StrUtil.subBetween(null, *, *) = null
* StrUtil.subBetween(*, null, *) = null
* StrUtil.subBetween(*, *, null) = null
* StrUtil.subBetween("", "", "") = ""
* StrUtil.subBetween("", "", "]") = null
* StrUtil.subBetween("", "[", "]") = null
* StrUtil.subBetween("yabcz", "", "") = ""
* StrUtil.subBetween("yabcz", "y", "z") = "abc"
* StrUtil.subBetween("yabczyabcz", "y", "z") = "abc"
*
*
* @param str 被切割的字符串
* @param before 截取开始的字符串标识
* @param after 截取到的字符串标识
* @return 截取后的字符串
* @since 3.1.1
*/
public static String subBetween(CharSequence str, CharSequence before, CharSequence after) {
if (str == null || before == null || after == null) {
return null;
}
final String str2 = str.toString();
final String before2 = before.toString();
final String after2 = after.toString();
final int start = str2.indexOf(before2);
if (start != INDEX_NOT_FOUND) {
final int end = str2.indexOf(after2, start + before2.length());
if (end != INDEX_NOT_FOUND) {
return str2.substring(start + before2.length(), end);
}
}
return null;
}
/**
* 截取指定字符串中间部分，不包括标识字符串
*
* 栗子：
*
*
* StrUtil.subBetween(null, *) = null
* StrUtil.subBetween("", "") = ""
* StrUtil.subBetween("", "tag") = null
* StrUtil.subBetween("tagabctag", null) = null
* StrUtil.subBetween("tagabctag", "") = ""
* StrUtil.subBetween("tagabctag", "tag") = "abc"
*
*
* @param str 被切割的字符串
* @param beforeAndAfter 截取开始和结束的字符串标识
* @return 截取后的字符串
* @since 3.1.1
*/
public static String subBetween(CharSequence str, CharSequence beforeAndAfter) {
return subBetween(str, beforeAndAfter, beforeAndAfter);
}
/**
* 截取指定字符串多段中间部分，不包括标识字符串
*
* 栗子：
*
*
* StrUtil.subBetweenAll("wx[b]y[z]", "[", "]") = ["b","z"]
* StrUtil.subBetweenAll(null, *, *) = []
* StrUtil.subBetweenAll(*, null, *) = []
* StrUtil.subBetweenAll(*, *, null) = []
* StrUtil.subBetweenAll("", "", "") = []
* StrUtil.subBetweenAll("", "", "]") = []
* StrUtil.subBetweenAll("", "[", "]") = []
* StrUtil.subBetweenAll("yabcz", "", "") = []
* StrUtil.subBetweenAll("yabcz", "y", "z") = ["abc"]
* StrUtil.subBetweenAll("yabczyabcz", "y", "z") = ["abc","abc"]
* StrUtil.subBetweenAll("[yabc[zy]abcz]", "[", "]"); = ["zy"] 重叠时只截取内部，
*
*
* @param str 被切割的字符串
* @param prefix 截取开始的字符串标识
* @param suffix 截取到的字符串标识
* @return 截取后的字符串
* @author dahuoyzs
* @since 5.2.5
*/
public static String[] subBetweenAll(CharSequence str, CharSequence prefix, CharSequence suffix) {
if (hasEmpty(str, prefix, suffix) ||
// 不包含起始字符串，则肯定没有子串
false == contains(str, prefix)) {
return new String[0];
}
final List result = new LinkedList<>();
final String[] split = splitToArray(str, prefix);
if (prefix.equals(suffix)) {
// 前后缀字符相同，单独处理
for (int i = 1, length = split.length - 1; i < length; i += 2) {
result.add(split[i]);
}
} else {
int suffixIndex;
String fragment;
for (int i = 1; i < split.length; i++) {
fragment = split[i];
suffixIndex = fragment.indexOf(suffix.toString());
if (suffixIndex > 0) {
result.add(fragment.substring(0, suffixIndex));
}
}
}
return result.toArray(new String[0]);
}
/**
* 截取指定字符串多段中间部分，不包括标识字符串
*
* 栗子：
*
*
* StrUtil.subBetweenAll(null, *) = []
* StrUtil.subBetweenAll(*, null) = []
* StrUtil.subBetweenAll(*, *) = []
* StrUtil.subBetweenAll("", "") = []
* StrUtil.subBetweenAll("", "#") = []
* StrUtil.subBetweenAll("gotanks", "") = []
* StrUtil.subBetweenAll("#gotanks#", "#") = ["gotanks"]
* StrUtil.subBetweenAll("#hello# #world#!", "#") = ["hello", "world"]
* StrUtil.subBetweenAll("#hello# world#!", "#"); = ["hello"]
*
*
* @param str 被切割的字符串
* @param prefixAndSuffix 截取开始和结束的字符串标识
* @return 截取后的字符串
* @author gotanks
* @since 5.5.0
*/
public static String[] subBetweenAll(CharSequence str, CharSequence prefixAndSuffix) {
return subBetweenAll(str, prefixAndSuffix, prefixAndSuffix);
}
// ------------------------------------------------------------------------ repeat
/**
* 重复某个字符
*
*
* StrUtil.repeat('e', 0) = ""
* StrUtil.repeat('e', 3) = "eee"
* StrUtil.repeat('e', -2) = ""
*
*
* @param c 被重复的字符
* @param count 重复的数目，如果小于等于0则返回""
* @return 重复字符字符串
*/
public static String repeat(char c, int count) {
if (count <= 0) {
return EMPTY;
}
char[] result = new char[count];
for (int i = 0; i < count; i++) {
result[i] = c;
}
return new String(result);
}
/**
* 重复某个字符串
*
* @param str 被重复的字符
* @param count 重复的数目
* @return 重复字符字符串
*/
public static String repeat(CharSequence str, int count) {
if (null == str) {
return null;
}
if (count <= 0 || str.length() == 0) {
return EMPTY;
}
if (count == 1) {
return str.toString();
}
// 检查
final int len = str.length();
final long longSize = (long) len * (long) count;
final int size = (int) longSize;
if (size != longSize) {
throw new ArrayIndexOutOfBoundsException("Required String length is too large: " + longSize);
}
final char[] array = new char[size];
str.toString().getChars(0, len, array, 0);
int n;
for (n = len; n < size - n; n <<= 1) {// n <<= 1相当于n *2
System.arraycopy(array, 0, array, n, n);
}
System.arraycopy(array, 0, array, n, size - n);
return new String(array);
}
/**
* 重复某个字符串到指定长度
*
* @param str 被重复的字符
* @param padLen 指定长度
* @return 重复字符字符串
* @since 4.3.2
*/
public static String repeatByLength(CharSequence str, int padLen) {
if (null == str) {
return null;
}
if (padLen <= 0) {
return StrUtil.EMPTY;
}
final int strLen = str.length();
if (strLen == padLen) {
return str.toString();
} else if (strLen > padLen) {
return subPre(str, padLen);
}
// 重复，直到达到指定长度
final char[] padding = new char[padLen];
for (int i = 0; i < padLen; i++) {
padding[i] = str.charAt(i % strLen);
}
return new String(padding);
}
/**
* 重复某个字符串并通过分界符连接
*
*
* StrUtil.repeatAndJoin("?", 5, ",") = "?,?,?,?,?"
* StrUtil.repeatAndJoin("?", 0, ",") = ""
* StrUtil.repeatAndJoin("?", 5, null) = "?????"
*
*
* @param str 被重复的字符串
* @param count 数量
* @param delimiter 分界符
* @return 连接后的字符串
* @since 4.0.1
*/
public static String repeatAndJoin(CharSequence str, int count, CharSequence delimiter) {
if (count <= 0) {
return EMPTY;
}
final StringBuilder builder = new StringBuilder(str.length() * count);
builder.append(str);
count--;
final boolean isAppendDelimiter = isNotEmpty(delimiter);
while (count-- > 0) {
if (isAppendDelimiter) {
builder.append(delimiter);
}
builder.append(str);
}
return builder.toString();
}
// ------------------------------------------------------------------------ equals
/**
* 比较两个字符串（大小写敏感）。
*
*
* equals(null, null) = true
* equals(null, "abc") = false
* equals("abc", null) = false
* equals("abc", "abc") = true
* equals("abc", "ABC") = false
*
*
* @param str1 要比较的字符串1
* @param str2 要比较的字符串2
* @return 如果两个字符串相同，或者都是{@code null}，则返回{@code true}
*/
public static boolean equals(CharSequence str1, CharSequence str2) {
return equals(str1, str2, false);
}
/**
* 比较两个字符串（大小写不敏感）。
*
*
* equalsIgnoreCase(null, null) = true
* equalsIgnoreCase(null, "abc") = false
* equalsIgnoreCase("abc", null) = false
* equalsIgnoreCase("abc", "abc") = true
* equalsIgnoreCase("abc", "ABC") = true
*
*
* @param str1 要比较的字符串1
* @param str2 要比较的字符串2
* @return 如果两个字符串相同，或者都是{@code null}，则返回{@code true}
*/
public static boolean equalsIgnoreCase(CharSequence str1, CharSequence str2) {
return equals(str1, str2, true);
}
/**
* 比较两个字符串是否相等，规则如下
*
* - str1和str2都为{@code null}
* - 忽略大小写使用{@link String#equalsIgnoreCase(String)}判断相等
* - 不忽略大小写使用{@link String#contentEquals(CharSequence)}判断相等
*
*
* @param str1 要比较的字符串1
* @param str2 要比较的字符串2
* @param ignoreCase 是否忽略大小写
* @return 如果两个字符串相同，或者都是{@code null}，则返回{@code true}
* @since 3.2.0
*/
public static boolean equals(CharSequence str1, CharSequence str2, boolean ignoreCase) {
if (null == str1) {
// 只有两个都为null才判断相等
return str2 == null;
}
if (null == str2) {
// 字符串2空，字符串1非空，直接false
return false;
}
if (ignoreCase) {
return str1.toString().equalsIgnoreCase(str2.toString());
} else {
return str1.toString().contentEquals(str2);
}
}
/**
* 给定字符串是否与提供的中任一字符串相同（忽略大小写），相同则返回{@code true}，没有相同的返回{@code false}
* 如果参与比对的字符串列表为空，返回{@code false}
*
* @param str1 给定需要检查的字符串
* @param strs 需要参与比对的字符串列表
* @return 是否相同
* @since 4.3.2
*/
public static boolean equalsAnyIgnoreCase(CharSequence str1, CharSequence... strs) {
return equalsAny(str1, true, strs);
}
/**
* 给定字符串是否与提供的中任一字符串相同，相同则返回{@code true}，没有相同的返回{@code false}
* 如果参与比对的字符串列表为空，返回{@code false}
*
* @param str1 给定需要检查的字符串
* @param strs 需要参与比对的字符串列表
* @return 是否相同
* @since 4.3.2
*/
public static boolean equalsAny(CharSequence str1, CharSequence... strs) {
return equalsAny(str1, false, strs);
}
/**
* 给定字符串是否与提供的中任一字符串相同，相同则返回{@code true}，没有相同的返回{@code false}
* 如果参与比对的字符串列表为空，返回{@code false}
*
* @param str1 给定需要检查的字符串
* @param ignoreCase 是否忽略大小写
* @param strs 需要参与比对的字符串列表
* @return 是否相同
* @since 4.3.2
*/
public static boolean equalsAny(CharSequence str1, boolean ignoreCase, CharSequence... strs) {
if (ArrayUtil.isEmpty(strs)) {
return false;
}
for (CharSequence str : strs) {
if (equals(str1, str, ignoreCase)) {
return true;
}
}
return false;
}
/**
* 字符串指定位置的字符是否与给定字符相同
* 如果字符串为null，返回false
* 如果给定的位置大于字符串长度，返回false
* 如果给定的位置小于0，返回false
*
* @param str 字符串
* @param position 位置
* @param c 需要对比的字符
* @return 字符串指定位置的字符是否与给定字符相同
* @since 3.3.1
*/
public static boolean equalsCharAt(CharSequence str, int position, char c) {
if (null == str || position < 0) {
return false;
}
return str.length() > position && c == str.charAt(position);
}
/**
* 截取第一个字串的部分字符，与第二个字符串比较（长度一致），判断截取的子串是否相同
* 任意一个字符串为null返回false
*
* @param str1 第一个字符串
* @param start1 第一个字符串开始的位置
* @param str2 第二个字符串
* @param ignoreCase 是否忽略大小写
* @return 子串是否相同
* @since 3.2.1
*/
public static boolean isSubEquals(CharSequence str1, int start1, CharSequence str2, boolean ignoreCase) {
return isSubEquals(str1, start1, str2, 0, str2.length(), ignoreCase);
}
/**
* 截取两个字符串的不同部分（长度一致），判断截取的子串是否相同
* 任意一个字符串为null返回false
*
* @param str1 第一个字符串
* @param start1 第一个字符串开始的位置
* @param str2 第二个字符串
* @param start2 第二个字符串开始的位置
* @param length 截取长度
* @param ignoreCase 是否忽略大小写
* @return 子串是否相同
* @since 3.2.1
*/
public static boolean isSubEquals(CharSequence str1, int start1, CharSequence str2, int start2, int length, boolean ignoreCase) {
if (null == str1 || null == str2) {
return false;
}
return str1.toString().regionMatches(ignoreCase, start1, str2.toString(), start2, length);
}
// ------------------------------------------------------------------------ format
/**
* 格式化文本, {} 表示占位符
* 此方法只是简单将占位符 {} 按照顺序替换为参数
* 如果想输出 {} 使用 \\转义 { 即可，如果想输出 {} 之前的 \ 使用双转义符 \\\\ 即可
* 例：
* 通常使用：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) {
if (null == template) {
return NULL;
}
if (ArrayUtil.isEmpty(params) || isBlank(template)) {
return template.toString();
}
return StrFormatter.format(template.toString(), params);
}
/**
* 有序的格式化文本，使用{number}做为占位符
* 通常使用：format("this is {0} for {1}", "a", "b") =》 this is a for b
*
* @param pattern 文本格式
* @param arguments 参数
* @return 格式化后的文本
*/
public static String indexedFormat(CharSequence pattern, Object... arguments) {
return MessageFormat.format(pattern.toString(), arguments);
}
// ------------------------------------------------------------------------ bytes
/**
* 编码字符串，编码为UTF-8
*
* @param str 字符串
* @return 编码后的字节码
*/
public static byte[] utf8Bytes(CharSequence str) {
return bytes(str, CharsetUtil.CHARSET_UTF_8);
}
/**
* 编码字符串
* 使用系统默认编码
*
* @param str 字符串
* @return 编码后的字节码
*/
public static byte[] bytes(CharSequence str) {
return bytes(str, Charset.defaultCharset());
}
/**
* 编码字符串
*
* @param str 字符串
* @param charset 字符集，如果此字段为空，则解码的结果取决于平台
* @return 编码后的字节码
*/
public static byte[] bytes(CharSequence str, String charset) {
return bytes(str, isBlank(charset) ? Charset.defaultCharset() : Charset.forName(charset));
}
/**
* 编码字符串
*
* @param str 字符串
* @param charset 字符集，如果此字段为空，则解码的结果取决于平台
* @return 编码后的字节码
*/
public static byte[] bytes(CharSequence str, Charset charset) {
if (str == null) {
return null;
}
if (null == charset) {
return str.toString().getBytes();
}
return str.toString().getBytes(charset);
}
/**
* 字符串转换为byteBuffer
*
* @param str 字符串
* @param charset 编码
* @return byteBuffer
*/
public static ByteBuffer byteBuffer(CharSequence str, String charset) {
return ByteBuffer.wrap(bytes(str, charset));
}
// ------------------------------------------------------------------------ wrap
/**
* 包装指定字符串
* 当前缀和后缀一致时使用此方法
*
* @param str 被包装的字符串
* @param prefixAndSuffix 前缀和后缀
* @return 包装后的字符串
* @since 3.1.0
*/
public static String wrap(CharSequence str, CharSequence prefixAndSuffix) {
return wrap(str, prefixAndSuffix, prefixAndSuffix);
}
/**
* 包装指定字符串
*
* @param str 被包装的字符串
* @param prefix 前缀
* @param suffix 后缀
* @return 包装后的字符串
*/
public static String wrap(CharSequence str, CharSequence prefix, CharSequence suffix) {
return nullToEmpty(prefix).concat(nullToEmpty(str)).concat(nullToEmpty(suffix));
}
/**
* 使用单个字符包装多个字符串
*
* @param prefixAndSuffix 前缀和后缀
* @param strs 多个字符串
* @return 包装的字符串数组
* @since 5.4.1
*/
public static String[] wrapAllWithPair(CharSequence prefixAndSuffix, CharSequence... strs) {
return wrapAll(prefixAndSuffix, prefixAndSuffix, strs);
}
/**
* 包装多个字符串
*
* @param prefix 前缀
* @param suffix 后缀
* @param strs 多个字符串
* @return 包装的字符串数组
* @since 4.0.7
*/
public static String[] wrapAll(CharSequence prefix, CharSequence suffix, CharSequence... strs) {
final String[] results = new String[strs.length];
for (int i = 0; i < strs.length; i++) {
results[i] = wrap(strs[i], prefix, suffix);
}
return results;
}
/**
* 包装指定字符串，如果前缀或后缀已经包含对应的字符串，则不再包装
*
* @param str 被包装的字符串
* @param prefix 前缀
* @param suffix 后缀
* @return 包装后的字符串
*/
public static String wrapIfMissing(CharSequence str, CharSequence prefix, CharSequence suffix) {
int len = 0;
if (isNotEmpty(str)) {
len += str.length();
}
if (isNotEmpty(prefix)) {
len += prefix.length();
}
if (isNotEmpty(suffix)) {
len += suffix.length();
}
StringBuilder sb = new StringBuilder(len);
if (isNotEmpty(prefix) && false == startWith(str, prefix)) {
sb.append(prefix);
}
if (isNotEmpty(str)) {
sb.append(str);
}
if (isNotEmpty(suffix) && false == endWith(str, suffix)) {
sb.append(suffix);
}
return sb.toString();
}
/**
* 使用成对的字符包装多个字符串，如果已经包装，则不再包装
*
* @param prefixAndSuffix 前缀和后缀
* @param strs 多个字符串
* @return 包装的字符串数组
* @since 5.4.1
*/
public static String[] wrapAllWithPairIfMissing(CharSequence prefixAndSuffix, CharSequence... strs) {
return wrapAllIfMissing(prefixAndSuffix, prefixAndSuffix, strs);
}
/**
* 包装多个字符串，如果已经包装，则不再包装
*
* @param prefix 前缀
* @param suffix 后缀
* @param strs 多个字符串
* @return 包装的字符串数组
* @since 4.0.7
*/
public static String[] wrapAllIfMissing(CharSequence prefix, CharSequence suffix, CharSequence... strs) {
final String[] results = new String[strs.length];
for (int i = 0; i < strs.length; i++) {
results[i] = wrapIfMissing(strs[i], prefix, suffix);
}
return results;
}
/**
* 去掉字符包装，如果未被包装则返回原字符串
*
* @param str 字符串
* @param prefix 前置字符串
* @param suffix 后置字符串
* @return 去掉包装字符的字符串
* @since 4.0.1
*/
public static String unWrap(CharSequence str, String prefix, String suffix) {
if (isWrap(str, prefix, suffix)) {
return sub(str, prefix.length(), str.length() - suffix.length());
}
return str.toString();
}
/**
* 去掉字符包装，如果未被包装则返回原字符串
*
* @param str 字符串
* @param prefix 前置字符
* @param suffix 后置字符
* @return 去掉包装字符的字符串
* @since 4.0.1
*/
public static String unWrap(CharSequence str, char prefix, char suffix) {
if (isEmpty(str)) {
return str(str);
}
if (str.charAt(0) == prefix && str.charAt(str.length() - 1) == suffix) {
return sub(str, 1, str.length() - 1);
}
return str.toString();
}
/**
* 去掉字符包装，如果未被包装则返回原字符串
*
* @param str 字符串
* @param prefixAndSuffix 前置和后置字符
* @return 去掉包装字符的字符串
* @since 4.0.1
*/
public static String unWrap(CharSequence str, char prefixAndSuffix) {
return unWrap(str, prefixAndSuffix, prefixAndSuffix);
}
/**
* 指定字符串是否被包装
*
* @param str 字符串
* @param prefix 前缀
* @param suffix 后缀
* @return 是否被包装
*/
public static boolean isWrap(CharSequence str, String prefix, String suffix) {
if (ArrayUtil.hasNull(str, prefix, suffix)) {
return false;
}
final String str2 = str.toString();
return str2.startsWith(prefix) && str2.endsWith(suffix);
}
/**
* 指定字符串是否被同一字符包装（前后都有这些字符串）
*
* @param str 字符串
* @param wrapper 包装字符串
* @return 是否被包装
*/
public static boolean isWrap(CharSequence str, String wrapper) {
return isWrap(str, wrapper, wrapper);
}
/**
* 指定字符串是否被同一字符包装（前后都有这些字符串）
*
* @param str 字符串
* @param wrapper 包装字符
* @return 是否被包装
*/
public static boolean isWrap(CharSequence str, char wrapper) {
return isWrap(str, wrapper, wrapper);
}
/**
* 指定字符串是否被包装
*
* @param str 字符串
* @param prefixChar 前缀
* @param suffixChar 后缀
* @return 是否被包装
*/
public static boolean isWrap(CharSequence str, char prefixChar, char suffixChar) {
if (null == str) {
return false;
}
return str.charAt(0) == prefixChar && str.charAt(str.length() - 1) == suffixChar;
}
// ------------------------------------------------------------------------ pad
/**
* 补充字符串以满足指定长度，如果提供的字符串大于指定长度，截断之
* 同：leftPad (org.apache.commons.lang3.leftPad)
*
*
* StrUtil.padPre(null, *, *);//null
* StrUtil.padPre("1", 3, "ABC");//"AB1"
* StrUtil.padPre("123", 2, "ABC");//"12"
* StrUtil.padPre("1039", -1, "0");//"103"
*
*
* @param str 字符串
* @param length 长度
* @param padStr 补充的字符
* @return 补充后的字符串
*/
public static String padPre(CharSequence str, int length, CharSequence padStr) {
if (null == str) {
return null;
}
final int strLen = str.length();
if (strLen == length) {
return str.toString();
} else if (strLen > length) {
//如果提供的字符串大于指定长度，截断之
return subPre(str, length);
}
return repeatByLength(padStr, length - strLen).concat(str.toString());
}
/**
* 补充字符串以满足最小长度，如果提供的字符串大于指定长度，截断之
* 同：leftPad (org.apache.commons.lang3.leftPad)
*
*
* StrUtil.padPre(null, *, *);//null
* StrUtil.padPre("1", 3, '0');//"001"
* StrUtil.padPre("123", 2, '0');//"12"
*
*
* @param str 字符串
* @param length 长度
* @param padChar 补充的字符
* @return 补充后的字符串
*/
public static String padPre(CharSequence str, int length, char padChar) {
if (null == str) {
return null;
}
final int strLen = str.length();
if (strLen == length) {
return str.toString();
} else if (strLen > length) {
//如果提供的字符串大于指定长度，截断之
return subPre(str, length);
}
return repeat(padChar, length - strLen).concat(str.toString());
}
/**
* 补充字符串以满足最小长度，如果提供的字符串大于指定长度，截断之
*
*
* StrUtil.padAfter(null, *, *);//null
* StrUtil.padAfter("1", 3, '0');//"100"
* StrUtil.padAfter("123", 2, '0');//"23"
* StrUtil.padAfter("123", -1, '0')//"" 空串
*
*
* @param str 字符串，如果为{@code null}，直接返回null
* @param length 长度
* @param padChar 补充的字符
* @return 补充后的字符串
*/
public static String padAfter(CharSequence str, int length, char padChar) {
if (null == str) {
return null;
}
final int strLen = str.length();
if (strLen == length) {
return str.toString();
} else if (strLen > length) {
//如果提供的字符串大于指定长度，截断之
return sub(str, strLen - length, strLen);
}
return str.toString().concat(repeat(padChar, length - strLen));
}
/**
* 补充字符串以满足最小长度
*
*
* StrUtil.padAfter(null, *, *);//null
* StrUtil.padAfter("1", 3, "ABC");//"1AB"
* StrUtil.padAfter("123", 2, "ABC");//"23"
*
*
* @param str 字符串，如果为{@code null}，直接返回null
* @param length 长度
* @param padStr 补充的字符
* @return 补充后的字符串
* @since 4.3.2
*/
public static String padAfter(CharSequence str, int length, CharSequence padStr) {
if (null == str) {
return null;
}
final int strLen = str.length();
if (strLen == length) {
return str.toString();
} else if (strLen > length) {
//如果提供的字符串大于指定长度，截断之
return subSufByLength(str, length);
}
return str.toString().concat(repeatByLength(padStr, length - strLen));
}
// ------------------------------------------------------------------------ center
/**
* 居中字符串，两边补充指定字符串，如果指定长度小于字符串，则返回原字符串
*
*
* StrUtil.center(null, *) = null
* StrUtil.center("", 4) = " "
* StrUtil.center("ab", -1) = "ab"
* StrUtil.center("ab", 4) = " ab "
* StrUtil.center("abcd", 2) = "abcd"
* StrUtil.center("a", 4) = " a "
*
*
* @param str 字符串
* @param size 指定长度
* @return 补充后的字符串
* @since 4.3.2
*/
public static String center(CharSequence str, final int size) {
return center(str, size, CharUtil.SPACE);
}
/**
* 居中字符串，两边补充指定字符串，如果指定长度小于字符串，则返回原字符串
*
*
* StrUtil.center(null, *, *) = null
* StrUtil.center("", 4, ' ') = " "
* StrUtil.center("ab", -1, ' ') = "ab"
* StrUtil.center("ab", 4, ' ') = " ab "
* StrUtil.center("abcd", 2, ' ') = "abcd"
* StrUtil.center("a", 4, ' ') = " a "
* StrUtil.center("a", 4, 'y') = "yayy"
* StrUtil.center("abc", 7, ' ') = " abc "
*
*
* @param str 字符串
* @param size 指定长度
* @param padChar 两边补充的字符
* @return 补充后的字符串
* @since 4.3.2
*/
public static String center(CharSequence str, final int size, char padChar) {
if (str == null || size <= 0) {
return str(str);
}
final int strLen = str.length();
final int pads = size - strLen;
if (pads <= 0) {
return str.toString();
}
str = padPre(str, strLen + pads / 2, padChar);
str = padAfter(str, size, padChar);
return str.toString();
}
/**
* 居中字符串，两边补充指定字符串，如果指定长度小于字符串，则返回原字符串
*
*
* StrUtil.center(null, *, *) = null
* StrUtil.center("", 4, " ") = " "
* StrUtil.center("ab", -1, " ") = "ab"
* StrUtil.center("ab", 4, " ") = " ab "
* StrUtil.center("abcd", 2, " ") = "abcd"
* StrUtil.center("a", 4, " ") = " a "
* StrUtil.center("a", 4, "yz") = "yayz"
* StrUtil.center("abc", 7, null) = " abc "
* StrUtil.center("abc", 7, "") = " abc "
*
*
* @param str 字符串
* @param size 指定长度
* @param padStr 两边补充的字符串
* @return 补充后的字符串
*/
public static String center(CharSequence str, final int size, CharSequence padStr) {
if (str == null || size <= 0) {
return str(str);
}
if (isEmpty(padStr)) {
padStr = SPACE;
}
final int strLen = str.length();
final int pads = size - strLen;
if (pads <= 0) {
return str.toString();
}
str = padPre(str, strLen + pads / 2, padStr);
str = padAfter(str, size, padStr);
return str.toString();
}
// ------------------------------------------------------------------------ str
/**
* {@link CharSequence} 转为字符串，null安全
*
* @param cs {@link CharSequence}
* @return 字符串
*/
public static String str(CharSequence cs) {
return null == cs ? null : cs.toString();
}
// ------------------------------------------------------------------------ count
/**
* 统计指定内容中包含指定字符串的数量
* 参数为 {@code null} 或者 "" 返回 {@code 0}.
*
*
* StrUtil.count(null, *) = 0
* StrUtil.count("", *) = 0
* StrUtil.count("abba", null) = 0
* StrUtil.count("abba", "") = 0
* StrUtil.count("abba", "a") = 2
* StrUtil.count("abba", "ab") = 1
* StrUtil.count("abba", "xxx") = 0
*
*
* @param content 被查找的字符串
* @param strForSearch 需要查找的字符串
* @return 查找到的个数
*/
public static int count(CharSequence content, CharSequence strForSearch) {
if (hasEmpty(content, strForSearch) || strForSearch.length() > content.length()) {
return 0;
}
int count = 0;
int idx = 0;
final String content2 = content.toString();
final String strForSearch2 = strForSearch.toString();
while ((idx = content2.indexOf(strForSearch2, idx)) > -1) {
count++;
idx += strForSearch.length();
}
return count;
}
/**
* 统计指定内容中包含指定字符的数量
*
* @param content 内容
* @param charForSearch 被统计的字符
* @return 包含数量
*/
public static int count(CharSequence content, char charForSearch) {
int count = 0;
if (isEmpty(content)) {
return 0;
}
int contentLength = content.length();
for (int i = 0; i < contentLength; i++) {
if (charForSearch == content.charAt(i)) {
count++;
}
}
return count;
}
// ------------------------------------------------------------------------ compare
/**
* 比较两个字符串，用于排序
*
*
* StrUtil.compare(null, null, *) = 0
* StrUtil.compare(null , "a", true) < 0
* StrUtil.compare(null , "a", false) > 0
* StrUtil.compare("a", null, true) > 0
* StrUtil.compare("a", null, false) < 0
* StrUtil.compare("abc", "abc", *) = 0
* StrUtil.compare("a", "b", *) < 0
* StrUtil.compare("b", "a", *) > 0
* StrUtil.compare("a", "B", *) > 0
* StrUtil.compare("ab", "abc", *) < 0
*
*
* @param str1 字符串1
* @param str2 字符串2
* @param nullIsLess {@code null} 值是否排在前（null是否小于非空值）
* @return 排序值。负数：str1 < str2，正数：str1 > str2, 0：str1 == str2
*/
public static int compare(final CharSequence str1, final CharSequence str2, final boolean nullIsLess) {
if (str1 == str2) {
return 0;
}
if (str1 == null) {
return nullIsLess ? -1 : 1;
}
if (str2 == null) {
return nullIsLess ? 1 : -1;
}
return str1.toString().compareTo(str2.toString());
}
/**
* 比较两个字符串，用于排序，大小写不敏感
*
*
* StrUtil.compareIgnoreCase(null, null, *) = 0
* StrUtil.compareIgnoreCase(null , "a", true) < 0
* StrUtil.compareIgnoreCase(null , "a", false) > 0
* StrUtil.compareIgnoreCase("a", null, true) > 0
* StrUtil.compareIgnoreCase("a", null, false) < 0
* StrUtil.compareIgnoreCase("abc", "abc", *) = 0
* StrUtil.compareIgnoreCase("abc", "ABC", *) = 0
* StrUtil.compareIgnoreCase("a", "b", *) < 0
* StrUtil.compareIgnoreCase("b", "a", *) > 0
* StrUtil.compareIgnoreCase("a", "B", *) < 0
* StrUtil.compareIgnoreCase("A", "b", *) < 0
* StrUtil.compareIgnoreCase("ab", "abc", *) < 0
*
*
* @param str1 字符串1
* @param str2 字符串2
* @param nullIsLess {@code null} 值是否排在前（null是否小于非空值）
* @return 排序值。负数：str1 < str2，正数：str1 > str2, 0：str1 == str2
*/
public static int compareIgnoreCase(CharSequence str1, CharSequence str2, boolean nullIsLess) {
if (str1 == str2) {
return 0;
}
if (str1 == null) {
return nullIsLess ? -1 : 1;
}
if (str2 == null) {
return nullIsLess ? 1 : -1;
}
return str1.toString().compareToIgnoreCase(str2.toString());
}
/**
* 比较两个版本
* null版本排在最小：即：
*
*
* StrUtil.compareVersion(null, "v1") < 0
* StrUtil.compareVersion("v1", "v1") = 0
* StrUtil.compareVersion(null, null) = 0
* StrUtil.compareVersion("v1", null) > 0
* StrUtil.compareVersion("1.0.0", "1.0.2") < 0
* StrUtil.compareVersion("1.0.2", "1.0.2a") < 0
* StrUtil.compareVersion("1.13.0", "1.12.1c") > 0
* StrUtil.compareVersion("V0.0.20170102", "V0.0.20170101") > 0
*
*
* @param version1 版本1
* @param version2 版本2
* @return 排序值。负数：version1 < version2，正数：version1 > version2, 0：version1 == version2
* @since 4.0.2
*/
public static int compareVersion(CharSequence version1, CharSequence version2) {
return VersionComparator.INSTANCE.compare(str(version1), str(version2));
}
// ------------------------------------------------------------------------ append and prepend
/**
* 如果给定字符串不是以给定的一个或多个字符串为结尾，则在尾部添加结尾字符串
* 不忽略大小写
*
* @param str 被检查的字符串
* @param suffix 需要添加到结尾的字符串
* @param suffixes 需要额外检查的结尾字符串，如果以这些中的一个为结尾，则不再添加
* @return 如果已经结尾，返回原字符串，否则返回添加结尾的字符串
* @since 3.0.7
*/
public static String appendIfMissing(CharSequence str, CharSequence suffix, CharSequence... suffixes) {
return appendIfMissing(str, suffix, false, suffixes);
}
/**
* 如果给定字符串不是以给定的一个或多个字符串为结尾，则在尾部添加结尾字符串
* 忽略大小写
*
* @param str 被检查的字符串
* @param suffix 需要添加到结尾的字符串
* @param suffixes 需要额外检查的结尾字符串，如果以这些中的一个为结尾，则不再添加
* @return 如果已经结尾，返回原字符串，否则返回添加结尾的字符串
* @since 3.0.7
*/
public static String appendIfMissingIgnoreCase(CharSequence str, CharSequence suffix, CharSequence... suffixes) {
return appendIfMissing(str, suffix, true, suffixes);
}
/**
* 如果给定字符串不是以给定的一个或多个字符串为结尾，则在尾部添加结尾字符串
*
* @param str 被检查的字符串
* @param suffix 需要添加到结尾的字符串，不参与检查匹配
* @param ignoreCase 检查结尾时是否忽略大小写
* @param testSuffixes 需要额外检查的结尾字符串，如果以这些中的一个为结尾，则不再添加
* @return 如果已经结尾，返回原字符串，否则返回添加结尾的字符串
* @since 3.0.7
*/
public static String appendIfMissing(CharSequence str, CharSequence suffix, boolean ignoreCase, CharSequence... testSuffixes) {
if (str == null || isEmpty(suffix) || endWith(str, suffix, ignoreCase)) {
return str(str);
}
if (ArrayUtil.isNotEmpty(testSuffixes)) {
for (final CharSequence testSuffix : testSuffixes) {
if (endWith(str, testSuffix, ignoreCase)) {
return str.toString();
}
}
}
return str.toString().concat(suffix.toString());
}
/**
* 如果给定字符串不是以给定的一个或多个字符串为开头，则在首部添加起始字符串
* 不忽略大小写
*
* @param str 被检查的字符串
* @param prefix 需要添加到首部的字符串
* @param prefixes 需要额外检查的首部字符串，如果以这些中的一个为起始，则不再添加
* @return 如果已经结尾，返回原字符串，否则返回添加结尾的字符串
* @since 3.0.7
*/
public static String prependIfMissing(CharSequence str, CharSequence prefix, CharSequence... prefixes) {
return prependIfMissing(str, prefix, false, prefixes);
}
/**
* 如果给定字符串不是以给定的一个或多个字符串为开头，则在首部添加起始字符串
* 忽略大小写
*
* @param str 被检查的字符串
* @param prefix 需要添加到首部的字符串
* @param prefixes 需要额外检查的首部字符串，如果以这些中的一个为起始，则不再添加
* @return 如果已经结尾，返回原字符串，否则返回添加结尾的字符串
* @since 3.0.7
*/
public static String prependIfMissingIgnoreCase(CharSequence str, CharSequence prefix, CharSequence... prefixes) {
return prependIfMissing(str, prefix, true, prefixes);
}
/**
* 如果给定字符串不是以给定的一个或多个字符串为开头，则在首部添加起始字符串
*
* @param str 被检查的字符串
* @param prefix 需要添加到首部的字符串
* @param ignoreCase 检查结尾时是否忽略大小写
* @param prefixes 需要额外检查的首部字符串，如果以这些中的一个为起始，则不再添加
* @return 如果已经结尾，返回原字符串，否则返回添加结尾的字符串
* @since 3.0.7
*/
public static String prependIfMissing(CharSequence str, CharSequence prefix, boolean ignoreCase, CharSequence... prefixes) {
if (str == null || isEmpty(prefix) || startWith(str, prefix, ignoreCase)) {
return str(str);
}
if (prefixes != null && prefixes.length > 0) {
for (final CharSequence s : prefixes) {
if (startWith(str, s, ignoreCase)) {
return str.toString();
}
}
}
return prefix.toString().concat(str.toString());
}
// ------------------------------------------------------------------------ replace
/**
* 替换字符串中的指定字符串，忽略大小写
*
* @param str 字符串
* @param searchStr 被查找的字符串
* @param replacement 被替换的字符串
* @return 替换后的字符串
* @since 4.0.3
*/
public static String replaceIgnoreCase(CharSequence str, CharSequence searchStr, CharSequence replacement) {
return replace(str, 0, searchStr, replacement, true);
}
/**
* 替换字符串中的指定字符串
*
* @param str 字符串
* @param searchStr 被查找的字符串
* @param replacement 被替换的字符串
* @return 替换后的字符串
* @since 4.0.3
*/
public static String replace(CharSequence str, CharSequence searchStr, CharSequence replacement) {
return replace(str, 0, searchStr, replacement, false);
}
/**
* 替换字符串中的指定字符串
*
* @param str 字符串
* @param searchStr 被查找的字符串
* @param replacement 被替换的字符串
* @param ignoreCase 是否忽略大小写
* @return 替换后的字符串
* @since 4.0.3
*/
public static String replace(CharSequence str, CharSequence searchStr, CharSequence replacement, boolean ignoreCase) {
return replace(str, 0, searchStr, replacement, ignoreCase);
}
/**
* 替换字符串中的指定字符串
*
* @param str 字符串
* @param fromIndex 开始位置（包括）
* @param searchStr 被查找的字符串
* @param replacement 被替换的字符串
* @param ignoreCase 是否忽略大小写
* @return 替换后的字符串
* @since 4.0.3
*/
public static String replace(CharSequence str, int fromIndex, CharSequence searchStr, CharSequence replacement, boolean ignoreCase) {
if (isEmpty(str) || isEmpty(searchStr)) {
return str(str);
}
if (null == replacement) {
replacement = EMPTY;
}
final int strLength = str.length();
final int searchStrLength = searchStr.length();
if (strLength < searchStrLength) {
// issue#I4M16G@Gitee
return str(str);
}
if (fromIndex > strLength) {
return str(str);
} else if (fromIndex < 0) {
fromIndex = 0;
}
final StringBuilder result = new StringBuilder(strLength - searchStrLength + replacement.length());
if (0 != fromIndex) {
result.append(str.subSequence(0, fromIndex));
}
int preIndex = fromIndex;
int index;
while ((index = indexOf(str, searchStr, preIndex, ignoreCase)) > -1) {
result.append(str.subSequence(preIndex, index));
result.append(replacement);
preIndex = index + searchStrLength;
}
if (preIndex < strLength) {
// 结尾部分
result.append(str.subSequence(preIndex, strLength));
}
return result.toString();
}
/**
* 替换指定字符串的指定区间内字符为固定字符
* 此方法使用{@link String#codePoints()}完成拆分替换
*
* @param str 字符串
* @param startInclude 开始位置（包含）
* @param endExclude 结束位置（不包含）
* @param replacedChar 被替换的字符
* @return 替换后的字符串
* @since 3.2.1
*/
public static String replace(CharSequence str, int startInclude, int endExclude, char replacedChar) {
if (isEmpty(str)) {
return str(str);
}
final String originalStr = str(str);
int[] strCodePoints = originalStr.codePoints().toArray();
final int strLength = strCodePoints.length;
if (startInclude > strLength) {
return originalStr;
}
if (endExclude > strLength) {
endExclude = strLength;
}
if (startInclude > endExclude) {
// 如果起始位置大于结束位置，不替换
return originalStr;
}
final StringBuilder stringBuilder = new StringBuilder();
for (int i = 0; i < strLength; i++) {
if (i >= startInclude && i < endExclude) {
stringBuilder.append(replacedChar);
} else {
stringBuilder.append(new String(strCodePoints, i, 1));
}
}
return stringBuilder.toString();
}
/**
* 替换指定字符串的指定区间内字符为指定字符串，字符串只重复一次
* 此方法使用{@link String#codePoints()}完成拆分替换
*
* @param str 字符串
* @param startInclude 开始位置（包含）
* @param endExclude 结束位置（不包含）
* @param replacedStr 被替换的字符串
* @return 替换后的字符串
* @since 3.2.1
*/
public static String replace(CharSequence str, int startInclude, int endExclude, CharSequence replacedStr) {
if (isEmpty(str)) {
return str(str);
}
final String originalStr = str(str);
int[] strCodePoints = originalStr.codePoints().toArray();
final int strLength = strCodePoints.length;
if (startInclude > strLength) {
return originalStr;
}
if (endExclude > strLength) {
endExclude = strLength;
}
if (startInclude > endExclude) {
// 如果起始位置大于结束位置，不替换
return originalStr;
}
final StringBuilder stringBuilder = new StringBuilder();
for (int i = 0; i < startInclude; i++) {
stringBuilder.append(new String(strCodePoints, i, 1));
}
stringBuilder.append(replacedStr);
for (int i = endExclude; i < strLength; i++) {
stringBuilder.append(new String(strCodePoints, i, 1));
}
return stringBuilder.toString();
}
/**
* 替换所有正则匹配的文本，并使用自定义函数决定如何替换
* replaceFun可以通过{@link Matcher}提取出匹配到的内容的不同部分，然后经过重新处理、组装变成新的内容放回原位。
*
* replace(this.content, "(\\d+)", parameters -> "-" + parameters.group(1) + "-")
* // 结果为："ZZZaaabbbccc中文-1234-"
*
*
* @param str 要替换的字符串
* @param pattern 用于匹配的正则式
* @param replaceFun 决定如何替换的函数
* @return 替换后的字符串
* @see ReUtil#replaceAll(CharSequence, java.util.regex.Pattern, Func1)
* @since 4.2.2
*/
public static String replace(CharSequence str, java.util.regex.Pattern pattern, Func1 replaceFun) {
return ReUtil.replaceAll(str, pattern, replaceFun);
}
/**
* 替换所有正则匹配的文本，并使用自定义函数决定如何替换
*
* @param str 要替换的字符串
* @param regex 用于匹配的正则式
* @param replaceFun 决定如何替换的函数
* @return 替换后的字符串
* @see ReUtil#replaceAll(CharSequence, String, Func1)
* @since 4.2.2
*/
public static String replace(CharSequence str, String regex, Func1 replaceFun) {
return ReUtil.replaceAll(str, regex, replaceFun);
}
/**
* 替换字符串中最后一个指定字符串
*
* @param str 字符串
* @param searchStr 被查找的字符串
* @param replacedStr 被替换的字符串
* @return 替换后的字符串
*/
public static String replaceLast(CharSequence str, CharSequence searchStr, CharSequence replacedStr) {
return replaceLast(str, searchStr, replacedStr, false);
}
/**
* 替换字符串中最后一个指定字符串
*
* @param str 字符串
* @param searchStr 被查找的字符串
* @param replacedStr 被替换的字符串
* @param ignoreCase 是否忽略大小写
* @return 替换后的字符串
*/
public static String replaceLast(CharSequence str, CharSequence searchStr, CharSequence replacedStr, boolean ignoreCase) {
if (isEmpty(str)) {
return str(str);
}
int lastIndex = lastIndexOf(str, searchStr, str.length(), ignoreCase);
if (INDEX_NOT_FOUND == lastIndex) {
return str(str);
}
return replace(str, lastIndex, searchStr, replacedStr, ignoreCase);
}
/**
* 替换字符串中第一个指定字符串
*
* @param str 字符串
* @param searchStr 被查找的字符串
* @param replacedStr 被替换的字符串
* @return 替换后的字符串
*/
public static String replaceFirst(CharSequence str, CharSequence searchStr, CharSequence replacedStr) {
return replaceFirst(str, searchStr, replacedStr, false);
}
/**
* 替换字符串中第一个指定字符串
*
* @param str 字符串
* @param searchStr 被查找的字符串
* @param replacedStr 被替换的字符串
* @param ignoreCase 是否忽略大小写
* @return 替换后的字符串
*/
public static String replaceFirst(CharSequence str, CharSequence searchStr, CharSequence replacedStr, boolean ignoreCase) {
if (isEmpty(str)) {
return str(str);
}
int startInclude = indexOf(str, searchStr, 0, ignoreCase);
if (INDEX_NOT_FOUND == startInclude) {
return str(str);
}
return replace(str, startInclude, startInclude + searchStr.length(), replacedStr);
}
/**
* 替换指定字符串的指定区间内字符为"*"
* 俗称：脱敏功能，后面其他功能，可以见：DesensitizedUtil(脱敏工具类)
*
*
* StrUtil.hide(null,*,*)=null
* StrUtil.hide("",0,*)=""
* StrUtil.hide("[email protected]",-1,4) ****[email protected]
* StrUtil.hide("[email protected]",2,3) ja*[email protected]
* StrUtil.hide("[email protected]",3,2) [email protected]
* StrUtil.hide("[email protected]",16,16) [email protected]
* StrUtil.hide("[email protected]",16,17) [email protected]
*
*
* @param str 字符串
* @param startInclude 开始位置（包含）
* @param endExclude 结束位置（不包含）
* @return 替换后的字符串
* @since 4.1.14
*/
public static String hide(CharSequence str, int startInclude, int endExclude) {
return replace(str, startInclude, endExclude, '*');
}
/**
* 脱敏，使用默认的脱敏策略
*
*
* StrUtil.desensitized("100", DesensitizedUtil.DesensitizedType.USER_ID)) = "0"
* StrUtil.desensitized("段正淳", DesensitizedUtil.DesensitizedType.CHINESE_NAME)) = "段**"
* StrUtil.desensitized("51343620000320711X", DesensitizedUtil.DesensitizedType.ID_CARD)) = "5***************1X"
* StrUtil.desensitized("09157518479", DesensitizedUtil.DesensitizedType.FIXED_PHONE)) = "0915*****79"
* StrUtil.desensitized("18049531999", DesensitizedUtil.DesensitizedType.MOBILE_PHONE)) = "180****1999"
* StrUtil.desensitized("北京市海淀区马连洼街道289号", DesensitizedUtil.DesensitizedType.ADDRESS)) = "北京市海淀区马********"
* StrUtil.desensitized("[email protected]", DesensitizedUtil.DesensitizedType.EMAIL)) = "d*************@gmail.com.cn"
* StrUtil.desensitized("1234567890", DesensitizedUtil.DesensitizedType.PASSWORD)) = "**********"
* StrUtil.desensitized("苏D40000", DesensitizedUtil.DesensitizedType.CAR_LICENSE)) = "苏D4***0"
* StrUtil.desensitized("11011111222233333256", DesensitizedType.BANK_CARD)) = "1101 **** **** **** 3256"
*
*
* @param str 字符串
* @param desensitizedType 脱敏类型;可以脱敏：用户id、中文名、身份证号、座机号、手机号、地址、电子邮件、密码
* @return 脱敏之后的字符串
* @author dazer and neusoft and qiaomu
* @see DesensitizedUtil 如果需要自定义，脱敏规则，请使用该工具类；
* @since 5.6.2
*/
public static String desensitized(CharSequence str, DesensitizedUtil.DesensitizedType desensitizedType) {
return DesensitizedUtil.desensitized(str, desensitizedType);
}
/**
* 替换字符字符数组中所有的字符为replacedStr
* 提供的chars为所有需要被替换的字符，例如："\r\n"，则"\r"和"\n"都会被替换，哪怕他们单独存在
*
* @param str 被检查的字符串
* @param chars 需要替换的字符列表，用一个字符串表示这个字符列表
* @param replacedStr 替换成的字符串
* @return 新字符串
* @since 3.2.2
*/
public static String replaceChars(CharSequence str, String chars, CharSequence replacedStr) {
if (isEmpty(str) || isEmpty(chars)) {
return str(str);
}
return replaceChars(str, chars.toCharArray(), replacedStr);
}
/**
* 替换字符字符数组中所有的字符为replacedStr
*
* @param str 被检查的字符串
* @param chars 需要替换的字符列表
* @param replacedStr 替换成的字符串
* @return 新字符串
* @since 3.2.2
*/
public static String replaceChars(CharSequence str, char[] chars, CharSequence replacedStr) {
if (isEmpty(str) || ArrayUtil.isEmpty(chars)) {
return str(str);
}
final Set set = new HashSet<>(chars.length);
for (char c : chars) {
set.add(c);
}
int strLen = str.length();
final StringBuilder builder = new StringBuilder();
char c;
for (int i = 0; i < strLen; i++) {
c = str.charAt(i);
builder.append(set.contains(c) ? replacedStr : c);
}
return builder.toString();
}
// ------------------------------------------------------------------------ length
/**
* 获取字符串的长度，如果为null返回0
*
* @param cs a 字符串
* @return 字符串的长度，如果为null返回0
* @since 4.3.2
*/
public static int length(CharSequence cs) {
return cs == null ? 0 : cs.length();
}
/**
* 给定字符串转为bytes后的byte数（byte长度）
*
* @param cs 字符串
* @param charset 编码
* @return byte长度
* @since 4.5.2
*/
public static int byteLength(CharSequence cs, Charset charset) {
return cs == null ? 0 : cs.toString().getBytes(charset).length;
}
/**
* 给定字符串数组的总长度
* null字符长度定义为0
*
* @param strs 字符串数组
* @return 总长度
* @since 4.0.1
*/
public static int totalLength(CharSequence... strs) {
int totalLength = 0;
for (CharSequence str : strs) {
totalLength += (null == str ? 0 : str.length());
}
return totalLength;
}
/**
* 限制字符串长度，如果超过指定长度，截取指定长度并在末尾加"..."
*
* @param string 字符串
* @param length 最大长度
* @return 切割后的剩余的前半部分字符串+"..."
* @since 4.0.10
*/
public static String maxLength(CharSequence string, int length) {
Assert.isTrue(length > 0);
if (null == string) {
return null;
}
if (string.length() <= length) {
return string.toString();
}
return sub(string, 0, length) + "...";
}
// ------------------------------------------------------------------------ firstXXX
/**
* 返回第一个非{@code null} 元素
*
* @param strs 多个元素
* @param 元素类型
* @return 第一个非空元素，如果给定的数组为空或者都为空，返回{@code null}
* @since 5.4.1
*/
@SuppressWarnings("unchecked")
public static T firstNonNull(T... strs) {
return ArrayUtil.firstNonNull(strs);
}
/**
* 返回第一个非empty 元素
*
* @param strs 多个元素
* @param 元素类型
* @return 第一个非空元素，如果给定的数组为空或者都为空，返回{@code null}
* @see #isNotEmpty(CharSequence)
* @since 5.4.1
*/
@SuppressWarnings("unchecked")
public static T firstNonEmpty(T... strs) {
return ArrayUtil.firstMatch(StrUtil::isNotEmpty, strs);
}
/**
* 返回第一个非blank 元素
*
* @param strs 多个元素
* @param 元素类型
* @return 第一个非空元素，如果给定的数组为空或者都为空，返回{@code null}
* @see #isNotBlank(CharSequence)
* @since 5.4.1
*/
@SuppressWarnings("unchecked")
public static T firstNonBlank(T... strs) {
return ArrayUtil.firstMatch(StrUtil::isNotBlank, strs);
}
// ------------------------------------------------------------------------ lower and upper
/**
* 原字符串首字母大写并在其首部添加指定字符串 例如：str=name, preString=get =》 return getName
*
* @param str 被处理的字符串
* @param preString 添加的首部
* @return 处理后的字符串
*/
public static String upperFirstAndAddPre(CharSequence str, String preString) {
if (str == null || preString == null) {
return null;
}
return preString + upperFirst(str);
}
/**
* 大写首字母
* 例如：str = name, return Name
*
* @param str 字符串
* @return 字符串
*/
public static String upperFirst(CharSequence str) {
if (null == str) {
return null;
}
if (str.length() > 0) {
char firstChar = str.charAt(0);
if (Character.isLowerCase(firstChar)) {
return Character.toUpperCase(firstChar) + subSuf(str, 1);
}
}
return str.toString();
}
/**
* 小写首字母
* 例如：str = Name, return name
*
* @param str 字符串
* @return 字符串
*/
public static String lowerFirst(CharSequence str) {
if (null == str) {
return null;
}
if (str.length() > 0) {
char firstChar = str.charAt(0);
if (Character.isUpperCase(firstChar)) {
return Character.toLowerCase(firstChar) + subSuf(str, 1);
}
}
return str.toString();
}
// ------------------------------------------------------------------------ filter
/**
* 过滤字符串
*
* @param str 字符串
* @param filter 过滤器，{@link Filter#accept(Object)}返回为{@code true}的保留字符
* @return 过滤后的字符串
* @since 5.4.0
*/
public static String filter(CharSequence str, final Filter filter) {
if (str == null || filter == null) {
return str(str);
}
int len = str.length();
final StringBuilder sb = new StringBuilder(len);
char c;
for (int i = 0; i < len; i++) {
c = str.charAt(i);
if (filter.accept(c)) {
sb.append(c);
}
}
return sb.toString();
}
// ------------------------------------------------------------------------ case
/**
* 给定字符串中的字母是否全部为大写，判断依据如下：
*
*
* 1. 大写字母包括A-Z
* 2. 其它非字母的Unicode符都算作大写
*
*
* @param str 被检查的字符串
* @return 是否全部为大写
* @since 4.2.2
*/
public static boolean isUpperCase(CharSequence str) {
if (null == str) {
return false;
}
final int len = str.length();
for (int i = 0; i < len; i++) {
if (Character.isLowerCase(str.charAt(i))) {
return false;
}
}
return true;
}
/**
* 给定字符串中的字母是否全部为小写，判断依据如下：
*
*
* 1. 小写字母包括a-z
* 2. 其它非字母的Unicode符都算作小写
*
*
* @param str 被检查的字符串
* @return 是否全部为小写
* @since 4.2.2
*/
public static boolean isLowerCase(CharSequence str) {
if (null == str) {
return false;
}
final int len = str.length();
for (int i = 0; i < len; i++) {
if (Character.isUpperCase(str.charAt(i))) {
return false;
}
}
return true;
}
/**
* 切换给定字符串中的大小写。大写转小写，小写转大写。
*
*
* StrUtil.swapCase(null) = null
* StrUtil.swapCase("") = ""
* StrUtil.swapCase("The dog has a BONE") = "tHE DOG HAS A bone"
*
*
* @param str 字符串
* @return 交换后的字符串
* @since 4.3.2
*/
public static String swapCase(final String str) {
if (isEmpty(str)) {
return str;
}
final char[] buffer = str.toCharArray();
for (int i = 0; i < buffer.length; i++) {
final char ch = buffer[i];
if (Character.isUpperCase(ch)) {
buffer[i] = Character.toLowerCase(ch);
} else if (Character.isTitleCase(ch)) {
buffer[i] = Character.toLowerCase(ch);
} else if (Character.isLowerCase(ch)) {
buffer[i] = Character.toUpperCase(ch);
}
}
return new String(buffer);
}
/**
* 将驼峰式命名的字符串转换为下划线方式。如果转换前的驼峰式命名的字符串为空，则返回空字符串。
* 例如：
*
*
* HelloWorld=》hello_world
* Hello_World=》hello_world
* HelloWorld_test=》hello_world_test
*
*
* @param str 转换前的驼峰式命名的字符串，也可以为下划线形式
* @return 转换后下划线方式命名的字符串
* @see NamingCase#toUnderlineCase(CharSequence)
*/
public static String toUnderlineCase(CharSequence str) {
return NamingCase.toUnderlineCase(str);
}
/**
* 将驼峰式命名的字符串转换为使用符号连接方式。如果转换前的驼峰式命名的字符串为空，则返回空字符串。
*
* @param str 转换前的驼峰式命名的字符串，也可以为符号连接形式
* @param symbol 连接符
* @return 转换后符号连接方式命名的字符串
* @see NamingCase#toSymbolCase(CharSequence, char)
* @since 4.0.10
*/
public static String toSymbolCase(CharSequence str, char symbol) {
return NamingCase.toSymbolCase(str, symbol);
}
/**
* 将下划线方式命名的字符串转换为驼峰式。如果转换前的下划线大写方式命名的字符串为空，则返回空字符串。
* 例如：hello_world=》helloWorld
*
* @param name 转换前的下划线大写方式命名的字符串
* @return 转换后的驼峰式命名的字符串
* @see NamingCase#toCamelCase(CharSequence)
*/
public static String toCamelCase(CharSequence name) {
return NamingCase.toCamelCase(name);
}
/**
* 将连接符方式命名的字符串转换为驼峰式。如果转换前的下划线大写方式命名的字符串为空，则返回空字符串。
* 例如：hello_world=》helloWorld; hello-world=》helloWorld
*
* @param name 转换前的下划线大写方式命名的字符串
* @param symbol 连接符
* @return 转换后的驼峰式命名的字符串
* @see NamingCase#toCamelCase(CharSequence, char)
*/
public static String toCamelCase(CharSequence name, char symbol) {
return NamingCase.toCamelCase(name, symbol);
}
// ------------------------------------------------------------------------ isSurround
/**
* 给定字符串是否被字符包围
*
* @param str 字符串
* @param prefix 前缀
* @param suffix 后缀
* @return 是否包围，空串不包围
*/
public static boolean isSurround(CharSequence str, CharSequence prefix, CharSequence suffix) {
if (StrUtil.isBlank(str)) {
return false;
}
if (str.length() < (prefix.length() + suffix.length())) {
return false;
}
final String str2 = str.toString();
return str2.startsWith(prefix.toString()) && str2.endsWith(suffix.toString());
}
/**
* 给定字符串是否被字符包围
*
* @param str 字符串
* @param prefix 前缀
* @param suffix 后缀
* @return 是否包围，空串不包围
*/
public static boolean isSurround(CharSequence str, char prefix, char suffix) {
if (StrUtil.isBlank(str)) {
return false;
}
if (str.length() < 2) {
return false;
}
return str.charAt(0) == prefix && str.charAt(str.length() - 1) == suffix;
}
// ------------------------------------------------------------------------ builder
/**
* 创建StringBuilder对象
*
* @param strs 初始字符串列表
* @return StringBuilder对象
*/
public static StringBuilder builder(CharSequence... strs) {
final StringBuilder sb = new StringBuilder();
for (CharSequence str : strs) {
sb.append(str);
}
return sb;
}
/**
* 创建StrBuilder对象
*
* @param strs 初始字符串列表
* @return StrBuilder对象
*/
public static StrBuilder strBuilder(CharSequence... strs) {
return StrBuilder.create(strs);
}
// ------------------------------------------------------------------------ getter and setter
/**
* 获得set或get或is方法对应的标准属性名
* 例如：setName 返回 name
*
*
* getName =》name
* setName =》name
* isName =》name
*
*
* @param getOrSetMethodName Get或Set方法名
* @return 如果是set或get方法名，返回field， 否则null
*/
public static String getGeneralField(CharSequence getOrSetMethodName) {
final String getOrSetMethodNameStr = getOrSetMethodName.toString();
if (getOrSetMethodNameStr.startsWith("get") || getOrSetMethodNameStr.startsWith("set")) {
return removePreAndLowerFirst(getOrSetMethodName, 3);
} else if (getOrSetMethodNameStr.startsWith("is")) {
return removePreAndLowerFirst(getOrSetMethodName, 2);
}
return null;
}
/**
* 生成set方法名
* 例如：name 返回 setName
*
* @param fieldName 属性名
* @return setXxx
*/
public static String genSetter(CharSequence fieldName) {
return upperFirstAndAddPre(fieldName, "set");
}
/**
* 生成get方法名
*
* @param fieldName 属性名
* @return getXxx
*/
public static String genGetter(CharSequence fieldName) {
return upperFirstAndAddPre(fieldName, "get");
}
// ------------------------------------------------------------------------ other
/**
* 连接多个字符串为一个
*
* @param isNullToEmpty 是否null转为""
* @param strs 字符串数组
* @return 连接后的字符串
* @since 4.1.0
*/
public static String concat(boolean isNullToEmpty, CharSequence... strs) {
final StrBuilder sb = new StrBuilder();
for (CharSequence str : strs) {
sb.append(isNullToEmpty ? nullToEmpty(str) : str);
}
return sb.toString();
}
/**
* 将给定字符串，变成 "xxx...xxx" 形式的字符串
*
*
* - abcdefgh 9 -》 abcdefgh
* - abcdefgh 8 -》 abcdefgh
* - abcdefgh 7 -》 ab...gh
* - abcdefgh 6 -》 ab...h
* - abcdefgh 5 -》 a...h
* - abcdefgh 4 -》 a..h
* - abcdefgh 3 -》 a.h
* - abcdefgh 2 -》 a.
* - abcdefgh 1 -》 a
* - abcdefgh 0 -》 abcdefgh
* - abcdefgh -1 -》 abcdefgh
*
*
* @param str 字符串
* @param maxLength 结果的最大长度
* @return 截取后的字符串
*/
public static String brief(CharSequence str, int maxLength) {
if (null == str) {
return null;
}
final int strLength = str.length();
if (maxLength <= 0 || strLength <= maxLength) {
return str.toString();
}
// since 5.7.5，特殊长度
switch (maxLength) {
case 1:
return String.valueOf(str.charAt(0));
case 2:
return str.charAt(0) + ".";
case 3:
return str.charAt(0) + "." + str.charAt(strLength - 1);
case 4:
return str.charAt(0) + ".." + str.charAt(strLength - 1);
}
final int suffixLength = (maxLength - 3) / 2;
final int preLength = suffixLength + (maxLength - 3) % 2; // suffixLength 或 suffixLength + 1
final String str2 = str.toString();
return format("{}...{}",
str2.substring(0, preLength),
str2.substring(strLength - suffixLength));
}
/**
* 以 conjunction 为分隔符将多个对象转换为字符串
*
* @param conjunction 分隔符 {@link StrPool#COMMA}
* @param objs 数组
* @return 连接后的字符串
* @see ArrayUtil#join(Object, CharSequence)
*/
public static String join(CharSequence conjunction, Object... objs) {
return ArrayUtil.join(objs, conjunction);
}
/**
* 以 conjunction 为分隔符将多个对象转换为字符串
*
* @param 元素类型
* @param conjunction 分隔符 {@link StrPool#COMMA}
* @param iterable 集合
* @return 连接后的字符串
* @see CollUtil#join(Iterable, CharSequence)
* @since 5.6.6
*/
public static String join(CharSequence conjunction, Iterable iterable) {
return CollUtil.join(iterable, conjunction);
}
/**
* 字符串的每一个字符是否都与定义的匹配器匹配
*
* @param value 字符串
* @param matcher 匹配器
* @return 是否全部匹配
* @since 3.2.3
*/
public static boolean isAllCharMatch(CharSequence value, Matcher matcher) {
if (StrUtil.isBlank(value)) {
return false;
}
for (int i = value.length(); --i >= 0; ) {
if (false == matcher.match(value.charAt(i))) {
return false;
}
}
return true;
}
/**
* 检查字符串是否都为数字组成
*
* @param str 字符串
* @return 是否都为数字组成
* @since 5.7.3
*/
public static boolean isNumeric(CharSequence str) {
return isAllCharMatch(str, Character::isDigit);
}
/**
* 循环位移指定位置的字符串为指定距离
* 当moveLength大于0向右位移，小于0向左位移，0不位移
* 当moveLength大于字符串长度时采取循环位移策略，即位移到头后从头（尾）位移，例如长度为10，位移13则表示位移3
*
* @param str 字符串
* @param startInclude 起始位置（包括）
* @param endExclude 结束位置（不包括）
* @param moveLength 移动距离，负数表示左移，正数为右移
* @return 位移后的字符串
* @since 4.0.7
*/
public static String move(CharSequence str, int startInclude, int endExclude, int moveLength) {
if (isEmpty(str)) {
return str(str);
}
int len = str.length();
if (Math.abs(moveLength) > len) {
// 循环位移，当越界时循环
moveLength = moveLength % len;
}
final StringBuilder strBuilder = new StringBuilder(len);
if (moveLength > 0) {
int endAfterMove = Math.min(endExclude + moveLength, str.length());
strBuilder.append(str.subSequence(0, startInclude))//
.append(str.subSequence(endExclude, endAfterMove))//
.append(str.subSequence(startInclude, endExclude))//
.append(str.subSequence(endAfterMove, str.length()));
} else if (moveLength < 0) {
int startAfterMove = Math.max(startInclude + moveLength, 0);
strBuilder.append(str.subSequence(0, startAfterMove))//
.append(str.subSequence(startInclude, endExclude))//
.append(str.subSequence(startAfterMove, startInclude))//
.append(str.subSequence(endExclude, str.length()));
} else {
return str(str);
}
return strBuilder.toString();
}
/**
* 检查给定字符串的所有字符是否都一样
*
* @param str 字符出啊
* @return 给定字符串的所有字符是否都一样
* @since 5.7.3
*/
public static boolean isCharEquals(CharSequence str) {
Assert.notEmpty(str, "Str to check must be not empty!");
return count(str, str.charAt(0)) == str.length();
}
/**
* 对字符串归一化处理，如 "Á" 可以使用 "u00C1"或 "u0041u0301"表示，实际测试中两个字符串并不equals
* 因此使用此方法归一为一种表示形式，默认按照W3C通常建议的，在NFC中交换文本。
*
* @param str 归一化的字符串
* @return 归一化后的字符串
* @see Normalizer#normalize(CharSequence, Normalizer.Form)
* @since 5.7.16
*/
public static String normalize(CharSequence str) {
return Normalizer.normalize(str, Normalizer.Form.NFC);
}
/**
* 在给定字符串末尾填充指定字符，以达到给定长度
* 如果字符串本身的长度大于等于length，返回原字符串
*
* @param str 字符串
* @param fixedChar 补充的字符
* @param length 补充到的长度
* @return 补充后的字符串
* @since 5.8.0
*/
public static String fixLength(CharSequence str, char fixedChar, int length) {
final int fixedLength = length - str.length();
if (fixedLength <= 0) {
return str.toString();
}
return str + repeat(fixedChar, fixedLength);
}
/**
* 指定字符串数组中，是否包含空字符串。
* 如果传入参数对象不是为空,则返回false。如果字符串包含字母,不区分大小写,则返回true
*
* @param str 对象
* @return 如果为字符串, 是否有字母
*/
public static boolean hasLetter(CharSequence str) {
if (null == str) {
return false;
}
for (int i = 0; i < str.length(); i++) {
if (CharUtil.isLetter(str.charAt(i))) {
return true;
}
}
return false;
}
/**
* 字符串1和字符串2的公共前缀
*
* @param str1 字符串1
* @param str2 字符串2
* @return 字符串1和字符串2的公共前缀
*/
public static CharSequence commonPrefix(CharSequence str1, CharSequence str2) {
if (isEmpty(str1) || isEmpty(str2)) {
return EMPTY;
}
final int minLength = Math.min(str1.length(), str2.length());
int index = 0;
for (; index < minLength; index++) {
if (str1.charAt(index) != str2.charAt(index)) {
break;
}
}
return str1.subSequence(0, index);
}
/**
* 字符串1和字符串2的公共后缀
*
* @param str1 字符串1
* @param str2 字符串2
* @return 字符串1和字符串2的公共后缀
*/
public static CharSequence commonSuffix(CharSequence str1, CharSequence str2) {
if (isEmpty(str1) || isEmpty(str2)) {
return EMPTY;
}
int str1Index = str1.length() - 1;
int str2Index = str2.length() - 1;
for (; str1Index >= 0 && str2Index >= 0; str1Index--, str2Index--) {
if (str1.charAt(str1Index) != str2.charAt(str2Index)) {
break;
}
}
return str1.subSequence(str1Index + 1, str1.length());
}
}