SocialSDK

最新版本(1.2.0) Easier 、Lighter 、 More Business-Oriented

以更简单、更轻量、更加面向业务需求为设计目标,提供 微博微信QQTimQQ 轻聊版钉钉 的登陆分享功能支持;

项目地址 : GitHub - SocialSdkLibrary

博客地址 :快速接入微信微博QQ钉钉原生登录分享


🤔 微信\QQ\微博 SDK 版本可以进行升级了,下个版本升级,微博变动较大;

🎉 2020.1.21 有362颗 🌟 啦, 发布版本 1.2.0, 插件更新,支持最新版本的 Gradle, 采用 Gradle + APT + ASM 自动发现 Platform 类,自动注册初始化代码,内置了 json 解析和 http 请求,初始化配置更简单;

🎉 2019.6.13 支持微信扫码登录

🎉 2019.5.28 项目获得了第329颗 🌟, 对生命周期做自动管理,统一回调参数,发布 稳定版本 1.0.1 ❤️,

🎉 2019.3.28 使用 gradle plugin 自动管理依赖,重新设计版本号 稳定版本 0.1.1 ❤️

🎉 2018.12.27 完成 gradle 插件,拆分平台,自动化依赖,一个新台阶 🐶

🎉 2018.12.21 已经225颗 🌟,着手准备拆分成不同平台库,方便灵活接入 ⛽️

🎉 2018.9.26 项目获得了第202颗 🌟,感谢新同事补星 2 个 😄

🎉 2018.6.7 项目获得了第100颗 🌟,最后一颗是我问同事要的 🤦‍

🎉 2018.5.12 修复内存问题、功能扩展 稳定版本 1.1.0 ❤️

🎉 2018.2.12 支持钉钉分享 🆕

🎉 2017.12.12 对代码进行简单重构并测试 稳定版本 1.0.0 ❤️

优势

🔥 开源:没有彩蛋,没有彩蛋,没有彩蛋;

🔥 简单:只需要关注登录、分享管理类和一个数据结构对象即可,不需要再关注平台之间的差异;

🔥 轻量:仅包含三方 SDK 和一个简单的异步框架(38k),网络请求、JSON 解析从外部注入,减少多余的依赖,保证与宿主项目高度统一;

🔥 全面:小程序分享、复制链接、扫码登录、推广联运等;

🔥 面向需求设计:

开始接入

STEP1: 添加插件依赖路径

project / build.gradle

buildscript {
    repositories {
        maven { url "https://dl.bintray.com/zfy/maven" }
    }
    dependencies {
        // 请查看文初最新版本,这边可能忘记更新!!!
        classpath 'com.zfy.social:social-sdk-plugin:1.2.0'
    }
}

allprojects {
    repositories {
        maven { url "https://dl.bintray.com/zfy/maven" }
    }
}

STEP2: 配置参数

app / build.gralde

为了安全起见更建议在 local.properties 中配置,这样可以避免提交到远端;

// 在顶部引用插件
apply plugin: 'socialsdk'

// android 配置模块
android {
    ...
}

// socialsdk 配置模块
socialsdk {
    wx {
        appId = '111xxx2222'
        appSecret = '111xxx2222'
        // 微信授权是否只返回 code, 用于服务端授权的场景
        onlyAuthCode = false
    }
    qq {
        appId = '111xxx2222'
        appSecret = '111xxx2222'
    }
    wb {
        appId = '111xxx2222'
        url = '111xxx2222'
    }
    dd {
        appId = '111xxx2222'
    }
}

以上是最简单的配置,更多配置参数参考,通常使用默认即可:

socialsdk {
    // 调试模式,默认 false, 可以在代码中开启
    debug = true
    // 分享:选择停留在微信时自动返回成功,默认返回失败
    shareSuccessIfStay = true
    // 登录:token 过期时间,单位小时,默认立即过期,有效期内可以不需要再次唤醒第三方 app,但是二次登录也没办法切换账号,这会引发问题,所以默认立即过期
    tokenExpiresHours = 100
    // 使用 gson 作为数据解析,默认 true,你如果不用 gson 就需要自己编写 JSONAdapter
    useGson = true
    // 使用 okHttp 发送请求,默认 true,你如果不用 okhttp 就需要自己编写 RequestAdapter
    useOkHttp = true
    // 配置 app 名称,默认使用 R.string.app_name
    appName = "哈哈哈"
    // 唤醒过程中的 loading 颜色
    color = "#FF0000"
    wx { }
    qq { }
    wb { }
    dd { }
}

STEP3:初始化

