每期一个小窍门: 简单文件摘要工具类

Posted 2022-12-07 李昊轩的博客

有时候我们程序内部要进行文件传输, 为了安全考虑, 需要摘要校验.

比如想传递文件A, 获取了文件A的摘要a, 对方在读取此文件时, 用同样的摘要算法算出a的话就证明文件A没有被篡改, 反之就是被篡改了(摘要码不匹配)

下方是工具类的使用

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.util.Arrays;


/**
 * 文件摘要类
 */
public class MD5Builder 

    private static final Logger logger = LoggerFactory.getLogger(MD5Builder.class);
    // 用来将字节转换成 16 进制表示的字符
    static char hexDigits[] = '0', '1', '2', '3', '4', '5', '6', '7', '8',
            '9', 'a', 'b', 'c', 'd', 'e', 'f';

    /**
     * 对文件全文生成MD5摘要
     *
     * @param file 要加密的文件
     * @return MD5摘要码
     */
    public static String getMD5(File file) 
        FileInputStream fis = null;
        try 
            MessageDigest md = MessageDigest.getInstance("MD5");

            logger.info("MD5摘要长度：" + md.getDigestLength());
            fis = new FileInputStream(file);
            byte[] buffer = new byte[2048];
            int length = -1;
            logger.info("开始生成摘要");
            long s = System.currentTimeMillis();
            while ((length = fis.read(buffer)) != -1) 
                md.update(buffer, 0, length);
            
            logger.info("摘要生成成功,总用时: "
                    + (System.currentTimeMillis() - s) + "ms");
            byte[] b = md.digest();
            return byteToHexString(b);
            // 16位加密
            // return buf.toString().substring(8, 24);
         catch (Exception ex) 
            logger.error(Arrays.toString(ex.getStackTrace()));
            ex.printStackTrace();
            return null;
         finally 
            try 
                fis.close();
             catch (IOException ex) 
                ex.printStackTrace();
            
        
    

    /**
     * 对一段String生成MD5加密信息
     *
     * @param message 要加密的String
     * @return 生成的MD5信息
     */
    public static String getMD5(String message) 
        try 
            MessageDigest md = MessageDigest.getInstance("MD5");
            logger.info("MD5摘要长度：" + md.getDigestLength());
            byte[] b = md.digest(message.getBytes());
            return byteToHexString(b);
         catch (NoSuchAlgorithmException e) 
            logger.error(Arrays.toString(e.getStackTrace()));
            e.printStackTrace();
            return null;
        
    

    /**
     * 把byte[]数组转换成十六进制字符串表示形式
     *
     * @param tmp 要转换的byte[]
     * @return 十六进制字符串表示形式
     */
    private static String byteToHexString(byte[] tmp) 
        String s;
        // 用字节表示就是 16 个字节
        char str[] = new char[16 * 2]; // 每个字节用 16 进制表示的话，使用两个字符，
        // 所以表示成 16 进制需要 32 个字符
        int k = 0; // 表示转换结果中对应的字符位置
        for (int i = 0; i < 16; i++)  // 从第一个字节开始，对 MD5 的每一个字节
            // 转换成 16 进制字符的转换
            byte byte0 = tmp[i]; // 取第 i 个字节
            str[k++] = hexDigits[byte0 >>> 4 & 0xf]; // 取字节中高 4 位的数字转换,
            // >>> 为逻辑右移，将符号位一起右移
            str[k++] = hexDigits[byte0 & 0xf]; // 取字节中低 4 位的数字转换
        
        s = new String(str); // 换后的结果转换为字符串
        return s;