欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

Java Base64工具类,提供常用(文件、图片、PDF、URL)转换方法,欢迎留言完善...(原创博文,欢迎转载)

程序员文章站 2022-07-03 15:54:30
...

原创博文,欢迎转载,转载时请务必附上博文链接,感谢您的尊重。

前言

通过本篇的学习,你将学会Base64在实战中的使用,此工具包提供了常用的方法,如下:

  1. text明文【转】Base64字符串;
  2. text的Base64字符串【转】明文;
  3. 文件(图片、pdf等)【转】Base64;
  4. Base64【转】文件(图片、pdf等);
  5. 将pdf的Base64编码格式【转为】img的Base64编码格式,只限最后一页的Base64编码;
  6. 将pdf的Base64编码格式【转为】img的Base64编码格式,并将所有页合成一张图片的Base64编码;
  7. ...

有关Base64编码(Encode)与解码(Decode)的基础知识,请请看我另一篇博文关于Base64编码(Encode)与解码(Decode)的几种方式,这里面有道道


一、所需的包

注意:java.util.Base64是JDK1.8中新增的类,所以它只支持JDK1.8及以后的版本,如果你的JDK版本低于1.8,请使用org.apache.commons.codec.binary.Base64.

下面的包,是用于Base64的pdf转img使用的,如果不需要要,可以不引用,并删掉对应的方法(前言中的5和6)。

    <dependency>
		<groupId>org.apache.pdfbox</groupId>
		<artifactId>fontbox</artifactId>
		<version>2.0.1</version>
	</dependency>
	<dependency>
		<groupId>org.apache.pdfbox</groupId>
		<artifactId>pdfbox</artifactId>
		<version>2.0.1</version>
	</dependency>

二、Base64Util

Base64Util类,代码如下(可以直接复制使用,直接运行main方法看效果):

import org.apache.commons.lang3.StringUtils;
import org.apache.pdfbox.pdmodel.PDDocument;
import org.apache.pdfbox.rendering.ImageType;
import org.apache.pdfbox.rendering.PDFRenderer;
import java.awt.image.BufferedImage;
import java.io.*;
import javax.imageio.ImageIO;
import java.util.Base64;

public class Base64Utils {

    // Base64 编码与解码
    private static final Base64.Decoder DECODER_64 = Base64.getDecoder();
    private static final Base64.Encoder ENCODER_64 = Base64.getEncoder();

    // dpi越大转换后的图片越清晰,相对转换速度越慢
    private static final Integer DPI = 200;

    // 编码、解码格式
    private static final String CODE_FORMATE = "UTF-8";

    /**
     * 1. text明文 转 Base64字符串
     * @param text  明文
     * @return      Base64 字符串
     */
    public static String textToBase64Str(String text) {
        if (StringUtils.isBlank(text)) {
            return text;
        }
        String encodedToStr = null;
        try {
            encodedToStr = ENCODER_64.encodeToString(text.getBytes(CODE_FORMATE));
        } catch (UnsupportedEncodingException e) {
            e.getMessage();
        }
        return encodedToStr;
    }

    /**
     * 2. text的Base64字符串 转 明文
     * @param base64Str text的Base64字符串
     * @return          text明文
     */
    public static String base64StrToText(String base64Str) {
        if (StringUtils.isBlank(base64Str)) {
            return base64Str;
        }
        String byteToText = null;
        try {
            byteToText = new String(DECODER_64.decode(base64Str), CODE_FORMATE);
        } catch (UnsupportedEncodingException e) {
            e.getMessage();
        }
        return byteToText;
    }

    /**
     * 3. 文件(图片、pdf) 转 Base64字符串
     * @param file  需要转Base64的文件
     * @return      Base64 字符串
     */
    public static String fileToBase64Str(File file) throws IOException {
        String base64Str = null;
        FileInputStream fin = null;
        BufferedInputStream bin = null;
        ByteArrayOutputStream baos = null;
        BufferedOutputStream bout = null;
        try {
            fin = new FileInputStream(file);
            bin = new BufferedInputStream(fin);
            baos = new ByteArrayOutputStream();
            bout = new BufferedOutputStream(baos);
            // io
            byte[] buffer = new byte[1024];
            int len = bin.read(buffer);
            while(len != -1){
                bout.write(buffer, 0, len);
                len = bin.read(buffer);
            }
            // 刷新此输出流,强制写出所有缓冲的输出字节
            bout.flush();
            byte[] bytes = baos.toByteArray();
            // Base64字符编码
            base64Str = ENCODER_64.encodeToString(bytes).trim();
        } catch (IOException e) {
            e.getMessage();
        } finally{
            try {
                fin.close();
                bin.close();
                bout.close();
            } catch (IOException e) {
                e.getMessage();
            }
        }
        return base64Str;
    }

