StringUtils (noark-core 3.4.2.Final API)

java.lang.Object
- xyz.noark.core.util.StringUtils

```
public class StringUtils
extends java.lang.Object
```
字符串工具类.

从以下版本开始:

3.0

作者:

小流氓[176543888@qq.com]

字段概要

字段
限定符和类型	字段和说明
`static java.lang.String`	`ASTERISK` 一个英文星号字符串 `"*"`
`static java.lang.String`	`COLON` 一个英文冒号字符串 `":"`
`static java.lang.String`	`COMMA` 一个英文逗号字符串 `","`
`static java.lang.String`	`CR` 一个回车字符串 `"\r"`
`static java.lang.String`	`EMPTY` 空字符串 `""`.
`static java.lang.String[]`	`EMPTY_STRING_ARRAY` 一个空字符串数组.
`static java.lang.String`	`HYPHEN` 一个英文连字符字符串 `"-"`
`static java.lang.String`	`LBRACE` 一个英文左大括号字符串 "{"
`static java.lang.String`	`LBRACKET` 一个英文左中括号字符串 `"["`
`static java.lang.String`	`LF` 一个换行字符串 `"\n"`
`static java.lang.String`	`LPAREN` 一个英文左括号字符串 `"("`
`static java.lang.String`	`RBRACE` 一个英文右大括号字符串 "}"
`static java.lang.String`	`RBRACKET` 一个英文右中括号字符串 `"]"`
`static java.lang.String`	`RPAREN` 一个英文右括号字符串 `")"`
`static java.lang.String`	`SEMICOLON` 一个英文分号字符串 `";"`
`static java.lang.String`	`SPACE` 一个空格字符串 `" "`

构造器概要

构造器
构造器和说明

StringUtils()

