Java实现二维码的编码与解码

1、构建maven项目,导入对应依赖

这里引用谷歌的zxing包实现二维码的编码与解码,导入依赖如下所示

<!-- 谷歌二维码 -->
<dependency>
    <groupId>com.google.zxing</groupId>
    <artifactId>core</artifactId>
    <version>3.3.0</version>
</dependency>

2、编写编码与解码的方法

二维码生成工具类如下所示,


import java.awt.BasicStroke;
import java.awt.Graphics;
import java.awt.Graphics2D;
import java.awt.Image;
import java.awt.Shape;
import java.awt.geom.AffineTransform;
import java.awt.geom.RoundRectangle2D;
import java.awt.image.BufferedImage;
import java.io.*;
import java.util.Base64;
import java.util.Hashtable;
import javax.imageio.ImageIO;

import com.google.zxing.*;
import com.google.zxing.common.BitMatrix;
import com.google.zxing.common.HybridBinarizer;
import com.google.zxing.qrcode.decoder.ErrorCorrectionLevel;

public class QrCodeUtil {
    private static final String CHARSET = "utf-8";
    private static final String IMAGE_SUFFIX = "JPG";
    /**
     * 二维码尺寸
     */
    private static final int QRCODE_SIZE = 300;
    /**
     * LOGO宽度
     */
    private static final int WIDTH = 60;
    /**
     * LOGO高度
     */
    private static final int HEIGHT = 60;

    /**
     * 生成二维码图片, 可自定义容错率
     * @param content  二维码内容
     * @param logoPath  logo图片路径
     * @param needCompress  是否需要压缩
     * @param level  L-7%  M-15%   Q-25%  H-30%  容错级别
     * @return
     * @throws Exception
     */
    private static BufferedImage createImage(String content, String logoPath, boolean needCompress, ErrorCorrectionLevel level) throws Exception {
        Hashtable hints = new Hashtable();
        hints.put(EncodeHintType.ERROR_CORRECTION, level);
        hints.put(EncodeHintType.CHARACTER_SET, CHARSET);
        hints.put(EncodeHintType.MARGIN, 1);
        //生成二维码
        BitMatrix bitMatrix = new MultiFormatWriter().encode(content, BarcodeFormat.QR_CODE, QRCODE_SIZE, QRCODE_SIZE, hints);
        int width = bitMatrix.getWidth();
        int height = bitMatrix.getHeight();
        BufferedImage image = new BufferedImage(width, height, BufferedImage.TYPE_INT_RGB);
        //构建图片
        for (int x = 0; x < width; x++) {
            for (int y = 0; y < height; y++) {
                image.setRGB(x, y, bitMatrix.get(x, y) ? 0xFF000000 : 0xFFFFFFFF);
            }
        }
        if (logoPath == null || "".equals(logoPath)) {
            return image;
        }
        // 插入图片,即中间显示的logo
        insertImage(image, logoPath, needCompress);
        return image;
    }

    /**
     * 生成二维码图片
     * @param content  二维码文字内容
     * @param logoPath  logo图片路径
     * @param needCompress  是否需要压缩
     * @return
     * @throws Exception
     */
    private static BufferedImage createImage(String content, String logoPath, boolean needCompress) throws Exception {
        return createImage(content, logoPath, needCompress, ErrorCorrectionLevel.H);
    }

    /**
     * 往二维码插入图片(logo)
     * @param source  二维码图片
     * @param imgPath  logo路径
     * @param needCompress  是否需要压缩
     * @throws Exception
     */
    private static void insertImage(BufferedImage source, String imgPath, boolean needCompress) throws Exception {
        File file = new File(imgPath);
        if (!file.exists()) {
            System.err.println("" + imgPath + "   该文件不存在!");
            return;
        }

        //获取源图片
        Image image = ImageIO.read(new File(imgPath));
        int width = image.getWidth(null);
        int height = image.getHeight(null);
        // 压缩LOGO
        if (needCompress) {
            width = width > WIDTH ? WIDTH : width;
            height = height > HEIGHT ? HEIGHT : height;
            image = image.getScaledInstance(width, height, Image.SCALE_SMOOTH);
            BufferedImage tag = new BufferedImage(width, height, BufferedImage.TYPE_INT_RGB);
            Graphics g = tag.getGraphics();
            // 绘制缩小后的图
            g.drawImage(image, 0, 0, null);
            g.dispose();
        }
        // 插入LOGO
        Graphics2D graph = source.createGraphics();
        int x = (QRCODE_SIZE - width) / 2;
        int y = (QRCODE_SIZE - height) / 2;
        graph.drawImage(image, x, y, width, height, null);
        Shape shape = new RoundRectangle2D.Float(x, y, width, width, 6, 6);
        graph.setStroke(new BasicStroke(3f));
        graph.draw(shape);
        graph.dispose();
    }