SocialOptions options = new SocialOptions.Builder(this)
        // 调试模式,开启 log 输出
        .debug(true)
        // 加载缩略图失败时,降级使用资源图
        .failImgRes(R.drawable.share_default_img)
        // 添加分享拦截器,重新处理分享的数据
        .addShareInterceptor((context, obj) -> {
            obj.setSummary("被重新组装" + obj.getSummary());
            return obj;
        })
        // 构建
        .build();
// 初始化
SocialSdk.init(options);

登录功能

登陆功能支持三个平台,qq,微信,微博;

// 3个平台
Target.LOGIN_QQ; // QQ 登录
Target.LOGIN_WX; // 微信 登录
Target.LOGIN_WX_SCAN; // 微信扫码 登录
Target.LOGIN_WB;  // 微博 登录

登录将会返回 LoginResult, 其中主要包括登录类型,基本用户信息,令牌信息 3 部分;

LoginResult {
    // 状态,成功,失败,取消等
    public int state;
    // 目标平台
    public int target;
    // 发生错误时使用
    public SocialError error;
    // 针对登录类型可强转为 WbUser,WxUser,QQUser 来获取更加丰富的信息
    public SocialUser socialUser;
    // 本次登陆的 token 信息,openId, unionId,token,expires_in
    public AccessToken accessToken;
    // 授权码,如果 onlyAuthCode 为 true, 将会返回它
    public String wxAuthCode;
    // 扫码登录二维码文件路径
    public String wxCodePath;
}

登录时需要设置登录回调:

new OnLoginStateListener() {
    @Override
    public void onState(Activity act, LoginResult result) {
        switch (result.state) {
            case LoginResult.STATE_START:
                // 登录开始
                break;
            case LoginResult.STATE_COMPLETE:
                // 登录完成
                break;
            case LoginResult.STATE_ACTIVE:
                // 透明 Activity 开启
                break;
            case LoginResult.STATE_SUCCESS:
                // 登录成功
                break;
            case LoginResult.STATE_FAIL:
                // 登录失败
                result.error
                break;
            case LoginResult.STATE_CANCEL:
                // 登录取消
                break;
            case LoginResult.STATE_WX_CODE_RECEIVE:
                 // 获取到微信登录二维码
                 break;
            case LoginResult.STATE_WX_CODE_SCANNED:
                 // 微信登录二维码被扫描
                 break;
        }
    }
};

获取更多用户信息:

SocialUser socialUser = loginResult.socialUser;
// 基本信息可以从 SocialUser 在获取到
String userNickName = socialUser.getUserNickName();
// 获取 openId
String openId = socialUser.getOpenId();
// 微信获取 unionId,其他平台仍旧返回 openId
String unionId = socialUser.getUnionId();
// 获取 userId,微信返回 unionId, 其他平台返回 openId
String userId = socialUser.getUserId();
// 强转为平台用户,可以拿到更多信息
int target = result.getTarget();
switch (target) {
    case Target.LOGIN_QQ:
        QQUser qqUser = (QQUser) socialUser;
        break;
    case Target.LOGIN_WB:
        WbUser wbUser = (WbUser) socialUser;
        break;
    case Target.LOGIN_WX:
        WxUser wxUser = (WxUser) socialUser;
        break;
}

发起登录:

LoginManager.login(mActivity, Target.LOGIN_QQ, listener);

带参数登录,如微信二维码扫码登录:

LoginObj obj = new LoginObj();
// 根据文档要求,以下数据应在服务端缓存获取
// 如果不设置,将会使用配置时设置的 secret
obj.setAppSecret("0a3cb00******ee3654f499171");
obj.setNonceStr("3611cdc33b******a49ca45bdfab2d");
obj.setTimestamp("15604******6904");
obj.setSignature("b28f69426******18c8ba792caa4a0a1bcc");
// 如果不设置,将会使用 SocialValues.WX_SCOPE
obj.setScope(SocialValues.WX_SCOPE);
LoginManager.login(mActivity, Target.LOGIN_WX_SCAN, obj, listener);

关于 token 时效,可以在初始化时设置 tokenExpiresHours 来控制,也同样提供清除授权 token 的方法。

// 清除全部平台的 token
LoginManager.clearAllToken(context);
// 清除指定平台的 token
LoginManager.clearToken(context, Target.LOGIN_QQ);

分享功能

重要:请仔细查看平台和数据类型中间的支持能力

当 微博 使用 openApi 形式去分享时,可能有较长的延时,建议在生命周期中增加进度条显示,避免用户等待很久没有响应。

划分分享数据类型

针对业务逻辑和 SDK 设计,将分享数据类型划分为 7 种类型,他们能涵盖大多数业务场景,分别是:

开启 App 类型,打开渠道应用;
文字类型,纯文本分享;
图片类型(jpg, png, gif(要求能动));
App 推广类型;
网页链接类型;
音频分享类型;
视频分享类型;

