Access Token
課程目標(biāo)
- 自定義對象
- 構(gòu)造函數(shù)
- 歸檔 & 接檔
接口定義
文檔地址
http://open.weibo.com/wiki/OAuth2/access_token
接口地址
https://api.weibo.com/oauth2/access_token
HTTP 請求方式
- POST
請求參數(shù)
| 參數(shù) | 描述 |
|---|---|
| client_id | 申請應(yīng)用時分配的AppKey |
| client_secret | 申請應(yīng)用時分配的AppSecret |
| grant_type | 請求的類型,填寫 authorization_code
|
| code | 調(diào)用authorize獲得的code值 |
| redirect_uri | 回調(diào)地址,需需與注冊應(yīng)用里的回調(diào)地址一致 |
返回數(shù)據(jù)
| 返回值字段 | 字段說明 |
|---|---|
| access_token | 用于調(diào)用access_token,接口獲取授權(quán)后的access token |
| expires_in | access_token的生命周期,單位是秒數(shù) |
| remind_in | access_token的生命周期(該參數(shù)即將廢棄,開發(fā)者請使用expires_in) |
| uid | 當(dāng)前授權(quán)用戶的UID |
用戶賬戶模型
加載AccessToken
- 在
HMOAuthViewController中增加函數(shù)加載AccessToken
/// 加載AccessToken的方法
///
/// - parameter code: 授權(quán)碼
private func loadAccessToken(code: String){
let urlString = "https://api.weibo.com/oauth2/access_token"
// 定義參數(shù)
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)
}
}
- 在獲取授權(quán)碼成功之后調(diào)用方法
// 判斷是否包含 'code=' 字樣
if let query = request.URL?.query where query.containsString("code=") {
// 截取授權(quán)碼
let code = query.substringFromIndex("code=".endIndex)
print("請求碼:\(code)")
// 請求AccessToken
loadAccessToken(code)
}else{
// 用戶點擊了取消授權(quán),直接關(guān)閉頁面
self.close()
}
運(yùn)行測試
- 返回錯誤信息
Error Domain=com.alamofire.error.serialization.response Code=-1016 "Request failed: unacceptable content-type: text/plain"
- 在
HMNetworkTools單例初始化時設(shè)置反序列化數(shù)據(jù)格式
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 {
// 用于調(diào)用access_token,接口獲取授權(quán)后的access token
var access_token: String?
// access_token的生命周期,單位是秒數(shù)
var expires_in: NSTimeInterval = 0
// 當(dāng)前授權(quán)用戶的UID
var uid: String?
init(dict: [String: AnyObject]) {
super.init()
setValuesForKeysWithDictionary(dict)
}
override func setValue(value: AnyObject?, forUndefinedKey key: String) {}
}
- 創(chuàng)建用戶帳號模型,在
HMOAuthViewController的網(wǎng)絡(luò)回調(diào)代碼中添加如下代碼
let account = HMUserAccount(dict: result as! [String: AnyObject])
print(account)
調(diào)試模型信息
與 OC 不同,如果要在 Swift 1.2 中調(diào)試模型信息,需要遵守
Printable協(xié)議,并且重寫description的getter方法,在 Swift 2.0 中,description屬性定義在CustomStringConvertible協(xié)議中
override var description: String {
let keys = ["access_token", "expires_in", "uid"]
return dictionaryWithValuesForKeys(keys).description
}
建議description此代碼抽取到Xcode的代碼塊中,方便使用
設(shè)置過期日期
過期日期
在新浪微博返回的數(shù)據(jù)中,過期日期是以當(dāng)前系統(tǒng)時間加上秒數(shù)計算的,為了方便后續(xù)使用,增加過期日期屬性
定義屬性
/// 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"]
加載用戶信息
課程目標(biāo)
- 通過
AccessToken獲取新浪微博網(wǎng)絡(luò)數(shù)據(jù)
接口定義
文檔地址
http://open.weibo.com/wiki/2/users/show
接口地址
https://api.weibo.com/2/users/show.json
HTTP 請求方式
- GET
請求參數(shù)
| 參數(shù) | 描述 |
|---|---|
| access_token | 采用OAuth授權(quán)方式為必填參數(shù),其他授權(quán)方式不需要此參數(shù),OAuth授權(quán)后獲得 |
| uid | 需要查詢的用戶ID |
返回數(shù)據(jù)
| 返回值字段 | 字段說明 |
|---|---|
| name | 友好顯示名稱 |
| avatar_large | 用戶頭像地址(大圖),180×180像素 |
測試 URL
https://api.weibo.com/2/users/show.json?access_token=2.00ml8IrF0qLZ9W5bc20850c50w9hi9&uid=5365823342
代碼實現(xiàn)
- 在
HMOAuthViewController中添加loadUserInfo方法
/// 加載用戶數(shù)據(jù)
///
/// - parameter userAccount: 用戶賬戶模型
private func loadUserInfo(userAccount: HMUserAccount) {
let urlString = "https://api.weibo.com/2/users/show.json"
// 定義參數(shù)
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成功后調(diào)用該方法
// 將返回字典轉(zhuǎn)成模型
let account = HMUserAccount(dict: result as! [String: AnyObject])
print(account)
// 請求用戶數(shù)據(jù)
self.loadUserInfo(account)
注意:在 Swift 中,閉包中輸入代碼的智能提示非常不好,因此新建一個函數(shù)單獨處理加載用戶功能
擴(kuò)展用戶模型
- 在
HMUserAccount中增加用戶名和頭像屬性
/// 友好顯示名稱
var screen_name: String?
/// 用戶頭像地址(大圖),180×180像素
var avatar_large: String?
- 擴(kuò)展
description中的屬性
override var description: String {
let keys = ["access_token", "expires_in", "expiresDate", "uid", "screen_name", "avatar_large"]
return dictionaryWithValuesForKeys(keys).description
}
- 在用戶信息請求成功之后獲取昵稱與頭像
// 發(fā)送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
}
// 設(shè)置請求回來的用戶昵稱和頭像
userAccount.screen_name = dict["screen_name"] as? String
userAccount.avatar_large = dict["avatar_large"] as? String
}
每一個令牌授權(quán)一個
特定的網(wǎng)站在特定的時段內(nèi)訪問特定的資源
歸檔 & 解檔
課程目標(biāo)
對比 OC 的
歸檔 & 解檔實現(xiàn)利用
歸檔 & 解檔保存用戶信息遵守協(xié)議
class HMUserAccount: NSObject, NSCoding
- 實現(xiàn)協(xié)議方法
// MARK: - NSCoding
/// 歸檔 - 將對象以二進(jìn)制形式保存至磁盤前被調(diào)用,與網(wǎng)絡(luò)的序列化類似
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")
}
/// 解檔 - 將二進(jìn)制數(shù)據(jù)從磁盤讀取并且轉(zhuǎn)換成對象時被調(diào)用,與網(wǎng)絡(luò)的反序列化類似
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
}
- 實現(xiàn)將當(dāng)前對象歸檔保存的函數(shù)
/// 歸檔保存當(dāng)前對象
func saveUserAccount(){
let path = (NSSearchPathForDirectoriesInDomains(.DocumentDirectory, .UserDomainMask, true).last! as NSString).stringByAppendingPathExtension("userAccount.archive")!
print("歸檔保存路徑:\(path)")
// 歸檔
NSKeyedArchiver.archiveRootObject(self, toFile: path)
}
視圖模型
目標(biāo)一:建立視圖模型,抽取網(wǎng)絡(luò)請求代碼
- 建立用戶賬戶的視圖模型
/// 用戶賬戶視圖模型
class HMUserAccountViewModel: NSObject {
/// 單例
static let sharedUserAccount = HMUserAccountViewModel()
/// 用戶賬戶模型
var userAccount: HMUserAccount?
}
- 抽取網(wǎng)絡(luò)請求代碼到視圖模型中
/// 加載AccessToken并且加載用戶信息
///
/// - parameter code: 授權(quán)碼
/// - parameter complete: 完成回調(diào)
func loadAccessToken(code: String, complete:(isSuccessed: Bool)->()){
let urlString = "https://api.weibo.com/oauth2/access_token"
// 定義參數(shù)
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
// 請求用戶數(shù)據(jù)
self.loadUserInfo(account.uid!, accessToken: account.access_token!, complete: complete)
}
}
/// 加載用戶信息
///
/// - parameter uid: 用戶uid
/// - parameter accessToken: accessToken
/// - parameter complete: 完成回調(diào)
private func loadUserInfo(uid: String, accessToken: String, complete:(isSuccessed: Bool)->()){
let urlString = "https://api.weibo.com/2/users/show.json"
// 組織參數(shù)
let params = [
"access_token": accessToken,
"uid": uid
]
// 發(fā)送請求
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("返回數(shù)據(jù)不是一個字典")
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中的代碼調(diào)用
// 請求 AccessToken以及用戶數(shù)據(jù)
HMUserAccountViewModel.sharedUserAccount.loadAccessToken(code, complete: { (isSuccessed) -> () in
if isSuccessed {
print("個人信息請求成功,跳轉(zhuǎn)界面")
}else{
print("個人信息請求失敗")
}
})
- 刪除控制器里面
loadAccessToken與loadUserInfo兩個方法
控制器的代碼簡單了!
目標(biāo)二:加載歸檔保存的 token,避免重復(fù)登錄
- 抽取歸檔代碼到 ViewModel中,并且實現(xiàn)解檔方法
// MARK: - 保存 & 加載
/// 解檔歸檔路徑
// 歸檔與解檔的路徑
private var archivePath: String = (NSSearchPathForDirectoriesInDomains(.DocumentDirectory, .UserDomainMask, true).last! as NSString).stringByAppendingPathComponent("useraccount.archive")
// 歸檔當(dāng)前對象
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())
- 代碼優(yōu)化,在視圖模型初始化方法里面添加解檔的邏輯
private override init() {
super.init()
userAccount = loadUserAccount()
}
private init可以避免外部調(diào)用構(gòu)造函數(shù)創(chuàng)建對象
- 在
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? {
// 其內(nèi)部判斷 accessToken 是否有
if !isExpires {
return userAccount?.access_token
}
return nil
}
- 修改
HMVisitorViewController中的用戶登錄標(biāo)記
var userLogon = HMUserAccountViewModel.sharedUserAccount.accessToken != nil
- 在視圖模型中增加
userLogon計算型屬性
/// 用戶登錄標(biāo)記
var userLogon: Bool {
return userAccount?.access_token != nil
}
- 再次修改
HMVisitorViewController中的用戶登錄標(biāo)記
var userLogon = HMUserAccountViewModel.sharedUserAccount.userLogon