SocialHelper
目前几乎所有app都包含了第三方的登录以及分享功能,之前大多都使用ShareSDK或者其他SDK来实现,但是有些情况不希望通过第三方的sdk来间接集成,所以这个组件就有了用武之地。
这个组件在demo中是没有包含相关调用的代码的只有一些配置和使用的东西,因为应用的申请实在麻烦,但是已经在项目中测试通过了,所以可以放心使用。
引用的sdk版本:微博:v4.3.6 QQ:open_sdk_r6019_lite WX:v5.1.6
优点
- 便捷实现第三方登录和分享及其回调
- 了解第三方登录或分享的实现流程
用法
包含了:如何引用、使用以及混淆
引用
1、在根目录的build.gradle中加入如下配置
allprojects {
repositories {
...
mavenCentral()
maven { url 'https://jitpack.io' }
maven { url "https://dl.bintray.com/thelasterstar/maven/" }
}
}
2、在要是用的module中增加如下引用
dependencies {
...
implementation 'com.android.support:appcompat-v7:28.0.0'
implementation 'com.google.code.gson:gson:2.8.2'
implementation 'com.github.arvinljw:SocialHelper:v1.2.2'
}
注:该module中只引用了qq、微信、微博的第三方包,其中v7和gson的版本仅供参考。
使用
1、相应配置
AndroidManifest.xml配置
添加权限
<!--微信权限,微博权限,qq只需前两个-->
<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE"/>
<uses-permission android:name="android.permission.READ_PHONE_STATE"/>
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
对于6.0以上权限适配可使用我的另一个库,也封装好了的类似rxPermissions,但是没有使用rxJava。PermissionHelper
在application下添加Activity
<!--qq配置开始-->
<activity
android:name="com.tencent.tauth.AuthActivity"
android:launchMode="singleTask"
android:noHistory="true">
<intent-filter>
<action android:name="android.intent.action.VIEW"/>
<category android:name="android.intent.category.DEFAULT"/>
<category android:name="android.intent.category.BROWSABLE"/>
<data android:scheme="tencentqqAppId"/>
</intent-filter>
</activity>
<activity
android:name="com.tencent.connect.common.AssistActivity"
android:configChanges="orientation|keyboardHidden|screenSize"
android:theme="@android:style/Theme.Translucent.NoTitleBar"/>
<!--qq配置结束-->
<!--微信配置开始-->
<activity
android:name=".wxapi.WXEntryActivity"
android:exported="true"
android:label="@string/app_name"
/>
<!--微信配置结束-->
<!--微博不需要-->
注:其中需要注意的是,qq配置中 qqAppId换成您申请的qqAppId即可
微信还需要在packageName.wxapi的包下创建WXEntryActivity,该Activity可继承WxHelperActivity,并传入SocialHelper的实例
public class WXEntryActivity extends WXHelperActivity {
@Override
protected SocialHelper getSocialHelper() {
return SocialUtil.INSTANCE.socialHelper;
}
}
具体实现可在这里查看
WxHelperActivity主要处理的是在其onResp的时候判断是登录还是分享做出相应的处理,通知本库触发回调。
2、获取实例
首先采用外观模式,暴露出来一个SocialHelper,可以通过构建者模式获取实例,调用相关方法,配置回调。
socialHelper = new SocialHelper.Builder()
.setQqAppId("qqAppId")
.setWxAppId("wxAppId")
.setWxAppSecret("wxAppSecret")
.setWbAppId("wbAppKey")
.setWbRedirectUrl("wbRedirectUrl")
.setNeedLoginResult(true)
.build();
其中setNeedLoginResult表示是否带有第三方登陆后的AccessToken等信息,默认是false。
返回的AccessToken等信息分别在ThirdInfoEntity里的qqInfo,wxInfo,wbInfo中的loginResultEntity中。
3、调用相关方法
这里提供了QQ、微信和微博的相应的登录和分享方法
- public void loginQQ(Activity activity, SocialLoginCallback callback)
- public void loginWX(Activity activity, SocialLoginCallback callback)
- public void loginWB(Activity activity, SocialLoginCallback callback)
- public void shareQQ(Activity activity, ShareEntity shareInfo, SocialShareCallback callback)
- public void shareWX(Activity activity, ShareEntity shareInfo, SocialShareCallback callback)
- public void shareWB(Activity activity, ShareEntity shareInfo, SocialShareCallback callback)
注:分享方法的参数顺序和老版本有一点变化,老版本的被遗弃了,计划下个版本删除
这个其实通过名字就能知道是什么意思,就不解释了,需要解释的是参数:
a、传入的Activity
主要是为了回调回来都在当前Activity中处理回调事情,避免在Fragment中去处理,这样也能减少一些工作
注:当然遇到在Fragment中调用登录或者分享的时候,请使用您最熟悉的方式回调到其Activity中处理相关操作
b、传入的回调
这里回调也分为了两种登录回调和分享回调
回调接口如下:
public interface SocialCallback {
void socialError(String msg);
}
public interface SocialLoginCallback extends SocialCallback{
void loginSuccess(ThirdInfoEntity info);
}
public interface SocialShareCallback extends SocialCallback{
void shareSuccess(int type);
}
登录和分享回调失败都会有一个信息返回;
登录成功会将封装的第三方信息返回,包含了常用的昵称,性别,头像,登录平台,更多信息也能在其中找到,详细的含义在Lib中有详细的注释;
分享成功就只有一个回调,便于提示。
c、ShareEntity
这个参数是分享的重点,对于QQ、微信和微博对应着QQShareEntity、WXShareEntity以及WBShareEntity
都可以通过其相应的静态方法创建相应分享类型
-
QQShareEntity
- createImageTextInfo 图文信息,网页信息
- createImageInfo 纯图片信息
- createMusicInfo 音乐信息
- createAppInfo 应用信息
- createImageTextInfoToQZone 图文信息到QQ空间
- createPublishTextToQZone 文字说说
- createPublishImageToQZone 图片说说
- createPublishVideoToQZone 视频说说
-
WXShareEntity
- createTextInfo 文本信息
- createImageInfo 纯图片信息
- createMusicInfo 音乐信息
- createVideoInfo 视频信息
- createWebPageInfo 网页信息
-
WBShareEntity
- createTextInfo 纯文本信息
- createImageTextInfo 图文信息
- createMultiImageInfo 多图信息
- createVideoInfo 视频信息
- createWebInfo 网页信息
具体详细的参数以及注释在相应类中都有明确的注释,这里就不过多的展开了;其中有ParamsRequired注解的参数代表必传。
注意,有些不必传的参数,不传虽然也能分享成功,但是有可能会影响分享出去的样式,请自行调试。
4、回调配置
在调用的Activity中配置
//用处:qq登录和分享回调,以及微博登录和分享回调
@Override
protected void onActivityResult(int requestCode, int resultCode, Intent data) {
super.onActivityResult(requestCode, resultCode, data);
if (socialHelper != null) {//qq分享如果选择留在qq,通过home键退出,再进入app则不会有回调
socialHelper.onActivityResult(requestCode, resultCode, data);
}
}
注意:socialHelper.onNewIntent(intent);
这个方法预计在下个版本移除,该版本已废弃
至于微信的回调配置,在一开始的时候说的WXEntryActivity的onResp中的处理就是了。
至此使用方式就基本完毕,算下来也就这么四部配置,就能愉快的使用了,当然前提是相应的app申请已经成功。
其中对于SocialHelper的实例,可以像Demo中一样使用一个工具简单封装成单例来使用。
5、销毁
@Override
protected void onDestroy() {
super.onDestroy();
if (socialHelper != null) {
socialHelper.clear();
}
}
在onDestroy方法中调用socialHelper.clear()方法,注销掉可能注册的广播以及把activity引用赋为空。
Release Log
最近重要版本更新内容:
v1.2.2
- 解决微信分享包含图片偶尔出现bitmap被回收问题
v1.2.1
- 增加qq分享到说说
- 更新微博sdk版本到4.3.6
v1.2.0
-
修正qq获取的unionId
之前返回的是loginResult的pfKey,若是没有申请unionId的话是获取不到正确的unionId的 对于qq的unionId的问题可以查看这个文档unionId介绍
-
删除微博回调调用的onNewIntent方法,使用onActivityResult代替
-
在demo中移除data为空的限制,这样才能获取到已取消的检测
v1.1.2
- 更新sdk版本
- 使用微博sdk缓存token,优化授权,去掉微博scope,之前版本对该字段有非空验证,目前已去掉
- 废弃微博分享回调,调用的onNewIntent方法,直接使用onActivityResult即可,预计下个版本删除该方法
v1.1.1:
- 增加第三方登陆返回的accessToken等信息
- 封装微信登陆和分享回调类WxHelperActivity
- 将微信的广播注册方式换成本地广播
- 将v7和gson包只是编译,需要自己引入,避免重复使用
- 调整相关包版本以及编译版本等
混淆
#qq
-keep class com.tencent.**{*;}
#微博
-keep class com.sina.weibo.sdk.** { *; }
#微信
-keep class com.tencent.mm.opensdk.** { *; }
-keep class packageName.wxapi.** { *; }
#Gson
-keep class com.google.gson.** {*;}
-keep class com.google.**{*;}
-keep class sun.misc.Unsafe { *; }
-keep class com.google.gson.stream.** { *; }
-keep class com.google.gson.examples.android.model.** { *; }
#Socialhelper
-keep class net.arvin.socialhelper.**{*;}
注:微信的packageName换成自己的包名
三方文档链接
反馈
若是有什么好的建议或者问题,请多多指教,感激不尽。
License
Copyright 2017 arvinljw
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.