📋 目录
一、工具类功能
算文件、输入流、字节数组和文本的摘要指纹,秒传去重、下载完整性校验、接口签名都用得上,同一份内容从哪个入口算都得到同一个值,还能直接跟 md5sum、openssl 对账。
二、所需环境
JDK 17或以上
三、方法与调用示例(按需调用)
🔢 方法序号:1
🎯 方法用途:
- 流式算文件的 MD5,输出小写十六进制
- 文件秒传、去重、和
md5sum命令对结果时用
🧩 方法定义:public static String md5Hex(Path file)
🗣️ 入参解释:public static String md5Hex(文件路径)
📤 返回值解释:String,32 位小写十六进制摘要
💡 边界口径:
- 按 64 KB 缓冲区流式更新,1 GB 文件与 1 KB 文件的内存占用相同
- 方法自己负责开流关流,调用方不用管
- 文件不存在或不是普通文件抛
IllegalArgumentException,消息里带上该路径 - MD5 已不适合抗碰撞,做完整性校验与内容指纹仍可用
🧪 方法示例:
md5Hex(helloTxt)拿到5d41402abc4b2a76b9719d911017c592,与md5sum的输出一致是true- 路径指向一个目录时抛
IllegalArgumentException,消息是「文件不存在或不是普通文件」再补上该路径
🔢 方法序号:2
🎯 方法用途:
- 流式算文件的 SHA-256,输出 64 位小写十六进制
- 内容指纹、下载完整性校验这类要抗碰撞的场景用它
🧩 方法定义:public static String sha256Hex(Path file)
🗣️ 入参解释:public static String sha256Hex(文件路径)
📤 返回值解释:String,64 位小写十六进制摘要
💡 边界口径:
- 与
md5Hex同为文件入口,只是算法换成 SHA-256 - 大文件同样按 64 KB 流式读,不吃内存
- 要换别的算法走
digestHex(Path, String) - 入参为 null 抛
IllegalArgumentException
🧪 方法示例:
sha256Hex(helloTxt)拿到2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824,长度 64 个字符
🔢 方法序号:3
🎯 方法用途:
- 算一段文本的 MD5,按 UTF-8 取字节
- 内容指纹、缓存 key 归一这类只要文本摘要时用
🧩 方法定义:public static String md5HexText(String text)
🗣️ 入参解释:public static String md5HexText(文本)
📤 返回值解释:String,32 位小写十六进制摘要
💡 边界口径:
- 与文件入口刻意不共用方法名:把路径字符串误传给文本入口会静默算出另一个摘要,编译期发现不了
- 结果与把同一串按 UTF-8 取字节走字节入口完全一致
- 空串有确定的指纹,不抛异常
- 入参为 null 抛
IllegalArgumentException
🧪 方法示例:
md5HexText("hello")与字节入口同值,判断拿到true- 文本传 null 抛
文本不能为null
🔢 方法序号:4
🎯 方法用途:
- 算一段文本的 SHA-256,按 UTF-8 取字节
- 中文内容也要指纹时用这一版
🧩 方法定义:public static String sha256HexText(String text)
🗣️ 入参解释:public static String sha256HexText(文本)
📤 返回值解释:String,64 位小写十六进制摘要
💡 边界口径:
- 编码固定 UTF-8,换字符集结果会变
- 空串的 SHA-256 是固定值,可以直接当「无内容」的指纹
- 与
md5HexText只有算法差别
🧪 方法示例:
- 中文串走
sha256HexText(cnText)拿到10c59eebffb07dba41220892bb015cb67fc4f8b9d26ced15dae26ac04a8d8d6c - 空串也有确定指纹,拿到
e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
🔢 方法序号:5
🎯 方法用途:
- 按算法名给文件算十六进制摘要,算法不写死
- 要支持 SM3、SHA-512 等注册到 JCA 的算法时用这一版
🧩 方法定义:public static String digestHex(Path file, String algorithm)
🗣️ 入参解释:public static String digestHex(文件路径, 算法名)
📤 返回值解释:String,该算法的小写十六进制摘要
💡 边界口径:
- 算法名写法宽容:
md5、SHA256、sha-256、带首尾空白都认 - 未收录的名字原样交给 JCA,方便第三方 Provider 命中,不做臆测式改写
- JVM 里没有的算法(如
SHA-0)明确报不支持,不会悄悄退化成别的算法 - 跨缓冲区的大文件按 64 KB 流式算,结果与一次性读入一致
🧪 方法示例:
digestHex(helloTxt, "SHA-1")拿到aaf4c61ddcc5e8a2dabede0f3b482cd9aea9434d,别名sha1与SHA-1同值- 算法名写成
" Md5 "也一样,判断拿到true - 65543 字节的大文件按 64 KB 流式算 SHA-256,前 16 位是
3545145ac858f18a - 算法名给空白抛
摘要算法名不能为null或空白
🔢 方法序号:6
🎯 方法用途:
- 对输入流算十六进制摘要,适合已经在手里的流、网络响应体
- 不想先把内容落到临时文件再算时用
🧩 方法定义:public static String digestHex(InputStream inputStream, String algorithm)
🗣️ 入参解释:public static String digestHex(输入流, 算法名)
📤 返回值解释:String,该算法的小写十六进制摘要
💡 边界口径:
- 只读不关流,关闭责任留在调用方,否则嵌套调用时上层会拿到一个已关的流
- 结果与同一内容走文件入口一致
- 流读到一半出错不吞异常,包成
IllegalStateException并带上失败原因 - 入参为 null 抛
IllegalArgumentException
🧪 方法示例:
- 流入口算完不关流,结果与文件入口一致,判断拿到
true - 中途出错时包装成
IllegalStateException且关闭责任仍在调用方,判断拿到true
🔢 方法序号:7
🎯 方法用途:
- 对字节数组算十六进制摘要,内容已在内存时用
- 接口签名、报文校验这类拿
byte[]的场景用它
🧩 方法定义:public static String digestHex(byte[] content, String algorithm)
🗣️ 入参解释:public static String digestHex(字节数组, 算法名)
📤 返回值解释:String,该算法的小写十六进制摘要
💡 边界口径:
- 与文件入口同值,同一份内容两个入口结果一致
- 空数组给出确定的空值指纹,不抛异常
digestHex的三个重载传裸 null 会因歧义编译不过,要写成digestHex((byte[]) null, MD5)这样显式转型- 数组为 null 抛
IllegalArgumentException
🧪 方法示例:
- 字节数组入口与文件入口同值,判断拿到
true digestHex(new byte[0], "MD5")拿到空值指纹d41d8cd98f00b204e9800998ecf8427e- 数组传 null 抛
待计算摘要的字节数组不能为null
🔢 方法序号:8
🎯 方法用途:
- 文件摘要以标准 Base64 输出,正是 OSS、七牛要的
Content-MD5形态 - 对象存储上传校验、 multipart 分片 ETAG 计算时用
🧩 方法定义:public static String digestBase64(Path file, String algorithm)
🗣️ 入参解释:public static String digestBase64(文件路径, 算法名)
📤 返回值解释:String,标准 Base64 摘要,含 padding 且不换行
💡 边界口径:
- Base64 是标准字母表、带 padding 且不换行
- 与同一算法的十六进制入口是同一份字节的两种编码
- 文件入口自己开关流,规则同
digestHex(Path, String) - 要 URL 安全形态得自己转,本方法不提供
🧪 方法示例:
digestBase64(helloTxt, "MD5")拿到XUFAKrxLKna5cZ2REBfFkg==,与字节入口同值
🔢 方法序号:9
🎯 方法用途:
- 字节数组的 Base64 摘要出口,与文件入口同形态
- 上传请求头里要填
Content-MD5、内容已在内存时用
🧩 方法定义:public static String digestBase64(byte[] content, String algorithm)
🗣️ 入参解释:public static String digestBase64(字节数组, 算法名)
📤 返回值解释:String,标准 Base64 摘要,含 padding
💡 边界口径:
- 与文件入口对同一内容给出相同字符串
- 空数组同样给出确定的 Base64 空值指纹
- 数组为 null 抛
IllegalArgumentException
🧪 方法示例:
digestBase64(bytes, "MD5")拿到XUFAKrxLKna5cZ2REBfFkg==,与文件入口一致是true
🔢 方法序号:10
🎯 方法用途:
- 校验文件的摘要是否等于期望值,用于下载完整性、上传落盘核对
- 只要「对不对」的结论、不想自己再算一遍时用
🧩 方法定义:public static boolean verifyFile(Path file, String expectedHex, String algorithm)
🗣️ 入参解释:public static boolean verifyFile(文件路径, 期望摘要, 算法名)
📤 返回值解释:boolean,摘要一致返回 true
💡 边界口径:
- 忽略期望值的大小写与首尾空白,比对的是解码后的字节
- 比较走
MessageDigest#isEqual的常量时间实现,不会因逐字符短路泄漏期望值前缀 - 期望值写成非十六进制字符只得到
false,不抛异常 - 文件不存在或不是普通文件抛
IllegalArgumentException
🧪 方法示例:
- 期望值写成大写、或者首尾带空白,两次校验都拿到
true - 文件内容改动后拿到
false - 期望值多写两个字符拿到
false,不抛异常
四、工具类源码(可直接复制)
📦 源码文件