SymmetricCrypto (hutool-crypto 5.2.0 API)

java.lang.Object
- cn.hutool.crypto.symmetric.SymmetricCrypto

所有已实现的接口:

Serializable

直接已知子类:

AES, DES, DESede, SM4
```
public class SymmetricCrypto
extends Object
implements Serializable
```
对称加密算法
在对称加密算法中，数据发信方将明文（原始数据）和加密密钥一起经过特殊加密算法处理后，使其变成复杂的加密密文发送出去。
收信方收到密文后，若想解读原文，则需要使用加密用过的密钥及相同算法的逆算法对密文进行解密，才能使其恢复成可读明文。
在对称加密算法中，使用的密钥只有一个，发收信双方都使用这个密钥对数据进行加密和解密，这就要求解密方事先必须知道加密密钥。

作者:

Looly

另请参阅:

序列化表格

构造器概要

构造器
构造器和说明
`SymmetricCrypto(String algorithm)` 构造，使用随机密钥
`SymmetricCrypto(String algorithm, byte[] key)` 构造
`SymmetricCrypto(String algorithm, SecretKey key)` 构造
`SymmetricCrypto(String algorithm, SecretKey key, AlgorithmParameterSpec paramsSpec)` 构造
`SymmetricCrypto(SymmetricAlgorithm algorithm)` 构造，使用随机密钥
`SymmetricCrypto(SymmetricAlgorithm algorithm, byte[] key)` 构造
`SymmetricCrypto(SymmetricAlgorithm algorithm, SecretKey key)` 构造

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`byte[]`	`decrypt(byte[] bytes)` 解密
`byte[]`	`decrypt(InputStream data)` 解密，不会关闭流
`byte[]`	`decrypt(String data)` 解密Hex（16进制）或Base64表示的字符串
`String`	`decryptStr(byte[] bytes)` 解密为字符串，默认UTF-8编码
`String`	`decryptStr(byte[] bytes, Charset charset)` 解密为字符串
`String`	`decryptStr(InputStream data)` 解密
`String`	`decryptStr(InputStream data, Charset charset)` 解密，不会关闭流
`String`	`decryptStr(String data)` 解密Hex表示的字符串，默认UTF-8编码
`String`	`decryptStr(String data, Charset charset)` 解密Hex（16进制）或Base64表示的字符串
`byte[]`	`encrypt(byte[] data)` 加密
`byte[]`	`encrypt(InputStream data)` 加密
`byte[]`	`encrypt(String data)` 加密，使用UTF-8编码
`byte[]`	`encrypt(String data, Charset charset)` 加密
`byte[]`	`encrypt(String data, String charset)` 加密
`String`	`encryptBase64(byte[] data)` 加密
`String`	`encryptBase64(InputStream data)` 加密
`String`	`encryptBase64(String data)` 加密，使用UTF-8编码
`String`	`encryptBase64(String data, Charset charset)` 加密
`String`	`encryptBase64(String data, String charset)` 加密
`String`	`encryptHex(byte[] data)` 加密
`String`	`encryptHex(InputStream data)` 加密
`String`	`encryptHex(String data)` 加密，使用UTF-8编码
`String`	`encryptHex(String data, Charset charset)` 加密
`String`	`encryptHex(String data, String charset)` 加密
`Cipher`	`getCipher()` 获得加密或解密器
`SecretKey`	`getSecretKey()` 获得对称密钥
`SymmetricCrypto`	`init(String algorithm, SecretKey key)` 初始化
`SymmetricCrypto`	`setIv(byte[] iv)` 设置偏移向量
`SymmetricCrypto`	`setIv(IvParameterSpec iv)` 设置偏移向量
`SymmetricCrypto`	`setParams(AlgorithmParameterSpec params)` 设置 `AlgorithmParameterSpec`，通常用于加盐或偏移向量

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

- 构造器详细资料
  - SymmetricCrypto
```
public SymmetricCrypto(SymmetricAlgorithm algorithm)
```
    构造，使用随机密钥
    
    参数:
    
    algorithm - SymmetricAlgorithm
  - SymmetricCrypto
```
public SymmetricCrypto(String algorithm)
```
    构造，使用随机密钥
    
    参数:
    
    algorithm - 算法，可以是"algorithm/mode/padding"或者"algorithm"
  - SymmetricCrypto