    /**
     * 编码生成二维码图片,固化到硬盘
     * @param content  二维码文字内容
     * @param logoPath  插入的logo路径
     * @param destPath  生成的二维码输出路径
     * @param needCompress  是否需要压缩
     * @param level  容错率
     * @throws Exception
     */
    public static void encode(String content, String logoPath, String destPath, boolean needCompress, ErrorCorrectionLevel level) throws Exception {
        mkdirs(destPath);
        ImageIO.write(createImage(content, logoPath, needCompress, level), IMAGE_SUFFIX, new File(destPath));
    }

    /**
     * 编码生成二维码图片,固化到硬盘
     * @param content  二维码文字内容
     * @param logoPath  logo图片路径
     * @param destPath  生成的二维码输出路径
     * @param needCompress  是否需要压缩
     * @throws Exception
     */
    public static void encode(String content, String logoPath, String destPath, boolean needCompress) throws Exception {
        mkdirs(destPath);
        ImageIO.write(createImage(content, logoPath, needCompress), IMAGE_SUFFIX, new File(destPath));
    }

    /**
     * 编码生成二维码图片,固化到硬盘
     * @param content  二维码文字内容
     * @param logoPath  logo图片路径
     * @param destPath  生成的二维码输出路径
     * @throws Exception
     */
    public static void encode(String content, String logoPath, String destPath) throws Exception {
        encode(content, logoPath, destPath, false);
    }

    /**
     * 编码生成二维码图片,固化到硬盘
     * @param content  二维码文字内容
     * @param destPath  生成的二维码输出路径
     * @throws Exception
     */
    public static void encode(String content, String destPath) throws Exception {
        encode(content, null, destPath, false);
    }

    /**
     * 编码生成二维码图片,输出到流
     * @param content  二维码文字内容
     * @param logoPath  logo图片路径
     * @param output  输出流
     * @param needCompress  是否需要压缩
     * @throws Exception
     */
    public static void encode(String content, String logoPath, OutputStream output, boolean needCompress) throws Exception {
        ImageIO.write(createImage(content, logoPath, needCompress), IMAGE_SUFFIX, output);
    }

    /**
     * 编码生成二维码图片,输出到流
     * @param content  二维码文字内容
     * @param output  输出流
     * @throws Exception
     */
    public static void encode(String content, OutputStream output) throws Exception {
        encode(content, null, output, false);
    }

    /**
     * 编码生成二维码图片,转化为base64字符串
     * @param content  二维码文字内容
     * @param imgPath  logo图片路径
     * @param needCompress  是否需要压缩
     * @param level  容错率
     * @param imageSuffix  生成的图片后缀
     * @return
     * @throws Exception
     */
    public static String encode(String content, String imgPath, boolean needCompress, ErrorCorrectionLevel level, String imageSuffix) throws Exception {
        imageSuffix = (imageSuffix == null || "".equals(imageSuffix)) ? IMAGE_SUFFIX : imageSuffix;
        BufferedImage image = createImage(content, imgPath, needCompress, level);
        ByteArrayOutputStream stream = new ByteArrayOutputStream();
        ImageIO.write(image, imageSuffix, stream);
        return Base64.getEncoder().encodeToString(stream.toByteArray());
    }

    /**
     * 编码生成二维码图片,直接返回图片对象
     * @param content  二维码文字内容
     * @param logoPath  logo图片路径
     * @param needCompress  是否需要压缩
     * @return
     * @throws Exception
     */
    public static BufferedImage encode(String content, String logoPath, boolean needCompress) throws Exception {
        return createImage(content, logoPath, needCompress);
    }

