二维码扫描库使用

2020-03-29 本文已影响0人奔跑的佩恩

前言

以前使用二维码相关扫描的时候，一直都是调用别人封装的扫描库，但是多少在使用时会感觉有些懵逼，特别是需要自定义扫描界面的时候。于是，由于近段时间也是涉及到扫描的问题。然后结合网上一些大神的处理和一些库对于扫描相关的处理，我自己自己引用zxing库简单封装了一个扫描库，这里对扫描库的使用做下简单介绍。

今天涉及内容：

库依赖
扫描库具备功能介绍
主要类介绍
定制版扫描界面功能的使用
4.1 CaptureActivity 特点
4.2 调用定制版的扫描界面为啥要多写个类继承CaptureActivity
4.3 定制版扫描界面示例
4.4 微调定制版扫描界面参数
自定义扫描界面功能的使用
5.1 BaseCaptureActivity中主要方法介绍
5.2 自定义扫描界面
一维码/二维码生成
扫描及一维码/二维码生成在MainActivity中的使用
效果图和项目结构图

先来波效果图

1.gif

一.库依赖

本扫描库是基于zxing库的封装，需要在你项目的app_module对应的build.gradle中添加如下依赖:

dependencies {
    //zxing扫描库
    implementation 'com.google.zxing:core:3.4.0'
}

二. 扫描库具备功能介绍

扫描库具备一维码/二维码扫描,生成一维码/二维码的功能。

三. 主要类介绍

此扫描库涉及的类比较多，但是我们在使用的时候，只要关注以下几个类即可：

BaseCaptureActivity —— 自定义扫描界面基类,需要自定义扫描界面的时候需要继承此类
CaptureActivity —— 定制版扫描界面基类,需要快速接入定制版扫描界面需要继承此类
EncodingUtils —— 一维码、二维码生成工具类

扫描库具备自定义扫描界面和使用定制版扫描界面的功能，若想快速接入扫描功能,推荐使用定制版扫描界面功能，若对扫描界面有特别的ui需求，可自行定义扫描界面，这时你可以使用自定义扫描界面功能。下面就以上两个功能一一讲解。

四.定制版扫描界面功能的使用

当你想使用库内的定制版扫描界面功能的时候，你需要在你项目中写一个类继承自CaptureActivity。CaptureActivity是一个定制版扫描界面的基类，其继承于BaseCaptureActivity。当你想快速使用一个定制版扫描界面的时候，你可以写一个类继承此类。

4.1 CaptureActivity 特点

CaptureActivity几乎实现了一个扫描界面需要的所有功能。包括直接扫描二维码,闪光灯,选择相册照片扫描。CaptureActivity实现了一个定制版的扫描界面。

4.2 调用定制版的扫描界面为啥要多写个类继承CaptureActivity

Q：CaptureActivity功能已经很完美了，那为啥还要多写个子类去继承它才能调用定制版的扫描界面,你秀你妹呢?
A：呃,CaptureActivity虽然功能完美,可以加快开发者接入一个扫描界面，但是介于以下几点考虑：

扫描后是直接关闭扫描界面，还是扫描后直接在扫描界面显示扫描结果并错逻辑处理
扫描界面各控件Pading，margin调整
扫描界面各控件文字内容,文字大小,文字颜色调整
扫描界面各控件图标切换,图标大小调整

基于以上几点，则需要开发者写一个子类继承于CaptureActivity,当有需求时用于微调定制版扫描界面参数。以达到最快接入且具备一定灵活性的特点。

4.3 定制版扫描界面示例

继承于CaptureActivity，你可以像下面这样写一个定制版扫描界面(以ScanActivity为例)：

/**
 * Title:扫描界面
 * description:
 * autor:pei
 * created on 2020/3/28
 */
public class ScanActivity extends CaptureActivity {

    @Override
    protected boolean scanFinish() {
        //扫描完毕后，是否立刻关闭扫描界面。true：是，false：否。
        return false;
    }

    @Override
    protected void noAlbumPermission() {

    }

    @Override
    protected void scanSuccess(String result, int width, int height) {
        LogUtil.i("======扫描success的结果====result="+result);
    }

    @Override
    protected void scanFailed(String result, int width, int height) {
        LogUtil.i("======扫描failed的结果====result="+result);
    }
}

假如你项目中界面A需要集成定制版扫描界面ScanActivity，那么你需要如下几步处理：

