iOS Moya实现OAuth请求的方法

0. 起源

开放授权（oauth）是一个开放标准，允许用户让第三方应用访问该用户在某一网站上存储的私密的资源（如照片，视频，联系人列表），而无需将用户名和密码提供给第三方应用。

而作为第三方软件，为用户提供 oauth 登录是更好的选择，可以有效打消用户对于个人账户密码泄露的顾虑，同时也能有效避免用户反复登录，进而增加用户的舒适度，提高用户粘性。

1. 环境

项目使用 mvvm 架构，引入了 rx 全家桶，网络请求框架使用了 moya ，以及处理 oauth 相关的库 oauth2 。

2. oauth2 部分

参阅 oauth2 库的 readme ，完成 oauth 的信息配置：

let oauth2 = oauth2codegrant(settings: [
  "client_id": "my_swift_app",
  "client_secret": "c7447242",
  "authorize_uri": "https://github.com/login/oauth/authorize",
  "token_uri": "https://github.com/login/oauth/access_token",
  "redirect_uris": ["myapp://oauth/callback"],
  "scope": "user repo:status",
  "secret_in_body": true,
  "keychain": false,
] as oauth2json)

同时因为 moya 的底层网络请求实现是基于 alamofire，因此我们可以参照 oauth2 提供的说明文档 alamofire 4 · p2/oauth2 wiki · github 完成相关配置，关键代码如下：

import foundation
import oauth2
import alamofire


class oauth2retryhandler: requestretrier, requestadapter {
  
  let loader: oauth2dataloader
  
  init(oauth2: oauth2) {
    loader = oauth2dataloader(oauth2: oauth2)
  }
  
  /// intercept 401 and do an oauth2 authorization.
  public func should(_ manager: sessionmanager, retry request: request, with error: error, completion: @escaping requestretrycompletion) {
    if let response = request.task?.response as? httpurlresponse, 401 == response.statuscode, let req = request.request {
      var datarequest = oauth2datarequest(request: req, callback: { _ in })
      datarequest.context = completion
      loader.enqueue(request: datarequest)
      loader.attempttoauthorize() { authparams, error in
        self.loader.dequeueandapply() { req in
          if let comp = req.context as? requestretrycompletion {
            comp(nil != authparams, 0.0)
          }
        }
      }
    }
    else {
      completion(false, 0.0)  // not a 401, not our problem
    }
  }
  
  /// sign the request with the access token.
  public func adapt(_ urlrequest: urlrequest) throws -> urlrequest {
    guard nil != loader.oauth2.accesstoken else {
      return urlrequest
    }
    return try urlrequest.signed(with: loader.oauth2)  // "try" added in 3.0.2
  }
}

3. moya 部分

moya 的 provider 在初始化时可以传入 sessionmanager ，因此参照文档，可以先使用 oauth2 生成一个特定的 sessionmanager ：

func getmanager() -> sessionmanager {

    let oauth2 = oauth2codegrant(settings: [
      "client_id": "my_swift_app",
      "client_secret": "c7447242",
      "authorize_uri": "https://github.com/login/oauth/authorize",
      "token_uri": "https://github.com/login/oauth/access_token",
      "redirect_uris": ["myapp://oauth/callback"],
      "scope": "user repo:status",
      "secret_in_body": true,
      "keychain": false,
      ] as oauth2json)

    let sessionmanager = sessionmanager()
    let oauthhandler = oauth2handler(oauth2: oauth2)
    sessionmanager.adapter = oauthhandler
    sessionmanager.retrier = oauthhandler
    return sessionmanager
  }

进而生成带 oauth 的 provider：

fileprivate lazy var provider: moyaprovider = {
  return moyaprovider<api>(manager: self.getmanager(),
              plugins: [networkloggerplugin()])
}()

使用

使用生成的 provider 发送请求即可，此时 moya 可自动处理 oauth 认证信息。

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。