11月 1, 2017 / 最終更新日 : 4月 1, 2023 りゅーたプログラミング

AndroidでQRコードのバイナリデータを取得する

AndroidでもiOSでもQRコードリーダアプリがたくさんありますが、QRコードのテキストデータ(URLとか)を読み取るものがほとんどと思います。

でも、QRコード自体はバイナリデータを含むことができます。3DSのソフトが発行するQRコードとかね。

今回はそんなQRコードのバイナリデータを Androidで取得する方法を紹介します。

「いや、サンプルとかいいからバイナリデータを読めるアプリが欲しいんだ」という方は、今回紹介するコードを組み込んだアプリを私がリリースしてますのでどうぞ

田舎からGeekを目指す

バイナリQRコードリーダー/ライター「QRefine」をリリースしました。

https://ryuta46.com/185

「QRefine」というアプリをリリースしました。Android/iOS両方あります。特長や使い方は特設ページを用意したので、そちらをご覧ください。このアプリを作ることになった経緯を書いておきます。私はゲームが好きで、とりわけ3DSのゲームなどを良くするのですが、最...

Android/iOS両方あるよ。是非ともご利用ください。ぜひ！

気を取り直して、AndroidでQRコードのバイナリデータを取得する方法です。

例によってコードの全文はgithubにあげてますのでそちらも参考にしてください。

動作確認環境

macOS High Sierra 10.13.1
Android Studio 3.0
ZXing Android Embedded 3.5.0

準備

QRコードの読み取りには、ZXingというライブラリを使います。

ZXing はGoogleが開発している、様々な1次元/2次元バーコードの読み書きができるオープンソースのライブラリです。

多くの言語にポーティングされており、ZXingを直接利用することも出来ますが、ここではZXingをAndroid用により扱いやすくしたZXing Android Embeddedというライブラリを使います。

ZXing Android Embedded のライブラリの Github にも導入方法ありますが、アプリケーションの build.gradle で

dependencies {
    ....
    implementation 'com.journeyapps:zxing-android-embedded:3.5.0'
}

dependencies {

....

implementation 'com.journeyapps:zxing-android-embedded:3.5.0'

}

を追加することで使えるようになります。(Android Studio 3.0 より前のバージョンの場合は implementation ではなく compile)

以前は ZXing のコアライブラリもアプリに取り込む必要があったのですが、ZXing Android Embedded 3.0 以降はライブラリ単体のみ取り込めば動作するようになったそうです。

コード

ZXing Android Embedded の Activity を呼び出して使う方法もありますが、レイアウトに自由度がある、DecoratedBarcodeView というビューを配置する方法を紹介します。

レイアウトファイルに DecoratedBarcodeView を追加

通常のビューと同様に、レイアウトファイルで DecoratedBarcodeView を配置します。

例えば下記のような感じで。

&lt;?xml version="1.0" encoding="utf-8"?&gt;
&lt;android.support.constraint.ConstraintLayout
    xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context=".MainActivity"&gt;

    &lt;com.journeyapps.barcodescanner.DecoratedBarcodeView
        android:id="@+id/decoratedBarcodeView"
        android:layout_width="0dp"
        android:layout_height="0dp"
        app:layout_constraintBottom_toTopOf="parent"
        app:layout_constraintLeft_toLeftOf="parent"
        app:layout_constraintRight_toRightOf="parent"
        app:layout_constraintTop_toTopOf="parent"
        /&gt;

&lt;/android.support.constraint.ConstraintLayout&gt;

<?xml version="1.0" encoding="utf-8"?>

<android.support.constraint.ConstraintLayout

xmlns:android="http://schemas.android.com/apk/res/android"

xmlns:app="http://schemas.android.com/apk/res-auto"

xmlns:tools="http://schemas.android.com/tools"

android:layout_width="match_parent"

android:layout_height="match_parent"

tools:context=".MainActivity">

<com.journeyapps.barcodescanner.DecoratedBarcodeView