你需要在你项目的Androidmanifast.xml中注册ScanActivity以用于界面跳转。
在界面A中点击按钮时处理打开相机,相册读写权限等。涉及要修改的地方有Androidmanifast.xml,fileprovider以及android6.0+用户手动权限 这里就不详细说明了。
然后在具备权限的情况下，你可以在界面A通过以下方法跳转到定制版扫描界面ScanActivity：

//跳转扫描界面
BaseCaptureActivity.startAct(Context context,Class<?>cls);

定制版扫描界面ScanActivity中几个方法的解释:

scanFinish():返回true表示扫描出结果后会立马关闭当前扫描界面，那么扫描结果会在界面A中处理，若是此种情况，你无需在ScanActivity界面的scanSuccess(String result, int width, int height)和scanFailed(String result, int width, int height) 中做任何逻辑处理。你需要在界面A中处理扫描返回结果。在界面A的onActivityResult(int requestCode, int resultCode, @Nullable Intent data) 中做扫描结果的处理，你可以像下面这样：

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

        BaseCaptureActivity.getCodeResult(requestCode, data, new OnScanResultListener() {
            @Override
            public void scanSuccess(String result, int width, int height) {
               //扫描结果成功的处理
               //.... 
            }

            @Override
            public void scanFailed(String result, int width, int height) {
                //扫描结果失败的处理
                //.... 
            }
        });
    }

返回false表示扫描出结果后，不关闭扫描界面。这时你的扫描结果是在定制版扫描界面ScanActivity中处理，而不是在界面A 中处理。所以你要在定制版扫描界面ScanActivity的scanSuccess(String result, int width, int height)和scanFailed(String result, int width, int height)中做扫描成功和扫描失败的处理，类似如下：

    @Override
    protected void scanSuccess(String result, int width, int height) {
        //扫描成功的处理
        //...
    }

    @Override
    protected void scanFailed(String result, int width, int height) {
        //扫描失败的处理
        //...
    }

scanSuccess(String result, int width, int height)和scanFailed(String result, int width, int height):当scanFinish()返回参数为 false(即扫描到结果后不立即关闭扫描界面)时，扫描结果成功和失败的处理逻辑。

4.4 微调定制版扫描界面参数

以修改扫描界面返回键文字为例，可以在ScanActivity中重载其父类CaptureActivity的initData()方法，并在其中修改返回键文字，类似下面这样:

/**
 * Title:扫描界面
 * description:
 * autor:pei
 * created on 2020/3/28
 */
public class ScanActivity extends CaptureActivity {
    
    //其他方法，在此省略
    //......
    
    @Override
    protected void initData() {
        super.initData();

        super.mTvBack.setText("大家好");
    }

}

其他参数的微调类似，必要时也可重写父类CaptureActivity中的一些方法，用以微调其他参数。

五.自定义扫描界面功能的使用

自定义扫描界面，你需要继承BaseCaptureActivity写一个自己的扫描界面。BaseCaptureActivity是一个扫描界面的基类，如果你需要自定义扫描界面，那么你可以直接继承它实现自己的扫描界面。

5.1 BaseCaptureActivity中主要方法介绍

BaseCaptureActivity包含以下几个静态方法，便于开发者在使用的过程中调用：

    /**默认跳转**/
    public static void startAct(Context context,Class<?>cls)
    
    /**获取二维码内容**/
    public static void getCodeResult(int resultCode, Intent data, OnScanResultListener listener)

startAct(Context context,Class<?>cls):当你项目中某个界面(如界面A)需要使用到扫描功能的时候，你可以在界面A通过点击按钮调用此方法跳转到定制扫描界面或自定义扫描界面。当然，前提是你已经在点击按钮的时候做过了扫描所需权限的处理。
getCodeResult(int resultCode, Intent data, OnScanResultListener listener)：当你界面A在调用完扫描界面并在关闭扫描界面后，想在界面A中接收扫描数据回传的时候，你可以在A界面的onActivityResult(int requestCode, int resultCode, @Nullable Intent data)中调用此方法，用于接收扫描回传值

其他主要方法介绍:

