cn.hutool.crypto.digest

Class Digester

java.lang.Object

cn.hutool.crypto.digest.Digester

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

MD5, SM3

public class Digester
extends Object
implements Serializable

摘要算法
注意：此对象实例化后为非线程安全！

Author:

Looly

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	digestCount 散列次数
protected byte[]	salt 盐值
protected int	saltPosition 加盐位置，即将盐值字符串放置在数据的index数，默认0

Constructor Summary

Constructors

Constructor and Description
Digester(DigestAlgorithm algorithm) 构造
Digester(DigestAlgorithm algorithm, Provider provider) 构造
Digester(MessageDigest messageDigest) 构造
Digester(String algorithm) 构造
Digester(String algorithm, Provider provider) 构造

Method Summary

Modifier and Type	Method and Description
byte[]	digest(byte[] data) 生成摘要，考虑加盐和重复摘要次数
byte[]	digest(File file) 生成文件摘要 使用默认缓存大小，见 NioUtil.DEFAULT_BUFFER_SIZE
byte[]	digest(InputStream data) 生成摘要，使用默认缓存大小，见 NioUtil.DEFAULT_BUFFER_SIZE
byte[]	digest(InputStream data, int bufferLength) 生成摘要
byte[]	digest(String data) 生成文件摘要
byte[]	digest(String data, Charset charset) 生成文件摘要
byte[]	digest(String data, String charsetName) 生成文件摘要
String	digestHex(byte[] data) 生成摘要，并转为16进制字符串
String	digestHex(File file) 生成文件摘要，并转为16进制字符串 使用默认缓存大小，见 NioUtil.DEFAULT_BUFFER_SIZE
String	digestHex(InputStream data) 生成摘要，并转为16进制字符串 使用默认缓存大小，见 NioUtil.DEFAULT_BUFFER_SIZE
String	digestHex(InputStream data, int bufferLength) 生成摘要，并转为16进制字符串 使用默认缓存大小，见 NioUtil.DEFAULT_BUFFER_SIZE
String	digestHex(String data) 生成文件摘要
String	digestHex(String data, Charset charset) 生成文件摘要，并转为16进制字符串
String	digestHex(String data, String charsetName) 生成文件摘要，并转为16进制字符串
MessageDigest	getDigest() 获得 MessageDigest
int	getDigestLength() 获取散列长度，0表示不支持此方法
Digester	init(String algorithm, Provider provider) 初始化
Digester	reset() 重置MessageDigest
Digester	setDigestCount(int digestCount) 设置重复计算摘要值次数
Digester	setSalt(byte[] salt) 设置加盐内容
Digester	setSaltPosition(int saltPosition) 设置加盐的位置，只有盐值存在时有效 加盐的位置指盐位于数据byte数组中的位置，例如： data: 0123456 则当saltPosition = 2时，盐位于data的1和2中间，即第二个空隙，即： data: 01[salt]23456

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

salt

protected byte[] salt

盐值

saltPosition

protected int saltPosition

加盐位置，即将盐值字符串放置在数据的index数，默认0

digestCount

protected int digestCount

散列次数

Constructor Detail

Digester

public Digester(DigestAlgorithm algorithm)

构造

Parameters:

algorithm - 算法枚举

Digester

public Digester(String algorithm)

构造

Parameters:

algorithm - 算法枚举

Digester

public Digester(DigestAlgorithm algorithm,
                Provider provider)

构造

Parameters:

algorithm - 算法

provider - 算法提供者，null表示JDK默认，可以引入Bouncy Castle等来提供更多算法支持

Since:

4.5.1

Digester

public Digester(String algorithm,
                Provider provider)

构造

Parameters:

algorithm - 算法

provider - 算法提供者，null表示JDK默认，可以引入Bouncy Castle等来提供更多算法支持

Since:

4.5.1

Digester

public Digester(MessageDigest messageDigest)

构造

Parameters:

messageDigest - MessageDigest

Method Detail

init

public Digester init(String algorithm,
                     Provider provider)

初始化

Parameters:

algorithm - 算法

provider - 算法提供者，null表示JDK默认，可以引入Bouncy Castle等来提供更多算法支持

Returns:

Digester

Throws:

