StringUtils (mybatis-plus-core 3.2.0 API)

java.lang.Object
- com.baomidou.mybatisplus.core.toolkit.StringUtils

```
public class StringUtils
extends java.lang.Object
```
String 工具类

从以下版本开始:

2016-08-18

作者:

D.Yang

字段概要

字段
限定符和类型	字段和说明
`static java.lang.String`	`EMPTY` 空字符
`static java.lang.String`	`IS` 字符串 is
`static java.util.regex.Pattern`	`MP_SQL_PLACE_HOLDER` MP 内定义的 SQL 占位符表达式，匹配诸如 {0},{1},{2} ...
`static char`	`UNDERLINE` 下划线字符

方法概要

所有方法静态方法具体方法已过时的方法
限定符和类型	方法和说明
`static java.lang.String`	`blob2String(java.sql.Blob blob)` Blob 转为 String 格式
`static java.lang.String`	`camelToHyphen(java.lang.String input)` 驼峰转连字符 StringUtils.camelToHyphen( "managerAdminUserService" ) = manager-admin-user-service
`static java.lang.String`	`camelToUnderline(java.lang.String param)` 字符串驼峰转下划线格式
`static java.lang.String`	`capitalize(java.lang.String str)` 字符串第一个字母大写
`static boolean`	`checkValNotNull(java.lang.Object object)` 判断对象是否为空
`static boolean`	`checkValNull(java.lang.Object object)` 判断对象是否为空
`static java.lang.String`	`concatCapitalize(java.lang.String concatStr, java.lang.String str)` 拼接字符串第二个字符串第一个字母大写
`static boolean`	`containsLowerCase(java.lang.String s)`
`static boolean`	`containsUpperCase(java.lang.String word)` 包含大写字母
`static boolean`	`endsWith(java.lang.String str, java.lang.String suffix)` Check if a String ends with a specified suffix.
`static boolean`	`endsWithIgnoreCase(java.lang.String str, java.lang.String suffix)` Case insensitive check if a String ends with a specified suffix.
`static java.lang.String`	`firstCharToLower(java.lang.String rawString)` 第一个首字母小写，之后字符大小写的不变 StringUtils.firstCharToLower( "UserService" ) = userService StringUtils.firstCharToLower( "UserServiceImpl" ) = userServiceImpl
`static java.lang.String`	`firstToLowerCase(java.lang.String param)` 首字母转换小写
`static java.lang.String`	`format(java.lang.String target, java.lang.Object... params)` 安全的进行字符串 format
`static java.lang.String`	`getTargetColumn(java.lang.String column)` 获取真正的字段名
`static boolean`	`isBoolean(java.lang.Class<?> propertyCls)` 是否为Boolean类型(包含普通类型)
`static boolean`	`isCamel(java.lang.String str)` 判断字符串是不是驼峰命名包含 '_' 不算首字母大写的不算
`static boolean`	`isCapitalMode(java.lang.String word)` 是否为大写命名
`static boolean`	`isCharSequence(java.lang.Class<?> clazz)` 是否为CharSequence类型
`static boolean`	`isEmpty(java.lang.CharSequence cs)` 判断字符串是否为空
`static boolean`	`isMixedMode(java.lang.String word)` 是否为驼峰下划线混合命名
`static boolean`	`isNotColumnName(java.lang.String str)` 判断字符串是否符合数据库字段的命名
`static boolean`	`isNotEmpty(java.lang.CharSequence cs)` 判断字符串是否不为空
`static boolean`	`isUpperCase(java.lang.String str)` 判断字符串是否为纯大写字母
`static boolean`	`matches(java.lang.String regex, java.lang.String input)` 正则表达式匹配
`static java.lang.String`	`prefixToLower(java.lang.String rawString, int index)` 前n个首字母小写,之后字符大小写的不变
`static java.lang.String`	`quotaMark(java.lang.Object obj)` 使用单引号包含字符串
`static java.lang.String`	`quotaMarkList(java.util.Collection<?> coll)` 使用单引号包含字符串
`static java.lang.String`	`removeIsPrefixIfBoolean(java.lang.String propertyName, java.lang.Class<?> propertyType)` 去除boolean类型is开头的字符串
`static java.lang.String`	`removePrefixAfterPrefixToLower(java.lang.String rawString, int index)` 删除字符前缀之后,首字母小写,之后字符大小写的不变 StringUtils.removePrefixAfterPrefixToLower( "isUser", 2 ) = user StringUtils.removePrefixAfterPrefixToLower( "isUserInfo", 2 ) = userInfo
`static java.lang.String`	`removeWordWithComma(java.lang.String s, java.lang.String p)` 已过时。 3.1.1
`static java.lang.StringBuilder`	`replace(java.lang.CharSequence src, java.util.regex.Pattern ptn, BiIntFunction<java.util.regex.Matcher,java.lang.CharSequence> replacer)` 根据指定的表达式替换字符串中指定格式的部分 BiIntFunction 中的第二个参数将传递参数在字符串中的索引
`static java.lang.String`	`resolveFieldName(java.lang.String getMethodName)` 解析 getMethodName -> propertyName
`static java.lang.String[]`	`split(java.lang.String str, java.lang.String separatorChars)` Splits the provided text into an array, separators specified.
`static java.util.List<java.lang.String>`	`splitWorker(java.lang.String str, java.lang.String separatorChars, int max, boolean preserveAllTokens)` Performs the logic for the `split` and `splitPreserveAllTokens` methods that return a maximum array length.
`static java.lang.String`	`sqlArgsFill(java.lang.String content, java.lang.Object... args)` 替换 SQL 语句中的占位符，例如输入 SELECT * FROM test WHERE id = {0} AND name = {1} 会被替换为 SELECT * FROM test WHERE id = 1 AND name = 'MP' 当数组中参数不足时，该方法会抛出错误：数组下标越界`ArrayIndexOutOfBoundsException`
`static java.lang.String`	`sqlParam(java.lang.Object obj)` 获取SQL PARAMS字符串
`static java.lang.String`	`underlineToCamel(java.lang.String param)` 字符串下划线转驼峰格式

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - EMPTY
```
public static final java.lang.String EMPTY
```
    空字符
    
    另请参阅:
    
    常量字段值
  - IS