handleDecode(Result rawResult, Bundle bundle)和handleDecode(String result)方法，主要用于将扫描结果回传到界面A的处理，此处只做了解，具体处理已经在 BaseCaptureActivity基类中完成。此方法只做了解即可，无需开发者调用。
restartPreviewAfterDelay(long delayMS):重复扫描。此方法已在 BaseCaptureActivity内部处理，当开发这使用的是扫描完结果后仍停在扫描界面的模式时，扫描框在获取到扫描完结果的2秒之后，继续恢复扫描功能。此方法只做了解即可，无需开发者调用。
defaultInitCrop(ViewGroup preLayout,ViewGroup scanLayout):默认获取扫描二维码的尺寸(宽高),当你在自定义扫描界面的时候，可以考虑在自定义扫描界面的initCrop()方法中调用此方法。当然,你也可以在自定义扫描界面的initCrop()方法中自己实现获取扫描二维码的尺寸。当然，你也可以在自定义的扫描界面的initCrop()中不做任何处理，这时，你获得的扫描结果中二维码尺寸(宽高)将为0。
Object[] getContentArray():虚拟方法，需要子类实现。传参及解释如下：

    /**
     * 传两个参数:第一个参数为int,布局id,如：R.layout.activity_capture
     *           第二个参数为boolean,true表示扫描后立即关闭扫描界面,false表示扫描后不关闭扫描界面
     *           第二个参数传null时,isScanedFinish取默认值为true,即扫描后立即返回
     * @return
     */
    protected abstract Object[] getContentArray();

还有以下几个虚拟方法，都是在自定义扫描界面的时候需要实现的：

    protected abstract void initView();
    protected abstract SurfaceView getSurfaceView();
    /**初始化截取的矩形区域**/
    protected abstract void initCrop();
    protected abstract void setListener();

    /**没有相册权限的处理**/
    protected abstract void noAlbumPermission();

    /**扫描成功返回的处理**/
    protected abstract void scanSuccess(String result,int width,int height);
    /**扫描失败返回的处理**/
    protected abstract void scanFailed(String result,int width,int height);

这里需要解释的是，在自定义扫描的界面中必须含有一个控件:SurfaceView,然后在getSurfaceView()中返回这个SurfaceView对象
自定义扫描界面中涉及选择相册中二维码照片扫描功能的时候,若用户不授权相册权限，需要在拒绝授权的方法中调用noAlbumPermission()方法，然后在noAlbumPermission()方法中做无相册权限的处理
在自定义扫描界面中，无需调用onActivityResult(int requestCode, int resultCode, @Nullable Intent data)方法处理相册数据回传问题，因为在BaseCaptureActivity中已做处理,开发者只需当getContentArray()方法中第二个参数为false(即扫描结果在扫描界面处理)的时候，在 scanSuccess(String result,int width,int height)和scanFailed(String result,int width,int height)中做好扫描成功和扫描失败的逻辑处理即可。
在自定义扫描界面中也可能会使用到BaseCaptureActivity中的以下几个方法：

    /***
     * 扫描动画
     *
     * @param view 扫描线的imageView
     * @param duration 扫描时间间隔，单位毫秒，若duration<=0,则取默认时间间隔2500毫秒
     */
    public void scanAnimation(View view,int duration)
    
    /**打开相册**/
    public void selectImage() 
    
    /**开启/关闭闪光灯**/
    public void changeFlashLight()

5.2 自定义扫描界面

自定义扫描界面需要继承BaseCaptureActivity,以自定义扫描界面CustScanActivity为例，你可以像下面这样开始你的自定义扫描界面：

/**
 * Title:自定义扫描界面
 * description:
 * autor:pei
 * created on 2020/3/28
 */
public class CustScanActivity extends BaseCaptureActivity {

    @Override
    protected Object[] getContentArray() {
        //参数1：布局文件id，如 R.layout.activity_cus_scan
        //参数2：扫描完毕后，是否立刻关闭扫描界面。true：是，false：否。
        //例如：return new Object[]{R.layout.activity_cus_scan,true};
        return new Object[]{1,true};
    }

    @Override
    protected void initView() {
       //初始化控件
    }

    @Override
    protected SurfaceView getSurfaceView() {
        return null;//返回SurfaceView对象,必须返回，不能为null
    }

    @Override
    protected void initData() {
        super.initData();
        //当你自定义扫描界面的时候，你可能需要使用到这个扫描动画的方法,具体使用可参考CaptureActivity类
//        //扫描动画
//        scanAnimation(mImvScan,0);
    }

