CharsetUtil (hutool 5.8.33 API)

java.lang.Object
- cn.hutool.core.util.CharsetUtil

```
public class CharsetUtil
extends Object
```
字符集工具类

Author:

xiaoleilu

Field Summary

Fields
Modifier and Type	Field and Description
`static Charset`	`CHARSET_GBK` GBK
`static Charset`	`CHARSET_ISO_8859_1` ISO-8859-1
`static Charset`	`CHARSET_UTF_8` UTF-8
`static String`	`GBK` GBK
`static String`	`ISO_8859_1` ISO-8859-1
`static String`	`UTF_8` UTF-8

Constructor Summary

Constructors
Constructor and Description

CharsetUtil()

Constructors
Constructor and Description
`CharsetUtil()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Charset`	`charset(String charsetName)` 转换为Charset对象
`static File`	`convert(File file, Charset srcCharset, Charset destCharset)` 转换文件编码此方法用于转换文件编码，读取的文件实际编码必须与指定的srcCharset编码一致，否则导致乱码
`static String`	`convert(String source, Charset srcCharset, Charset destCharset)` 转换字符串的字符集编码当以错误的编码读取为字符串时，打印字符串将出现乱码。
`static String`	`convert(String source, String srcCharset, String destCharset)` 转换字符串的字符集编码
`static Charset`	`defaultCharset()` 系统默认字符集编码
`static Charset`	`defaultCharset(InputStream in, Charset... charsets)` 探测编码注意：此方法会读取流的一部分，然后关闭流，如重复使用流，请使用使用支持reset方法的流
`static Charset`	`defaultCharset(int bufferSize, InputStream in, Charset... charsets)` 探测编码注意：此方法会读取流的一部分，然后关闭流，如重复使用流，请使用使用支持reset方法的流
`static String`	`defaultCharsetName()` 系统默认字符集编码
`static Charset`	`parse(String charsetName)` 解析字符串编码为Charset对象，解析失败返回系统默认编码
`static Charset`	`parse(String charsetName, Charset defaultCharset)` 解析字符串编码为Charset对象，解析失败返回默认编码
`static Charset`	`systemCharset()` 系统字符集编码，如果是Windows，则默认为GBK编码，否则取 `defaultCharsetName()`
`static String`	`systemCharsetName()` 系统字符集编码，如果是Windows，则默认为GBK编码，否则取 `defaultCharsetName()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ISO_8859_1
```
public static final String ISO_8859_1
```
    ISO-8859-1
    
    See Also:
    
    Constant Field Values
  - UTF_8
```
public static final String UTF_8
```
    UTF-8
    
    See Also:
    
    Constant Field Values
  - GBK
```
public static final String GBK
```
    GBK
    
    See Also:
    
    Constant Field Values
  - CHARSET_ISO_8859_1
```
public static final Charset CHARSET_ISO_8859_1
```
    ISO-8859-1
  - CHARSET_UTF_8
```
public static final Charset CHARSET_UTF_8
```
    UTF-8
  - CHARSET_GBK
```
public static final Charset CHARSET_GBK
```
    GBK
- Constructor Detail
  - CharsetUtil
```
public CharsetUtil()
```
- Method Detail
  - charset
```
public static Charset charset(String charsetName)
                       throws UnsupportedCharsetException
```
    转换为Charset对象
    
    Parameters:
    
    charsetName - 字符集，为空则返回默认字符集
    
    Returns:
    
    Charset
    
    Throws:
    
    UnsupportedCharsetException - 编码不支持
  - parse
```
public static Charset parse(String charsetName)
```
    解析字符串编码为Charset对象，解析失败返回系统默认编码
    
    Parameters:
    
    charsetName - 字符集，为空则返回默认字符集
    
    Returns:
    
    Charset
    
    Since:
    
    5.2.6
  - parse
```
public static Charset parse(String charsetName,
                            Charset defaultCharset)
```
    解析字符串编码为Charset对象，解析失败返回默认编码
    
    Parameters:
    
    charsetName - 字符集，为空则返回默认字符集
    
    defaultCharset - 解析失败使用的默认编码
    
    Returns:
    
    Charset
    
    Since:
    
    5.2.6
  - convert
```
public static String convert(String source,
                             String srcCharset,
                             String destCharset)
