Project Icon

composable-core-location

简化iOS应用中位置服务的实现和测试

Composable Core Location是一个Swift开源库,旨在简化iOS应用中位置服务的实现和测试。它将Core Location功能与Composable Architecture设计模式相结合,提供了结构化的API来处理位置授权、更新和地理围栏等功能。通过封装CLLocationManager,该库不仅提高了代码的可组合性,还大大增强了位置相关功能的可测试性,使开发者能更轻松地构建和维护使用位置服务的应用。

可组合的 Core Location

CI

可组合的 Core Location 是一个连接可组合架构Core Location 的库。

示例

查看 LocationManager 演示以了解 ComposableCoreLocation 的实际应用。

基本用法

要在你的应用中使用 ComposableCoreLocation,你可以在你的领域中添加一个代表管理器可以通过 CLLocationManagerDelegate 方法发出的所有操作的动作:

import ComposableCoreLocation

enum AppAction {
  case locationManager(LocationManager.Action)

  // 你的领域的其他动作:
  ...
}

LocationManager.Action 枚举为 CLLocationManagerDelegate 的每个委托方法保存一个情况,如 didUpdateLocationsdidEnterRegiondidUpdateHeading 等。

接下来,我们将 LocationManager(库提供的 CLLocationManager 的包装器)添加到应用程序的依赖环境中:

struct AppEnvironment {
  var locationManager: LocationManager

  // 你的领域的其他依赖:
  ...
}

然后,我们通过从一个动作返回效果来同时订阅委托动作并请求授权,以启动我们应用程序的 reducer。这种动作的一个好选择是视图的 onAppear

let appReducer = Reducer<AppState, AppAction, AppEnvironment> {
  state, action, environment in

  switch action {
  case .onAppear:
    return .merge(
      environment.locationManager
        .delegate()
        .map(AppAction.locationManager),

      environment.locationManager
        .requestWhenInUseAuthorization()
        .fireAndForget()
    )

  ...
  }
}

完成初始设置后,我们现在将通过动作获得所有 CLLocationManagerDelegate 的委托方法传递给我们的 reducer。要处理特定的委托动作,我们可以在我们添加到 AppAction.locationManager 情况中解构它。例如,一旦我们从用户那里获得位置授权,我们就可以请求他们的当前位置:

case .locationManager(.didChangeAuthorization(.authorizedAlways)),
     .locationManager(.didChangeAuthorization(.authorizedWhenInUse)):

  return environment.locationManager
    .requestLocation()
    .fireAndForget()

如果用户拒绝位置访问,我们可以显示一个警告,告诉他们我们需要访问权限才能在应用中做任何事情:

case .locationManager(.didChangeAuthorization(.denied)),
     .locationManager(.didChangeAuthorization(.restricted)):

  state.alert = """
    请给予位置访问权限,以便我们能够向你展示一些很酷的内容。
    """
  return .none

否则,我们将通过处理 .didUpdateLocations 动作来获知用户的位置:

case let .locationManager(.didUpdateLocations(locations)):
  // 使用用户的当前位置做些很酷的事情。
  ...

一旦你处理了所有你关心的 CLLocationManagerDelegate 动作,你可以忽略其余的:

case .locationManager:
  return .none

最后,当创建 Store 来驱动你的应用程序时,你将提供 LocationManager 的"实时"实现,这是一个内部持有 CLLocationManager 并直接与之交互的实例:

let store = Store(
  initialState: AppState(),
  reducer: appReducer,
  environment: AppEnvironment(
    locationManager: .live,
    // 以及你的其他依赖...
  )
)

这足以实现一个与 Core Location 交互的基本应用程序。

以这种方式构建你的应用程序并与 Core Location 交互的真正力量在于能够_测试_你的应用程序如何与 Core Location 交互。它从创建一个 TestStore 开始,其环境包含 .failing 版本的 LocationManager。然后,你可以选择性地覆盖你的功能需要提供确定性功能的任何端点。

例如,要测试请求位置授权、被拒绝和显示警告的流程,我们需要覆盖 createrequestWhenInUseAuthorization 端点。create 端点需要返回一个发出委托动作的效果,我们可以通过发布主题来控制。而 requestWhenInUseAuthorization 端点是一个即发即忘的效果,但我们可以断言它是按我们预期的方式被调用的。

let store = TestStore(
  initialState: AppState(),
  reducer: appReducer,
  environment: AppEnvironment(
    locationManager: .failing
  )
)

var didRequestInUseAuthorization = false
let locationManagerSubject = PassthroughSubject<LocationManager.Action, Never>()

