Core NFC框架详细解析 (三) —— CoreNFC使用简单示例(二)

版本号 时间
V1.0 2020.06.07 星期日

前言

今天翻阅苹果的API文档,发现多了一个框架Core NFC,看了下才看见是iOS11.0新添加的框架,这里我们就一起来看一下框架Core NFC。感兴趣的看下面几篇文章。
1. Core NFC框架详细解析 (一) —— 基本概览(一)
2. Core NFC框架详细解析 (二) —— CoreNFC使用简单示例(一)

源码

1. Swift

首先看下工程组织结构

下面就是源码了

1. NFCUtility.swift
import Foundation
import CoreNFC

typealias NFCReadingCompletion = (Result<NFCNDEFMessage?, Error>) -> Void
typealias LocationReadingCompletion = (Result<Location, Error>) -> Void

enum NFCError: LocalizedError {
  case unavailable
  case invalidated(message: String)
  case invalidPayloadSize

  var errorDescription: String? {
    switch self {
    case .unavailable:
      return "NFC Reader Not Available"
    case let .invalidated(message):
      return message
    case .invalidPayloadSize:
      return "NDEF payload size exceeds the tag limit"
    }
  }
}

class NFCUtility: NSObject {
  enum NFCAction {
    case readLocation
    case setupLocation(locationName: String)
    case addVisitor(visitorName: String)

    var alertMessage: String {
      switch self {
      case .readLocation:
        return "Place tag near iPhone to read the location."
      case .setupLocation(let locationName):
        return "Place tag near iPhone to setup \(locationName)"
      case .addVisitor(let visitorName):
        return "Place tag near iPhone to add \(visitorName)"
      }
    }
  }

  private static let shared = NFCUtility()
  private var action: NFCAction = .readLocation

  // 1
  private var session: NFCNDEFReaderSession?
  private var completion: LocationReadingCompletion?

  // 2
  static func performAction(
    _ action: NFCAction,
    completion: LocationReadingCompletion? = nil
  ) {
    // 3
    guard NFCNDEFReaderSession.readingAvailable else {
      completion?(.failure(NFCError.unavailable))
      print("NFC is not available on this device")
      return
    }

    shared.action = action
    shared.completion = completion
    // 4
    shared.session = NFCNDEFReaderSession(
      delegate: shared.self,
      queue: nil,
      invalidateAfterFirstRead: false)
    // 5
    shared.session?.alertMessage = action.alertMessage
    // 6
    shared.session?.begin()
  }
}

// MARK: - NFC NDEF Reader Session Delegate
extension NFCUtility: NFCNDEFReaderSessionDelegate {
  func readerSession(
    _ session: NFCNDEFReaderSession,
    didDetectNDEFs messages: [NFCNDEFMessage]
  ) {
    // Not used
  }

  private func handleError(_ error: Error) {
    session?.alertMessage = error.localizedDescription
    session?.invalidate()
  }

  func readerSession(
    _ session: NFCNDEFReaderSession,
    didInvalidateWithError error: Error
  ) {
    if
      let error = error as? NFCReaderError,
      error.code != .readerSessionInvalidationErrorFirstNDEFTagRead &&
        error.code != .readerSessionInvalidationErrorUserCanceled {
      completion?(.failure(NFCError.invalidated(message: error.localizedDescription)))
    }

    self.session = nil
    completion = nil
  }

