07-Access Token

Access Token

课程目标

• 自定义对象
• 构造函数
• 归档 & 接档

接口定义

文档地址

http://open.weibo.com/wiki/OAuth2/access_token

接口地址

https://api.weibo.com/oauth2/access_token

HTTP 请求方式

• POST

请求参数

参数	描述
client_id	申请应用时分配的AppKey
client_secret	申请应用时分配的AppSecret
grant_type	请求的类型，填写 authorization_code
code	调用authorize获得的code值
redirect_uri	回调地址，需需与注册应用里的回调地址一致

返回数据

返回值字段	字段说明
access_token	用于调用access_token，接口获取授权后的access token
expires_in	access_token的生命周期，单位是秒数
remind_in	access_token的生命周期（该参数即将废弃，开发者请使用expires_in）
uid	当前授权用户的UID

用户账户模型

加载AccessToken

• 在 HMOAuthViewController 中增加函数加载 AccessToken

/// 加载AccessToken的方法
///
/// - parameter code: 授权码
private func loadAccessToken(code: String){
    let urlString = "https://api.weibo.com/oauth2/access_token"

    // 定义参数
    let params = [
        "client_id": WB_APPKEY,
        "client_secret": WB_APPSECRET,
        "grant_type": "authorization_code",
        "code": code,
        "redirect_uri": WB_REDIRECTURI]

    NetworkTools.shareTools.request(.POST, url: urlString, params: params) { (result, error) -> () in
        print(result)
    }
}

• 在获取授权码成功之后调用方法

// 判断是否包含 'code=' 字样
if let query = request.URL?.query where query.containsString("code=") {
    // 截取授权码
    let code = query.substringFromIndex("code=".endIndex)
    print("请求码：\(code)")
    // 请求AccessToken
    loadAccessToken(code)
}else{
    // 用户点击了取消授权，直接关闭页面
    self.close()
}

运行测试

• 返回错误信息

Error Domain=com.alamofire.error.serialization.response Code=-1016 "Request failed: unacceptable content-type: text/plain"

• 在 HMNetworkTools 单例初始化时设置反序列化数据格式

static let shareTools: HMNetworkTools = {
    let tools = HMNetworkTools()
    tools.responseSerializer.acceptableContentTypes?.insert("text/plain")
    return tools
}()

定义 HMUserAcount 模型

• 在 Model 目录下添加 HMUserAccount 类
• 定义模型属性

/// 用户帐号模型
/// - see: [http://open.weibo.com/wiki/OAuth2/access_token](http://open.weibo.com/wiki/OAuth2/access_token)
class HMUserAccount: NSObject {

    // 用于调用access_token，接口获取授权后的access token
    var access_token: String?
    // access_token的生命周期，单位是秒数
    var expires_in: NSTimeInterval = 0
    // 当前授权用户的UID
    var uid: String?

    init(dict: [String: AnyObject]) {
        super.init()

        setValuesForKeysWithDictionary(dict)
    }

    override func setValue(value: AnyObject?, forUndefinedKey key: String) {}
}

• 创建用户帐号模型，在 HMOAuthViewController 的网络回调代码中添加如下代码

let account = HMUserAccount(dict: result as! [String: AnyObject])
print(account)

• 调试模型信息

• 与 OC 不同，如果要在 Swift 1.2 中调试模型信息，需要遵守 Printable 协议，并且重写 description 的 getter 方法，在 Swift 2.0 中，description 属性定义在 CustomStringConvertible 协议中

override var description: String {
    let keys = ["access_token", "expires_in", "uid"]
    return dictionaryWithValuesForKeys(keys).description
}

建议description此代码抽取到Xcode的代码块中，方便使用

设置过期日期

过期日期

• 在新浪微博返回的数据中，过期日期是以当前系统时间加上秒数计算的，为了方便后续使用，增加过期日期属性

• 定义属性

/// token过期日期
var expiresDate: NSDate?

• 在 expires_in 的 didSet 方法里面给 expiresDate 赋值

var expires_in: NSTimeInterval = 0 {
    didSet{
        expiresDate = NSDate(timeIntervalSinceNow: expires_in)
    }
}

• 修改 description

let keys = ["access_token", "expires_in", "expiresDate", "uid"]

加载用户信息

课程目标

• 通过 AccessToken 获取新浪微博网络数据

接口定义

文档地址

http://open.weibo.com/wiki/2/users/show

接口地址

https://api.weibo.com/2/users/show.json

HTTP 请求方式

• GET

请求参数