```
public SymmetricCrypto(SymmetricAlgorithm algorithm,
                       byte[] key)
```
    构造
    
    参数:
    
    algorithm - 算法 SymmetricAlgorithm
    
    key - 自定义KEY
  - SymmetricCrypto
```
public SymmetricCrypto(SymmetricAlgorithm algorithm,
                       SecretKey key)
```
    构造
    
    参数:
    
    algorithm - 算法 SymmetricAlgorithm
    
    key - 自定义KEY
    
    从以下版本开始:
    
    3.1.2
  - SymmetricCrypto
```
public SymmetricCrypto(String algorithm,
                       byte[] key)
```
    构造
    
    参数:
    
    algorithm - 算法
    
    key - 密钥
  - SymmetricCrypto
```
public SymmetricCrypto(String algorithm,
                       SecretKey key)
```
    构造
    
    参数:
    
    algorithm - 算法
    
    key - 密钥
    
    从以下版本开始:
    
    3.1.2
  - SymmetricCrypto
```
public SymmetricCrypto(String algorithm,
                       SecretKey key,
                       AlgorithmParameterSpec paramsSpec)
```
    构造
    
    参数:
    
    algorithm - 算法
    
    key - 密钥
    
    paramsSpec - 算法参数，例如加盐等
    
    从以下版本开始:
    
    3.3.0
- 方法详细资料
  - init
```
public SymmetricCrypto init(String algorithm,
                            SecretKey key)
```
    初始化
    
    参数:
    
    algorithm - 算法
    
    key - 密钥，如果为null自动生成一个key
    
    返回:
    
    SymmetricCrypto的子对象，即子对象自身
  - setParams
```
public SymmetricCrypto setParams(AlgorithmParameterSpec params)
```
    设置 AlgorithmParameterSpec，通常用于加盐或偏移向量
    
    参数:
    
    params - AlgorithmParameterSpec
    
    返回:
    
    自身
  - setIv
```
public SymmetricCrypto setIv(IvParameterSpec iv)
```
    设置偏移向量
    
    参数:
    
    iv - IvParameterSpec偏移向量
    
    返回:
    
    自身
  - setIv
```
public SymmetricCrypto setIv(byte[] iv)
```
    设置偏移向量
    
    参数:
    
    iv - 偏移向量，加盐
    
    返回:
    
    自身
  - encrypt
```
public byte[] encrypt(byte[] data)
```
    加密
    
    参数:
    
    data - 被加密的bytes
    
    返回:
    
    加密后的bytes
  - encryptHex
```
public String encryptHex(byte[] data)
```
    加密
    
    参数:
    
    data - 数据
    
    返回:
    
    加密后的Hex
  - encryptBase64
```
public String encryptBase64(byte[] data)
```
    加密
    
    参数:
    
    data - 数据
    
    返回:
    
    加密后的Base64
    
    从以下版本开始:
    
    4.0.1
  - encrypt
```
public byte[] encrypt(String data,
                      String charset)
```
    加密
    
    参数:
    
    data - 被加密的字符串
    
    charset - 编码
    
    返回:
    
    加密后的bytes
  - encrypt
```
public byte[] encrypt(String data,
                      Charset charset)
```
    加密
    
    参数:
    
    data - 被加密的字符串
    
    charset - 编码
    
    返回:
    
    加密后的bytes
  - encryptHex
```
public String encryptHex(String data,
                         String charset)
```
    加密
    
    参数:
    
    data - 被加密的字符串
    
    charset - 编码
    
    返回:
    
    加密后的Hex
    
    从以下版本开始:
    
    4.5.12
  - encryptHex
```
public String encryptHex(String data,
                         Charset charset)
```
    加密
    
    参数:
    
    data - 被加密的字符串
    
    charset - 编码
    
    返回:
    
    加密后的Hex
    
    从以下版本开始:
    
    4.5.12
  - encryptBase64
```
public String encryptBase64(String data,
                            String charset)
```
    加密
    
    参数:
    
    data - 被加密的字符串
    
    charset - 编码
    
    返回:
    
    加密后的Base64
  - encryptBase64
```
public String encryptBase64(String data,
                            Charset charset)
```
    加密
    
    参数:
    
    data - 被加密的字符串
    
    charset - 编码
    
    返回:
    
    加密后的Base64
    
    从以下版本开始:
    
    4.5.12
  - encrypt
