基于AFNetworking 的OAuth2认证 类 AFOAu

情况介绍:

这篇文章目的是解决OAuth2 授权验证方式, POST请求返回结果 40X,报错,原因出在哪里呢,如何修改呢,现在将过程交代一下情况如下:

接口分析:

后台使用OAuth2 授权验证方式,POST请求,接口类型如下

功能描述: 获取access_token
请求地址: http://domain/uaa/oauth/token
请求动作: POST
请求示例: http://domain/uaa/oauth/token?grant_type=password&username=mayun&password=mayun
Authorization：
- Type:Base Auth
- Username:iosClient
- Password: iosClient

返回示例 { "access_token": "bdfc82c8-8020-4f50-8c69-125b34594a46", "token_type": "bearer", "refresh_token": "6fcec503-ead9-414c-87ee-9af13a855e03", "expires_in": 36464, "scope": "xx" }

首先需要身份验证,要传入验证身份的clientID 和 secret,分别是iosClient和iosSecret,这个是后台授权的客户端的key

grant_type ,这个值,可把我坑坏了,由于不了解OAuth2 ,所以在POST请求时,老是以为问题出在这(因为iOS,NSDictionary,对于带下划线的参数,会变成"grant_type"),打印传入的参数一看,总是不对,浪费了很多不必要的时间, grant_type其实是OAuth2 规定的, grant_type=password

该分析的都分析好了,下面讲一下两种解决方案

方案一:

看链接可以发现,不就是让我们通过POST,传入几个参数,加上身份验证吗,那我们就直接给后台想要的东西,将grant_type password和phoneNum直接拼到链接后面,然后设置

// self 是继承自AFHTTPSessionManager,这个方法AFHTTPRequestSerializer类有提供,设置header
 [ self.requestSerializer setAuthorizationHeaderFieldWithUsername:@"iosClient" password:@"iosClient"];

这一步相当于传入身份验证的key给验证服务器
整个方法代码如下

+ (void)AuthenticationWithPhoneNum:(NSString *)phoneNum password:(NSString *)password callBack:(void (^)(NSDictionary * result))success{

    [ [CBNetworkManager sharedManager].requestSerializer setAuthorizationHeaderFieldWithUsername:@"iosClient" password:@"iosClient"];
    
    [CBNetworkManager post_requestWithURLString:[NSString stringWithFormat:@" http://domain/uaa/oauth/token?grant_type=password&password=%@phoneNum=%@",password,phoneNum] parameters:nil progressBlock:^(float progress) {
        
    } callBack:^(NSURLSessionTask *task, id response, NSError *error) {
        if (error) {
            NSLog(@"error == %@",error);
        }
        else {

            NSLog(@"response == %@", response);
            if ([response isKindOfClass:[NSDictionary class]]) {
                NSDictionary * result = response;
                success(result);
            }
        }
    }];
}

这种方式,简单粗暴,效果好,见效快,但是如果后端比较严格, 筛选参数传递方式,是拼接,还是body,这个方法就不好使了.因此引入第二种方案

方案二:

引入AFOAuth2Manager 类,一个依托于AFNetworking框架的一个扩展模块,就是为了解决OAuth2认证机制开发的模块
关于这个类的详细介绍,请看这篇文章Auth2认证

首先引入AFOAuth2Manager 框架, 导入#import <AFOAuth2Manager.h>,调用AFOAuth2Manager的身份验证方法

NSURL *baseURL = [NSURL URLWithString:@"http://example.com/"];
AFOAuth2Manager *OAuth2Manager =
            [[AFOAuth2Manager alloc] initWithBaseURL:baseURL
                                            clientID:kClientID
                                              secret:kClientSecret];

[OAuth2Manager authenticateUsingOAuthWithURLString:@"/oauth/token"
                                          username:@"username"
                                          password:@"password"
                                             scope:@"email"
                                           success:^(AFOAuthCredential *credential) {
                                               NSLog(@"Token: %@", credential.accessToken);
                                           }
                                           failure:^(NSError *error) {
                                               NSLog(@"Error: %@", error);
                                           }];

然后将我们获取到的参数,传递到这个方法里,直接进行调用

+ (void)AuthenticationWithPhoneNum:(NSString *)phoneNum password:(NSString *)password callBack:(void (^)(NSDictionary * result))success{

    NSURL *baseURL = [NSURL URLWithString:@" http://domain"];
    AFOAuth2Manager *OAuth2Manager =
    [[AFOAuth2Manager alloc] initWithBaseURL:baseURL
                                    clientID:@"iosClient"
                                      secret:@"iosClient"];
    
    [OAuth2Manager authenticateUsingOAuthWithURLString:@"/uaa/oauth/token"
                                              username:@"185565xxxxx"
                                              password:@"123456"
                                                 scope:@""
                                               success:^(AFOAuthCredential *credential) {
                                                   // 存储access_token
                                                   NSLog(@"Token: %@", credential.accessToken);
                                                   
                                               }
                                               failure:^(NSError *error) {
                                                   NSLog(@"Error: %@", error);
                                                   
                                               }];
}

注意: 这个地方注意两个链接,在拼接的时候,会出现错误,请留意请求链接是否完整,要小心!

在success回调方法里,就可以获得我们要的access_token了. AFOAuth2Manager具体的源码如下:

- (NSURLSessionTask *)authenticateUsingOAuthWithURLString:(NSString *)URLString
                                                 username:(NSString *)username
                                                 password:(NSString *)password
                                                    scope:(NSString *)scope
                                                  success:(void (^)(AFOAuthCredential * _Nonnull))success
                                                  failure:(void (^)(NSError * _Nonnull))failure {
    NSParameterAssert(username);
    NSParameterAssert(password);

    NSMutableDictionary *parameters = [NSMutableDictionary dictionary];
    [parameters setValue:kAFOAuthPasswordCredentialsGrantType forKey:@"grant_type"];
    [parameters setValue:username forKey:@"username"];
    [parameters setValue:password forKey:@"password"];

    if (scope) {
        [parameters setValue:scope forKey:@"scope"];
    }

    return [self authenticateUsingOAuthWithURLString:URLString parameters:parameters success:success failure:failure];
}

前面一直纠结的grant_type,其实是OAuth2约定的,所以就不用在参数中自己进行设置,返回的AFOAuthCredential,里面就包含了我们要的access_token和refresh_token了.

有问题欢迎请留言!