Android 扫码 - 集成 zxing-android-embedded

我命由我12345

于 2025-03-20 13:03:30 发布

阅读量906

点赞数 14

分类专栏： Android - 简化库编程文章标签： android java-ee java 安卓 android-studio android studio android jetpack

本文链接：https://blog.csdn.net/weixin_52173250/article/details/146394123

版权

Android - 简化库编程专栏收录该内容

9 篇文章

订阅专栏

一、zxing-android-embedded

1、ZXing 概述

ZXing 是谷歌开源的让开发者更方便使用摄像头的库，而常用的扫码功能就是其中之一
第三方 ZXing 库 zxing-android-embedded，抽取其中的扫码功能单独使用

2、基本使用

（1）依赖与权限配置

在项目级 build.gradle 中配置相关依赖

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

在清单文件 AndroidManifest.xml 中配置相关权限

<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.VIBRATE" />
<uses-permission android:name="android.permission.FLASHLIGHT" />

（2）XML 文件

activity_scanner.xml

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout
    xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:orientation="vertical">

    <Button
        android:id="@+id/btn_my_start_sacn"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:layout_margin="5dp"
        android:text="扫描二维码" />

    <LinearLayout
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:orientation="horizontal"
        android:gravity="center">
        <TextView
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:textSize="20dp"
            android:text="扫描结果：" />

        <TextView
            android:id="@+id/tv_my_sacn_res"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:textSize="20dp"
            android:text="XXX" />
    </LinearLayout>
</LinearLayout>

（3）Java 代码

package com.my.zxing_android_embedded;

import android.app.Activity;
import android.content.Intent;
import android.os.Bundle;
import android.view.View;
import android.widget.Button;
import android.widget.TextView;

import com.google.zxing.integration.android.IntentIntegrator;
import com.google.zxing.integration.android.IntentResult;

public class ScannerActivity extends Activity implements View.OnClickListener {
    private TextView tv_sacn_res;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_scanner);

        Button btn_start_scan = findViewById(R.id.btn_start_sacn);
        tv_sacn_res = findViewById(R.id.tv_sacn_res);
        btn_start_scan.setOnClickListener(this);
    }

    @Override
    public void onClick(View v) {

        IntentIntegrator intentIntegrator = new IntentIntegrator(this);

        // 扫码的类型，一维码、二维码、一 / 二维码，默认一 / 二维码
        // ONE_D_CODE_TYPES：一维码，QR_CODE_TYPES：二维码
//        intentIntegrator.setDesiredBarcodeFormats(IntentIntegrator.ONE_D_CODE_TYPES);

        // 设置提示语，设为""可以置空
        intentIntegrator.setPrompt("请对准二维码");

        // 选择摄像头，可使用前置或者后置
        // 0：前置摄像头，1：后置摄像头
        intentIntegrator.setCameraId(0);

        // 扫描成功的“哔”声，默认开启
        intentIntegrator.setBeepEnabled(false);

        // 初始化扫码
        intentIntegrator.initiateScan();
    }

    @Override
    protected void onActivityResult(int requestCode, int resultCode, Intent data) {

        // 扫完码之后会在 onActivityResult 方法中得到回调结果
        IntentResult result = IntentIntegrator.parseActivityResult(requestCode, resultCode, data);

        if(result != null) {
            if(result.getContents() != null) {
                tv_sacn_res.setText(result.getContents());
            } else {
                tv_sacn_res.setText("扫描结果为空");
            }
        } else {
            super.onActivityResult(requestCode, resultCode, data);
        }
    }
}

3、常见异常

（1）异常描述

Your project has set `android.useAndroidX=true`, but configuration `:zxing-android-embedded:debugRuntimeClasspath` still contains legacy support libraries, which may cause runtime issues.
This behavior will not be allowed in Android Gradle plugin 8.0.
Please use only AndroidX dependencies or set `android.enableJetifier=true` in the `gradle.properties` file to migrate your project to AndroidX (see https://developer.android.com/jetpack/androidx/migrate for more info).

（2）异常处理

在 gradle.properties 文件中添加如下内容

android.enableJetifier=true

二、自定义竖屏扫码

1、概述

在设置 IntentIntegrator 时会有一个 setCaptureActivity 方法，这个方法就是用来设置扫码界面的 Activity，默认会调用作者自己写的 CaptureActivity

2、源码分析

CaptureActivity.java

CaptureManager 是用来开启扫码和处理扫码结果的类
DecoratedBarcodeView 则是一个显示扫码界面的自定义 View

public class CaptureActivity extends Activity {
    private CaptureManager capture;
    private DecoratedBarcodeView barcodeScannerView;
    
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        barcodeScannerView = initializeContent();

        capture = new CaptureManager(this, barcodeScannerView);
        capture.initializeFromIntent(getIntent(), savedInstanceState);
        capture.decode();
    }

    ...
}

DecoratedBarcodeView.java

BarcodeView 为背景
ViewfinderView 为扫描框
TextView 为下方提示文字

public class DecoratedBarcodeView extends FrameLayout {
    private BarcodeView barcodeView;
    private ViewfinderView viewFinder;
    private TextView statusView;

    ...
}

3、实现步骤

新建一个 Activity（XML + Java）
把 CaptureManager 和 DecoratedBarcodeView 复制到自定义的 Activity 中
setCaptureActivity 方法为自定义的 Activity
在清单文件 AndroidManifest.xml 中注册自定义的 Activity

4、具体实现

（1）XML 文件

activity_custom_scanner.xml，自定义竖屏扫码

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout
    xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="match_parent">

    <com.journeyapps.barcodescanner.DecoratedBarcodeView
        android:id="@+id/dbv_custom"
        android:layout_width="match_parent"
        android:layout_height="match_parent" />
</LinearLayout>

activity_my_scanner.xml

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout
    xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:orientation="vertical">

    <Button
        android:id="@+id/btn_my_start_sacn"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:layout_margin="5dp"
        android:text="自定义扫描二维码" />

    <LinearLayout
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:orientation="horizontal"
        android:gravity="center">
        <TextView
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:textSize="20dp"
            android:text="扫描结果：" />

        <TextView
            android:id="@+id/tv_my_sacn_res"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:textSize="20dp"
            android:text="XXX" />
    </LinearLayout>
</LinearLayout>

（2）Java 代码

CustomScannerActivity.java，自定义竖屏扫码

package com.my.zxing_android_embedded;

import android.app.Activity;
import android.os.Bundle;
import android.view.KeyEvent;

import androidx.annotation.NonNull;

import com.journeyapps.barcodescanner.CaptureManager;
import com.journeyapps.barcodescanner.DecoratedBarcodeView;

public class CustomScannerActivity extends Activity {
    private CaptureManager capture;
    private DecoratedBarcodeView barcodeScannerView;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_custom_scanner);

        barcodeScannerView = findViewById(R.id.dbv_custom);

        capture = new CaptureManager(this, barcodeScannerView);
        capture.initializeFromIntent(getIntent(), savedInstanceState);
        capture.decode();
    }

    @Override
    protected void onResume() {
        super.onResume();
        capture.onResume();
    }

    @Override
    protected void onPause() {
        super.onPause();
        capture.onPause();
    }

    @Override
    protected void onDestroy() {
        super.onDestroy();
        capture.onDestroy();
    }

    @Override
    protected void onSaveInstanceState(Bundle outState) {
        super.onSaveInstanceState(outState);
        capture.onSaveInstanceState(outState);
    }

    @Override
    public void onRequestPermissionsResult(int requestCode, @NonNull String permissions[], @NonNull int[] grantResults) {
        capture.onRequestPermissionsResult(requestCode, permissions, grantResults);
    }

    @Override
    public boolean onKeyDown(int keyCode, KeyEvent event) {
        return barcodeScannerView.onKeyDown(keyCode, event) || super.onKeyDown(keyCode, event);
    }
}

MyScannerActivity.java

package com.my.zxing_android_embedded;

import android.app.Activity;
import android.content.Intent;
import android.os.Bundle;
import android.view.View;
import android.widget.Button;
import android.widget.TextView;

import com.google.zxing.integration.android.IntentIntegrator;
import com.google.zxing.integration.android.IntentResult;

public class MyScannerActivity extends Activity implements View.OnClickListener {
    TextView tv_my_sacn_res;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_my_scanner);

        Button btn_my_start_sacn = findViewById(R.id.btn_my_start_sacn);
        tv_my_sacn_res = findViewById(R.id.tv_my_sacn_res);
        btn_my_start_sacn.setOnClickListener(this);
    }

    @Override
    public void onClick(View v) {

        IntentIntegrator intentIntegrator = new IntentIntegrator(this);
        intentIntegrator.setPrompt("请对准二维码");
        intentIntegrator.setCameraId(0);
        intentIntegrator.setBeepEnabled(false);
        intentIntegrator.setCaptureActivity(CustomScannerActivity.class);
        intentIntegrator.initiateScan();
    }

    @Override
    protected void onActivityResult(int requestCode, int resultCode, Intent data) {

        // 扫完码之后会在 onActivityResult 方法中得到回调结果
        IntentResult result = IntentIntegrator.parseActivityResult(requestCode, resultCode, data);

        if(result != null) {
            if(result.getContents() != null) {
                tv_my_sacn_res.setText(result.getContents());
            } else {
                tv_my_sacn_res.setText("扫描结果为空");
            }
        } else {
            super.onActivityResult(requestCode, resultCode, data);
        }
    }
}