    /**
     * 二维码解码读取文字信息
     * @param image 二维码图片
     * @return
     * @throws Exception
     */
    public static String decode(BufferedImage image) throws Exception {
        if (image == null) { return null; }
        BufferedImageLuminanceSource source = new BufferedImageLuminanceSource(image);
        BinaryBitmap bitmap = new BinaryBitmap(new HybridBinarizer(source));
        Hashtable hints = new Hashtable();
        //设置编码方式
        hints.put(DecodeHintType.CHARACTER_SET, CHARSET);
        //优化精度,解决com.google.zxing.NotFoundException
        hints.put(DecodeHintType.TRY_HARDER, Boolean.TRUE);
        //开启PURE_BARCODE模式(复杂模式)
        hints.put(DecodeHintType.PURE_BARCODE, Boolean.TRUE);
        Result result = new MultiFormatReader().decode(bitmap, hints);
        return result.getText();
    }

    /**
     * 二维码解码读取文字信息
     * @param file 二维码图片
     * @return
     * @throws Exception
     */
    public static String decode(File file) throws Exception {
        return decode(ImageIO.read(file));
    }

    /**
     * 二维码解码读取文字信息
     * @param base64Str  二维码图片base64格式字符串
     * @return
     * @throws Exception
     */
    public static String decode(String base64Str) throws Exception{
        return decode(ImageIO.read(new ByteArrayInputStream(Base64.getDecoder().decode(base64Str))));
    }

    /**
     * 创建文件夹
     * @param destPath  文件夹路径
     */
    public static void mkdirs(String destPath) {
        File file = new File(destPath);
        // 当文件夹不存在时,mkdirs会自动创建多层目录,区别于mkdir.(mkdir如果父目录不存在则会抛出异常)
        if (!file.exists() && !file.isDirectory()) {
            file.mkdirs();
        }
    }

    public static class BufferedImageLuminanceSource extends LuminanceSource {

        private final BufferedImage image;
        private final int left;
        private final int top;

        public BufferedImageLuminanceSource(BufferedImage image) {
            this(image, 0, 0, image.getWidth(), image.getHeight());
        }

        public BufferedImageLuminanceSource(BufferedImage image, int left, int top, int width, int height) {
            super(width, height);

            int sourceWidth = image.getWidth();
            int sourceHeight = image.getHeight();
            if (left + width > sourceWidth || top + height > sourceHeight) {
                throw new IllegalArgumentException("Crop rectangle does not fit within image data.");
            }

            for (int y = top; y < top + height; y++) {
                for (int x = left; x < left + width; x++) {
                    if ((image.getRGB(x, y) & 0xFF000000) == 0) {
                        image.setRGB(x, y, 0xFFFFFFFF); // = white
                    }
                }
            }

            this.image = new BufferedImage(sourceWidth, sourceHeight, BufferedImage.TYPE_BYTE_GRAY);
            this.image.getGraphics().drawImage(image, 0, 0, null);
            this.left = left;
            this.top = top;
        }

        @Override
        public byte[] getRow(int y, byte[] row) {
            if (y < 0 || y >= getHeight()) {
                throw new IllegalArgumentException("Requested row is outside the image: " + y);
            }
            int width = getWidth();
            if (row == null || row.length < width) {
                row = new byte[width];
            }
            image.getRaster().getDataElements(left, top + y, width, 1, row);
            return row;
        }

        @Override
        public byte[] getMatrix() {
            int width = getWidth();
            int height = getHeight();
            int area = width * height;
            byte[] matrix = new byte[area];
            image.getRaster().getDataElements(left, top, width, height, matrix);
            return matrix;
        }

        @Override
        public boolean isCropSupported() {
            return true;
        }

        @Override
        public LuminanceSource crop(int left, int top, int width, int height) {
            return new BufferedImageLuminanceSource(image, this.left + left, this.top + top, width, height);
        }

        @Override
        public boolean isRotateSupported() {
            return true;
        }