store.environment.locationManager.create = { locationManagerSubject.eraseToEffect() }
store.environment.locationManager.requestWhenInUseAuthorization = {
  .fireAndForget { didRequestInUseAuthorization = true }
}

然后我们可以编写一个断言,模拟一系列用户步骤和位置管理器委托动作,并断言状态如何变化以及如何接收效果。例如,我们可以让用户来到屏幕,拒绝位置授权请求,然后断言收到了一个导致警告显示的效果:

store.send(.onAppear)

// 模拟用户拒绝位置访问
locationManagerSubject.send(.didChangeAuthorization(.denied))

// 我们从效果中接收到授权更改委托动作
store.receive(.locationManager(.didChangeAuthorization(.denied))) {
  $0.alert = """
    请给予位置访问权限,以便我们能够向你展示一些很酷的内容。
    """

// Store 断言要求所有效果都完成,所以我们手动完成主题。
locationManagerSubject.send(completion: .finished)

这仅仅是冰山一角。我们可以进一步测试当用户授予授权并且请求他们的位置返回我们控制的特定位置时会发生什么,甚至当请求他们的位置失败时会发生什么。编写这些测试非常容易,我们可以测试我们应用程序的深层、微妙的属性。

安装

你可以通过添加包依赖来将 ComposableCoreLocation 添加到 Xcode 项目中。

  1. 文件菜单中,选择Swift Packages › 添加包依赖…
  2. 在包仓库 URL 文本字段中输入 "https://github.com/pointfreeco/composable-core-location"

文档

Composable Core Location API 的最新文档可在此处获得。

帮助

如果你想讨论 Composable Core Location 和可组合架构,或者有关于如何使用它们解决特定问题的问题,可以在它的 Swift 论坛上询问。

许可证

该库根据 MIT 许可证发布。有关详细信息,请参阅 LICENSE

项目侧边栏1项目侧边栏2
推荐项目
Project Cover

豆包MarsCode

豆包 MarsCode 是一款革命性的编程助手,通过AI技术提供代码补全、单测生成、代码解释和智能问答等功能,支持100+编程语言,与主流编辑器无缝集成,显著提升开发效率和代码质量。

Project Cover

AI写歌

Suno AI是一个革命性的AI音乐创作平台,能在短短30秒内帮助用户创作出一首完整的歌曲。无论是寻找创作灵感还是需要快速制作音乐,Suno AI都是音乐爱好者和专业人士的理想选择。

Project Cover

有言AI

有言平台提供一站式AIGC视频创作解决方案,通过智能技术简化视频制作流程。无论是企业宣传还是个人分享,有言都能帮助用户快速、轻松地制作出专业级别的视频内容。

Project Cover

Kimi

Kimi AI助手提供多语言对话支持,能够阅读和理解用户上传的文件内容,解析网页信息,并结合搜索结果为用户提供详尽的答案。无论是日常咨询还是专业问题,Kimi都能以友好、专业的方式提供帮助。

Project Cover

阿里绘蛙

绘蛙是阿里巴巴集团推出的革命性AI电商营销平台。利用尖端人工智能技术,为商家提供一键生成商品图和营销文案的服务,显著提升内容创作效率和营销效果。适用于淘宝、天猫等电商平台,让商品第一时间被种草。

Project Cover

吐司

探索Tensor.Art平台的独特AI模型,免费访问各种图像生成与AI训练工具,从Stable Diffusion等基础模型开始,轻松实现创新图像生成。体验前沿的AI技术,推动个人和企业的创新发展。

Project Cover

SubCat字幕猫

SubCat字幕猫APP是一款创新的视频播放器,它将改变您观看视频的方式!SubCat结合了先进的人工智能技术,为您提供即时视频字幕翻译,无论是本地视频还是网络流媒体,让您轻松享受各种语言的内容。

Project Cover

美间AI

美间AI创意设计平台,利用前沿AI技术,为设计师和营销人员提供一站式设计解决方案。从智能海报到3D效果图,再到文案生成,美间让创意设计更简单、更高效。

Project Cover

AIWritePaper论文写作

AIWritePaper论文写作是一站式AI论文写作辅助工具,简化了选题、文献检索至论文撰写的整个过程。通过简单设定,平台可快速生成高质量论文大纲和全文,配合图表、参考文献等一应俱全,同时提供开题报告和答辩PPT等增值服务,保障数据安全,有效提升写作效率和论文质量。

投诉举报邮箱: service@vectorlightyear.com
@2024 懂AI·鲁ICP备2024100362号-6·鲁公网安备37021002001498号