  func readerSession(
    _ session: NFCNDEFReaderSession,
    didDetect tags: [NFCNDEFTag]
  ) {
    guard
      let tag = tags.first,
      tags.count == 1
      else {
        session.alertMessage = "There are too many tags present. Remove all and then try again."
        DispatchQueue.global().asyncAfter(deadline: .now() + .milliseconds(500)) {
          session.restartPolling()
        }
        return
    }

    // 1
    session.connect(to: tag) { error in
      if let error = error {
        self.handleError(error)
        return
      }

      // 2
      tag.queryNDEFStatus { status, _, error in
        if let error = error {
          self.handleError(error)
          return
        }

        // 3
        switch (status, self.action) {
        case (.notSupported, _):
          session.alertMessage = "Unsupported tag."
          session.invalidate()
        case (.readOnly, _):
          session.alertMessage = "Unable to write to tag."
          session.invalidate()
        case (.readWrite, .setupLocation(let locationName)):
          self.createLocation(Location(name: locationName), tag: tag)
        case (.readWrite, .readLocation):
          self.read(tag: tag)
        case (.readWrite, .addVisitor(let visitorName)):
          self.addVisitor(Visitor(name: visitorName), tag: tag)
        default:
          return
        }
      }
    }
  }
}

// MARK: - Utilities
extension NFCUtility {
  func readLocation(from tag: NFCNDEFTag) {
    // 1
    tag.readNDEF { message, error in
      if let error = error {
        self.handleError(error)
        return
      }
      // 2
      guard
        let message = message,
        let location = Location(message: message)
        else {
          self.session?.alertMessage = "Could not read tag data."
          self.session?.invalidate()
          return
      }
      self.completion?(.success(location))
      self.session?.alertMessage = "Read tag."
      self.session?.invalidate()
    }
  }

  private func read(
    tag: NFCNDEFTag,
    alertMessage: String = "Tag Read",
    readCompletion: NFCReadingCompletion? = nil
  ) {
    tag.readNDEF { message, error in
      if let error = error {
        self.handleError(error)
        return
      }

      // 1
      if let readCompletion = readCompletion,
        let message = message {
        readCompletion(.success(message))
      } else if let message = message,
        let record = message.records.first,
        let location = try? JSONDecoder()
          .decode(Location.self, from: record.payload) {
        // 2
        self.completion?(.success(location))
        self.session?.alertMessage = alertMessage
        self.session?.invalidate()
      } else {
        self.session?.alertMessage = "Could not decode tag data."
        self.session?.invalidate()
      }
    }
  }

  private func createLocation(_ location: Location, tag: NFCNDEFTag) {
    read(tag: tag) { _ in
      self.updateLocation(location, tag: tag)
    }
  }

  private func updateLocation(
    _ location: Location,
    withVisitor visitor: Visitor? = nil,
    tag: NFCNDEFTag
  ) {
    // 1
    var alertMessage = "Successfully setup location."
    var tempLocation = location

    if let visitor = visitor {
      tempLocation.visitors.append(visitor)
      alertMessage = "Successfully added visitor."
    }

    // 2
    let jsonEncoder = JSONEncoder()
    guard let customData = try? jsonEncoder.encode(tempLocation) else {
      self.handleError(NFCError.invalidated(message: "Bad data"))
      return
    }

    // 3
    let payload = NFCNDEFPayload(
      format: .unknown,
      type: Data(),
      identifier: Data(),
      payload: customData)
    // 4
    let message = NFCNDEFMessage(records: [payload])

    tag.queryNDEFStatus { _, capacity, _ in
      // 1
      guard message.length <= capacity else {
        self.handleError(NFCError.invalidPayloadSize)
        return
      }

      // 2
      tag.writeNDEF(message) { error in
        if let error = error {
          self.handleError(error)
          return
        }
        if self.completion != nil {
          self.read(tag: tag, alertMessage: alertMessage)
        }
      }
    }
  }

  private func addVisitor(_ visitor: Visitor, tag: NFCNDEFTag) {
    read(tag: tag) { message in
      guard
        let message = try? message.get(),
        let record = message.records.first,
        let location = try? JSONDecoder()
          .decode(Location.self, from: record.payload)
        else {
          return
      }

      self.updateLocation(location, withVisitor: visitor, tag: tag)
    }
  }
}
2. LocationModel.swift
import CoreNFC

struct Location: Codable {
  let name: String
  var visitors: [Visitor]

  init(name: String) {
    self.name = name
    visitors = []
  }