```
public static final java.lang.String IS
```
    字符串 is
    
    另请参阅:
    
    常量字段值
  - UNDERLINE
```
public static final char UNDERLINE
```
    下划线字符
    
    另请参阅:
    
    常量字段值
  - MP_SQL_PLACE_HOLDER
```
public static final java.util.regex.Pattern MP_SQL_PLACE_HOLDER
```
    MP 内定义的 SQL 占位符表达式，匹配诸如 {0},{1},{2} ... 的形式
- 方法详细资料
  - format
```
public static java.lang.String format(java.lang.String target,
                                      java.lang.Object... params)
```
    安全的进行字符串 format
    
    参数:
    
    target - 目标字符串
    
    params - format 参数
    
    返回:
    
    format 后的
  - blob2String
```
public static java.lang.String blob2String(java.sql.Blob blob)
```
    Blob 转为 String 格式
    
    参数:
    
    blob - Blob 对象
    
    返回:
    
    转换后的
  - isEmpty
```
public static boolean isEmpty(java.lang.CharSequence cs)
```
    判断字符串是否为空
    
    参数:
    
    cs - 需要判断字符串
    
    返回:
    
    判断结果
  - isCamel
```
public static boolean isCamel(java.lang.String str)
```
    判断字符串是不是驼峰命名
  - 包含 '_' 不算
  - 首字母大写的不算

参数:: str - 字符串
返回:: 结果

isNotEmpty
```
public static boolean isNotEmpty(java.lang.CharSequence cs)
```
判断字符串是否不为空

参数:

cs - 需要判断字符串

返回:

判断结果

isNotColumnName
```
public static boolean isNotColumnName(java.lang.String str)
```
判断字符串是否符合数据库字段的命名

参数:

str - 字符串

返回:

判断结果

getTargetColumn
```
public static java.lang.String getTargetColumn(java.lang.String column)
```
获取真正的字段名

参数:

column - 字段名

返回:

字段名

camelToUnderline
```
public static java.lang.String camelToUnderline(java.lang.String param)
```
字符串驼峰转下划线格式

参数:

param - 需要转换的字符串

返回:

转换好的字符串

resolveFieldName
```
public static java.lang.String resolveFieldName(java.lang.String getMethodName)
```
解析 getMethodName -> propertyName

参数:

getMethodName - 需要解析的

返回:

返回解析后的字段名称

underlineToCamel
```
public static java.lang.String underlineToCamel(java.lang.String param)
```
字符串下划线转驼峰格式

参数:

param - 需要转换的字符串

返回:

转换好的字符串

firstToLowerCase
```
public static java.lang.String firstToLowerCase(java.lang.String param)
```
首字母转换小写

参数:

param - 需要转换的字符串

返回:

转换好的字符串

isUpperCase
```
public static boolean isUpperCase(java.lang.String str)
```
判断字符串是否为纯大写字母

参数:

str - 要匹配的字符串

返回:

matches
```
public static boolean matches(java.lang.String regex,
                              java.lang.String input)
```
正则表达式匹配