    @Override
    protected void initCrop() {
        //在此设置扫描二维码的尺寸，如：
//        super.mCropRect=new Rect();
//        mCropRect.set(0,0,200,200);
        //不过一般我们都直接调用父类默认测量代码，
        //参考CaptureActivity中super.defaultInitCrop(mPreLayout,mScanLayout);
    }

    @Override
    protected void setListener() {

    }

    @Override
    protected void noAlbumPermission() {
       //未给定打开相册权限的处理
    }

    @Override
    public void onClick(View v) {

    }

    @Override
    protected void scanSuccess(String result, int width, int height) {
        //扫描成功的处理

    }

    @Override
    protected void scanFailed(String result, int width, int height) {
        //扫描失败的处理
    }

}

假如你项目中界面A需要集成定义扫描界面CustScanActivity.那么你需要如下几步处理：

你需要在你项目的Androidmanifast.xml中注册CustScanActivity以用于界面跳转。
在界面A中点击按钮时处理打开相机,相册读写权限等。涉及要修改的地方有Androidmanifast.xml,fileprovider以及android6.0+用户手动权限 这里就不详细说明了。
然后在具备权限的情况下，你可以在界面A通过以下方法跳转到自定义扫描界面CustScanActivity：

//跳转扫描界面
BaseCaptureActivity.startAct(Context context,Class<?>cls);

在自定义扫描界面CustScanActivity中实现getContentArray()方法，类似如下：

    @Override
    protected Object[] getContentArray() {
        //参数1：布局文件id，如 R.layout.activity_cus_scan
        //参数2：扫描完毕后，是否立刻关闭扫描界面。true：是，false：否。
        return new Object[]{R.layout.activity_cus_scan,true};
    }

当第二个参数为true时，表示扫描出结果后会立马关闭当前扫描界面，那么扫描结果会在界面A中处理，若是此种情况，你无需在CustScanActivity界面的scanSuccess(String result, int width, int height)和scanFailed(String result, int width, int height)中做任何逻辑处理。你需要在界面A中处理扫描返回结果。在界面A的onActivityResult(int requestCode, int resultCode, @Nullable Intent data) 中做扫描结果的处理，你可以像下面这样：

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

        BaseCaptureActivity.getCodeResult(requestCode, data, new OnScanResultListener() {
            @Override
            public void scanSuccess(String result, int width, int height) {
               //扫描结果成功的处理
               //.... 
            }

            @Override
            public void scanFailed(String result, int width, int height) {
                //扫描结果失败的处理
                //.... 
            }
        });
    }

当第二个参数为false时，表示扫描出结果后，不关闭扫描界面。这时你的扫描结果是在自定义扫描界面CustScanActivity中处理，而不是在界面A 中处理。所以你要在自定义扫描界面CustScanActivity的scanSuccess(String result, int width, int height)和scanFailed(String result, int width, int height)中做扫描成功和扫描失败的处理，类似如下：

    @Override
    protected void scanSuccess(String result, int width, int height) {
        //扫描成功的处理
        //...
    }

    @Override
    protected void scanFailed(String result, int width, int height) {
        //扫描失败的处理
        //...
    }

自定义扫描界面CustScanActivity其他几个方法的解释