参数	描述
access_token	采用OAuth授权方式为必填参数，其他授权方式不需要此参数，OAuth授权后获得
uid	需要查询的用户ID

返回数据

返回值字段	字段说明
name	友好显示名称
avatar_large	用户头像地址（大图），180×180像素

测试 URL

https://api.weibo.com/2/users/show.json?access_token=2.00ml8IrF0qLZ9W5bc20850c50w9hi9&uid=5365823342

代码实现

• 在 HMOAuthViewController 中添加 loadUserInfo 方法

/// 加载用户数据
///
/// - parameter userAccount: 用户账户模型
private func loadUserInfo(userAccount: HMUserAccount) {

    let urlString = "https://api.weibo.com/2/users/show.json"
    // 定义参数
    let params = [
        "uid": userAccount.uid!,
        "access_token": userAccount.access_token!
    ]

    HMNetworkTools.shareTools.request(.GET, url: urlString, params: params) { (result, error) -> () in
        if error != nil {
            print("请求失败:\(error)")
            return
        }
        print(result)
    }
}

• 在 loadAccessToken 方法中请求accessToken成功后调用该方法

// 将返回字典转成模型
let account = HMUserAccount(dict: result as! [String: AnyObject])
print(account)
// 请求用户数据
self.loadUserInfo(account)

注意：在 Swift 中，闭包中输入代码的智能提示非常不好，因此新建一个函数单独处理加载用户功能

扩展用户模型

• 在 HMUserAccount 中增加用户名和头像属性

/// 友好显示名称
var screen_name: String?
/// 用户头像地址（大图），180×180像素
var avatar_large: String?

• 扩展 description 中的属性

override var description: String {
    let keys = ["access_token", "expires_in", "expiresDate", "uid", "screen_name", "avatar_large"]

    return dictionaryWithValuesForKeys(keys).description
}

• 在用户信息请求成功之后获取昵称与头像

// 发送get请求
HMNetworkTools.shareTools.request(.GET, url: urlString, params: params) { (result, error) -> () in
    if error != nil {
        print("请求失败:\(error)")
        return
    }
    guard let dict = result as? [String: AnyObject] else {
        return
    }
    // 设置请求回来的用户昵称和头像
    userAccount.screen_name = dict["screen_name"] as? String
    userAccount.avatar_large = dict["avatar_large"] as? String
}

每一个令牌授权一个 特定的网站 在 特定的时段内 访问 特定的资源

归档 & 解档

课程目标

• 对比 OC 的归档 & 解档实现

• 利用归档 & 解档保存用户信息

• 遵守协议

class HMUserAccount: NSObject, NSCoding

• 实现协议方法

// MARK: - NSCoding
/// 归档 - 将对象以二进制形式保存至磁盘前被调用，与网络的序列化类似
func encodeWithCoder(aCoder: NSCoder) {
    aCoder.encodeObject(access_token, forKey: "access_token")
    aCoder.encodeObject(expiresDate, forKey: "expiresDate")
    aCoder.encodeObject(uid, forKey: "uid")
    aCoder.encodeObject(name, forKey: "name")
    aCoder.encodeObject(avatar_large, forKey: "avatar_large")
}

/// 解档 - 将二进制数据从磁盘读取并且转换成对象时被调用，与网络的反序列化类似
required init?(coder aDecoder: NSCoder) {
    access_token = aDecoder.decodeObjectForKey("access_token") as? String
    expiresDate = aDecoder.decodeObjectForKey("expiresDate") as? NSDate
    uid = aDecoder.decodeObjectForKey("uid") as? String
    name = aDecoder.decodeObjectForKey("name") as? String
    avatar_large = aDecoder.decodeObjectForKey("avatar_large") as? String
}

• 实现将当前对象归档保存的函数

/// 归档保存当前对象
func saveUserAccount(){
    let path = (NSSearchPathForDirectoriesInDomains(.DocumentDirectory, .UserDomainMask, true).last! as NSString).stringByAppendingPathExtension("userAccount.archive")!
    print("归档保存路径：\(path)")
    // 归档
    NSKeyedArchiver.archiveRootObject(self, toFile: path)
}

视图模型

目标一：建立视图模型，抽取网络请求代码

• 建立用户账户的视图模型

/// 用户账户视图模型
class HMUserAccountViewModel: NSObject {

    /// 单例
    static let sharedUserAccount = HMUserAccountViewModel()

    /// 用户账户模型
    var userAccount: HMUserAccount?
}

• 抽取网络请求代码到视图模型中