参数:

regex - 正则表达式字符串

input - 要匹配的字符串

返回:

如果 input 符合 regex 正则表达式格式, 返回true, 否则返回 false;

sqlArgsFill
```
public static java.lang.String sqlArgsFill(java.lang.String content,
                                           java.lang.Object... args)
```
替换 SQL 语句中的占位符，例如输入 SELECT * FROM test WHERE id = {0} AND name = {1} 会被替换为 SELECT * FROM test WHERE id = 1 AND name = 'MP'
当数组中参数不足时，该方法会抛出错误：数组下标越界ArrayIndexOutOfBoundsException

参数:

content - 填充内容

args - 填充参数

replace

public static java.lang.StringBuilder replace(java.lang.CharSequence src,
                                              java.util.regex.Pattern ptn,
                                              BiIntFunction<java.util.regex.Matcher,java.lang.CharSequence> replacer)

根据指定的表达式替换字符串中指定格式的部分

BiIntFunction 中的第二个参数将传递参数在字符串中的索引

参数:: src - 源字符串; ptn - 需要替换部分的正则表达式; replacer - 替换处理器
返回:: 返回字符串构建起

sqlParam

public static java.lang.String sqlParam(java.lang.Object obj)

获取SQL PARAMS字符串

参数:: obj -
返回:

quotaMark
```
public static java.lang.String quotaMark(java.lang.Object obj)
```
使用单引号包含字符串

参数:

obj - 原字符串

返回:

单引号包含的原字符串

quotaMarkList
```
public static java.lang.String quotaMarkList(java.util.Collection<?> coll)
```
使用单引号包含字符串

参数:

coll - 集合

返回:

单引号包含的原字符串的集合形式

concatCapitalize

public static java.lang.String concatCapitalize(java.lang.String concatStr,
                                                java.lang.String str)

拼接字符串第二个字符串第一个字母大写

capitalize
```
public static java.lang.String capitalize(java.lang.String str)
```
字符串第一个字母大写

参数:

str - 被处理的字符串

返回:

首字母大写后的字符串

checkValNotNull
```
public static boolean checkValNotNull(java.lang.Object object)
```
判断对象是否为空

参数:

object - ignore

返回:

ignore

checkValNull
```
public static boolean checkValNull(java.lang.Object object)
```
判断对象是否为空

参数:

object - ignore

返回:

ignore

containsUpperCase
```
public static boolean containsUpperCase(java.lang.String word)
```
包含大写字母

参数:

word - 待判断字符串

返回:

ignore

isCapitalMode
```
public static boolean isCapitalMode(java.lang.String word)
```
是否为大写命名

参数:

word - 待判断字符串

返回:

ignore

isMixedMode
```
public static boolean isMixedMode(java.lang.String word)
```
是否为驼峰下划线混合命名

参数:

word - 待判断字符串

返回:

ignore

endsWith
```
public static boolean endsWith(java.lang.String str,
                               java.lang.String suffix)
```
Check if a String ends with a specified suffix.
nulls are handled without exceptions. Two null references are considered to be equal. The comparison is case sensitive.
```
 StringUtils.endsWith(null, null)      = true
 StringUtils.endsWith(null, "abcdef")  = false
 StringUtils.endsWith("def", null)     = false
 StringUtils.endsWith("def", "abcdef") = true
 StringUtils.endsWith("def", "ABCDEF") = false
 
```
参数:

str - the String to check, may be null

suffix - the suffix to find, may be null

返回:

true if the String ends with the suffix, case sensitive, or both null

从以下版本开始:

2.4

另请参阅:

String.endsWith(String)

endsWithIgnoreCase
```
public static boolean endsWithIgnoreCase(java.lang.String str,
                                         java.lang.String suffix)
```
Case insensitive check if a String ends with a specified suffix.
nulls are handled without exceptions. Two null references are considered to be equal. The comparison is case insensitive.
```
 StringUtils.endsWithIgnoreCase(null, null)      = true
 StringUtils.endsWithIgnoreCase(null, "abcdef")  = false
 StringUtils.endsWithIgnoreCase("def", null)     = false
 StringUtils.endsWithIgnoreCase("def", "abcdef") = true
 StringUtils.endsWithIgnoreCase("def", "ABCDEF") = false
 
```
参数:

str - the String to check, may be null

suffix - the suffix to find, may be null

返回:

true if the String ends with the suffix, case insensitive, or both null

从以下版本开始:

2.4

另请参阅:

String.endsWith(String)

split
```
public static java.lang.String[] split(java.lang.String str,
                                       java.lang.String separatorChars)
```
Splits the provided text into an array, separators specified. This is an alternative to using StringTokenizer.
The separator is not included in the returned String array. Adjacent separators are treated as one separator. For more control over the split use the StrTokenizer class.

