可组合的 Core Location

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

示例
基本用法
安装
文档
帮助

示例

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

基本用法

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

import ComposableCoreLocation

enum AppAction {
  case locationManager(LocationManager.Action)

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

LocationManager.Action 枚举为 CLLocationManagerDelegate 的每个委托方法保存一个情况，如 didUpdateLocations、didEnterRegion、didUpdateHeading 等。

接下来，我们将 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。然后，你可以选择性地覆盖你的功能需要提供确定性功能的任何端点。

例如，要测试请求位置授权、被拒绝和显示警告的流程，我们需要覆盖 create 和 requestWhenInUseAuthorization 端点。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)

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