[Umeng] 友盟集成 - 第三方登录/分享

作者: 流火绯瞳 | 来源:发表于2017-11-16 17:38 被阅读121次

文章涉及的demo在Github LQThirdParty, 欢迎Star | Fork

一. 注册账号

首先到友盟的开放平台注册成为开发者, 并新建应用, 获得相应的 APPKey.然后到相应的第三方平台注册成为开发者, 新建应用, 获取对应的AppKey.

微信开放平台 , QQ开放平台, 新浪微博开放平台

二. 集成及配置

2.1 集成

2.1.1 CocoaPods集成

CocoaPods集成好处不多说, 根据官方文档在项目 Podfile 文件添加相应的引入即可:

# 集成微信(精简版0.2M)
pod 'UMengUShare/Social/ReducedWeChat'
 # 集成QQ/QZone/TIM(精简版0.5M)
pod 'UMengUShare/Social/ReducedQQ'
# 集成新浪微博(精简版1M)
pod 'UMengUShare/Social/ReducedSina'

这里只集成了精简版的SDK, 能够满足登录及分享需求. 如果还有微信支付, 请将微信SDK换成完整版.

如果使用Swift, 需要在桥接文件, 引入:

#import <UMSocialCore/UMSocialCore.h>

如果使用Objective-C, 在使用的类中引入即可;

PS: 如果项目中使用了微信支付, 请集成完整版微信SDK:

# 集成微信(完整版14.4M)
pod 'UMengUShare/Social/WeChat'

2.1.2 手动集成

官方集成文档
首先下载iOS SDK, 在下载页选择需要的第三方平台SDK, 点击下载即可;

1. Document     - U-Share SDK文档
2. UMSocialDemo - U-Share SDK Demo（如点选下载）
3. UMSocial     - U-Share SDK核心目录
        UMSocialSDK       - U-Share SDK核心framework
        UMSocialUI        - U-Share 分享UI资源、分享面板framework
        SocialLibraries   - 所选择下载的第三方平台SDK及U-Share链接库
        UMSocialSDKPlugin - SDK需要的依赖插件

主要使用的是 UMSocial 文件夹中的文件:
UMSocialSDK 与 SocialLibraries是必须要添加的,
UMSocialUI 根据需要添加;
UMSocialSDKPlugin 用于生成开发者调试log，集成测试完毕后可移除。
到此, 所需文件集成完毕.

2.2 配置项目

接下来,我们需要添加一些系统的依赖库, 和引用设置;

2.2.1 在Other Linker Flags加入-ObjC

在Target -> Build Setting -> Linking ->Other Linker Flags添加 -ObjC , 注意大小写.

2.2.2 添加依赖库

在Target -> General -> Linked Frameworks and Libraries 添加

系统库:

libsqlite3.tbd
CoreGraphics.framework

第三方依赖库, 以微信/QQ/新浪微博为例, 其他的可参考官方文档:

注意: 以下依赖库的添加, 只针对完整版SDK, 精简版的SDK, 不需要添加

微信(完整版)-精简版无需添加以下依赖库
SystemConfiguration.framework
CoreTelephony.framework
libsqlite3.tbd
libc++.tbd
libz.tbd

QQ/QZone/TIM(完整版)-精简版无需添加以下依赖库
SystemConfiguration.framework
libc++.tbd 

新浪微博(完整版)-精简版无需添加以下依赖库
SystemConfiguration.framework
CoreTelephony.framework
ImageIO.framework
libsqlite3.tbd
libz.tbd

2.3 设置 URL Scheme

URL Scheme是通过系统找到并跳转对应app的设置，通过向项目中的info.plist文件中加入URL types可使用第三方平台所注册的appkey信息向系统注册你的app，当跳转到第三方应用授权或分享后，可直接跳转回你的app。

在 Info -> URL Types 中添加:

具体的设置, 可参考官方文档

2.4 适配 iOS 9 +

在iOS 9以上系统, 需要添加一些设置:

2.4.1 配置SSO白名单

在iOS9以上系统需要增加一个可跳转App的白名单，即LSApplicationQueriesSchemes, 否则将在SDK判断是否跳转时用到的canOpenURL时返回NO，进而只进行webview授权或授权/分享失败.
在项目中的info.plist中加入应用白名单，右键info.plist选择source code打开, 根据选择的平台对以下配置进行缩减：

