如何使用 Swift 开发简单的条形码检测器?

【编者按】本文作者为 Matthew Maher,主要手把手地介绍如何用 Swift 构建简单的条形码检测器。文章系 OneAPM 工程师编译整理。

超市收银员对货物进行扫码,机场内录入行李或检查乘客,或是在大型零售商的存货管理等活动中,条形码扫码器都是一个简单而实用的工具。事实上,条形码扫码器还帮助消费者实现了智能购物,货物分类等用途。这次,我们将为iPhone开发一个扫码器。

我们很幸运,苹果公司让条形码扫描过程的实现变得很简单。我们将会深入AV Foundation框架开发一个简单的能够扫描CD条形码的app,然后获得专辑的关键信息,最后在app的界面中打印出来。阅读条形码很酷炫也很重要,我们会根据读到的条形码采取进一步的操作。

不用多说,能扫码的设备必须要有一个摄像头。从这里开始,让我们拿一个配备有摄像头的iOS设备开始干活吧!

简介 CDbarcodes

我们今天开发的这个app名叫CDBarcodes——通俗易懂,即条形码扫描对象是CD。当我们的设备检测到一个条形码时,会拾取这个货码然后发送到Discogs的数据库,获得其专辑名称、艺人姓名以及发布年份。Discogs的音乐数据库十分强大,因此我们很有可能找到一些实用信息。

下载CDBarcodes的初始项目

除了一个不错的数据库,Discogs还有一个实用的API来帮助查询。我们涉及的仅仅是Discogs提供给开发者的一小部分功能,不过这已经足够使我们的app跑起来了。

Discogs

进入Discogs网站。首先我们必须注册一个Discogs账号并登录。在这之后,下拉到页面最底端。在页尾最左栏点击API。

在Discogs的API界面左侧的数据库区域点击搜索(Search)。

这是我们查询的端点。我们将会从“title”和“year”这两个参数上获得专辑信息。

现在,我们将这个URL记录在CDBarcodes中以便后面的查询。在Constants.swift中添加DISCOGS_AUTH_URL并赋值https://api.discogs.com/database/search?q=作为常量。

let DISCOGS_KEY = "your-discogs-key"

现在我们能够在整个app里面通过DISCOGS_AUTH_URL调用URL。

回到Discogs的API页面,选择创建一个新的app,并获得一些认证信息。在页面顶端的导航栏中,找到“Create an App”,点击该按钮。

在应用名称栏里输入“CDBarcodes Your Name”,或是其他合适的名字。描述可以使用下面的文字:

“这是一个iOS应用,旨在在读取CD的条形码后显示专辑信息。”

然后,点击“Create Application”(即创建应用)按钮。

在结束页面,会看到允许我们使用条形码的认证信息。

复制“Consumer Key”(用户秘钥)到Constants.swiftDISCOGS_KEY里面。

有了这个URL,我们可以很方便的在整个CDBarcodes应用里使用这些参数。

CocoaPods

我们使用功能强大的依赖管理器(dependency manager)CocoaPods来与Discogs的API进行交互。有关CocoaPods的安装和其他信息,可以参照CocoaPods官网

经由CocoaPods,在网络端我们将会使用Alamofire,并借助SwiftyJSON来处理Discogs返回的JSON。

现在开始在CDBarcodes实战吧!

安装好CocoaPods,打开终端界面,调至CDBarcodes,在Xcode项目中使用下面的代码初始化CoccoaPods:

cd <your-xcode-project-directory>
pod init

在Xcode里打开Podfile文件:

open -a Xcode Podfile

输入或是复制粘贴下面的代码至Podfile文件:

source ‘https://github.com/CocoaPods/Specs.git‘
platform :ios, ‘8.0‘
use_frameworks!

pod ‘Alamofire‘, ‘~> 3.0‘

target ‘CDBarcodes’ do
pod ‘SwiftyJSON‘, :git => ‘https://github.com/SwiftyJSON/SwiftyJSON.git‘
end