android:id="@+id/decoratedBarcodeView"

android:layout_width="0dp"

android:layout_height="0dp"

app:layout_constraintBottom_toTopOf="parent"

app:layout_constraintLeft_toLeftOf="parent"

app:layout_constraintRight_toRightOf="parent"

app:layout_constraintTop_toTopOf="parent"

</android.support.constraint.ConstraintLayout>

このビューを配置した範囲にカメラ画像が写ります。特に設定とかしなくてもガイドとメッセージが出ます。

こんな感じで。(下部の START SCAN のボタンは自分でつけてます。)

コード追加

続いて、QRコード読み取りのコードを追加します。

パーミッションチェックなどを省いて、QRコード処理部分だけを抜き出します。

private var qrReaderView: DecoratedBarcodeView? = null
private var startButton: Button? = null

override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    setContentView(R.layout.activity_main)

    qrReaderView = findViewById(R.id.decoratedBarcodeView)
    startCapture()
}

private fun startCapture() {
    startButton?.isEnabled = false

    qrReaderView?.decodeSingle(object : BarcodeCallback {
        override fun barcodeResult(result: BarcodeResult?) {
            stopCapture()
            if (result == null) {
                // no result
                Log.w(TAG, "No result")
                return
            }
            Log.i(TAG, "QRCode Result: ${result.text}")
            val bytes = result.resultMetadata[ResultMetadataType.BYTE_SEGMENTS] as? List&lt;*&gt;
            val data = bytes?.get(0) as? ByteArray ?: return

            // print result
            val resultString = StringBuffer()
            data.map { byte -&gt;
                resultString.append(String.format("0x%02X,", byte))            
            }
            Log.i(TAG, resultString.toString())
        }
        override fun possibleResultPoints(resultPoints: MutableList&lt;ResultPoint&gt;?) { }
    })
    qrReaderView?.resume()
}

private var qrReaderView: DecoratedBarcodeView? = null

private var startButton: Button? = null

override fun onCreate(savedInstanceState: Bundle?) {

super.onCreate(savedInstanceState)

setContentView(R.layout.activity_main)

qrReaderView = findViewById(R.id.decoratedBarcodeView)

startCapture()

}

private fun startCapture() {

startButton?.isEnabled = false

qrReaderView?.decodeSingle(object : BarcodeCallback {

override fun barcodeResult(result: BarcodeResult?) {

stopCapture()

if (result == null) {

// no result

Log.w(TAG, "No result")

return

}

Log.i(TAG, "QRCode Result: ${result.text}")

val bytes = result.resultMetadata[ResultMetadataType.BYTE_SEGMENTS] as? List<*>

val data = bytes?.get(0) as? ByteArray ?: return

// print result

val resultString = StringBuffer()

data.map { byte ->

resultString.append(String.format("0x%02X,", byte))

}

Log.i(TAG, resultString.toString())

}

override fun possibleResultPoints(resultPoints: MutableList<ResultPoint>?) { }

})

qrReaderView?.resume()

}

手順としては、

DecoratedBarcodeView を取得
DecoratedBarcodeView#decodeSingle でリスナ登録
DecoratedBarcodeView#resume で読み取り開始

です。

リスナで読み取り結果が BarcodeResult というクラスで通知されるので、そこから中身を取り出していきます。

よく利用されるテキストデータは、text というプロパティで取得できますが、バイナリデータは resultMetadata という別のプロパティにmapの一部として格納されています。

バイナリデータは、ResultMetadataType.BYTE_SEGMENTSというキーの値として保存されています。(バイト配列の配列として保存されています)

読み取り結果については ZXing のコアライブラリの方の Result クラスに対応していると思われますので、ResultクラスのAPIリファレンスも合わせて読むと理解が深まるかと。

細かい部分は github をご覧ください。

ちなみに上記サンプルはKotlinで書いてるので、Javaで同様のことをする場合はgetText()、getResultMetadata()で取得できます。

