BarcodeScanner源码分析
项目地址：BarcodeScanner，本文分析版本: 78278e7
1.简介
项目开发中我们经常遇到需要扫描二维码功能的需求,二维码识别算法我们都知道有zxing,但是它提供的demo里并不支持竖屏扫描,而且定制性也不好,不能拿来即用。所以github上又产生一些对zxing封装的项目,能很简易的集成而且又提供良好定制性。今天我们就来介绍其中一个项目BarcodeScanner,也是我认为相当不错的一个项目。
BarcodeScanner同时提供了zxing扫描方案和zbar扫描方案。zbar的扫描算法是C实现的,扫描速度要比zxing快,但是错误率好像要高于zxing。我并没有在项目中实际使用过zbar,具体是参照这里。本文我们并不分析zxing的实现方式(我也不会。。),我们只分析BarcodeScanner具体的使用和实现方式。
2.使用方法
BarcodeScanner的集成和使用方法相当简单,我们放上一个集成好的Activity代码:
public class SimpleScannerActivity extends BaseScannerActivity implements ZXingScannerView.ResultHandler {
private ZXingScannerView mScannerView;
private static final String TAG = "SimpleScannerActivity";
@Override
public void onCreate(Bundle state) {
super.onCreate(state);
setContentView(R.layout.activity_simple_scanner);
setupToolbar();
ViewGroup contentFrame = (ViewGroup) findViewById(R.id.content_frame);
mScannerView = new ZXingScannerView(this);
contentFrame.addView(mScannerView);
Log.d(TAG, "onCreate id : " + Thread.currentThread().getName());
}
@Override
public void onResume() {
super.onResume();
mScannerView.setResultHandler(this);
mScannerView.startCamera();
}
@Override
public void onPause() {
super.onPause();
mScannerView.stopCamera();
}
@Override
public void handleResult(Result rawResult) {
Toast.makeText(this, "Contents = " + rawResult.getText() +
", Format = " + rawResult.getBarcodeFormat().toString(), Toast.LENGTH_SHORT).show();
}
}
- 首先实现
ZXingScannerView.ResultHandler接口,该接口的handleResult(Result rawResult);回调方法就是用来处理扫描出的结果rawResult的. - 如果你不需要自定制扫描的界面,
BarcodeScanner提供给了我们一个默认实现的样式,所以使用默认样式直接mScannerView = new ZXingScannerView(this);如果需要自定义界面则需要重写ZXingScannerView的父类BarcodeScannerView中的createViewFinderView(Context context)方法,代码如下:
mScannerView = new ZXingScannerView(this) {
@Override
protected IViewFinder createViewFinderView(Context context) {
//返回我们自定义的IViewFinder
return new CustomViewFinderView(context);
}
};
- 分别在
onResume()和onPause()里执行响应的函数。
此外BarcodeScanner还支持:
- 开关闪光灯
- 是否开启自动对焦
- 自定义扫描条形码或者二维码的格式
- 前后置摄像头切换
代码这里就不贴了,大家可以参照demo中具体的这个类FullScannerActivity。
3.类关系图
BarcodeScanner.png
从类图上看大部分类都跟
BarcodeScannerView相关,BarcodeScannerView是继承自FrameLayout的,这个布局是用来放置我们用于相机预览的SurfaceView以及我们自定义的扫描界面IViewFinder以及实现控制闪光灯的功能。先大致了解这么多,下面我们详细的来看。
4.源码分析
BarcodeScanner的实现并不复杂,我们也就按照惯例,从它的调用流程开始看:
1.BarcodeScannerView的实现
可以在使用方法中首先看到,我们在Activity的onCreate()方法里实例化了一个ZXingScannerView对象,并添加到我们的布局里。进入ZXingScannerView类里看到它是继承自BarcodeScannerView类的,所以我们再跟进到BarcodeScannerView中去看看具体的实现,发现BarcodeScannerView继承自FrameLayout并且实现了Camera.PreviewCallback接口,下面是BarcodeScannerView的具体实现,省略了部分非主要代码:
public abstract class BarcodeScannerView extends FrameLayout implements Camera.PreviewCallback {
//Camera对象
private Camera mCamera;
//Camera预览对象,继承自SurfaceView,负责刷新相机预览界面
private CameraPreview mPreview;
//自定义的扫描遮罩,控制扫描框的大小
private IViewFinder mViewFinderView;
//扫描区域的大小
private Rect mFramingRectInPreview;
//相机HandlerThread,负责在子线程中开启相机
private CameraHandlerThread mCameraHandlerThread;
//闪光灯状态
private Boolean mFlashState;
private boolean mAutofocusState = true;
public BarcodeScannerView(Context context) {
super(context);
}
public BarcodeScannerView(Context context, AttributeSet attributeSet) {
super(context, attributeSet);
}
public final void setupLayout(Camera camera) {
removeAllViews();
//实例化相机预览对象,并添加到一个RelativeLayout里
mPreview = new CameraPreview(getContext(), camera, this);
RelativeLayout relativeLayout = new RelativeLayout(getContext());
relativeLayout.setGravity(Gravity.CENTER);
relativeLayout.setBackgroundColor(Color.BLACK);
relativeLayout.addView(mPreview);
addView(relativeLayout);
//实例化mViewFinderView对象,并添加到布局中
mViewFinderView = createViewFinderView(getContext());
if (mViewFinderView instanceof View) {
addView((View) mViewFinderView);
} else {
throw new IllegalArgumentException("IViewFinder object returned by " +
"'createViewFinderView()' should be instance of android.view.View");
}
}
//创建二维码扫描样式,重写此方法即可自定义样式,
protected IViewFinder createViewFinderView(Context context) {
return new ViewFinderView(context);
}
//通过HandlerThread开启相机
public void startCamera(int cameraId) {
if(mCameraHandlerThread == null) {
mCameraHandlerThread = new CameraHandlerThread(this);
}
mCameraHandlerThread.startCamera(cameraId);
}
//开启相机预览
public void setupCameraPreview(Camera camera) {
mCamera = camera;
if(mCamera != null) {
setupLayout(mCamera);
mViewFinderView.setupViewFinder();
if(mFlashState != null) {
setFlash(mFlashState);
}
setAutoFocus(mAutofocusState);
}
}
public void startCamera() {
startCamera(-1);
}
//关闭相机
public void stopCamera() {
if(mCamera != null) {
mPreview.stopCameraPreview();
mPreview.setCamera(null, null);
mCamera.release();
mCamera = null;
}
if(mCameraHandlerThread != null) {
mCameraHandlerThread.quit();
mCameraHandlerThread = null;
}
}
//停止预览
public void stopCameraPreview() {
if(mPreview != null) {
mPreview.stopCameraPreview();
}
}
//恢复预览
protected void resumeCameraPreview() {
if(mPreview != null) {
mPreview.showCameraPreview();
}
}
//得到预览区域中需要扫描的区域的Rect
public synchronized Rect getFramingRectInPreview(int previewWidth, int previewHeight) {
if (mFramingRectInPreview == null) {
Rect framingRect = mViewFinderView.getFramingRect();
int viewFinderViewWidth = mViewFinderView.getWidth();
int viewFinderViewHeight = mViewFinderView.getHeight();
if (framingRect == null || viewFinderViewWidth == 0 || viewFinderViewHeight == 0) {
return null;
}
Rect rect = new Rect(framingRect);
rect.left = rect.left * previewWidth / viewFinderViewWidth;
rect.right = rect.right * previewWidth / viewFinderViewWidth;
rect.top = rect.top * previewHeight / viewFinderViewHeight;
rect.bottom = rect.bottom * previewHeight / viewFinderViewHeight;
mFramingRectInPreview = rect;
}
return mFramingRectInPreview;
}
//省略了部分闪光灯相关代码
}
可以看到BarcodeScannerView是一个抽象类,它主要是用来组织我们用来预览图像的SurfaceView以及决定我们二维码扫描样式的IViewFinder对象,以及提供出一些控制相机和闪光灯的方法。以及实现了Camera.PreviewCallback接口,但是在这里并未实现,所以继承自BarcodeScannerView的子类需要实现这个接口,并处理相机的回调数据。
所以在BarcodeScannerView里有还有三个对象比较重要依次是:CameraPreview,IViewFinder和CameraHandlerThread,这些都是具体用来做什么的呢?我相信大家通过名字和其中的一些方法应该已经大致知道,下面我们就一起来看看这些类到底有些什么作用.
2.CameraPreview的实现
CameraPreview是继承自SurfaceView的,做过相机开发的都知道,一般我们需要在SurfaceView中更新相机的预览画面,所以CameraPreview就是一个标准的SurfaceView的实现,这里我们就不再在分析SurfaceView是如何使用的.我只要知道CameraPreview类里是真正控制
相机预览以及显示相机预览的就可以了,具体的代码希望大家自行去研究。
值得一提的是CameraPreview中设置预览画面大小的方法值得我们学习。因为我们知道不同手机使用的摄像头是不同的,而且摄像头所支持的分辨率也不尽相同,而且我们更有可能给我们的扫码界面设置不一样的大小,所以一个好的扫码库一定要做到自适应大小才是最好的,那让我们看看它是怎么做的:
public void setupCameraParameters() {
//首先根据当前View的宽高,再根据所有相机支持的分辨率
//来找出一个最适合的相机Size
Camera.Size optimalSize = getOptimalPreviewSize();
//获得相机的参数并且设定
Camera.Parameters parameters = mCamera.getParameters();
parameters.setPreviewSize(optimalSize.width, optimalSize.height);
mCamera.setParameters(parameters);
//再调整View的宽高
adjustViewSize(optimalSize);
}
实现的流程已经在上面了,详细的方法我们这里就不展开说了,有兴趣的可以自己查看.
3.IViewFinder的实现
IViewFinder是一个为了让我们能自定义扫码框而抽象的一个接口,代码如下:
public interface IViewFinder {
//当相机预览开始的时候调用,一般推荐用来更新扫描框的大小和刷新View
void setupViewFinder();
//返回扫码识别的区域
Rect getFramingRect();
//返回View的宽度,因为View中已经实现,所以你不需要重写这个方法.
int getWidth();
//返回View的高度,因为View中已经实现,所以你不需要重写这个方法.
int getHeight();
}
IViewFinder是为了帮助我们能自定义扫码框以及扫码的区域抽象出来的一个接口,在前面我们知道.我们在实现任何扫码框的样式的时候都需要继承自View否则在添加时将会抛出异常,实现起来就比较简单了,当然BarcodeScanner中为我们默认实现了一个ViewFinderView。代码我们就补贴了,大家可以自行阅读。
4.CameraHandlerThread的实现
public class CameraHandlerThread extends HandlerThread {
private static final String LOG_TAG = "CameraHandlerThread";
private BarcodeScannerView mScannerView;
public CameraHandlerThread(BarcodeScannerView scannerView) {
super("CameraHandlerThread");
mScannerView = scannerView;
start();
}
public void startCamera(final int cameraId) {
Handler localHandler = new Handler(getLooper());
localHandler.post(new Runnable() {
@Override
public void run() {
//在子线程中获得camera对象
final Camera camera = CameraUtils.getCameraInstance(cameraId);
Handler mainHandler = new Handler(Looper.getMainLooper());
mainHandler.post(new Runnable() {
@Override
public void run() {
mScannerView.setupCameraPreview(camera);
}
});
}
});
}
}
CameraHandlerThread的实现看起来相当简单,但是它的作用却是相当重要的,根据代码我们可以看到,其实是在子线程中获取到了camera对象,再通过Looper.getMainLooper()初始化一个运行在主线程中的Handler通知mScannerView.setupCameraPreview(camera);。这样处理之后我们整个的相机就运行在子线程中了,包括相机预览的刷新以及Camera.PreviewCallback的onPreviewFrame()方法的回调都在子线程中了。这样做的好处是什么呢?我大致列举了两个
- 在子线程中初始化相机,能增加扫码Activity的进入速度。
- 由于相机更新是在子线程中的,那么我们如果再在主线程中实现各种动画就会相当流畅。不会有卡顿现象。
所以CameraHandlerThread还是相当有必要的。
5.ZXingScannerView的实现
所以在ZXingScannerView中只要做初始化Zxing的相关类以及在onPreviewFrame(byte[] data, Camera camera)回调方法中处理我们相机回调的数据扫描即可,为了验证onPreviewFrame(byte[] data, Camera camera)是运行在子线程中我们可以看到方法的最后:
@Override
public void onPreviewFrame(byte[] data, Camera camera) {
if(mResultHandler == null) {
return;
}
.....省略部分扫码相关代码
final Result finalRawResult = rawResult;
if (finalRawResult != null) {
Handler handler = new Handler(Looper.getMainLooper());
handler.post(new Runnable() {
@Override
public void run() {
ResultHandler tmpResultHandler = mResultHandler;
mResultHandler = null;
stopCameraPreview();
if (tmpResultHandler != null) {
tmpResultHandler.handleResult(finalRawResult);
}
}
});
} else {
camera.setOneShotPreviewCallback(this);
}
}
通过一个Handler在主线程中回调handleResult()方法。所以到此我们就大致知道了BarcodeScanner中Zxing的扫码是如何实现的了,聪明的同学应该也已经知道这个库中Zbar扫码的模块也应该是如何实现的了,无非也是继承自BarcodeScannerView只不过是使用Zbar的扫描算法来完成扫码识别,那么到底是不是这样?还欢迎大家把BarcodeScanner这个库clone来自己验证了!好了源码实现我们就写到这。
5.个人评价
BarcodeScanner是我在项目开发中使用过的二维码扫描库中个人觉得结构和可拓展性都比较好的库,在当初使用这个库的时候,它并没有实现CameraHandlerThread,当时自己也实现了在HandlerThread中开启相机的功能,实现的方法这里就不写了,因为BarcodeScanner的这种实现方式要比我自己实现的要好。所以总体来说值得推荐!
多说一句,因为最近眼睛做了手术,所以我只写了一遍博客,并没有review难免有错字或者写错的地方,还希望大家帮忙指出,最后谢谢大家的支持。_
我每周会写一篇源代码分析的文章,以后也可能会有其他主题.
如果你喜欢我写的文章的话,欢迎关注我的新浪微博@达达达达sky
地址: http://weibo.com/u/2030683111
每周我会第一时间在微博分享我写的文章,也会积极转发更多有用的知识给大家.