```
    转换字符串的字符集编码
    
    Parameters:
    
    source - 字符串
    
    srcCharset - 源字符集，默认ISO-8859-1
    
    destCharset - 目标字符集，默认UTF-8
    
    Returns:
    
    转换后的字符集
  - convert
```
public static String convert(String source,
                             Charset srcCharset,
                             Charset destCharset)
```
    转换字符串的字符集编码
    当以错误的编码读取为字符串时，打印字符串将出现乱码。
    此方法用于纠正因读取使用编码错误导致的乱码问题。
    例如，在Servlet请求中客户端用GBK编码了请求参数，我们使用UTF-8读取到的是乱码，此时，使用此方法即可还原原编码的内容
```
 客户端 -》 GBK编码 -》 Servlet容器 -》 UTF-8解码 -》 乱码
 乱码 -》 UTF-8编码 -》 GBK解码 -》 正确内容
 
```
    Parameters:
    
    source - 字符串
    
    srcCharset - 源字符集，默认ISO-8859-1
    
    destCharset - 目标字符集，默认UTF-8
    
    Returns:
    
    转换后的字符集
  - convert
```
public static File convert(File file,
                           Charset srcCharset,
                           Charset destCharset)
```
    转换文件编码
    此方法用于转换文件编码，读取的文件实际编码必须与指定的srcCharset编码一致，否则导致乱码
    
    Parameters:
    
    file - 文件
    
    srcCharset - 原文件的编码，必须与文件内容的编码保持一致
    
    destCharset - 转码后的编码
    
    Returns:
    
    被转换编码的文件
    
    Since:
    
    3.1.0
  - systemCharsetName
```
public static String systemCharsetName()
```
    系统字符集编码，如果是Windows，则默认为GBK编码，否则取 defaultCharsetName()
    
    Returns:
    
    系统字符集编码
    
    Since:
    
    3.1.2
    
    See Also:
    
    defaultCharsetName()
  - systemCharset
```
public static Charset systemCharset()
```
    系统字符集编码，如果是Windows，则默认为GBK编码，否则取 defaultCharsetName()
    
    Returns:
    
    系统字符集编码
    
    Since:
    
    3.1.2
    
    See Also:
    
    defaultCharsetName()
  - defaultCharsetName
```
public static String defaultCharsetName()
```
    系统默认字符集编码
    
    Returns:
    
    系统字符集编码
  - defaultCharset
```
public static Charset defaultCharset()
```
    系统默认字符集编码
    
    Returns:
    
    系统字符集编码
  - defaultCharset
```
public static Charset defaultCharset(InputStream in,
                                     Charset... charsets)
```
    探测编码
    注意：此方法会读取流的一部分，然后关闭流，如重复使用流，请使用使用支持reset方法的流
    
    Parameters:
    
    in - 流，使用后关闭此流
    
    charsets - 需要测试用的编码，null或空使用默认的编码数组
    
    Returns:
    
    编码
    
    Since:
    
    5.7.10
    
    See Also:
    
    CharsetDetector.detect(InputStream, Charset...)
  - defaultCharset
```
public static Charset defaultCharset(int bufferSize,
                                     InputStream in,
                                     Charset... charsets)
```
    探测编码
    注意：此方法会读取流的一部分，然后关闭流，如重复使用流，请使用使用支持reset方法的流
    
    Parameters:
    
    bufferSize - 自定义缓存大小，即每次检查的长度
    
    in - 流，使用后关闭此流
    
    charsets - 需要测试用的编码，null或空使用默认的编码数组
    
    Returns:
    
    编码
    
    Since:
    
    5.7.10
    
    See Also:
    
    CharsetDetector.detect(int, InputStream, Charset...)

Class CharsetUtil

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ISO_8859_1

UTF_8

GBK

CHARSET_ISO_8859_1

CHARSET_UTF_8

CHARSET_GBK

Constructor Detail

CharsetUtil

Method Detail

charset

parse

parse

convert

convert

convert

systemCharsetName

systemCharset

defaultCharsetName

defaultCharset

defaultCharset

defaultCharset