    /**
     * 4. Base64字符串 转 文件(图片、pdf) -- 多用于测试
     * @param base64Content Base64 字符串
     * @param filePath      存放路径
     */
    public static void base64ContentToFile(String base64Content, String filePath) throws IOException{
        BufferedInputStream bis = null;
        FileOutputStream fos = null;
        BufferedOutputStream bos = null;
        try {
            // Base64解码到字符数组
            byte[] bytes =  DECODER_64.decode(base64Content);
            ByteArrayInputStream byteInputStream = new ByteArrayInputStream(bytes);
            bis = new BufferedInputStream(byteInputStream);
            File file = new File(filePath);
            File path = file.getParentFile();
            if(!path.exists()){
                path.mkdirs();
            }
            fos = new FileOutputStream(file);
            bos = new BufferedOutputStream(fos);
            // io
            byte[] buffer = new byte[1024];
            int length = bis.read(buffer);
            while(length != -1){
                bos.write(buffer, 0, length);
                length = bis.read(buffer);
            }
            // 刷新此输出流,强制写出所有缓冲的输出字节
            bos.flush();
        } catch (IOException e) {
            e.getMessage();
        }finally{
            try {
                bis.close();
                fos.close();
                bos.close();
            } catch (IOException e) {
                e.getMessage();
            }
        }
    }

    /**
     * 5. 将pdf的base64编码格式 转为 img的base64编码格式,只限最后一页
     * @param base64Pdf  pdf的base64编码
     * @return           image的base64编码
     */
    public static String base64PdfToJpgBase64(String base64Pdf){
        if (StringUtils.isBlank(base64Pdf)){
            return base64Pdf;
        }
        String jpg_base64 = null;
        PDDocument doc = null;
        try {
            // Base64解码
            byte[] pdf_bytes = DECODER_64.decode(base64Pdf);
            // 利用PdfBox生成图像
            doc = PDDocument.load(pdf_bytes);
            int size = doc.getNumberOfPages();
            for (int i = 0; i < size; i++) {
                BufferedImage image = new PDFRenderer(doc).renderImageWithDPI(i, DPI, ImageType.RGB);
                // io流
                ByteArrayOutputStream baos = new ByteArrayOutputStream();
                // 写入流中
                ImageIO.write(image, "jpg", baos);
                // 转换成字节
                byte[] jpg_Bytes = baos.toByteArray();
                // Base64编码
                jpg_base64 = ENCODER_64.encodeToString(jpg_Bytes).trim();
                // 删除 \r\n
                jpg_base64 = jpg_base64.replaceAll("\n|\n", "");
            }
        } catch (IOException e) {
            e.getMessage();
        } finally {
            if (doc != null) {
                try {
                    doc.close();
                } catch (IOException e) {
                    e.getMessage();
                }
            }
        }
        return jpg_base64;
    }

    /**
     * 6. 将pdf的base64编码格式 转为 img的base64编码格式,并将所有页合成一张图片
     * @param pdfBase64Str  pdf的base64编码
     * @return              image的base64编码
     */
    public static String base64PdfToJpgBase64ForOne(String pdfBase64Str){
        if (StringUtils.isBlank(pdfBase64Str)){
            return pdfBase64Str;
        }
        String jpg_base64 = null;
        PDDocument doc = new PDDocument();
        // io
        ByteArrayOutputStream baos = new ByteArrayOutputStream();
        try {
            // Base64解码
            byte[] pdf_bytes = DECODER_64.decode(pdfBase64Str);
            doc = PDDocument.load(pdf_bytes);
            int size = doc.getNumberOfPages();
            /* 图像合并使用的参数 */
            // 定义宽度
            int width = 0;
            // 保存一张图片中的RGB数据
            int[] singleImgRGB;
            // 定义高度,后面用于叠加
            int shiftHeight = 0;
            // 保存每张图片的像素值
            BufferedImage imageResult = null;
            // 利用PdfBox生成图像
            PDDocument pdDocument = doc;
            PDFRenderer renderer = new PDFRenderer(pdDocument);
            /* 根据总页数, 按照50页生成一张长图片的逻辑, 进行拆分 */
            // 每50页转成1张图片,有多少转多少
            int pageLength = size;
            // 总计循环的次数
            int totalCount = pdDocument.getNumberOfPages() / pageLength + 1;
            for (int m = 0; m < totalCount; m++) {
                for (int i = 0; i < pageLength; i++) {
                    int pageIndex = i + (m * pageLength);
                    if (pageIndex == pdDocument.getNumberOfPages()) {
                        System.out.println("循环次数 m = " + m);
                        break;
                    }
                    // dpi越大,则图片越清晰,图片越大,转换耗费的时间也越多
                    BufferedImage image = renderer.renderImageWithDPI(pageIndex, DPI, ImageType.RGB);
                    int imageHeight = image.getHeight();
                    int imageWidth = image.getWidth();
                    if (i == 0) {
                        // 计算高度和偏移量
                        // 使用第一张图片宽度;
                        width = imageWidth;
                        // 保存每页图片的像素值
                        // 加个判断:如果m次循环后所剩的图片总数小于pageLength,则图片高度按剩余的张数绘制,否则会出现长图片下面全是黑色的情况
                        if ((pdDocument.getNumberOfPages() - m * pageLength) < pageLength) {
                            imageResult = new BufferedImage(width, imageHeight * (pdDocument.getNumberOfPages() - m * pageLength), BufferedImage.TYPE_INT_RGB);
                        } else {
                            imageResult = new BufferedImage(width, imageHeight * pageLength, BufferedImage.TYPE_INT_RGB);
                        }
                    } else {
                        // 将高度不断累加
                        shiftHeight += imageHeight;
                    }
                    singleImgRGB = image.getRGB(0, 0, width, imageHeight, null, 0, width);
                    imageResult.setRGB(0, shiftHeight, width, imageHeight, singleImgRGB, 0, width);
                }
                // 这个很重要,下面会有说明
                shiftHeight = 0;
            }
            pdDocument.close();
            // 写入流中
            ImageIO.write(imageResult, "jpg", baos);
            // 转换成字节
            byte[] jpg_Bytes = baos.toByteArray();
            // 转换成base64串
            jpg_base64 = ENCODER_64.encodeToString(jpg_Bytes).trim();
            // 删除 \r\n
            jpg_base64 = jpg_base64.replaceAll("\n|\n", "");
        } catch (IOException e) {
            e.getMessage();
        } finally {
            if (baos != null) {
                try {
                    baos.close();
                } catch (IOException e) {
                    e.getMessage();
                }
            }
            if (doc != null) {
                try {
                    doc.close();
                } catch (IOException e) {
                    e.getMessage();
                }
            }
        }
        return jpg_base64;
    }