构造器
构造器和说明
`StringUtils()`

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static int`	`asciiSizeInBytes(long v)` 计算一个Long类型的数字的文本长度.
`static java.lang.String`	`build(java.lang.String delimiter, java.lang.String prefix, java.lang.String suffix, java.lang.String... strings)` 拼接字符串.
`static byte[]`	`bytes(java.lang.CharSequence str)` 编码字符串使用系统默认编码
`static byte[]`	`bytes(java.lang.CharSequence str, java.nio.charset.Charset charset)` 编码字符串
`static java.lang.String`	`format(java.lang.String str, java.lang.Object... arguments)` 常规的格式化一个带有占位符的字符串.
`static boolean`	`isBlank(java.lang.String text)` 检测字符串是否为空，null或Java空白字符。
`static boolean`	`isEmpty(java.lang.String text)` 检测字符串是否为 null或"".
`static boolean`	`isNotBlank(java.lang.String text)` 检测字符串是否不为空，null或Java空白字符。
`static boolean`	`isNotEmpty(java.lang.String text)` 检测字符串是否不为 null且不为"".
`static java.lang.String`	`join(java.lang.String... strings)` 拼接字符串.
`static java.lang.String`	`leftPad(java.lang.String str, int size)` 从左边使用空格(' ')补齐指定位位数的字符串.
`static java.lang.String`	`leftPad(java.lang.String str, int size, char padChar)` 从左边使用指定字符补齐指定位位数的字符串.
`static int`	`length(java.lang.String text)` 检测一个字符串长度.
`static java.lang.String`	`lowerWord(java.lang.CharSequence cs, char c)` 将一个字符串由驼峰式命名变成分割符分隔单词 lowerWord("helloWorld", '_') => "hello_world"
`static java.lang.String`	`pathJoin(java.lang.String... paths)` 拼接路径字符串.
`static java.lang.String`	`readString(java.io.InputStream inputStream)` 从输入流中读出所有文本.
`static java.lang.String`	`readString(java.io.InputStream inputStream, java.nio.charset.Charset charset)` 从输入流中读出所有文本.
`static java.lang.String`	`readString(java.io.Reader reader)` 读出所有文本。
`static java.lang.String[]`	`split(java.lang.String str, java.lang.String separatorChars)` Splits the provided text into an array, separators specified.
`static java.lang.String[]`	`split(java.lang.String str, java.lang.String separatorChars, int max)` 切割指定字符串
`static byte[]`	`utf8Bytes(java.lang.CharSequence str)` 编码字符串，编码为UTF-8

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

字段详细资料
- EMPTY
```
public static final java.lang.String EMPTY
```
  空字符串 "".
  
  另请参阅:
  
  常量字段值
- SPACE
```
public static final java.lang.String SPACE
```
  一个空格字符串 " "
  
  另请参阅:
  
  常量字段值
- LF
```
public static final java.lang.String LF
```
  一个换行字符串 "\n"
  
  另请参阅:
  
  常量字段值
- CR
```
public static final java.lang.String CR
```
  一个回车字符串 "\r"
  
  另请参阅:
  
  常量字段值
- COMMA
```
public static final java.lang.String COMMA
```
  一个英文逗号字符串 ","
  
  另请参阅:
  
  常量字段值
- HYPHEN
```
public static final java.lang.String HYPHEN
```
  一个英文连字符字符串 "-"
  
  另请参阅:
  
  常量字段值
- LPAREN
```
public static final java.lang.String LPAREN
```
  一个英文左括号字符串 "("
  
  另请参阅:
  
  常量字段值
- RPAREN
```
public static final java.lang.String RPAREN
```
  一个英文右括号字符串 ")"
  
  另请参阅:
  
  常量字段值
- LBRACE
```
public static final java.lang.String LBRACE
```
  一个英文左大括号字符串 "{"
  
  另请参阅:
  
  常量字段值
- RBRACE
```
public static final java.lang.String RBRACE
```
  一个英文右大括号字符串 "}"
  
  另请参阅:
  
  常量字段值
- LBRACKET
```
public static final java.lang.String LBRACKET
```
  一个英文左中括号字符串 "["
  
  另请参阅:
  
  常量字段值
- RBRACKET
```
public static final java.lang.String RBRACKET
```
  一个英文右中括号字符串 "]"
  
  另请参阅:
  
  常量字段值
- COLON
```
public static final java.lang.String COLON
```
  一个英文冒号字符串 ":"
  
  另请参阅:
  
  常量字段值
- ASTERISK
```
public static final java.lang.String ASTERISK
```
  一个英文星号字符串 "*"
  
  另请参阅:
  
  常量字段值
- SEMICOLON
```
public static final java.lang.String SEMICOLON
```
  一个英文分号字符串 ";"
  
  另请参阅:
  
  常量字段值
- EMPTY_STRING_ARRAY
```
public static final java.lang.String[] EMPTY_STRING_ARRAY
```
  一个空字符串数组.

构造器详细资料
- StringUtils
```
public StringUtils()
```

方法详细资料

isEmpty

public static boolean isEmpty(java.lang.String text)

检测字符串是否为 null或"".

 StringUtils.isEmpty(null)      = true
 StringUtils.isEmpty("")        = true
 StringUtils.isEmpty(" ")       = false
 StringUtils.isEmpty("test")     = false
 StringUtils.isEmpty("  test  ") = false

参数:: text - 被检测字符串
返回:: 如果字符为null或""则返回true,否则返回false.

isNotEmpty

public static boolean isNotEmpty(java.lang.String text)

检测字符串是否不为 null且不为"".

 StringUtils.isNotEmpty(null)      = false
 StringUtils.isNotEmpty("")        = false
 StringUtils.isNotEmpty(" ")       = true
 StringUtils.isNotEmpty("test")    = true
 StringUtils.isNotEmpty("  test ") = true

参数:: text - 被检测字符串
返回:: 如果字符不为 null且不为""则返回true,否则返回false.

isBlank

public static boolean isBlank(java.lang.String text)

检测字符串是否为空，null或Java空白字符。

Java空白字符的定义请参考Character.isWhitespace(char).

 StringUtils.isBlank(null)      = true
 StringUtils.isBlank("")        = true
 StringUtils.isBlank(" ")       = true
 StringUtils.isBlank("bob")     = false
 StringUtils.isBlank("  bob  ") = false

参数:: text - 被检测字符串
返回:: 如果字符串为空，null或Java空白字符则返回true,否则返回false.

isNotBlank

public static boolean isNotBlank(java.lang.String text)

检测字符串是否不为空，null或Java空白字符。

Java空白字符的定义请参考Character.isWhitespace(char).

 StringUtils.isNotBlank(null)      = false
 StringUtils.isNotBlank("")        = false
 StringUtils.isNotBlank(" ")       = false
 StringUtils.isNotBlank("bob")     = true
 StringUtils.isNotBlank("  bob  ") = true

参数:: text - 被检测字符串
返回:: 如果字符串不为空，null或Java空白字符则返回true,否则返回false.

length
```
public static int length(java.lang.String text)
```
检测一个字符串长度.
字符串有可能包含中文等其他文字，中文应该算2个长度.

参数:

text - 被检测字符串

返回:

字符串长度

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

split

public static java.lang.String[] split(java.lang.String str,
                                       java.lang.String separatorChars,
                                       int max)

切割指定字符串

参数:: str - 要切割的字符串; separatorChars - 切割符; max - 最大分几部分
返回:: 切割后的数组

lowerWord

public static java.lang.String lowerWord(java.lang.CharSequence cs,
                                         char c)

将一个字符串由驼峰式命名变成分割符分隔单词

  lowerWord("helloWorld", '_') => "hello_world"

参数:: cs - 字符串; c - 分隔符
返回:: 转换后字符串

asciiSizeInBytes
```
public static int asciiSizeInBytes(long v)
```
计算一个Long类型的数字的文本长度.
包含负数计算

参数:

v - Long类型的数字

返回:

数字的文本长度

join
```
public static java.lang.String join(java.lang.String... strings)
```
拼接字符串.

参数:

strings - 需要拼接的字串

返回:

拼接后的字符串

pathJoin
```
public static java.lang.String pathJoin(java.lang.String... paths)
```
拼接路径字符串.

参数:

paths - 需要拼接的路径字串

返回:

拼接后的路径字符串

build

public static java.lang.String build(java.lang.String delimiter,
                                     java.lang.String prefix,
                                     java.lang.String suffix,
                                     java.lang.String... strings)

拼接字符串.

在比较长或多的情况计算长度比StringJoiner性能好.

     StringJoiner result = new StringJoiner(delimiter, prefix, suffix);
     for (String str : strings) {
         result.add(str);
    }
     return result.toString();

     Stream.of(strings).collect(Collectors.joining(delimiter, prefix, suffix))

参数:: delimiter - 分隔符; prefix - 前缀; suffix - 后缀; strings - 需要拼接的字串
返回:: 拼接后的字符串

utf8Bytes
```
public static byte[] utf8Bytes(java.lang.CharSequence str)
```
编码字符串，编码为UTF-8

参数:

str - 字符串

返回:

编码后的字节数组

bytes
```
public static byte[] bytes(java.lang.CharSequence str)
```
编码字符串
使用系统默认编码

参数:

str - 字符串

返回:

编码后的字节码

bytes
```
public static byte[] bytes(java.lang.CharSequence str,
                           java.nio.charset.Charset charset)