CryptoException - Cause by IOException

setSalt

public Digester setSalt(byte[] salt)

设置加盐内容

Parameters:

salt - 盐值

Returns:

this

Since:

4.4.3

setSaltPosition

public Digester setSaltPosition(int saltPosition)

设置加盐的位置，只有盐值存在时有效
加盐的位置指盐位于数据byte数组中的位置，例如：

 data: 0123456
 

则当saltPosition = 2时，盐位于data的1和2中间，即第二个空隙，即：

 data: 01[salt]23456
 

Parameters:

saltPosition - 盐的位置

Returns:

this

Since:

4.4.3

setDigestCount

public Digester setDigestCount(int digestCount)

设置重复计算摘要值次数

Parameters:

digestCount - 摘要值次数

Returns:

this

reset

public Digester reset()

重置MessageDigest

Returns:

this

Since:

4.5.1

digest

public byte[] digest(String data,
                     String charsetName)

生成文件摘要

Parameters:

data - 被摘要数据

charsetName - 编码

Returns:

摘要

digest

public byte[] digest(String data,
                     Charset charset)

生成文件摘要

Parameters:

data - 被摘要数据

charset - 编码

Returns:

摘要

Since:

4.6.0

digest

public byte[] digest(String data)

生成文件摘要

Parameters:

data - 被摘要数据

Returns:

摘要

digestHex

public String digestHex(String data,
                        String charsetName)

生成文件摘要，并转为16进制字符串

Parameters:

data - 被摘要数据

charsetName - 编码

Returns:

摘要

digestHex

public String digestHex(String data,
                        Charset charset)

生成文件摘要，并转为16进制字符串

Parameters:

data - 被摘要数据

charset - 编码

Returns:

摘要

Since:

4.6.0

digestHex

public String digestHex(String data)

生成文件摘要

Parameters:

data - 被摘要数据

Returns:

摘要

digest

public byte[] digest(File file)
              throws CryptoException

生成文件摘要
使用默认缓存大小，见 NioUtil.DEFAULT_BUFFER_SIZE

Parameters:

file - 被摘要文件

Returns:

摘要bytes

Throws:

CryptoException - Cause by IOException

digestHex

public String digestHex(File file)

生成文件摘要，并转为16进制字符串
使用默认缓存大小，见 NioUtil.DEFAULT_BUFFER_SIZE

Parameters:

file - 被摘要文件

Returns:

摘要

digest

public byte[] digest(byte[] data)

生成摘要，考虑加盐和重复摘要次数

Parameters:

data - 数据bytes

Returns:

摘要bytes

digestHex

public String digestHex(byte[] data)

生成摘要，并转为16进制字符串

Parameters:

data - 被摘要数据

Returns:

摘要

digest

public byte[] digest(InputStream data)

生成摘要，使用默认缓存大小，见 NioUtil.DEFAULT_BUFFER_SIZE

Parameters:

data - InputStream 数据流

Returns:

摘要bytes

digestHex

public String digestHex(InputStream data)

生成摘要，并转为16进制字符串
使用默认缓存大小，见 NioUtil.DEFAULT_BUFFER_SIZE

Parameters:

data - 被摘要数据

Returns:

摘要

digest

public byte[] digest(InputStream data,
                     int bufferLength)
              throws IORuntimeException

生成摘要

Parameters:

data - InputStream 数据流

bufferLength - 缓存长度，不足1使用 NioUtil.DEFAULT_BUFFER_SIZE 做为默认值

Returns:

摘要bytes

Throws:

IORuntimeException - IO异常

digestHex

public String digestHex(InputStream data,
                        int bufferLength)

生成摘要，并转为16进制字符串
使用默认缓存大小，见 NioUtil.DEFAULT_BUFFER_SIZE

Parameters:

data - 被摘要数据

bufferLength - 缓存长度，不足1使用 NioUtil.DEFAULT_BUFFER_SIZE 做为默认值

Returns:

摘要

getDigest

public MessageDigest getDigest()

获得 MessageDigest

Returns:

MessageDigest

getDigestLength

public int getDigestLength()

获取散列长度，0表示不支持此方法

Returns:

散列长度，0表示不支持此方法

Since:

4.5.0