    // 测试
    public static void main(String args[]){
        // 1.测试:text明文 转 Base64字符串
        String text = "这是一串需要编码的明文,可以是URL、图片、文件或其他。";
        String result_1 = Base64Utils.textToBase64Str(text);
        System.out.println("text明文 转 Base64字符串:" + text + " → 经Base64编码后 → " + result_1);

        // 2.测试:text的Base64字符串 转 明文
        String base64Str = "6L+Z5piv5LiA5Liy6ZyA6KaB57yW56CB55qE5piO5paH77yM5Y+v5Lul5pivVVJM44CB5Zu+54mH44CB5paH5Lu25oiW5YW25LuW44CC";
        String result_2 = Base64Utils.base64StrToText(base64Str);
        System.out.println("text的Base64字符串 转 明文:" + base64Str + " → 经Base64解码后 → " + result_2);

        // 3.测试:文件 转 Base64
        // 4.测试:Base64 转 文件
        try {
            File filePath = new File("D:\\downloads\\test.pdf");
            String tempBase64Str = Base64Utils.fileToBase64Str(filePath);
            System.out.println("文件 转 Base64,完成,使用方法【4】反转验证。");
            Base64Utils.base64ContentToFile(tempBase64Str, "D:\\downloads\\test_4.pdf");
        } catch (IOException e) {
            e.getMessage();
        }
        System.out.println("文件与Base64互转,完成,方法【4】通常用于测试。");

        // 5.测试:将pdf的base64编码格式 转为 img的base64编码格式,只限最后一页
        try {
            File filePath = new File("D:\\downloads\\test.pdf");
            String tempBase64Str_1 = Base64Utils.fileToBase64Str(filePath);
            String tempBase64Str_2 = Base64Utils.base64PdfToJpgBase64(tempBase64Str_1);
            Base64Utils.base64ContentToFile(tempBase64Str_2, "D:\\downloads\\pdf_to_image_5.jpg");
        } catch (IOException e) {
            e.getMessage();
        }
        System.out.println("将pdf的base64编码格式 转为 img的base64编码格式,只限最后一页,完成。");

        // 6.测试:将pdf的base64编码格式 转为 img的base64编码格式,并合成一张图片
        try {
            File filePath = new File("D:\\downloads\\test.pdf");
            String tempBase64Str_1 = Base64Utils.fileToBase64Str(filePath);
            String tempBase64Str_2 = Base64Utils.base64PdfToJpgBase64ForOne(tempBase64Str_1);
            Base64Utils.base64ContentToFile(tempBase64Str_2, "D:\\downloads\\pdf_to_image_6.jpg");
        } catch (IOException e) {
            e.getMessage();
        }
        System.out.println("将pdf的base64编码格式 转为 img的base64编码格式,并将所有页合成一张图片,完成。");
    }
}

 

总结

  • 上述工具类中的方法,都是小编实际生产中遇到的场景,亲改亲测总结下来的;
  • 方法可以直接复制使用,测试类也已调试好;
  • 由于java.util.Base64是JDK1.8中新增的类,所以该类仅支持JDK1.8及以后的版本;
  • 如果JDK版本低于1.8,需要把java.util.Base64换成org.apache.commons.codec.binary.Base64,具体方法可见【本篇“前言”中提示的博文】。
  • 欢迎大家及时补充,把Util类变的更加完善,让更多的程序员能从中受益。

我是一名小白程序员,您的点赞、评论和关注,是我不懈创作的动力!!
学无止境,气有浩然,让我们一起加油,乘风破浪,江湖有缘再见。