<key>LSApplicationQueriesSchemes</key>
<array>
    <!-- 微信 URL Scheme 白名单-->
    <string>wechat</string>
    <string>weixin</string>

    <!-- 新浪微博 URL Scheme 白名单-->
    <string>sinaweibohd</string>
    <string>sinaweibo</string>
    <string>sinaweibosso</string>
    <string>weibosdk</string>
    <string>weibosdk2.5</string>

    <!-- QQ、Qzone、TIM URL Scheme 白名单-->
    <string>mqqapi</string>
    <string>mqq</string>
    <string>mqqOpensdkSSoLogin</string>
    <string>mqqconnect</string>
    <string>mqqopensdkdataline</string>
    <string>mqqopensdkgrouptribeshare</string>
    <string>mqqopensdkfriend</string>
    <string>mqqopensdkapi</string>
    <string>mqqopensdkapiV2</string>
    <string>mqqopensdkapiV3</string>
    <string>mqqopensdkapiV4</string>
    <string>mqzoneopensdk</string>
    <string>wtloginmqq</string>
    <string>wtloginmqq2</string>
    <string>mqqwpa</string>
    <string>mqzone</string>
    <string>mqzonev2</string>
    <string>mqzoneshare</string>
    <string>wtloginqzone</string>
    <string>mqzonewx</string>
    <string>mqzoneopensdkapiV2</string>
    <string>mqzoneopensdkapi19</string>
    <string>mqzoneopensdkapi</string>
    <string>mqqbrowser</string>
    <string>mttbrowser</string>
    <string>tim</string>
    <string>timapi</string>
    <string>timopensdkfriend</string>
    <string>timwpa</string>
    <string>timgamebindinggroup</string>
    <string>timapiwallet</string>
    <string>timOpensdkSSoLogin</string>
    <string>wtlogintim</string>
    <string>timopensdkgrouptribeshare</string>
    <string>timopensdkapiV4</string>
    <string>timgamebindinggroup</string>
    <string>timopensdkdataline</string>
    <string>wtlogintimV1</string>
    <string>timapiV1</string>

    <!-- 支付宝 URL Scheme 白名单-->
    <string>alipay</string>
    <string>alipayshare</string>
</array>

其他平台, 可参考官方文档

2.4.2 网络请求

方式一: 暂时回退到HTTP请求
在Info.plist文件中添加字段: NSAppTransportSecurity, 类型为字典;
然后添加一个Key：NSAllowsArbitraryLoads, 类型为Boolean, 值为 YES

回退到HTTP

或者以Source Code 打开Info.plist文件, 空白处添加以下代码:

<key>NSAppTransportSecurity</key>
    <dict>
        <key>NSAllowsArbitraryLoads</key>
        <true/>
    </dict>

方式二: 设置域

在项目的info.plist中添加一个Key：NSAppTransportSecurity，类型为字典类型。
然后给它添加一个值: NSExceptionDomains，类型为字典类型；
把需要的支持的域添加給NSExceptionDomains
其中域作为Key，类型为字典类型。
每个域下面需要设置3个属性：
NSIncludesSubdomains、
NSExceptionRequiresForwardSecrecy、NSExceptionAllowsInsecureHTTPLoads。

均为Boolean类型，值分别为YES、NO、YES

微信需要设置的域为:

qq.com

QQ域

或者以Source Code 打开Info.plist文件, 空白处添加以下代码:

<key>NSAppTransportSecurity</key>
    <dict>
        <key>NSExceptionDomains</key>
        <dict>
            <key>qq.com</key>
            <dict>
                <key>NSExceptionAllowsInsecureHTTPLoads</key>
                <true/>
                <key>NSExceptionRequiresForwardSecrecy</key>
                <false/>
                <key>NSIncludesSubdomains</key>
                <true/>
            </dict>
        </dict>
    </dict>

PS: 这种方式需要对每个要以HTTP方式访问的域名进行设置, 比较麻烦, 建议使用第一种方式.

到此, 相关的配置就完成了, 下面就是使用相关的API实现相应的功能.

PS: 如果是Swift项目, 在使用相关API的时候, 需要新建桥接头文件, 或者在已有桥接头文件内引用其头文件:

#import <UMSocialCore/UMSocialCore.h>

编译一下, 如果没有报错, 即集成完成, 下面可以正常使用相关API了;
在Xcode9 +的版本中, 可能会报找不到头文件<UMSocialCore/UMSocialCore.h>的错误, 只需要将拖进来的文件从目录中删除, 不要删除文件, 删除引用即可: 右键 -> Delegate -> Remove References