最后,运行下面的代码下载Alamofire和SwiftyJSON:

pod install

现在回到Xcode!注意开发app时要保持打开CDBarcodes.xcworkspace(工作区)。

条形码阅读器

苹果的AV Foundation框架提供了我们开发这个条形码阅读器app需要的相关工具。下面是整个过程中会涉及到的几个方面:

  • AVCaptureSession将会处理来自相机的输入输出数据。
  • AVCaptureDevice指的是物理设备及其它的属性。AVCaptureSession从AVCaptureDevice这里接受输入信息。
  • AVCaptureDeviceInput从输入设备获取输入数据。
  • AVCaptureMetadataOutput将元数据对象发送至代理对象(delegate object)处进行处理。

BarcodeReaderViewController.swift里面,我们的第一步操作是导入AVFoundation。

import UIKit
import AVFoundation

注意要遵循AVCaptureMetadataOutputObjectsDelegate

viewDidLoad(),将运行我们的条形码阅读引擎。

首先,新建一个AVCaptureSession对象并设置AVCaptureDevice。然后,我们新建一个输入对象并添加至AVCaptureSession

class BarcodeReaderViewController: UIViewController, AVCaptureMetadataOutputObjectsDelegate {

var session: AVCaptureSession!
var previewLayer: AVCaptureVideoPreviewLayer!

override func viewDidLoad() {
    super.viewDidLoad()

    // Create a session object. 新建一个模块对象
    session = AVCaptureSession()

    // Set the captureDevice. 设置captureDevice
    let videoCaptureDevice = AVCaptureDevice.defaultDeviceWithMediaType(AVMediaTypeVideo)

    // Create input object. 新建输入设备
    let videoInput: AVCaptureDeviceInput?

    do {
        videoInput = try AVCaptureDeviceInput(device: videoCaptureDevice)
    } catch {
        return
    }

    // Add input to the session. 将输入添加至模块中
    if (session.canAddInput(videoInput)) {
        session.addInput(videoInput)
    } else {
        scanningNotPossible()
    }

如果设备碰巧没有摄像头时,扫描过程将不可能实现。因此,我们需要一个报错函数。在这里,我们通知用户寻找一个有相机的iOS设备以便进行下一步CD条形码的读取。

func scanningNotPossible() {
    // Let the user know that scanning isn‘t possible with the current device. 告知用户扫描现有设备无法扫描
    let alert = UIAlertController(title: "Can‘t Scan.", message: "Let‘s try a device equipped with a camera.", preferredStyle: .Alert)
    alert.addAction(UIAlertAction(title: "OK", style: .Default, handler: nil))
    presentViewController(alert, animated: true, completion: nil)
    session = nil
}

回到viewDidLoad(),在将输入添加至(session)模块后,我们接着新建AVCaptureMetadataOutput并将它添加到模块中。我们将捕捉到的数据通过一个串行序列的形式发送给代理对象。

下一步就是明确我们应该扫描的条形码类型。在这里我们面对的是EAN-13类型的条形码。有趣的是,并不是所有的条形码都是这种类型;有一些将会是UPC-A格式。这可能会导致错误出现。

苹果会自动将UPC-A格式的条形码前面加一个0后转为EAN-13格式。UPC-A格式的条形码仅仅有12位数字;而在EAN-13格式的条形码中则是13位。这个自动转换过程的一个好处是我们可以查询metadataObjectTypes AVMetadataObjectTypeEAN13Code,因此两种格式的条形码我们就都能读取了。需要注意的是这个转换会直接改变条形码从而误导Discogs数据库。不过不用担心,我们马上就会解决这个问题。

无论如何,在用户设备相机有问题时我们就将用户引导至scanningNotPossible()函数。

// Create output object. 新建输出对象
let metadataOutput = AVCaptureMetadataOutput()

// Add output to the session. 将输出添加至模块
if (session.canAddOutput(metadataOutput)) {
    session.addOutput(metadataOutput)

    // Send captured data to the delegate object via a serial queue. 通过串行序列将捕捉到的数据发送至代理对象。
    metadataOutput.setMetadataObjectsDelegate(self, queue: dispatch_get_main_queue())

    // Set barcode type for which to scan: EAN-13. 设置需要扫描的条形码类型:EAN-13
    metadataOutput.metadataObjectTypes = [AVMetadataObjectTypeEAN13Code]

} else {
    scanningNotPossible()
}

现在我们就搞定了这个酷炫的功能,拉出来溜溜吧!我们将使用AVCaptureVideoPreviewLayer以整个屏幕展示视频。

最后,我们开始捕捉模块。

// Add previewLayer and have it show the video data. 添加previewLayer并展示视频数据

    previewLayer = AVCaptureVideoPreviewLayer(session: session);
    previewLayer.frame = view.layer.bounds;
    previewLayer.videoGravity = AVLayerVideoGravityResizeAspectFill;
    view.layer.addSublayer(previewLayer);

    // Begin the capture session. 开启捕捉模块

    session.startRunning()

In captureOutput:didOutputMetadataObjects:fromConnection, we celebrate, as our barcode reader found something!

通过captureOutput:didOutputMetadataObjects:fromConnection,我们的条形码阅读器终于读取到了一些数据。

首先,我们需要使用第一个对象获得metadataObjects数组并将其转换为可机读代码。然后,我们将readableCode字符串发送至barcodeDetected()

在进入barcodeDetected()函数前,我们会停止捕捉模块并给用户一个震动反馈。如果我们忘了叫停捕捉模块,那么震动也就停不下来了!这也是为什么这是一个好案例的原因。

func captureOutput(captureOutput: AVCaptureOutput!, didOutputMetadataObjects metadataObjects: [AnyObject]!, fromConnection connection: AVCaptureConnection!) {

    // Get the first object from the metadataObjects array. 获得metadataObjects数组的第一个对象
    if let barcodeData = metadataObjects.first {
        // Turn it into machine readable code 转换为可机读代码
        let barcodeReadable = barcodeData as? AVMetadataMachineReadableCodeObject;
        if let readableCode = barcodeReadable {
            // Send the barcode as a string to barcodeDetected() 发送条形码数据
            barcodeDetected(readableCode.stringValue);
        }

        // Vibrate the device to give the user some feedback. 震动反馈
        AudioServicesPlaySystemSound(SystemSoundID(kSystemSoundID_Vibrate))

        // Avoid a very buzzy device. 结束捕捉模块
        session.stopRunning()
    }
}

barcodeDetected()函数里面我们有很多事情要做。第一个任务是在震动反馈之后,提示用户我们已经发现了条形码。然后我们利用找到的数据开始干活!

条形代码中的空格必须移除。在这之后我们需要确认条形码格式是EAN-13还是UPC-A。如果是EAN-13我们可以直接使用。如果对象是一个UPC-A代码,那么它已经被转化为EAN-13格式,我们需要将其转换为原始格式。

如我们前文已经讨论的那样,苹果设备在UPC-A格式的条形码前添加一个0将其转化为EAN-13格式,因此我们首先确定代码是以0开头的。如果是,我们需要将它移除。少了这一步,Discogs数据库将不能识别这个数字,我们也就得不到想要的数据了。

在获得清理后的条形码字符串后,我们将它发送至DataService.searchAPI()并弹出BarcodeReaderViewController.swift

func barcodeDetected(code: String) {

    // Let the user know we‘ve found something. 告知用户扫描结果
    let alert = UIAlertController(title: "Found a Barcode!", message: code, preferredStyle: UIAlertControllerStyle.Alert)
    alert.addAction(UIAlertAction(title: "Search", style: UIAlertActionStyle.Destructive, handler: { action in

        // Remove the spaces. 移除空格
        let trimmedCode = code.stringByTrimmingCharactersInSet(NSCharacterSet.whitespaceCharacterSet())

        // EAN or UPC?  确定格式
        // Check for added "0" at beginning of code.

        let trimmedCodeString = "\(trimmedCode)"
        var trimmedCodeNoZero: String

        if trimmedCodeString.hasPrefix("0") && trimmedCodeString.characters.count > 1 {
            trimmedCodeNoZero = String(trimmedCodeString.characters.dropFirst())

            // Send the doctored UPC to DataService.searchAPI() 将UPC发送至API
            DataService.searchAPI(trimmedCodeNoZero)
        } else {

            // Send the doctored EAN to DataService.searchAPI()
            DataService.searchAPI(trimmedCodeString)
        }

        self.navigationController?.popViewControllerAnimated(true)
    }))

    self.presentViewController(alert, animated: true, completion: nil)
}

在离开BarcodeReaderViewController.swift之前,在viewDidLoad()下面,我们添加 viewWillAppear()viewWillDisappear()函数。viewWillAppear()将会开启捕捉模块;而viewWillDisappear()会终止这一模块。

override func viewWillAppear(animated: Bool) {

    super.viewWillAppear(animated)
    if (session?.running == false) {
        session.startRunning()
    }
}

override func viewWillDisappear(animated: Bool) {
    super.viewWillDisappear(animated)

    if (session?.running == true) {
        session.stopRunning()
    }
}

数据服务

DataService.swift里,我们首先要导入Alamofire 和 SwiftyJSON。

接着,我们声明一些变量以便存储从Discogs返回的原始数据。根据Bionik6的建议,我们巧妙地使用private(set)函数避免了用户可能导致的阻塞问题。

然后,建立Alamofire GET请求。在这里JSON会被解析,从而获得专辑的title(名称)和year(发行年份)。将原始的title和year字符串赋给ALBUM_FROM_DISCOGSYEAR_FROM_DISCOGS,在后文将会用到它们来初始化我们的专辑。

现在,我们拥有了来自Discogs的数据,我们可以正式开秀了;随之我们通知AlbumDetailsViewController.swift模块捕捉到的信息。

import Foundation
import Alamofire
import SwiftyJSON

class DataService {

static let dataService = DataService()

private(set) var ALBUM_FROM_DISCOGS = ""
private(set) var YEAR_FROM_DISCOGS = ""

static func searchAPI(codeNumber: String) {
    // The URL we will use to get out album data from Discogs 使用URL获得数据
    let discogsURL = "\(DISCOGS_AUTH_URL)\(codeNumber)&?barcode&key=\(DISCOGS_KEY)&secret=\(DISCOGS_SECRET)"

    Alamofire.request(.GET, discogsURL)
        .responseJSON { response in

            var json = JSON(response.result.value!)

            let albumArtistTitle = "\(json["results"][0]["title"])"
            let albumYear = "\(json["results"][0]["year"])"

            self.dataService.ALBUM_FROM_DISCOGS = albumArtistTitle
            self.dataService.YEAR_FROM_DISCOGS = albumYear

            // Post a notification to let AlbumDetailsViewController know we have some data. 通知AlbumDetailsViewController
            NSNotificationCenter.defaultCenter().postNotificationName("AlbumNotification", object: nil)
    }
}

}

专辑模块

在专辑模块Album.swift中,我们会处理专辑数据以便符合我们的要求。这个模块将会获取原始的artistAlbumalbumYear字符串然后将它们用户友好化。在AlbumDetailsViewController.swift我们展示加工后的albumyear信息。

import Foundation

class Album {        

private(set) var album: String!
private(set) var year: String!

init(artistAlbum: String, albumYear: String) {

    // Add a little extra text to the album information 添加额外专辑信息
    self.album = "Album: \n\(artistAlbum)"
    self.year = "Released in: \(albumYear)"
}

}

专辑展示时间!

viewDidLoad()模块中,设置好指向条形码阅读器的标签(label)。然后,我们需要在NSNotification添加观察者(Observer),以便我们已经展示的提示能够集群。在deinit中,我们会移除观察者(Observer)。

deinit {
    NSNotificationCenter.defaultCenter().removeObserver(self)
}

override func viewDidLoad() {
    super.viewDidLoad()

    artistAlbumLabel.text = "Let‘s scan an album!"
    yearLabel.text = ""

    NSNotificationCenter.defaultCenter().addObserver(self, selector: #selector(setLabels(_:)), name: "AlbumNotification", object: nil)
}

当通知出现时,setLabels()函数将会被调用。在这里,我们会使用来自DataService.swift的原始数据初始化Album。标签将会展示加工后的字符串。

func setLabels(notification: NSNotification){

    // Use the data from DataService.swift to initialize the Album.
    let albumInfo = Album(artistAlbum: DataService.dataService.ALBUM_FROM_DISCOGS, albumYear: DataService.dataService.YEAR_FROM_DISCOGS)
    artistAlbumLabel.text = "\(albumInfo.album)"
    yearLabel.text = "\(albumInfo.year)"
}

测试 CDBarcodes

应用搭建完毕,扫一下CD的条形码我们就能确定专辑的名称,艺人和发行年份信息,这很有意思!为了更好的测试CDBarcodes,我们可以随机找一些CD或是黑胶唱片。这样我们就更有机会同时遇到EAN-13和UPC-A两种条形码格式的案例。目前我们两者都能处理!

为了使应用顺利运行至BarcodeReaderViewController模块,注意避免闪光以确保相机能捕捉到条形码信息。

这里是完整代码的下载链接

结论

不管是商人,机智的消费者还是一般人士,这个条形码阅读器都很实用。因此,开发者拿这个案例来练练手是极好的。

但是我们也看到有趣的仅仅是扫码部分。在获得数据后,我们遇到了一点小问题,如EAN-13 和 UPC-A格式问题。我们找到了解决问题应对需求的办法。

接下来,我们可以探讨一些其他的metadataObjectTypes以及一些新API。机会无穷,经验无价。

本文系 OneAPM 工程师编译整理。OneAPM Mobile Insight真实用户体验为度量标准进行 Crash 分析,监控网络请求及网络错误,提升用户留存。访问 OneAPM 官方网站感受更多应用性能优化体验,想阅读更多技术文章,请访问 OneAPM 官方技术博客

本文转自 OneAPM 官方博客

原文链接:http://www.appcoda.com/simple-barcode-reader-app-swift/

时间: 2024-10-09 21:55:18

如何使用 Swift 开发简单的条形码检测器?的相关文章

Swift语言编写一个简单的条形码扫描APP

swift语言编写一个简单的条形码扫描APP 原文地址:appcoda 在处理职员在杂货店的收银台排了很长的队伍,在机场帮助检查背包和旅客,或者在主要的食品供应商,协助处理乏味的存货清单过程,条形码扫描是很简单的处理工具.实际上,他们已经用了这个办法来解决消费者在智能购物,图书分类,等其他目的.因此,让我们来制作一个iPhone版本的条形码扫描工具吧! 对我们来说幸运的是,苹果已经制作了条形码扫描的程序,实现它是一件很简单的事情.我们将要研究进入AV Foundation框架的世界,组建APP,

iOS开发Swift篇—简单介绍

iOS开发Swift篇—简单介绍 一.简介 Swift是苹果于2014年WWDC(苹果开发者大会)发布的全新编程语言 Swift在天朝译为“雨燕”,是它的LOGO 是一只燕子,跟Objective-C一样,可以用于开发iOS.Mac应用程序 苹果从2010年7月开始设计Swift语言,耗时4年打造 Swift的语法特点 从它的语法中能看到Objective-C.JavaScript.Python等语言的影子 语法简单.代码简洁.使用方便 可与Objective-C混合使用(相互调用) 为什么要设

Swift开发笔记

Swift开发笔记(一) 刚开始接触XCode时,整个操作逻辑与Android Studio.Visual Studio等是完全不同的,因此本文围绕IOS中控件的设置.事件的注册来简单的了解IOS开发 1.新建一个Xcode项目,项目目录大致如图: 2.在Main.storyboard添加控件 首先要显示右侧的工具栏(Utilities),之后选择显示Object Library,就可以找到常用的一些控件了,然后添加几个控件到界面中 3.将控件和ViewController进行关联 此时要将Ed

关于《Swift开发指南》背后的那些事

时间轴(倒叙)2014年8月底在图灵出版社的大力支持下,全球第一本全面.系统.科学的,包含本人多年经验的呕心沥血之作<Swift开发指南>(配有同步视频课程和同步练习)全线重磅推出2014年7月5日苹果宣布Swift语言二十天后,<Swift开发指南>第一稿交予图灵出版社2014年6月9日苹果宣布Swift语言三天后,启动<Swift开发指南>撰写2014年6月2日凌晨1点(北京时间:)在苹果开发者大会WWDC 2014上,苹果宣布了全新的iOS及OS X平台开发语言S

对苹果“五仁”编程语言Swift的简单分析

对苹果"五仁"编程语言Swift的简单分析 苹果在昨天的WWDC上,发布了新的编程语言Swift.这两天开发社区都在讨论这个语言,从语言的特性上大家发现了好多语言的影子,这样的情况可以说是集大成,也可以说是"五仁".每个人看问题的角度都不同,下面从个人的角度来看看这门语言涉及到的工具链及其对越狱开发的影响. 由于刚刚发布,针对相关工具的介绍几乎没有,那我们就从xcode中寻找.在shell中执行: find /Applications/Xcode6-Beta.app

Swift开发的几个小技巧(整理自图拉鼎的博客)

正所谓掌握一样技术最好的办法就是用它来做一个东西,于是这段时间的实战让我对 Swift 的理解更深了一层,也积累了一些使用技巧.今天就分享一则:如何正确地定义一个类变量(和类常量). Swift 语言对于无论是静态语言过来还是动态语言过来的开发者来说,都有点点不适应,很多问题的解决思路不能用已经习以为常的方法去做. 如何正确的定义一个类变量(和类常量) Swift 支持用 class func 来修饰一个「类方法」,然而却不能用「class var」和「class let」来指定类变量和类常量,

Swift开发的几个小技巧

正所谓掌握一样技术最好的办法就是用它来做一个东西,于是这段时间的实战让我对 Swift 的理解更深了一层,也积累了一些使用技巧.今天就分享一则:如何正确地定义一个类变量(和类常量). Swift 语言对于无论是静态语言过来还是动态语言过来的开发者来说,都有点点不适应,很多问题的解决思路不能用已经习以为常的方法去做. 如何正确的定义一个类变量(和类常量) Swift 支持用 class func 来修饰一个「类方法」,然而却不能用「class var」和「class let」来指定类变量和类常量,

Swift开发语法

Swift开发入门 简介 Swift 语言由苹果公司在 2014 年推出,用来撰写 OS X 和 iOS 应用程序 2014 年,在 Apple WWDC 发布 历史 2010 年 7 月,苹果开发者工具部门总监 Chris Lattner(克里斯·拉特纳) 开始着手 Swift 编程语言的设计工作 用一年时间,完成基本架构 Swift 大约历经 4 年的开发期,2014 年 6 月发表 克里斯·拉特纳 ) 特色 苹果宣称 Swift 的特点是:快速.现代.安全.互动,而且明显优于 Object

使用Vmware虚拟机部署Swift开发环境之Mac OS X系统安装

 一.使用VMware虚拟机部署Swift开发环境所需工具: Vmware Workstation 10.0虚拟机软件 VM安装Mac解锁工具Unlock 苹果操作系统(Mac OS X Mavericks 10.9.4) 下载地址:http://pan.baidu.com/s/1qWLkffQ 密码:ewb2 二.VMware Workstation 10上安装并使用Mac OS X 10.9 1.安装VMware Workstation 10虚拟机,安装过程不再赘述. 2.使用Mac解锁