为了保证每个平台都有封闭且统一的外观,如果某个平台不兼容某种类型的分享,将会使用 web 分享的方式代替;比如微信不支持 app 分享,分享出去之后时 web 分享的模式。

划分分享渠道

// 支持的分享渠道
Target.SHARE_DD; // 钉钉好友
Target.SHARE_QQ_FRIENDS; // qq好友
Target.SHARE_QQ_ZONE; // qq空间
Target.SHARE_WX_FRIENDS; // 微信好友
Target.SHARE_WX_ZONE; // 微信朋友圈
Target.SHARE_WX_FAVORITE; // 微信收藏
Target.SHARE_WB; // 新浪微博
Target.SHARE_SMS; // 短信分享
Target.SHARE_EMAIL; // 邮件分享
Target.SHARE_CLIPBOARD; // 粘贴板分享

创建分享数据

分享时,我们首先要构造分享用的数据,ShareObj 对象提供了多种静态方法用来快速创建对应分享的类型的对象;

// 测试用的路径
localImagePath = new File(Environment.getExternalStorageDirectory(), "1.jpg").getAbsolutePath();
localVideoPath = new File(Environment.getExternalStorageDirectory(), "video.mp4").getAbsolutePath();
localGifPath = new File(Environment.getExternalStorageDirectory(), "3.gif").getAbsolutePath();
netVideoPath = "http://7xtjec.com1.z0.glb.clouddn.com/export.mp4";
netImagePath = "http://7xtjec.com1.z0.glb.clouddn.com/token.png";
netMusicPath = "http://7xtjec.com1.z0.glb.clouddn.com/test_music.mp3";
netMusicPath = "http://mp3.haoduoge.com/test/2017-05-19/1495207225.mp3";
targetUrl = "http://bbs.csdn.net/topics/391545021";

// 打开渠道对应app
ShareObj shareMediaObj = ShareObj.buildOpenAppObj();
// 分享文字
ShareObj textObj = ShareObj.buildTextObj("分享文字", "summary");
// 分享图片
ShareObj imageObj = ShareObj.buildImageObj("分享图片", "summary", localImagePath);
// 分享gif
ShareObj imageGifObj = ShareObj.buildImageObj("分享图片", "summary", localGifPath);
// 分享app
ShareObj appObj = ShareObj.buildAppObj("分享app", "summary", localImagePath, targetUrl);
// 分享web
ShareObj webObj = ShareObj.buildWebObj("分享web", "summary", localImagePath, targetUrl);
// 分享视频
ShareObj videoObj = ShareObj.buildVideoObj("分享视频", "summary", localImagePath, targetUrl, localVideoPath, 10);
// 本地视频分享、部分平台支持
ShareObj videoLocalObj = ShareObj.buildVideoObj("分享本地视频", "summary", localImagePath, targetUrl, localVideoPath, 0);
// 分享音乐
ShareObj musicObj = ShareObj.buildMusicObj("分享音乐", "summary", localImagePath, targetUrl, netMusicPath, 10);

针对一些不能被统一的参数使用扩展的参数支持:

// 使 ShareObj 支持短信分享
webObj.setSmsParams("13611301719", "说啥呢");
// 使 ShareObj 支持粘贴板分享
webObj.setClipboardParams("复制的内容");
// 使 ShareObj 支持邮件分享
webObj.setEMailParams("[email protected]", "主题", "内容");
// 使 ShareObj 在微信平台优先使用小程序分享
webObj.setWxMiniParams("51299u9**q31",SocialValues.WX_MINI_TYPE_RELEASE,"/page/path");

分享监听

使用 OnShareStateListener 作为监听分享回调;

new OnShareStateListener() {
    @Override
    public void onState(Activity act, ShareResult result) {
        switch (result.state) {
            case LoginResult.STATE_START:
                // 分享开始
                break;
            case LoginResult.STATE_COMPLETE:
                // 分享完成
                break;
            case LoginResult.STATE_ACTIVE:
                // 透明 Activity 开启
                break;
            case ShareResult.STATE_SUCCESS:
                // 分享成功
                break;
            case ShareResult.STATE_FAIL:
                SocialError e = result.error;
                // 分享失败
                break;
            case ShareResult.STATE_CANCEL:
                // 分享取消
                break;
        }
    }
};

发起分享

// 唤醒分享
ShareManager.share(mActivity, Target.SHARE_QQ_FRIENDS, imageObj, mOnShareListener);

重写分享对象

关于重写分享对象,其实提供一种能在分享之前对需要分享的 ShareObj 进行统一处理的机会,类似分享功能的一个切面,比如如下场景:

重写分享对象,我们使用拦截器来实现,拦截器在 SDK 初始化时注入,支持多个,可以将不同业务分为不同的拦截器,所有拦截器会被顺序调用;

