使用 Swift 建立简单的二维码扫描应用

时间 2019-12-06

标签使用 swift 建立简单二维扫描应用栏目 Swift 繁體版

原文原文链接

做者：AppCoda，原文连接，原文日期：2016-05-19
译者：Prayer；校对：numbbbbb；定稿：CMBios

排着长队等待结帐的商店，帮助旅客记录包裹和航班信息的机场，帮助大型零售商处理大量无聊的存货清单，这些场景很是适合使用条码扫描器。此外，条码扫描器也能帮消费者进行智能购物和产品分类。既然它这么棒，不如咱们在 iPhone 上作一个吧！git

幸运的是，对 Apple 开发者来讲，实现条码扫描很是容易，苹果大法好！咱们会使用 AV Foundation 来实现一个小巧的 iPhone app，可以扫描 CD 上的条码，获取专辑的一些重要信息，并将内容输出到 App 视图中。可以实现读取条码的功能，这很是的酷，可是咱们的野心不止于此，咱们会对识别的条码内容做进一步的操做。github

我本不应再多啰嗦，不过仍是友情提醒一下，这个条码扫描 app 只有在设备具备摄像头时才能正确工做。记住这一点，准备一台有摄像头的 iOS 设备，咱们开始吧！数据库

关于 CDBarcodes

今天咱们建立的应用叫作 CDBarcodes —— 它仍是很智能的。当设备扫描到一个条码时，咱们会将处理后的条码内容发送给 Discogs 数据库，而后得到专辑的名称、艺术家以及发布年份。Discogs 的数据库中有大量的音乐数据，因此咱们基本上能查到全部数据。json

从这里下载 CDBarcodes 的 starter projectswift

Discogs

先从 Discogs 开始。首先，咱们须要登陆或者注册一个 Discogs 帐户。登陆以后，拉到网站的最底端，在 footer 的最左边边栏，点击 API。api

在 Discogs API 页面，点击左边栏 Database 中的 Search。数组

这个就是咱们将会用到的 API。咱们使用 “title” 和 “year” 参数来获取专辑信息。xcode

如今咱们须要将查询的 URL 保存到咱们的 CDBarcodes 中。在 Constants.swift 文件中，将 https://api.discogs.com/database/search?q= 添加到常量 DISCOGS_AUTH_URL 中。ruby

let DISCOGS_AUTH_URL = "https://api.discogs.com/database/search?q="

如今咱们能够很方便地在应用中使用 DISCOGS_AUTH_URL 获取查询 URL。

回到刚才的 Discogs API 网站。咱们须要建立一个新应用，取得 API 的使用资格。在导航栏中，网页的最顶部，点击 Create an App。以后点击 Create an Application 按钮。

应用名称的话，输入 “CDBarcodes + 你的名字”，或者其余你喜欢的名字。description 字段能够写：

“This is an iOS app that reads barcodes from CDs and displays information about the albums.”

译注：“这个 iOS 应用会读取 CD 的条形码并显示唱片信息。”

最后，点击 Create Application 按钮。

在最后的结果页面，咱们可以获得使用条码来作一些操做的资格信息。

拷贝 Consumer Key，粘贴到 Constants.swift 文件的 DISCOGS_KEY 中。再拷贝 Consumer Secret，粘贴到 Constants.swift 文件的 DISCOGS_SECRET 中。

同 URL 同样，如今咱们能够在应用中很方便地使用这些变量了。

CocoaPods

为了可以和 Discogs API 通讯，咱们使用一个优秀的第三方库管理工具：CocoaPods。若是想要了解更多关于 CocoaPods 的信息，或者想学习如何安装它，能够到它的官网查询。

有了 CocoaPods 就能够安装第三方库，咱们会使用 Alamofire 来请求网络，使用 SwiftyJSON 来处理从 Discogs 返回的 JSON 数据。

下面咱们把这两个库引入到 CDBarcodes 工程中！

CocoaPods 安装好以后，打开终端，进入 CDBarcodes 目录，初始化 CocoaPods，命令以下：

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

使用 Xcode 打开 Podfile：

bash
open -a Xcode Podfile

将下面内容拷贝到 Podfile 中：

ruby
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：

bash
pod install

如今让咱们回到 Xcode 中！切记要打开的是 CDBarcodes.xcworkspace

识别条码

AV Foundation 框架提供了识别条码的工具。咱们来大概描述一下工做原理。

AVCaptureSession 会管理从摄像头获取的数据——将输入的数据转为可使用的输出
AVCaptureDevice 表示物理设备和其余属性。AVCaptureSession 会从 AVCaptureDevice 获取输入数据
AVCaptureDeviceInput 从设备中捕获数据
AVCaptureMetadataOutput 会向处理数据的 delegate 转发得到的元数据