屏幕快照 2017-11-16 上午11.26.43.png

然后, 重新右键 -> Add Files To..., 找到添加的文件, 重新添加即可.
此时, 再去编译, 就不会报错了.

三. 登录

以上配置完成, 接下来的就很简单了, 登录授权的API相对比较简单.所有平台的登录请参考官方文档

3.1 注册APP

在相应的开放平台新建APP之后, 获取到相应的APPkey和appSecret; 调用以下方法进行注册:

class func registApp() {
        // 打开调试模式日志
        UMSocialManager.default().openLog(true)
        UMSocialManager.default().umSocialAppkey = kUMengAppKey
        //        UMSocialManager.default().umSocialAppSecret = ""
        
        // 关闭强制验证https, 即可分享http链接图片
UMSocialGlobal.shareInstance().isUsingHttpsWhenShareContent = false
    
       //注册微信
        UMSocialManager.default().setPlaform(UMSocialPlatformType.wechatSession, appKey: kWechatAppID, appSecret: kWechatAppSecret, redirectURL: "")
        
        //注册QQ
        UMSocialManager.default().setPlaform(UMSocialPlatformType.QQ, appKey: kQQAppID, appSecret: nil, redirectURL: "")
        
        // 注册新浪微博
        UMSocialManager.default().setPlaform(UMSocialPlatformType.sina, appKey: kSinaWeiboAppKey, appSecret: kSinaWeiboAppSecret, redirectURL: kSinaWeibOredirectUri)
    }

此方法要在AppDelegate中的 func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool 方法中调用;

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
        // Override point for customization after application launch.
        
        LQUmengTool.registApp()
        return true
    }

3.2 设置系统回调

系统回调有的API会有系统版本的限制, 具体可参考官方文档, 这里只给出通用的设置:

func application(_ application: UIApplication, open url: URL, sourceApplication: String?, annotation: Any) -> Bool {
        
        UMSocialManager.default().handleOpen(url,sourceApplication: sourceApplication, annotation: annotation)
        return true
    }

此系统方法, 在iOS 9之后被废弃了, 建议使用下面的方法:

func application(_ app: UIApplication, open url: URL, options: [UIApplicationOpenURLOptionsKey : Any] = [:]) -> Bool {
        
        UMSocialManager.default().handleOpen(url, options: options)
        return true
    }

但是, 使用上面的API也不会有警告, 如果需要适配iOS 9以下系统, 直接使用上面那个方法即可;

3.3 获取授权及用户信息

以上设置完毕, 只需要在登登录的事件内添加以下获取授权的方法即可, 这里我封装进了一个方法里:

class func login(_ type: LQPlatformType, handle: @escaping ((_ uid: String, _ name: String, _ url: String, _ sex: String) -> Void)) {
        
        var loginType: UMSocialPlatformType? = nil
        
        if type == .QQ {
            loginType = UMSocialPlatformType.QQ
        } else if type == .Wechat {
            loginType = UMSocialPlatformType.wechatSession
        } else if type == .SinaWeibo {
            loginType = UMSocialPlatformType.sina
        }
        
        if let login = loginType {
            // 取消上次授权
            UMSocialManager.default().cancelAuth(with: login) { (result, error) in }
            
            UMSocialManager.default().getUserInfo(with: login, currentViewController: nil) { (result, error) in
                
                if let resp = result as? UMSocialUserInfoResponse {
                    
                    var uid = ""
                    if resp.uid != nil {
                        uid = resp.uid!
                    }
                    
                    var name = ""
                    if resp.name != nil {
                        name = resp.name!
                    }
                    
                    var icon = ""
                    if resp.iconurl != nil {
                        icon = resp.iconurl
                    }
                    
                    var gender = ""
                    if resp.unionGender != nil {
                        gender = resp.unionGender!
                    }
                    
                    handle(uid, name, icon, gender)
                } else {
                    print(error!)
                }
            }
        }
    }

其中 LQPlatformType 为登录的类型:

enum LQPlatformType {
    case QQ, Wechat, SinaWeibo
}

这里只使用了微信/QQ/新浪微博登录, 一般常用的也是这三种, 结果回调里返回了uid, name, 头像, 性别. 其他的内容可参考文档获取.对象的 originalResponse属性可获取原始的第三方数据.

四. 分享

4.1 使用友盟分享面板

引入友盟UShareUI模块后, 即可使用友盟的分享面板, 然后根据回调中的类型, 再去创建分享到各个平台的消息.