  init?(message: NFCNDEFMessage) {
    guard
      let locationRecord = message.records.first,
      let locationName = locationRecord.wellKnownTypeTextPayload().0
      else {
        return nil
    }

    name = locationName
    visitors = []
  }
}

struct Visitor: Codable, Hashable {
  let name: String

  init(name: String) {
    self.name = name
  }
}
3. AppView.swift
import SwiftUI

struct AppView: View {
  var body: some View {
    TabView {
      VisitorView()
        .tabItem {
          VStack {
            Image(systemName: "magnifyingglass")
            Text("Visitors")
          }
        }
      AdminView()
        .tabItem {
          VStack {
            Image(systemName: "lock")
            Text("Admin")
          }
        }
    }
    .accentColor(Color("rw-green"))
  }
}

struct AppView_Previews: PreviewProvider {
  static var previews: some View {
    Group {
      AppView()
    }
  }
}
4. VisitorView.swift
import SwiftUI

struct VisitorView: View {
  @State private var visitorName = ""
  @State private var locationModel: Location?

  // swiftlint:disable multiple_closures_with_trailing_closure multiline_arguments
  private var visitorSection: some View {
    Section(header: Text("Visitor Information")) {
      TextField("Enter Your Name", text: $visitorName)
        .textContentType(.name)
        .autocapitalization(.words)

      Button(action: {
        NFCUtility.performAction(.addVisitor(visitorName: self.visitorName)) { location in
          self.locationModel = try? location.get()
          self.visitorName = ""
        }
      }) {
        Text("Add To Tag…")
      }
      .disabled(visitorName.isEmpty)
    }
  }

  private var scanSection: some View {
    Section {
      Button(action: {
        NFCUtility.performAction(.readLocation) { location in
          self.locationModel = try? location.get()
        }
      }) {
        Text("Scan Location Tag…")
      }
    }
  }
  // swiftlint:enable multiple_closures_with_trailing_closure multiline_arguments

  private var scannedSection: some View {
    locationModel.map { location in
      Section(
        header: Text("Location: \(location.name)"),
        footer: Text("Visitors: \(location.visitors.count)")) {
          ForEach(location.visitors, id: \.self) { visitor in
            Text(visitor.name)
          }
      }
    }
  }

  var body: some View {
    NavigationView {
      Form {
        visitorSection
        scanSection
        scannedSection
      }
      .navigationBarTitle("Visitors")
    }
    .navigationViewStyle(StackNavigationViewStyle())
  }
}

struct VisitorView_Previews: PreviewProvider {
  static var previews: some View {
    VisitorView()
  }
}
5. AdminView.swift
import SwiftUI

struct AdminView: View {
  @State private var locationName = ""

  var body: some View {
    NavigationView {
      Form {
        Section(
          header: Text("Location Setup"),
          footer: Text("This will clear all visitor data from tag.")
            .fontWeight(.bold)
        ) {
          TextField("Enter Location Name", text: $locationName)
            .autocapitalization(.words)
          // swiftlint:disable multiple_closures_with_trailing_closure multiline_arguments
          Button(action: {
            NFCUtility.performAction(.setupLocation(locationName: self.locationName)) { _ in
              self.locationName = ""
            }
          }) {
            Text("Save Location…")
          }
          .disabled(locationName.isEmpty)
        }
        // swiftlint:enable multiple_closures_with_trailing_closure multiline_arguments
      }
      .navigationBarTitle("Administration")
    }
    .navigationViewStyle(StackNavigationViewStyle())
  }
}

struct AdminView_Previews: PreviewProvider {
  static var previews: some View {
    AdminView()
  }
}

后记

本篇主要讲述了CoreNFC使用简单示例,感兴趣的给个赞或者关注~~~

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 220,192评论 6 511
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,858评论 3 396
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 166,517评论 0 357
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 59,148评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,162评论 6 397
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,905评论 1 308
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,537评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,439评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,956评论 1 319
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,083评论 3 340
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,218评论 1 352
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,899评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,565评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,093评论 0 23
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,201评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,539评论 3 375
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,215评论 2 358