```
public byte[] encrypt(String data)
```
    加密，使用UTF-8编码
    
    参数:
    
    data - 被加密的字符串
    
    返回:
    
    加密后的bytes
  - encryptHex
```
public String encryptHex(String data)
```
    加密，使用UTF-8编码
    
    参数:
    
    data - 被加密的字符串
    
    返回:
    
    加密后的Hex
  - encryptBase64
```
public String encryptBase64(String data)
```
    加密，使用UTF-8编码
    
    参数:
    
    data - 被加密的字符串
    
    返回:
    
    加密后的Base64
  - encrypt
```
public byte[] encrypt(InputStream data)
               throws IORuntimeException
```
    加密
    
    参数:
    
    data - 被加密的字符串
    
    返回:
    
    加密后的bytes
    
    抛出:
    
    IORuntimeException - IO异常
  - encryptHex
```
public String encryptHex(InputStream data)
```
    加密
    
    参数:
    
    data - 被加密的字符串
    
    返回:
    
    加密后的Hex
  - encryptBase64
```
public String encryptBase64(InputStream data)
```
    加密
    
    参数:
    
    data - 被加密的字符串
    
    返回:
    
    加密后的Base64
  - decrypt
```
public byte[] decrypt(byte[] bytes)
```
    解密
    
    参数:
    
    bytes - 被解密的bytes
    
    返回:
    
    解密后的bytes
  - decryptStr
```
public String decryptStr(byte[] bytes,
                         Charset charset)
```
    解密为字符串
    
    参数:
    
    bytes - 被解密的bytes
    
    charset - 解密后的charset
    
    返回:
    
    解密后的String
  - decryptStr
```
public String decryptStr(byte[] bytes)
```
    解密为字符串，默认UTF-8编码
    
    参数:
    
    bytes - 被解密的bytes
    
    返回:
    
    解密后的String
  - decrypt
```
public byte[] decrypt(String data)
```
    解密Hex（16进制）或Base64表示的字符串
    
    参数:
    
    data - 被解密的String，必须为16进制字符串或Base64表示形式
    
    返回:
    
    解密后的bytes
  - decryptStr
```
public String decryptStr(String data,
                         Charset charset)
```
    解密Hex（16进制）或Base64表示的字符串
    
    参数:
    
    data - 被解密的String
    
    charset - 解密后的charset
    
    返回:
    
    解密后的String
  - decryptStr
```
public String decryptStr(String data)
```
    解密Hex表示的字符串，默认UTF-8编码
    
    参数:
    
    data - 被解密的String
    
    返回:
    
    解密后的String
  - decrypt
```
public byte[] decrypt(InputStream data)
               throws IORuntimeException
```
    解密，不会关闭流
    
    参数:
    
    data - 被解密的bytes
    
    返回:
    
    解密后的bytes
    
    抛出:
    
    IORuntimeException - IO异常
  - decryptStr
```
public String decryptStr(InputStream data,
                         Charset charset)
```
    解密，不会关闭流
    
    参数:
    
    data - 被解密的InputStream
    
    charset - 解密后的charset
    
    返回:
    
    解密后的String
  - decryptStr
```
public String decryptStr(InputStream data)
```
    解密
    
    参数:
    
    data - 被解密的InputStream
    
    返回:
    
    解密后的String
  - getSecretKey
```
public SecretKey getSecretKey()
```
    获得对称密钥
    
    返回:
    
    获得对称密钥
  - getCipher
```
public Cipher getCipher()
```
    获得加密或解密器
    
    返回:
    
    加密或解密

类 SymmetricCrypto

构造器概要

方法概要

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

构造器详细资料

SymmetricCrypto

SymmetricCrypto

SymmetricCrypto

SymmetricCrypto

SymmetricCrypto

SymmetricCrypto

SymmetricCrypto

方法详细资料

init

setParams

setIv

setIv

encrypt

encryptHex

encryptBase64

encrypt

encrypt

encryptHex

encryptHex

encryptBase64

encryptBase64

encrypt

encryptHex

encryptBase64

encrypt

encryptHex

encryptBase64

decrypt

decryptStr

decryptStr

decrypt

decryptStr

decryptStr

decrypt

decryptStr

decryptStr

getSecretKey

getCipher