テスト

テキストデータから生成されたQRコード

こちらの画像のQRコードを読み込んだ場合。

このサイトのURLを埋め込んだソースになります。

結果のログ

I/MainActivity: QRCode Result: http://ryuta46.com/qrefine
I/MainActivity: 0x68,0x74,0x74,0x70,0x3A,0x2F,0x2F,0x72,0x79,0x75,0x74,0x61,0x34,0x36,0x2E,0x63,0x6F,0x6D,0x2F,0x71,0x72,0x65,0x66,0x69,0x6E,0x65,

I/MainActivity: QRCode Result: http://ryuta46.com/qrefine

I/MainActivity: 0x68,0x74,0x74,0x70,0x3A,0x2F,0x2F,0x72,0x79,0x75,0x74,0x61,0x34,0x36,0x2E,0x63,0x6F,0x6D,0x2F,0x71,0x72,0x65,0x66,0x69,0x6E,0x65,

テキストでURLが入っていて、バイナリデータとしてはURLがそのままコードになっている感じですね。

バイナリデータから生成されたQRコード

こちらの以前3DSのゲームアイテム配布用に作られたバイナリのQRコードの場合。

結果のログ

I/MainActivity: QRCode Result: qb��h�"~�����2�j��I+�*4/�bw�3�03ڼ��i�~ELU���u/L?�\BPBe�_3�wiJ�z��7r��̝o�W�)�'�6�H�m����&amp;*�-l���X��;�e��D�4}��0�:U��P�!Y; ���\Sziߙj����&lt;�4r���6�v0ω��V��$��LX&gt;N�N� ,�-&amp;����X&gt;N�N� ,�-&amp;����X&gt;N�N� ,�-&amp;����
I/MainActivity: 0x0C,0x71,0x62,0xED,0xD2,0x68,0xF8,0x22,0x7E,0x0A,0xDA,0xCA,0xE9,0x1A, ...(以下略)...

I/MainActivity: QRCode Result: qb��h�"~��2�j��I+�*4/�bw�3�03ڼ��i�~ELU��u/L?�\BPBe�_3�wiJ�z��7r��̝o�W�)�'�6�H�m��&*�-l��X��;�e��D�4}��0�:U��P�!Y; ��\Sziߙj��<�4r��6�v0ω��V��$��LX>N�N� ,�-&��X>N�N� ,�-&��X>N�N� ,�-&��

I/MainActivity: 0x0C,0x71,0x62,0xED,0xD2,0x68,0xF8,0x22,0x7E,0x0A,0xDA,0xCA,0xE9,0x1A, ...(以下略)...

テキストの方は化けてしまっていますが、バイナリ列は問題なく取得できていました。当然ながら、何を意味するバイナリ列なのかはわかりません。

さいごに

QRコード回りはAndroidもiOSでも標準ライブラリである程度読み込みなどできるようになってきてますが、ことバイナリデータになるとなかなか取得する方法がないのが現状です。

今回はAndroidでしたが、ZXing を使うとiOSでも同様のことができます。

今回の記事で反響がありそうであれば、iOS版の方も書いてみたいと思います。

2018/02/10 追記
そこそこ反響があったので、iOS版を書きました。

田舎からGeekを目指す

iOSでQRコードのバイナリデータを取得する

https://ryuta46.com/963

以前書いた Android で QR コードのバイナリデータを取得するサンプルの、iOS 版です。以前書いた記事はこちらiOSの方もQRコードのバイナリデータを読み込む方法がなかなか見つからなかったので、サンプルコードを提示しておきます。QRコードのバイナリデータを読み...

最後まで読んでいただきありがとうございます。このブログを「いいな」と感じていただけましたら、Twiter にてフォローいただけるとうれしいです。ブログ更新情報などもお届けします。

Follow @ryuta461

この記事をシェアする

カテゴリー: プログラミング

タグ: Android Kotlin QRコード