```
编码字符串

参数:

str - 字符串

charset - 字符集，如果此字段为空，则编码的结果取决于平台

返回:

编码后的字节数组

format
```
public static java.lang.String format(java.lang.String str,
                                      java.lang.Object... arguments)
```
常规的格式化一个带有占位符的字符串.
区别于JDK的MessageFormat.format(String, Object...)，这个方法只是简单的按位填充

参数:

str - 带有占位符的字符串

arguments - 参数列表

返回:

格式化以后的字符串

readString
```
public static java.lang.String readString(java.io.InputStream inputStream)
                                   throws java.io.IOException
```
从输入流中读出所有文本.

参数:

inputStream - 输入流

返回:

返回流中的文本

抛出:

java.io.IOException - If an I/O error occurs

readString

public static java.lang.String readString(java.io.InputStream inputStream,
                                          java.nio.charset.Charset charset)
                                   throws java.io.IOException

从输入流中读出所有文本.

参数:: inputStream - 输入流; charset - 文本的编码方式
返回:: 返回流中的文本
抛出:: java.io.IOException - If an I/O error occurs

readString
```
public static java.lang.String readString(java.io.Reader reader)
                                   throws java.io.IOException
```
读出所有文本。
这里没有选择BufferedReader就是不想一行一行的读，浪费字符串拼接性能
正常用于读HTTP的响应，配置文件内容，小文件等情况

参数:

reader - 抽象的文本流

返回:

返回流中所有文本

抛出:

java.io.IOException - If an I/O error occurs

leftPad

public static java.lang.String leftPad(java.lang.String str,
                                       int size)

从左边使用空格(' ')补齐指定位位数的字符串.

 StringUtils.leftPad(null, *)   = null
 StringUtils.leftPad("", 3)     = "   "
 StringUtils.leftPad("bat", 3)  = "bat"
 StringUtils.leftPad("bat", 5)  = "  bat"
 StringUtils.leftPad("bat", 1)  = "bat"
 StringUtils.leftPad("bat", -1) = "bat"

参数:: str - 字符串; size - 补齐后的位数
返回:: 返回补齐后的字符串null

leftPad

public static java.lang.String leftPad(java.lang.String str,
                                       int size,
                                       char padChar)

从左边使用指定字符补齐指定位位数的字符串.

 StringUtils.leftPad(null, *, *)     = null
 StringUtils.leftPad("", 3, 'b')     = "bbb"
 StringUtils.leftPad("bat", 3, 'b')  = "bat"
 StringUtils.leftPad("bat", 5, ' ')  = "  bat"
 StringUtils.leftPad("bat", 1, 'b')  = "bat"
 StringUtils.leftPad("bat", -1, 'b') = "bat"

参数:: str - 字符串; size - 补齐后的位数; padChar - 补齐字符
返回:: 返回补齐后的字符串null

类 StringUtils

字段概要

构造器概要

方法概要

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

字段详细资料

EMPTY

SPACE

LF

CR

COMMA

HYPHEN

LPAREN

RPAREN

LBRACE

RBRACE

LBRACKET

RBRACKET

COLON

ASTERISK

SEMICOLON

EMPTY_STRING_ARRAY

构造器详细资料

StringUtils

方法详细资料

isEmpty

isNotEmpty

isBlank

isNotBlank

length

split

split

lowerWord

asciiSizeInBytes

join

pathJoin

build

utf8Bytes

bytes

bytes

format

readString

readString

readString

leftPad

leftPad