在 BarcodeReaderViewController.swift 文件中，首先导入 AVFoundation

import UIKit
import AVFoundation

同时，咱们须要遵循 AVCaptureMetadataOutputObjectsDelegate 协议。

在 viewDidLoad() 中，咱们要发动条码扫描引擎。

首先，建立一个 AVCaptureSession 对象，而后设置 AVCaptureDevice。以后咱们将建立一个输入对象（input object），而后将其加入到 AVCaptureSession 中。

class BarcodeReaderViewController: UIViewController, AVCaptureMetadataOutputObjectsDelegate {

var session: AVCaptureSession!
var previewLayer: AVCaptureVideoPreviewLayer!

override func viewDidLoad() {
    super.viewDidLoad()
    
    // 建立一个 session 对象
    session = AVCaptureSession()
    
    // 设置 captureDevice.
    let videoCaptureDevice = AVCaptureDevice.defaultDeviceWithMediaType(AVMediaTypeVideo)
    
    // 建立 input object.
    let videoInput: AVCaptureDeviceInput?
    
    do {
        videoInput = try AVCaptureDeviceInput(device: videoCaptureDevice)
    } catch {
        return
    }
    
    // 将 input 加入到 session 中
    if (session.canAddInput(videoInput)) {
        session.addInput(videoInput)
    } else {
        scanningNotPossible()
    }

若是你的设备没有摄像头，那就没法扫描条码。咱们添加了一个处理失败场景的方法。若是没有摄像头，会弹出一个提示框来提示用户，换一个有摄像头的设备来扫描 CD 的条码。

func scanningNotPossible() {
    // 告知用户该设备没法进行条码扫描
    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() 方法中，将 input 添加到 session 以后，咱们须要建立 AVCaptureMetadataOutput 并把它也添加到 session 中。咱们会将捕获到的数据经过串行队列发送给 delegate 对象。

下一步须要声明咱们将要扫描的条码类型。对咱们而言，咱们须要使用 EAN-13 条码。有意思的是，咱们扫描的条码并不是都是 EAN-13 类型的；一些有多是 UPC-A 类型，这可能会形成识别的问题。

Apple 经过在前面加上 0 来将 UPC-A 条码转换为 EAN-13 条码。UPC-A 条码只有 12 位，EAN-13 条码，和你猜想的同样，是 13 位。这个自动转化特性的好处是，咱们在设置 metadataObjectTypes 时，只要设置为 AVMetadataObjectTypeEAN13Code，EAN-13 和 UPC-A 条码都将会被识别。不过这会修改条码，所以有可能会在查询 Discogs 时出问题，后面咱们会处理这个问题。

若是摄像头有问题，咱们须要使用 scanningNotPossible() 来告知用户。

// 建立 output 对象
let metadataOutput = AVCaptureMetadataOutput()

// 将 output 对象添加到 session 上
if (session.canAddOutput(metadataOutput)) {
   session.addOutput(metadataOutput)
   
   // 经过串行队列，将捕获到的数据发送给相应的代理
   metadataOutput.setMetadataObjectsDelegate(self, queue: dispatch_get_main_queue())
   
   // 设置可扫描的条码类型
   metadataOutput.metadataObjectTypes = [AVMetadataObjectTypeEAN13Code]
   
} else {
   scanningNotPossible()
}

咱们已经拥有了扫描条码的强大能力，如今须要作的是预览扫描画面。使用 AVCaptureVideoPreviewLayer 在整个屏幕上显示拍摄到的画面。

而后，咱们就能够开始扫描了。

// 添加 previewLayer 让其显示摄像头拍到的画面
        
previewLayer = AVCaptureVideoPreviewLayer(session: session);
previewLayer.frame = view.layer.bounds;
previewLayer.videoGravity = AVLayerVideoGravityResizeAspectFill;
view.layer.addSublayer(previewLayer);
    
// 开始运行 session
    
session.startRunning()

在 captureOutput:didOutputMetadataObjects:fromConnection 方法中，咱们能够庆祝一下，由于执行到该方法就说明已经识别了一些信息。

首先，咱们须要从 metadataObjects 数组中取出第一个对象，而后将其转化为机器能够识别的格式。而后将转换后的 readableCode 做为一个 string 值传入 barcodeDetected() 方法中。

在看 barcodeDetected() 方法以前，咱们须要以震动的形式给用户一些扫描成功的反馈而且关闭 session（stop the session）。万一你忘记关闭了 session，不要紧，你的设备会一直震动，直到你关闭为止。

func captureOutput(captureOutput: AVCaptureOutput!, didOutputMetadataObjects metadataObjects: [AnyObject]!, fromConnection connection: AVCaptureConnection!) {
 
    // 从 metadataObjects 数组中取得第一个对象
    if let barcodeData = metadataObjects.first {
        // 将其转化为机器能够识别的格式
        let barcodeReadable = barcodeData as? AVMetadataMachineReadableCodeObject;
        if let readableCode = barcodeReadable {
            // 将 readableCode 做为一个 string 值，传入 barcodeDetected() 方法中
            barcodeDetected(readableCode.stringValue);
        }
        
        // 以震动的形式告知用户，识别成功        AudioServicesPlaySystemSound(SystemSoundID(kSystemSoundID_Vibrate))
        
        // 关闭 session （避免你的设备一直嗡嗡震动）
        session.stopRunning()
    }
}

咱们须要在 barcodeDetected() 中作一些操做。第一个任务是弹出一个提示框告知用户，咱们扫描到了一个条码。而后将扫描到的信息转化为咱们须要的内容。

必须去掉扫描内容中的空格。去掉空格以后，咱们须要判断条码是 EAN-13 仍是 UPC-A 类型。若是是 EAN-13 类型，不须要额外的操做。若是是 UPC-A 条码，它被转化为了 EAN-13 类型，咱们须要把它还原成原有的格式。

就像咱们以前讨论的那样，苹果在 UPC-A 条码的前头加上一个 0 来将其转换为 EAN-13，因此咱们须要判断其是否以 0 开头，若是是的话，删掉它。若是没有这一步，Discogs 没法识别这个数字，咱们也没有办法获得正确的数据。

拿处处理后的条码数据以后，咱们将它传给 DataService.searchAPI() 而后显示 BarcodeReaderViewController

func barcodeDetected(code: String) {
 
    // 让用户知道，咱们扫描到了
    let alert = UIAlertController(title: "Found a Barcode!", message: code, preferredStyle: UIAlertControllerStyle.Alert)
    alert.addAction(UIAlertAction(title: "Search", style: UIAlertActionStyle.Destructive, handler: { action in
        
        // 去除空格
        let trimmedCode = code.stringByTrimmingCharactersInSet(NSCharacterSet.whitespaceCharacterSet())
        
        // 判断是 EAN 仍是 UPC?
        
        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()
            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() 方法中，咱们让 session 开始运行。相应的，在 viewWillDisappear() 方法中，让 session 中止运行。

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 获得专辑的名称和年份。咱们分别把获得的名称和年份原始数据赋值给 ALBUM_FROM_DISCOGS 和 YEAR_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) {
        
        // 从 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
                
                // 发送通知，让 AlbumDetailsViewController 知道咱们获得了数据
                NSNotificationCenter.defaultCenter().postNotificationName("AlbumNotification", object: nil)
        }
    }

}

Album 模型

在专辑的数据模型 Album.swift 中，须要将专辑模型转化为咱们想要的数据。这个模型接受原始的 artistAlbum 和 albumYear 数据，把它们转换为更加易读的数据。

import Foundation
 
class Album {        
 
private(set) var album: String!
private(set) var year: String!
 
init(artistAlbum: String, albumYear: String) {
    
    // 为专辑信息添加一些额外的数据
    self.album = "Album: \n\(artistAlbum)"
    self.year = "Released in: \(albumYear)"
}
 
}

是时候秀一波专辑数据了！

在 viewDidLoad() 方法中，设置 labels 的内容，提示用户开始扫描。咱们须要添加 observer 来监听 NSNotification 从而接收通知。同时须要在 deinit 中移除监听者。

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 对象。而后将 label 中的内容设置为咱们想要的 Album 内容。

func setLabels(notification: NSNotification){

    // 使用 DataService.swift 中的数据初始化 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

咱们的 app 完成啦！固然，咱们能够直接从 CD 封面看到专辑名称、艺术家和发行年份，可是用咱们的 app 要有趣得多！为了更好地测试 CDBarcodes 应用，咱们须要找一些 CD 和唱片。这样就有可能同时遇到 EAN-13 和 UPC-A 条码，真正发挥 app 的威力。

在 BarcodeReaderViewController 中，注意将相机对焦到条码上。

这里是完成以后的 CDBarcodes 代码。

总结

不管是商务人士、购物者仍是普通人，条码扫描器都一个特别有用的工具。所以，可以开发条码扫描也很是有用。

扫描那部分比较有趣。在得到扫描的数据以后，咱们须要对数据作进一步操做，例如判断是 EAN-13 仍是 UPC-A 类型。咱们须要找到转化数据的正确方式，而后老司机就上路了。

若是想了解更多内容，能够读取其余的 metadataObjectTypes 和一些新 API。惟一的限制就是你的想象力。

本文由 SwiftGG 翻译组翻译，已经得到做者翻译受权，最新文章请访问 http://swift.gg。