initView()`：用于处理控件初始化
getSurfaceView():返回SurfaceView对象,必须返回，不能为null。即你在自定义扫描界面CustScanActivity中必须有一个SurfaceView控件在initView()初始化后，在此方法中返回SurfaceView对象
initData():可在此方法中做初始化时数据的解基本处理，例如在定制界面CaptureActivity中此处做的是扫描动画处理
initCrop():用于处理获取扫描的二维码的尺寸逻辑，不写此方法的逻辑时，默认获取二维码尺寸为0
setListener():设置控件监听
onClick(View v):实现点击按键处理逻辑
noAlbumPermission():用户拒绝权限的方法中调用此方法。并在此方法中处理用户拒绝授权的逻辑
scanSuccess(String result, int width, int height)和scanFailed(String result, int width, int height)：当扫描界面在getContentArray()方法中第二个参数设置为false(即扫描结果的处理在扫描界面处理的时候)，用于做扫描结果成功或失败的处理

六.一维码/二维码生成

一维码/二维码生成主要用到工具类EncodingUtils，下面列出EncodingUtils几个主要方法:

    /**
     * 创建黑色二维码
     *
     * @param content   content
     * @param widthPix  widthPix
     * @param heightPix heightPix
     * @param logoBm    logoBm
     * @return 二维码
     */
    public static Bitmap createQRCode(String content, int widthPix, int heightPix, Bitmap logoBm)

    /**
     * 生成单色二维码
     * @param content 二维码内容
     * @param widthPix 二维码尺寸(宽度)
     * @param color 二维码颜色,格式为： 0xff000000 或 Color.RED
     * @param heightPix 二维码尺寸(高度)
     * @param logoBm 二维码logo，为null时表示二维码中无图片
     * @return
     */
    public static Bitmap createPureColorQRCode(String content, int widthPix, int heightPix, int color,Bitmap logoBm) 

    /**
     * 生成一维码
     *
     * @param content 文本内容
     * @param qrWidth 条形码的宽度
     * @param qrHeight 条形码的高度
     * @param hasText 一维码底部是否显示文字。true:显示，false：不显示
     * @return bitmap
     */
    public static Bitmap createBarCode(String content, int qrWidth, int qrHeight,boolean hasText)

七.扫描及一维码/二维码生成在MainActivity中的使用

下main贴出在MainActivity中使用代码：

public class MainActivity extends AppCompatActivity implements View.OnClickListener {

    private TextView mTextView;
    private TextView mTextView1;
    //声明
    private ImageView mImv;
    private Button mButton1;
    private Button mButton2;
    private Button mButton3;
    private Button mButton4;

    private static final int PERMISSION_CODE=1234;


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

        mTextView1=findViewById(R.id.tv1);
        //初始化
        mImv=findViewById(R.id.imv);

        mButton1=findViewById(R.id.btn1);
        mButton2=findViewById(R.id.btn2);
        mButton3=findViewById(R.id.btn3);
        mButton4=findViewById(R.id.btn4);

        //设置监听
        setListener();

        //申请权限
        requestPermission(MainActivity.PERMISSION_CODE);

    }


    private void requestPermission(int requestCode) {
        String permissions[] = {
                Manifest.permission.CAMERA,
                Manifest.permission.READ_EXTERNAL_STORAGE,
                Manifest.permission.WRITE_EXTERNAL_STORAGE};
        PermissionHelper.getInstance().checkPermissions(permissions, requestCode, MainActivity.this);
    }

    @PermissionSuccess(requestCode = MainActivity.PERMISSION_CODE)
    public void requestSuccess() {
        //申请到权限后的处理
        //......

        LogUtil.i("=====权限申请成功======");
    }

    @PermissionFail(requestCode = MainActivity.PERMISSION_CODE)
    public void requestFail() {
        //未获取到权限的处理
        //......

        LogUtil.i("=====权限申请失败======");
    }

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

    private void setListener(){
        mButton1.setOnClickListener(this);
        mButton2.setOnClickListener(this);
        mButton3.setOnClickListener(this);
        mButton4.setOnClickListener(this);
    }

    @Override
    public void onClick(View v) {
       String input="http://weixin.qq.com/r/k0MlPaDEaf0WreRe9xaB";
       switch (v.getId()) {
           case R.id.btn1://扫描
               BaseCaptureActivity.startAct(this,ScanActivity.class);
               break;
           case R.id.btn2://生成条形码
               //生成底部文字的条形码
               Bitmap bitmap1= EncodingUtils.createBarCode("ben pao de pain", ScreenUtil.dp2px(250,this), ScreenUtil.dp2px(100,this),true);
               mImv.setImageBitmap(bitmap1);
               break;
           case R.id.btn3://生成黑色带logo的二维码
               Bitmap bitmaoLogo= BitmapFactory.decodeResource(getResources(),R.mipmap.ic_pain);
               Bitmap bitmap2=EncodingUtils.createQRCode(input, ScreenUtil.dp2px(250,this),ScreenUtil.dp2px(250,this),bitmaoLogo);
               mImv.setImageBitmap(bitmap2);
               break;
           case R.id.btn4://生成单色二维码
               Bitmap bitmap3=EncodingUtils.createPureColorQRCode(input, ScreenUtil.dp2px(250,this),ScreenUtil.dp2px(250,this), 0xff0c9f11,null);
               mImv.setImageBitmap(bitmap3);
               break;
           default:
               break;
       }
    }

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

    }
}

八.效果图和项目结构图