#import <UShareUI/UShareUI.h>

UMSocialUIManager.showShareMenuViewInWindow { (type, info) in
            
        }

4.2 分享网页

// 创建分享内容
        let obj = UMShareWebpageObject()
        obj.thumbImage = "https://timgsa.baidu.com/timg?image&quality=80&size=b9999_10000&sec=1510824926407&di=73ce61c358f9947833d03e13aa9712dc&imgtype=0&src=http%3A%2F%2Fimage.tianjimedia.com%2FuploadImages%2F2013%2F255%2FHP4C7KBZQ0YP.jpg"
        obj.title = "欢迎关注简书: 流火绯瞳"
        obj.descr = "一个开发者"
        obj.webpageUrl = "http://www.jianshu.com/u/2846c3d3a974"
        
        //创建分享消息
        let message = UMSocialMessageObject(mediaObject: obj)
        
        UMSocialManager.default().share(to: UMSocialPlatformType.wechatSession, messageObject: message, currentViewController: nil) { (info, error) in
            if let respons = info as? UMSocialShareResponse {
                
                print(respons.message)
                print(respons.originalResponse)
            }
        }

4.3 分享图片

let obj = UMShareImageObject()
        // 图片内容 （可以是UIImage类对象，也可以是NSdata类对象，也可以是图片链接imageUrl NSString类对象）
        obj.shareImage = "https://timgsa.baidu.com/timg?image&quality=80&size=b9999_10000&sec=1510826207776&di=5308bfb4c02cefc1210cad3eb963993b&imgtype=0&src=http%3A%2F%2Fimgsrc.baidu.com%2Fimgad%2Fpic%2Fitem%2Fd788d43f8794a4c273cb6b0804f41bd5ad6e392c.jpg"
        // 这两个属性设置之后, 不会体现在图片的分享中
//        obj.title = "分享一个美女"
//        obj.descr = "自己看看得了, 不要到处说"
        
        // 分享图片的缩略图
        obj.thumbImage = "https://timgsa.baidu.com/timg?image&quality=80&size=b9999_10000&sec=1510824926407&di=73ce61c358f9947833d03e13aa9712dc&imgtype=0&src=http%3A%2F%2Fimage.tianjimedia.com%2FuploadImages%2F2013%2F255%2FHP4C7KBZQ0YP.jpg"
        
        let message = UMSocialMessageObject(mediaObject: obj)
        
        UMSocialManager.default().share(to: UMSocialPlatformType.wechatSession, messageObject: message, currentViewController: nil) { (info, error) in
            if let respons = info as? UMSocialShareResponse {
                
                print(respons.message)
                print(respons.originalResponse)
            }
        }

4.4 分享文本

分享纯文本的时候, 找了半天没有找到纯文本的媒体对象, 后来发现, 直接设置发送消息即可, 文档中也没用说明, 着实有点坑:

let message = UMSocialMessageObject()
message.text = "这是分享的文本内容, 很长很长"

UMSocialManager.default().share(to: UMSocialPlatformType.wechatSession, messageObject: message, currentViewController: nil) { (info, error) in
            if let respons = info as? UMSocialShareResponse {
                
                print(respons.message)
                print(respons.originalResponse)
            }
        }

4.5 分享视频

   let obj = UMShareVideoObject()
        
        obj.title = "视频标题"
        obj.descr = "视频描述"
        // 视频缩略图
        obj.thumbImage = "https://timgsa.baidu.com/timg?image&quality=80&size=b9999_10000&sec=1510824926407&di=73ce61c358f9947833d03e13aa9712dc&imgtype=0&src=http%3A%2F%2Fimage.tianjimedia.com%2FuploadImages%2F2013%2F255%2FHP4C7KBZQ0YP.jpg"
        // 视频网页url
        obj.videoUrl = ""
        // 视频低质量网页url
        obj.videoLowBandUrl = ""
        
        // 视频数据流url
        obj.videoStreamUrl = ""
        // 视频低质量数据流url
        obj.videoLowBandStreamUrl = ""
        
        let message = UMSocialMessageObject(mediaObject: obj)
        UMSocialManager.default().share(to: UMSocialPlatformType.wechatSession, messageObject: message, currentViewController: nil) { (info, error) in
            if let respons = info as? UMSocialShareResponse {
                
                print(respons.message)
                print(respons.originalResponse)
            }

        }

其他类型的分享, 可直接参考官方文档或者其API.