        @Override
        public LuminanceSource rotateCounterClockwise() {
            int sourceWidth = image.getWidth();
            int sourceHeight = image.getHeight();
            AffineTransform transform = new AffineTransform(0.0, -1.0, 1.0, 0.0, 0.0, sourceWidth);
            BufferedImage rotatedImage = new BufferedImage(sourceHeight, sourceWidth, BufferedImage.TYPE_BYTE_GRAY);
            Graphics2D g = rotatedImage.createGraphics();
            g.drawImage(image, transform, null);
            g.dispose();
            int width = getWidth();
            return new BufferedImageLuminanceSource(rotatedImage, top, sourceWidth - (left + width), getHeight(), width);
        }

    }
}

主要方法功能描述如下:

  • createImage():生成二维码图片

createImage()重载了两个方法,其中 createImage(String content, String logoPath, boolean needCompress, ErrorCorrectionLevel level)方法可通过level参数调节二维码容错率;createImage(String content, String logoPath, boolean needCompress)方法使用固定的容错率:ErrorCorrectionLevel.H。

  • insertImage():往二维码插入图片(logo),可以调用此方法在二维码中间位置插入一个logo
  • encode():进行二维码编码
    此方法重载了几个方法返回不同的结果,如:直接生成二维码图片固化到硬盘;生成BASE64字符串返回;直接返回BufferedImage图片对象。
  • decode():对二维码进行解码,获取文字内容

3、编写测试代码

编写测试代码进行不同返回对象的测试,测试代码如下所示

public static void main(String[] args) throws Exception {
        // 存放在二维码中的内容
        String text = "使用 com.google.zxing 依赖生成二维码图片,encode()方法生成二维码图片,decode()方法将二维码解码获取文字内容\n" ;
        // 嵌入二维码的图片(logo)路径
        String imgPath = "E:/templates/0.jpg";
        // 生成的二维码的路径及名称
        String destPath = "E:/templates/qrcode/1.jpg";
        // 生成的二维码的路径及名称
        String destPath1 = "E:/templates/qrcode/2.jpg";

        //生成不带logo的二维码
        QrCodeUtil.encode(text, null, destPath, true, ErrorCorrectionLevel.L);

        //生成带logo的二维码
        QrCodeUtil.encode(text, imgPath, destPath1, true, ErrorCorrectionLevel.L);

        // 解析二维码
        String str = QrCodeUtil.decode(new File(destPath1));
        // 打印出解析出的内容
        System.out.println(str);

        //图片生成base64字符串
        String base64 = QrCodeUtil.encode(text, imgPath, true, ErrorCorrectionLevel.L, "png");
        System.out.println("\nbase64字符串:" + base64);
        System.out.println("\n二维码解码内容:" + QrCodeUtil.decode(base64));

    }

4、可能遇到的问题

  1. 解析二维码报错com.google.zxing.NotFoundException
    原因:二维码所有的bit都是0,生成二维码时白色像素使用透明色填充。在显示时因为背景是白色,所以看上去和用手机扫都没有问题,但是在代码识别的时候会把透明色识别为黑色,这样就导致整个二维码图片全是黑色像素,抛出com.google.zxing.NotFoundException异常。
    解决方案:优化精度,解码时配置参数
        //优化精度,解决com.google.zxing.NotFoundException
        hints.put(DecodeHintType.TRY_HARDER, Boolean.TRUE);
        //开启PURE_BARCODE模式(复杂模式)
        hints.put(DecodeHintType.PURE_BARCODE, Boolean.TRUE);
  1. 扫码时由于文字太多无法识别
    解决方案: 调整ErrorCorrectionLevel 参数,适当调整容错率(7%~30%)。
    对应四个级别:
    ErrorCorrectionLevel.L (7%)
    ErrorCorrectionLevel.M (15%)
    ErrorCorrectionLevel.Q (25%)
    ErrorCorrectionLevel.H (30%)
    容错率越高,二维码的有效像素点越多。
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,386评论 6 479
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,939评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,851评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,953评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,971评论 5 369
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,784评论 1 283
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,126评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,765评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,148评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,744评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,858评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,479评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,080评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,053评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,278评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,245评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,590评论 2 343

推荐阅读更多精彩内容