aiDee: iOS生物识别微框架使用指南

aiDee: iOS生物识别微框架使用指南

aiDee Micro-framework to enable and facilitate the use of LocalAuthentication (Touch / Face ID) on your iOS Projects 项目地址: https://gitcode.com/gh_mirrors/ai/aiDee

1. 项目目录结构及介绍

aiDee项目采用Swift语言编写，专为简化iOS设备上的生物识别（Touch ID与Face ID）认证过程而设计。下面是其主要的目录结构及其简介：

• Example: 包含了该框架的一个示例应用，用于演示如何在实际项目中集成和使用aiDee。

  • aiDee.xcworkspace: Xcode的工作空间文件，用于打开并管理项目及其依赖。
  • LICENSE: 许可证文件，表明该项目遵循MIT许可证。
  • README.md: 项目的快速入门指南和基本信息。
  • Podfile (如果适用): 当使用CocoaPods时的配置文件，定义第三方库依赖。
  • Example/: 示例应用的源代码目录。
  • aiDee.podspec (如果适用): Carthage或CocoaPods使用的规格描述文件。

• aiDee/: 主要的库文件夹，存放框架的核心代码。

  • BiometricAuthentication.swift: 实现生物识别认证逻辑的主要类。
  • BiometricType.swift: 枚举类型，代表可用的生物识别类型。
  • 其他可能的支持文件和资源。

• .gitignore: 控制版本控制中哪些文件不应被追踪。

• swiftPackage.swift (假设存在): Swift Package Manager的配置文件，定义包依赖和元数据。

2. 项目启动文件介绍

启动点主要是通过Xcode工作空间(aiDee.xcworkspace)来访问的。开发者首先应该在这个工作空间中打开Example项目，这是了解和测试框架功能的入口点。在开发过程中，直接编辑aiDee目录下的源码文件，然后在Example中进行编译和测试以确保一切运行正常。

3. 项目的配置文件介绍

Info.plist配置

在集成aiDee到一个新项目前，需在应用程序的Info.plist文件中添加一个键值对：

• 键：NSFaceIDUsageDescription （对于支持Face ID的应用）
• 值：应提供一个字符串，解释为什么应用需要使用生物识别技术，例如：“为了安全地验证您的身份，我们请求使用Face ID。”

此步骤是苹果的要求，旨在告知用户应用使用生物识别的目的，提升透明度和用户理解。

其他配置文件

• Podfile 或 Cartfile: 若使用CocoaPods或Carthage作为依赖管理工具，则分别在相应的配置文件中加入aiDee的引用信息，以便自动下载和集成该框架。
• swiftPackage.swift: 对于使用Swift Package Manager的项目，需在该文件中指定aiDee仓库的URL及所需版本，以完成包的添加和管理。

通过以上步骤和配置，开发者可以顺利地集成aiDee到其iOS应用中，实现便捷的生物识别认证功能。

aiDee Micro-framework to enable and facilitate the use of LocalAuthentication (Touch / Face ID) on your iOS Projects 项目地址: https://gitcode.com/gh_mirrors/ai/aiDee