⚠️ 拦截器会在子线程执行,也就意味着你可以做耗时操作(图片处理,网络请求),需要更改 UI 需要到主线程执行;

SocialOptions options = new SocialOptions.Builder(this)
        // ... 其他初始化代码
        // 添加分享拦截器
        .addShareInterceptor((context, target, obj) -> {
            obj.setSummary("描述加前缀" + obj.getSummary());
            return obj;
        })
        .addShareInterceptor((context, target, obj) -> {
            obj.setTargetUrl(obj.getTargetUrl()+"?id=100");
            return obj;
        })
        // 构建
        .build();
// 初始化
SocialSdk.init(options);

系统平台

我们在做分享时通常会遇到需求,复制到粘贴板/支持短信分享/支持邮件分享等等,SocialSdk 内置了这些功能,需要在创建 ShareObj 之后添加额外参数来实现;

shareObj.setSmsParams("13611301719", "说啥呢");
shareObj.setEMailParams("[email protected]", "主题", "内容");
shareObj.setClipboardParams("复制的内容");

微信小程序分享

支持微信小程序分享,也同样使用额外参数的形式

shareObj.setWxMiniParams("51299u9**q31",SocialValues.WX_MINI_TYPE_RELEASE,"/page/path");

错误码

为了更好的统一分享失败时返回的异常,返回的所有异常都会有一个 code,可以根据不同的 code 定位问题和给出更友好的提示。

int CODE_COMMON_ERROR = 101; // 通用错误,未归类
int CODE_NOT_INSTALL = 102; // 没有安装应用
int CODE_VERSION_LOW = 103; // 版本过低,不支持
int CODE_SHARE_BY_INTENT_FAIL = 105; // 使用 Intent 分享失败
int CODE_STORAGE_READ_ERROR = 106; // 没有读存储的权限,获取分享缩略图将会失败
int CODE_STORAGE_WRITE_ERROR = 107; // 没有写存储的权限,微博分享视频copy操作将会失败
int CODE_FILE_NOT_FOUND = 108; // 文件不存在
int CODE_SDK_ERROR = 109; // sdk 返回错误
int CODE_REQUEST_ERROR = 110; // 网络请求发生错误
int CODE_CANNOT_OPEN_ERROR = 111; // 无法启动 app
int CODE_PARSE_ERROR = 112; // 数据解析错误
int CODE_IMAGE_COMPRESS_ERROR = 113; // 图片压缩失败
int CODE_PARAM_ERROR = 114; // 参数错误
int CODE_SDK_INIT_ERROR = 115; // SocialSdk 初始化错误
int CODE_PREPARE_BG_ERROR = 116; // 执行 prepareOnBackground 时错误
int CODE_NOT_SUPPORT = 117; // 不支持

例如你可以这么做:

listener = new OnShareStateListener() {
    @Override
        public void onState(Activity act, ShareResult result) {
            switch (result.state) {
                case ShareResult.STATE_FAIL:
                    SocialError e = result.error;
                    showMsg("分享失败  " + e.toString());
                    // 如下因为没有存储权限导致失败,请求权限
                    if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
                        if (e.getCode() == SocialError.CODE_STORAGE_READ_ERROR) {
                            requestPermissions(new String[]{Manifest.permission.READ_EXTERNAL_STORAGE}, 100);
                        } else if (e.getCode() == SocialError.CODE_STORAGE_WRITE_ERROR) {
                            requestPermissions(new String[]{Manifest.permission.WRITE_EXTERNAL_STORAGE}, 100);
                        }
                    }
                    break;
            }
        }
};

扩展新的平台?

public class HuaweiPlatform extends AbsPlatform {

    // 工厂函数
    public static class Factory implements PlatformFactory {
        @Override
        public IPlatform create(Context context, int target) {
            return new HuaweiPlatform(context, null, null, target);
        }

        @Override
        public int getPlatformTarget() {
            return PLATFORM_HUAWEI;
        }

        @Override
        public boolean checkShareTarget(int shareTarget) {
            return false;
        }

        @Override
        public boolean checkLoginTarget(int loginTarget) {
            return loginTarget == LOGIN_HUAWEI;
        }
    }

    public HuaweiPlatform(Context context, String appId, String appName, int target) {
        super(context, appId, appName, target);
    }
}

最重要的是编写平台的工厂函数,框架会自动发现 然后注册到系统中,不需要手动注册了;

其他

SocialSdk 内部对生命周期有自动的管理,每次登录分享结束了都会回收掉所有的资源; 发起登录分享的 Activity 建议实现 LifecycleOwner 接口,可以直接使用 AppCompatActivity,内部会做生命周期的绑定,避免内存泄漏的发生;

相关文档

QQ:

微信:

微博:

钉钉: