开发 Android 时常会需要应用到条码读取或是产生的功能,如果是自己写一支条码读取和产生的功能的话会牵扯到许多相机应用、图像辨识以及条码结构的问题需要去了解,费时费力,也不见得能做得出来。因此本篇文章将提供一个比较快速的方式,在 Android App 中实作出条码扫描和产生的功能。

CodeScanner

CodeScanner 是一个 Java 类别(Class),可以快速地使用简易条码扫描仪来协助 App 扫描或是读取条码。

程序如下:

package org.magiclen.code;

import java.util.List;
import java.util.Locale;

import android.app.Activity;
import android.app.AlertDialog;
import android.app.Fragment;
import android.content.DialogInterface;
import android.content.Intent;
import android.content.pm.PackageManager;
import android.content.pm.ResolveInfo;
import android.net.Uri;

/**
 * 条码扫描
 *
 * @author magiclen
 *
 */
public class CodeScanner {

    // -----类别常数-----
    private static final String SCAN_MODES = "SCAN_MODE";
    private static final String USE_CROP = "USE_CROP";
    private static final String SCAN_PREFIX = "SCAN_PREFIX";

    private static final String[] STRING_INSTALL_TITLE = new String[]{"Install Barcode Scanner", "安装条码扫描仪"};
    private static final String[] STRING_INSTALL_CLOSE = new String[]{"Close", "关闭"};
    private static final String[] STRING_INSTALL_INSTALL = new String[]{"Install", "安装"};
    private static final String[] STRING_INSTALL_MESSAGE = new String[]{"In order to scan barcode, you need to install Easy Barcode Scanner first.", "为了能够扫描条码,您需要一个简易条码扫描仪。"};
    private static final String[] STRING_URL_EASY_BARCODE_SCANNER = new String[]{"https://play.google.com/store/apps/details?id=org.magiclen.barcodescanner"};

    // -----类别枚举-----
    public static enum Mode {
        PRODUCT_MODE, SCAN_MODE, ONE_D_MODE, TWO_D_MODE, QR_CODE_MODE, DATA_MATRIX_MODE;
    }

    // -----类别界面-----
    public static interface CodeReaderListener {

        public void codeReadResult(final String type, final String data);
    }

    // -----类别变量-----
    private static boolean chinese = isChinese();

    // -----类别方法-----
    private static boolean isChinese() {
        final Locale locale = Locale.getDefault();
        return locale.equals(Locale.CHINESE) || locale.equals(Locale.SIMPLIFIED_CHINESE) || locale.equals(Locale.TRADITIONAL_CHINESE);
    }

    private static String getString(final String[] string) {
        int index = chinese ? 1 : 0;
        if (index >= string.length) {
            index = 0;
        }
        return string[index];
    }

    private static int ACTIVITY_SCANNER = 9974;

    // -----对象变量-----
    private Activity activity;
    private Fragment fragment;
    private CodeReaderListener codeReaderListener;
    private Mode mode = Mode.SCAN_MODE;
    private boolean crop = false;
    private String scanPrefix = null;

    // -----构造器-----
    public CodeScanner(final Activity activity, final CodeReaderListener codeReaderListener) {
        this.activity = activity;
        this.codeReaderListener = codeReaderListener;
    }

    public CodeScanner(final Fragment fragment, final CodeReaderListener codeReaderListener) {
        this(fragment.getActivity(), codeReaderListener);
        this.fragment = fragment;
    }

    // -----对象方法-----
    public Activity getActivity() {
        if (activity != null) {
            return activity;
        } else {
            return null;
        }
    }

    public CodeReaderListener getCodeReaderListener() {
        return codeReaderListener;
    }

    public void setCrop(final boolean crop) {
        this.crop = crop;
    }

    public boolean getCrop() {
        return crop;
    }

    public void setMode(final Mode mode) {
        if (mode != null) {
            this.mode = mode;
        } else {
            this.mode = Mode.SCAN_MODE;
        }
    }

    public Mode getMode() {
        return mode;
    }

    public void setScanPrefix(final String scanPrefix) {
        this.scanPrefix = scanPrefix;
    }

    public String getScanPrefix() {
        return scanPrefix;
    }

    public boolean scan() {
        final PackageManager packageManager = activity.getPackageManager();
        final Intent easyBarcodeScanner = new Intent("org.magiclen.barcodescanner.SCAN");
        easyBarcodeScanner.setPackage("org.magiclen.barcodescanner");
        final List<ResolveInfo> list = packageManager.queryIntentActivities(easyBarcodeScanner, PackageManager.MATCH_DEFAULT_ONLY);
        if (list.size() > 0) {
            easyBarcodeScanner.putExtra(SCAN_MODES, mode.toString());
            easyBarcodeScanner.putExtra(USE_CROP, crop);
            easyBarcodeScanner.putExtra(SCAN_PREFIX, scanPrefix);
            if (fragment != null) {
                fragment.startActivityForResult(easyBarcodeScanner, ACTIVITY_SCANNER);
            } else {
                activity.startActivityForResult(easyBarcodeScanner, ACTIVITY_SCANNER);
            }
            return true;
        } else {
            new AlertDialog.Builder(activity).setTitle(getString(STRING_INSTALL_TITLE)).setMessage(getString(STRING_INSTALL_MESSAGE)).setPositiveButton(getString(STRING_INSTALL_INSTALL), new DialogInterface.OnClickListener() {

                @Override
                public void onClick(final DialogInterface dialog, final int which) {
                    final String url = getString(STRING_URL_EASY_BARCODE_SCANNER);
                    final Intent openURLIntent = new Intent(Intent.ACTION_VIEW);
                    openURLIntent.setData(Uri.parse(url));
                    final List<ResolveInfo> list = packageManager.queryIntentActivities(openURLIntent, PackageManager.MATCH_DEFAULT_ONLY);
                    if (list.size() > 0) {
                        final Intent destIntent = Intent.createChooser(openURLIntent, null);
                        activity.startActivity(destIntent);
                    }
                }

            }).setNegativeButton(getString(STRING_INSTALL_CLOSE), null).show();
            return false;
        }
    }

    public void onActivityResult(final int requestCode, final int resultCode, final Intent data) {
        if (requestCode == ACTIVITY_SCANNER && codeReaderListener != null) {
            if (resultCode == Activity.RESULT_OK) {
                final String resultType = data.getStringExtra("code_type");
                final String resultData = data.getStringExtra("code_data");
                codeReaderListener.codeReadResult(resultType, resultData);
            } else {
                codeReaderListener.codeReadResult(null, null);
            }
        }
    }
}

CodeScanner 使用方式十分简单,一开始要先传入 Activity 或是 Fragment 以及 CodeReaderListener 将其实体化(new)出来,如下:

CodeReaderListener codeReaderListener = new CodeReaderListener(){
    @Override
    public void codeReadResult(final String type, final String data) {
        // type就是条码的类型,EAN、ISBN、QRCode...等等
        // data就是条码的内容,为任意字符串
        // 若扫描未完成,type和data的值将为null
    }
};
...
CodeScanner cs = new CodeScanner(activity, codeReaderListener);

接着可以对 CodeScanner 进行一些设置,像是要扫描的条码类型(一维条码、二维条码、QR Code 等)、要接受的条码内容(条码内容的开头必须符合设置才会完成扫描)、是否直接使用小范围扫描(增大扫描成功率)。如下:

cs.setMode(Mode.QR_CODE_MODE);
cs.setScanPrefix(QR_KEY);
cs.setCrop(true);

再来覆写(Override) Activity 或是 Fragment 的 onActivityResult 方法,将 CodeScanner 的 onActivityResult 方法加进去。如下:

@Override
protected void onActivityResult(final int requestCode, final int resultCode, final Intent data) {
    cs.onActivityResult(requestCode, resultCode, data);
    super.onActivityResult(requestCode, resultCode, data);
}

之后就可以在任何想要打开扫描的地方调用 CodeScanner 对象的 scan 方法,就可以开始进行条码扫描了。如下:

cs.scan();

不管扫描有没有结束,当扫描仪被关闭的时候,都会调用 CodeReaderListener 的 codeReadResult 方法,可处理后续的动作。

QRCodeEncoder

QRCodeEncoder 是一个 Java 类别(Class),可以快速地使用简易条码扫描仪来协助 App 产生 QR Code。

程序如下:

package org.magiclen.code;

import java.util.List;
import java.util.Locale;

import android.app.Activity;
import android.app.AlertDialog;
import android.content.DialogInterface;
import android.content.Intent;
import android.content.pm.PackageManager;
import android.content.pm.ResolveInfo;
import android.net.Uri;

/**
 * QR Code产生
 *
 * @author magiclen
 *
 */
public class QRCodeEncoder {

    // -----类别常数-----
    private static final String ENCODE_DATA = "ENCODE_DATA";

    private static final String[] STRING_INSTALL_TITLE = new String[]{"Install Barcode Scanner", "安装条码扫描仪"};
    private static final String[] STRING_INSTALL_CLOSE = new String[]{"Close", "关闭"};
    private static final String[] STRING_INSTALL_INSTALL = new String[]{"Install", "安装"};
    private static final String[] STRING_INSTALL_MESSAGE = new String[]{"In order to see the QR code, you need to install Easy Barcode Scanner first.", "为了能够看到QR Code,您需要安装简易条码扫描仪。"};
    private static final String[] STRING_URL_EASY_BARCODE_SCANNER = new String[]{"https://play.google.com/store/apps/details?id=org.magiclen.barcodescanner"};

    // -----类别变量-----
    private static boolean chinese = isChinese();

    // -----类别方法-----
    private static boolean isChinese() {
        final Locale locale = Locale.getDefault();
        return locale.equals(Locale.CHINESE) || locale.equals(Locale.SIMPLIFIED_CHINESE) || locale.equals(Locale.TRADITIONAL_CHINESE);
    }

    private static String getString(final String[] string) {
        int index = chinese ? 1 : 0;
        if (index >= string.length) {
            index = 0;
        }
        return string[index];
    }

    public static boolean encode(final Activity activity, final String text) {
        final PackageManager packageManager = activity.getPackageManager();
        final Intent easyBarcodeScanner = new Intent("org.magiclen.barcodescanner.ENCODE");
        easyBarcodeScanner.setPackage("org.magiclen.barcodescanner");
        final List<ResolveInfo> list = packageManager.queryIntentActivities(easyBarcodeScanner, PackageManager.MATCH_DEFAULT_ONLY);
        if (list.size() > 0) {
            easyBarcodeScanner.putExtra(ENCODE_DATA, text);
            activity.startActivity(easyBarcodeScanner);
            return true;
        } else {
            new AlertDialog.Builder(activity).setTitle(getString(STRING_INSTALL_TITLE)).setMessage(getString(STRING_INSTALL_MESSAGE)).setPositiveButton(getString(STRING_INSTALL_INSTALL), new DialogInterface.OnClickListener() {

                @Override
                public void onClick(final DialogInterface dialog, final int which) {
                    final String url = getString(STRING_URL_EASY_BARCODE_SCANNER);
                    final Intent openURLIntent = new Intent(Intent.ACTION_VIEW);
                    openURLIntent.setData(Uri.parse(url));
                    final List<ResolveInfo> list = packageManager.queryIntentActivities(openURLIntent, PackageManager.MATCH_DEFAULT_ONLY);
                    if (list.size() > 0) {
                        final Intent destIntent = Intent.createChooser(openURLIntent, null);
                        activity.startActivity(destIntent);
                    }
                }

            }).setNegativeButton(getString(STRING_INSTALL_CLOSE), null).show();
            return false;
        }
    }

}

QRCodeEncoder 不需要实体化即可使用,只要调用 encode 方法并传入 activity 和要产生的条码内容,就可以产生 QR Code 出来。如下:

QRCodeEncoder.encode(activity, text);