【Spring Boot】QRコードを返却するAPI作る！BASE64で返却します（Java）

投稿者 投稿日:

Spring BootでQRコードを生成し、それをBASE64エンコードし返却してみます

ざっくりした手順は以下のイメージです

  1. QRコードを生成する（例：zxingライブラリなどを使う）
  2. QRコードを画像（BufferedImage）にする
  3. BufferedImageをバイト配列に変換
  4. それをBase64エンコードして、APIレスポンスで返す

では具体的な手順を見ていきましょう

1. build.gradleに設定

build.gradleにQR生成に必要なライブラリを設定します

dependencies {
    implementation 'com.google.zxing:core:3.5.2'
    implementation 'com.google.zxing:javase:3.5.2'
}

2. 機能実装

Spring Bootのコントローラーを実装します

import com.google.zxing.BarcodeFormat;
import com.google.zxing.EncodeHintType;
import com.google.zxing.qrcode.QRCodeWriter;
import com.google.zxing.common.BitMatrix;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.imageio.ImageIO;
import java.awt.image.BufferedImage;
import java.io.ByteArrayOutputStream;
import java.util.Base64;
import java.util.HashMap;
import java.util.Map;

@RestController
public class QrCodeController {

    @GetMapping("/qrcode")
    public String getQrCode() throws Exception {
        String text = "https://example.com"; // QRに埋め込む文字列
        int width = 300;
        int height = 300;

        // QRコード生成
        QRCodeWriter qrCodeWriter = new QRCodeWriter();
        Map<EncodeHintType, Object> hints = new HashMap<>();
        hints.put(EncodeHintType.CHARACTER_SET, "UTF-8");
        BitMatrix bitMatrix = qrCodeWriter.encode(text, BarcodeFormat.QR_CODE, width, height, hints);

        // BitMatrix → BufferedImageに変換
        BufferedImage bufferedImage = new BufferedImage(width, height, BufferedImage.TYPE_INT_RGB);
        for (int x = 0; x < width; x++) {
            for (int y = 0; y < height; y++) {
                bufferedImage.setRGB(x, y, bitMatrix.get(x, y) ? 0xFF000000 : 0xFFFFFFFF);
            }
        }

        // BufferedImage → バイト配列（PNG形式）
        ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
        ImageIO.write(bufferedImage, "PNG", outputStream);

        // バイト配列をBase64エンコード
        byte[] pngData = outputStream.toByteArray();
        String base64Image = Base64.getEncoder().encodeToString(pngData);

        return base64Image;
    }
}

上記実装を行うことで、BASE64にエンコードされたPNG画像が文字列で返却されます

クライアントで以下を実装することで、画面に表示することができます

<img src="data:image/png;base64,ここにBase64文字列" />

こんな感じです

「https://example.com」のページに飛びます

要件に合わせて調整して実装してみてください

是非フォローしてください

最新の情報をお伝えします

投稿者: Mon