/// 加载AccessToken并且加载用户信息
///
/// - parameter code:     授权码
/// - parameter complete: 完成回调
func loadAccessToken(code: String, complete:(isSuccessed: Bool)->()){

    let urlString = "https://api.weibo.com/oauth2/access_token"

    // 定义参数
    let params = [
        "client_id": WB_APPKEY,
        "client_secret": WB_APPSECRET,
        "grant_type": "authorization_code",
        "code": code,
        "redirect_uri": WB_REDIRECTURI]

    HMNetworkTools.sharedTools.request(.POST, urlString: urlString, parameters: params) { (response, error) -> () in

        if error != nil {
            print(error)
            return
        }

        let account = HMUserAccount(dict: response as! [String: AnyObject])
        print(account)
        self.userAccount = account
        // 请求用户数据
        self.loadUserInfo(account.uid!, accessToken: account.access_token!, complete: complete)
    }
}

/// 加载用户信息
///
/// - parameter uid:         用户uid
/// - parameter accessToken: accessToken
/// - parameter complete:    完成回调
private func loadUserInfo(uid: String, accessToken: String, complete:(isSuccessed: Bool)->()){

    let urlString = "https://api.weibo.com/2/users/show.json"
    // 组织参数
    let params = [
        "access_token": accessToken,
        "uid": uid
    ]
    // 发送请求
    HMNetworkTools.sharedTools.request(.GET, urlString: urlString, parameters: params) { (response, error) -> () in

        if error != nil {
            print("请求失败\(error)")
            complete(isSuccessed: false)
            return
        }
        print(response)

        // 在 if let 或者 guard let 里面 使用 as 都使用 ?
        guard let responseDic = response as? [String: AnyObject] else {
            print("返回数据不是一个字典")
            complete(isSuccessed: false)
            return
        }
        // 赋值用户的头像与昵称
        self.userAccount?.screen_name = responseDic["screen_name"] as? String
        self.userAccount?.avatar_large = responseDic["avatar_large"] as? String

        complete(isSuccessed: true)
    }
}

• 修改 HMOAuthViewController 中的代码调用

// 请求  AccessToken以及用户数据
HMUserAccountViewModel.sharedUserAccount.loadAccessToken(code, complete: { (isSuccessed) -> () in
    if isSuccessed {
        print("个人信息请求成功，跳转界面")
    }else{
        print("个人信息请求失败")
    }
})

• 删除控制器里面 loadAccessToken 与 loadUserInfo 两个方法

控制器的代码简单了！

目标二：加载归档保存的 token，避免重复登录

• 抽取归档代码到 ViewModel中，并且实现解档方法

// MARK: - 保存 & 加载
/// 解档归档路径
    // 归档与解档的路径
    private var archivePath: String = (NSSearchPathForDirectoriesInDomains(.DocumentDirectory, .UserDomainMask, true).last! as NSString).stringByAppendingPathComponent("useraccount.archive")

// 归档当前对象
func saveAccount(account: HMUserAccount) {
    // 归档
    NSKeyedArchiver.archiveRootObject(account, toFile: archivePath)
}

// 解档
func loadUserAccount() -> HMUserAccount? {
    // 解档
    let result = NSKeyedUnarchiver.unarchiveObjectWithFile(archivePath) as? HMUserAccount
    return result
}

• 在 AppDelegate 中添加以下代码测试

printLog(HMUserAccountViewModel.sharedUserAccount.loadUserAccount())

• 代码优化，在视图模型初始化方法里面添加解档的逻辑

private override init() {
    super.init()
    userAccount = loadUserAccount()
}

private init 可以避免外部调用构造函数创建对象

• 在 view model 中添加 accessToken 计算型属性

// 提供给外界accessToken的值
var accessToken: String? {
    return userAccount?.access_token
}

• 添加 isExpires 判断帐号是否过期

// 帐号是否过期
var isExpires: Bool {
    if userAccount?.expiresDate?.compare(NSDate()) == NSComparisonResult.OrderedDescending {
        return false
    }
    return true
}

• 更改 accessToken 的 get 方法

// 访问令牌
var accessToken: String? {
    // 其内部判断 accessToken 是否有
    if !isExpires {
        return userAccount?.access_token
    }
    return nil
}

• 修改 HMVisitorViewController 中的用户登录标记

var userLogon = HMUserAccountViewModel.sharedUserAccount.accessToken != nil

• 在视图模型中增加 userLogon 计算型属性

/// 用户登录标记
var userLogon: Bool {
    return userAccount?.access_token != nil
}

• 再次修改 HMVisitorViewController 中的用户登录标记

var userLogon = HMUserAccountViewModel.sharedUserAccount.userLogon