A null input String returns null. A null separatorChars splits on whitespace.
```
 StringUtils.split(null, *)         = null
 StringUtils.split("", *)           = []
 StringUtils.split("abc def", null) = ["abc", "def"]
 StringUtils.split("abc def", " ")  = ["abc", "def"]
 StringUtils.split("abc  def", " ") = ["abc", "def"]
 StringUtils.split("ab:cd:ef", ":") = ["ab", "cd", "ef"]
 
```
参数:

str - the String to parse, may be null

separatorChars - the characters used as the delimiters, null splits on whitespace

返回:

an array of parsed Strings, null if null String input

splitWorker
```
public static java.util.List<java.lang.String> splitWorker(java.lang.String str,
                                                           java.lang.String separatorChars,
                                                           int max,
                                                           boolean preserveAllTokens)
```
Performs the logic for the split and splitPreserveAllTokens methods that return a maximum array length.

参数:

str - the String to parse, may be null

separatorChars - the separate character

max - the maximum number of elements to include in the array. A zero or negative value implies no limit.

preserveAllTokens - if true, adjacent separators are treated as empty token separators; if false, adjacent separators are treated as one separator.

返回:

an array of parsed Strings, null if null String input

isCharSequence
```
public static boolean isCharSequence(java.lang.Class<?> clazz)
```
是否为CharSequence类型

参数:

clazz - class

返回:

true 为是 CharSequence 类型

removeIsPrefixIfBoolean

public static java.lang.String removeIsPrefixIfBoolean(java.lang.String propertyName,
                                                       java.lang.Class<?> propertyType)

去除boolean类型is开头的字符串

参数:: propertyName - 字段名; propertyType - 字段类型

isBoolean
```
public static boolean isBoolean(java.lang.Class<?> propertyCls)
```
是否为Boolean类型(包含普通类型)

参数:

propertyCls - ignore

返回:

ignore

firstCharToLower
```
public static java.lang.String firstCharToLower(java.lang.String rawString)
```
第一个首字母小写，之后字符大小写的不变
StringUtils.firstCharToLower( "UserService" ) = userService

StringUtils.firstCharToLower( "UserServiceImpl" ) = userServiceImpl

参数:

rawString - 需要处理的字符串

返回:

ignore

prefixToLower
```
public static java.lang.String prefixToLower(java.lang.String rawString,
                                             int index)
```
前n个首字母小写,之后字符大小写的不变

参数:

rawString - 需要处理的字符串

index - 多少个字符(从左至右)

返回:

ignore

removePrefixAfterPrefixToLower
```
public static java.lang.String removePrefixAfterPrefixToLower(java.lang.String rawString,
                                                              int index)
```
删除字符前缀之后,首字母小写,之后字符大小写的不变
StringUtils.removePrefixAfterPrefixToLower( "isUser", 2 ) = user

StringUtils.removePrefixAfterPrefixToLower( "isUserInfo", 2 ) = userInfo

参数:

rawString - 需要处理的字符串

index - 删除多少个字符(从左至右)

返回:

ignore

camelToHyphen
```
public static java.lang.String camelToHyphen(java.lang.String input)
```
驼峰转连字符
StringUtils.camelToHyphen( "managerAdminUserService" ) = manager-admin-user-service

参数:

input - ignore

返回:

以'-'分隔

另请参阅:

document

containsLowerCase

public static boolean containsLowerCase(java.lang.String s)

removeWordWithComma

@Deprecated
public static java.lang.String removeWordWithComma(java.lang.String s,
                                                               java.lang.String p)

已过时。 3.1.1

从字符串中移除一个单词及随后的一个逗号

参数:: s - 原字符串; p - 移除的单词
返回:: ignore

类 StringUtils

字段概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

EMPTY

IS

UNDERLINE

MP_SQL_PLACE_HOLDER

方法详细资料

format

blob2String

isEmpty

isCamel

isNotEmpty

isNotColumnName

getTargetColumn

camelToUnderline

resolveFieldName

underlineToCamel

firstToLowerCase

isUpperCase

matches

sqlArgsFill

replace

sqlParam

quotaMark

quotaMarkList

concatCapitalize

capitalize

checkValNotNull

checkValNull

containsUpperCase

isCapitalMode

isMixedMode

endsWith

endsWithIgnoreCase

split

splitWorker

isCharSequence

removeIsPrefixIfBoolean

isBoolean

firstCharToLower

prefixToLower

removePrefixAfterPrefixToLower

camelToHyphen

containsLowerCase

removeWordWithComma