Java生成二维码的两种方法

本文介绍Java生成二维码的两种方法，这两种方法都依赖于google提供的二维码依赖包。
一种是自己写工具类，代码可以网上抄。
另一种是使用hutool第三方工具类的依赖包，不用自己抄代码。

一、自定义工具类

自定义工具包就是借助google生成二维码的依赖包，然后自己写工具类。

<dependency>
 <groupId>com.google.zxinggroupId>
  <artifactId>coreartifactId>
  <version>3.4.1version>
dependency>

<dependency>
  <groupId>com.google.zxinggroupId>
  <artifactId>javaseartifactId>
  <version>3.4.1version>
dependency>

工具类

public class MyQrCodeUtil {

    //CODE_WIDTH：二维码宽度，单位像素
    private static final int CODE_WIDTH = 400;
    //CODE_HEIGHT：二维码高度，单位像素
    private static final int CODE_HEIGHT = 400;
    //FRONT_COLOR：二维码前景色，0x000000 表示黑色
    private static final int FRONT_COLOR = 0x000000;
    //BACKGROUND_COLOR：二维码背景色，0xFFFFFF 表示白色
    //演示用 16 进制表示，和前端页面 CSS 的取色是一样的，注意前后景颜色应该对比明显，如常见的黑白
    private static final int BACKGROUND_COLOR = 0xFFFFFF;

    public static void createCodeToFile(String content, File codeImgFileSaveDir, String fileName) {
        try {
            if (StringUtils.isBlank(content) || StringUtils.isBlank(fileName)) {
                return;
            }
            content = content.trim();
            if (codeImgFileSaveDir==null || codeImgFileSaveDir.isFile()) {
                //二维码图片存在目录为空，默认放在桌面...
                codeImgFileSaveDir = FileSystemView.getFileSystemView().getHomeDirectory();
            }
            if (!codeImgFileSaveDir.exists()) {
                //二维码图片存在目录不存在，开始创建...
                codeImgFileSaveDir.mkdirs();
            }

            //核心代码-生成二维码
            BufferedImage bufferedImage = getBufferedImage(content);

            File codeImgFile = new File(codeImgFileSaveDir, fileName);
            ImageIO.write(bufferedImage, "png", codeImgFile);

            System.out.println("二维码图片生成成功：" + codeImgFile.getPath());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    /**
     * 生成二维码并输出到输出流, 通常用于输出到网页上进行显示，输出到网页与输出到磁盘上的文件中，区别在于最后一句 ImageIO.write
     * write(RenderedImage im,String formatName,File output)：写到文件中
     * write(RenderedImage im,String formatName,OutputStream output)：输出到输出流中
     * @param content  ：二维码内容
     * @param outputStream ：输出流，比如 HttpServletResponse 的 getOutputStream
     */
    public static void createCodeToOutputStream(String content, OutputStream outputStream) {
        try {
            if (StringUtils.isBlank(content)) {
                return;
            }
            content = content.trim();
            //核心代码-生成二维码
            BufferedImage bufferedImage = getBufferedImage(content);

            //区别就是这一句，输出到输出流中，如果第三个参数是 File，则输出到文件中
            ImageIO.write(bufferedImage, "png", outputStream);

            System.out.println("二维码图片生成到输出流成功...");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    //核心代码-生成二维码
    private static BufferedImage getBufferedImage(String content) throws WriterException {

        //com.google.zxing.EncodeHintType：编码提示类型,枚举类型
        Map<EncodeHintType, Object> hints = new HashMap();

        //EncodeHintType.CHARACTER_SET：设置字符编码类型
        hints.put(EncodeHintType.CHARACTER_SET, "UTF-8");

        //EncodeHintType.ERROR_CORRECTION：设置误差校正
        //ErrorCorrectionLevel：误差校正等级，L = ~7% correction、M = ~15% correction、Q = ~25% correction、H = ~30% correction
        //不设置时，默认为 L 等级，等级不一样，生成的图案不同，但扫描的结果是一样的
        hints.put(EncodeHintType.ERROR_CORRECTION, ErrorCorrectionLevel.M);

        //EncodeHintType.MARGIN：设置二维码边距，单位像素，值越小，二维码距离四周越近
        hints.put(EncodeHintType.MARGIN, 1);

        MultiFormatWriter multiFormatWriter = new MultiFormatWriter();
        BitMatrix bitMatrix = multiFormatWriter.encode(content, BarcodeFormat.QR_CODE, CODE_WIDTH, CODE_HEIGHT, hints);
        BufferedImage bufferedImage = new BufferedImage(CODE_WIDTH, CODE_HEIGHT, BufferedImage.TYPE_INT_BGR);
        for (int x = 0; x < CODE_WIDTH; x++) {
            for (int y = 0; y < CODE_HEIGHT; y++) {
                bufferedImage.setRGB(x, y, bitMatrix.get(x, y) ? FRONT_COLOR : BACKGROUND_COLOR);
            }
        }
        return bufferedImage;
    }

}

测试代码

public class App 
{
    public static void main( String[] args )
    {
        //使用自定义工具包生成二维码
        File myUtilFileDir = new File("E:\\files");
        MyQrCodeUtil.createCodeToFile("123",myUtilFileDir,"qrcode1.png");
    }
}

二、使用第三方工具类

hutool-all依赖包已经封装好了一个生成二维码的工具类，但他同样依赖于google提供的生成二维码的依赖包。

<dependency>
 <groupId>cn.hutoolgroupId>
  <artifactId>hutool-allartifactId>
  <version>5.8.12version>
dependency>

测试代码

public class App 
{
    public static void main( String[] args )
    {
        System.out.println( "Hello World!" );

        //使用自定义工具包生成二维码
        File myUtilFileDir = new File("E:\\files");
        MyQrCodeUtil.createCodeToFile("123",myUtilFileDir,"qrcode1.png");

        //使用hutool工具包生成二维码
        File hutoolFile = new File("E:\\files\\qrcode2.png");
        QrConfig qrConfig = QrConfig.create();
        qrConfig.setBackColor(Color.WHITE);
        qrConfig.setForeColor(Color.BLACK);
        QrCodeUtil.generate("123", qrConfig,hutoolFile);
    }
}

关于生成二维码的一些讨论

前端生成二维码还是后端生成二维码

在后端生成二维码，和传送二维码给前端其实都是对服务器有压力的做法，所以一般情况下我觉得将二维码的内容传递给前端，交给前端生成比较好，降低服务器压力，减小传输成本。
不过，如果二维码内容信息敏感，比如用户的关键数据，支付信息，支付凭证，密钥之类的，则不应该传递给前端生成。

致谢

Java生成二维码的几种实现方式(基于Spring Boot)
com.google.zxing 二维码生成与解析