如今的App十个有九个会集成定向分享的功能,当提到分享你可能第一直觉就是ShareSDK,可能很多人都不愿意自己一个一个去接各个第三方分享,因为每个第三方分享的对接方式都不一样,主要包括:
- 入参不一样;
- 返回参数不一样;
- 唤起分享方式不一样;
- 最重要的是回调方式不一样;
因为它们的千差万别,每接入一个分享还要兼容现有的,想想就头大,因此遇到很赶的项目很少人沉下心来去了解它们,所以ShareSDK就是首选,曾经我也是曾经一员,但一次特别的经历后我退出了,随后iOS团队也遇到一次另外的经历也随后退出了,从此走上自己写分享SDK的路,我所谓的经历就是遇到了通过ShareSDK微信分享失败但没有任何反馈,通过单独接微信分享却是可以的。
其实,ShareSDK并没有做多少工作,无非就是做了一个资源整合的工作,自己实现也能锻炼自己的设计能力,再者遇到问题无需等待第三方解决。总之,如果是一个长期开发维护的项目,自己的项目自己做主,尽可能减少第三方的过度依赖有利于项目良性发展。
1. 自己设计分享SDK,要满足以下几个主要功能:
- 支持文本、网页、图片、视频、小程序等内容分享;
- 支持QQ好友、QQ空间、微信好友、微信朋友圈、新浪微博等分享平台;
- 支持一次弹出的分享框里分享出去的内容不一样,如:通过微信好友分享出去的是小程序,通过QQ分享出去的是网页。
- 支持直接唤起某一个第三方分享;
- 权限管理(遇到超大的byte[]图片通过Intent传递会导致分享失败,只能先存储,再以存储的图片路径分享出去);
- 支持统一的分享回调结果;
- 统一的管理第三方分享SDK的app id;
- 最重要的是可灵活增加分享内容类型和分享平台;
2. 分享内部的组成部分:
- ShareTo:即分享平台,支持的分享目标,包括QQ、QZone、Sms、Timeline、WeChat等,ShareTo的子类主要作用是实现抽象方法用于提供分享弹框里的图标和文字、在分享框里的排序、判断分享目标app是否安装、提供appId以及告知支持哪些内容的分享, 下面以“微信好友”作为示例:
public class WeChat extends ShareTo {
public static final int ID = 1;
public WeChat(ShareContent shareContent) {
super(shareContent);
}
@Override
public int getShareLogo() {
return R.drawable.logo_wechat;
}
@Override
public int getShareName() {
return R.string.share_wechat;
}
@Override
public int getSortId() {
return ID;// 用于确认默认排序或区分不同的shareTo
}
@Override
public boolean installed(Context context) {
if (isAppNotInstalled(context, "com.tencent.mm")) {
Toast.makeText(context, R.string.share_we_chat_not_installed_warning, Toast.LENGTH_SHORT).show();
return false;
}
return true;
}
@Override
public boolean isSupportToShare() {
// 因为shareTo与shareContent是一对多关系,
// 且又不是对应所有的shareContent,所以这里有个校验工作,
// 防止类似明明分享的是小程序,结果分享对话框里显示出了QQ空间这种情况发生
return mShareContent instanceof AudioUrl
|| mShareContent instanceof ImageBytes
|| mShareContent instanceof ImagePath
|| mShareContent instanceof ImageUrl
|| mShareContent instanceof MiniProgram
|| mShareContent instanceof Text
|| mShareContent instanceof VideoPath
|| mShareContent instanceof VideoUrl
|| mShareContent instanceof WebUrl;
}
@Override
public void share(Context context) {
if (!mShareContent.validate(context)) {
return;
}
String appId = ShareConfig.getWeChatAppId();
if (mShareContent instanceof AudioUrl) {
// 调用微信sdk里的音频url分享的实现
return;
}
if (mShareContent instanceof ImageBytes) {
// 调用微信sdk里的图片分享的实现
return;
}
// ... 其他shareContent的判断与实现
}
}
- ShareContent:即分享出去的内容类型,包括AudioUrl、ImageBytes、ImagePath、ImageUrl、MiniProgram、Text、WebUrl、VideoPath、VideoUrl、WebUrl等,ShareContent的子类主要作用是提供构造其必要参数的入口、内部参数校验以及各个平台的具体分享实现,下面“视频链接”分享作为示例:
public class VideoUrl extends ShareContent implements Serializable {
private final String videoUrl;
private String title;
private String summary;
private Thumbnail thumbnail;
public VideoUrl(@NonNull String videoUrl) {
this.videoUrl = videoUrl;
}
public void setTitle(String title) {
this.title = title;
}
public void setSummary(String summary) {
this.summary = summary;
}
public void setThumbnail(Thumbnail thumbnail) {
this.thumbnail = thumbnail;
}
public String getVideoUrl() {
return videoUrl;
}
public String getTitle() {
return title;
}
public String getSummary() {
return summary;
}
public Thumbnail getThumbnail() {
return thumbnail;
}
@Override
public boolean validate(Context context) {
if (TextUtils.isEmpty(videoUrl)) {
Toast.makeText(context, R.string.share_video_no_url, Toast.LENGTH_SHORT).show();
return false;
}
return true;
}
}
所有ShareContent子类都继承ShareContent,它的作用就是参数的定义和必要参数的校验,它是shareTo的不可或缺的入参,即:分享的真正内容;
构造函数传入的参数都是必要参数,其余通过setXX()提供的为非必要参数,一律如此;
2.3 SDK的API入口:Share
// 弹出分享框并显示指定shareContent所支持的所有分享图标
WebUrl webUrl = new WebUrl("https://www.qq.com", "百度首页");
Share.with(Activity.this|Fragment.this).shareAll(webUrl);
// 弹出分享框并显示指定数量的ShareTo对应的分享图标
MiniProgram miniProgram = new MiniProgram("https://m.chebada.com", userName, path, thumbnail));
miniProgram.setTitle(resBody.grabShareItem.shareDescription);
miniProgram.setSummary(context.getString(R.string.train_detail_share_des));
WeChat weChat = new WeChat(miniProgram);
QQ qq = new QQ(webUrl);
Share.with(Activity.this|Fragment.this).share(weChat, qq);
// 类似share(ShareTo... shareTos)
Share.with(Activity.this|Fragment.this).share(List<ShareTo> shareTos);
// 直接唤醒第三方分享(无分享框显示)
WeChat weChat = new WeChat(webUrl);
webChat.share(context);
3. 分享回调的统一收口
由于类似微信这种SDK设计回调是通过另外一个独立Activity里回来的,看似跟当前发起分享的Activity是完全独立的,所以一般很难想到办法将分享回调API设计成如下方式:
WebUrl webUrl = new WebUrl("https://www.baidu.com", "百度首页");
WeChat weChat = new WeChat(webUrl);
QQ qq = new QQ(webUrl);
Share.with(MainActivity.this).setShareListener(new OnShareListener() {
@Override
public void onStart(ShareTo shareTo) {
super.onStart(shareTo);
Log.d(TAG, "onStart");
}
@Override
public void onSuccess(ShareTo shareTo, Map<String, String> resultInfo) {
super.onSuccess(shareTo, resultInfo);
}
@Override
public void onFailed(ShareTo shareTo) {
super.onFailed(shareTo);
}
@Override
public void onCanceled(ShareTo shareTo) {
super.onCanceled(shareTo);
}
}).share(weChat, qq);
这里分享回调设计了4个回调方法,分别是:
- onStart(ShareTo shareTo): 只要在分享对话框里点击里任何一个图片就触发此回调执行;
- onSuccess(ShareTo shareTo, Map<String, String> resultInfo):当分享成功后被回调;
- onFailed(ShareTo shareTo):当分享失败后被回调;
- onCanceled(ShareTo shareTo):当然分享取消后被回调(注意不是分享对话框上的取消按钮,而是类似已经进入微信里又返回出来这种情况);
其实办法不是没有,只是早些年没有Lifecycle,即便自己模拟出Lifecycle,侵入型也比较强。之前的做法是在所有的第三方分享回调里都通过Local Broadcast汇总回调,只要在分享页面定义一个BroadcastReceiver就能知道是分享的回调了;现在的做法是把BroadcastReceiver的注册和解除注册融入Share内部,如下:
private BroadcastReceiver mReceiver = new BroadcastReceiver() {
@Override
public void onReceive(Context context, Intent intent) {
if (mOnShareListener != null) {
String action = intent.getAction();
if (TextUtils.equals(action, buildAction(context))) {
LocalBroadcastManager.getInstance(context).unregisterReceiver(this);
int shareToInt = intent.getIntExtra(EXTRA_SHARE_TO, -1);
ShareTo shareTo = ShareTo.parseFrom(shareToInt);
Map<String, String> shareInfo = (Map<String, String>) intent.getSerializableExtra(EXTRA_SHARE_INFO);
int shareResult = intent.getIntExtra(EXTRA_SHARE_RESULT, -1);
if (shareResult == ShareResult.SUCCESS) {
mOnShareListener.onSuccess(shareTo, shareInfo);
} else if (shareResult == ShareResult.FAILED) {
mOnShareListener.onFailed(shareTo);
} else if (shareResult == ShareResult.CANCELED) {
mOnShareListener.onCanceled(shareTo);
}
}
}
}
};
private Share(FragmentActivity activity) {
mContext = activity;
mPermissions = new Permissions(activity);
registerReceiver(activity.getApplicationContext(), activity.getLifecycle());
}
private Share(Fragment fragment) {
mContext = fragment.getActivity();
mPermissions = new Permissions(fragment);
registerReceiver(fragment.getContext(), fragment.getLifecycle());
}
public static Share with(AppCompatActivity context) {
return new Share(context);
}
public static Share with(Fragment fragment) {
return new Share(fragment);
}
private void registerReceiver(Context context, Lifecycle lifecycle) {
lifecycle.addObserver(new LifecycleObserver() {
@OnLifecycleEvent(Lifecycle.Event.ON_CREATE)
public void onCreate() {
IntentFilter filter = new IntentFilter();
filter.addAction(buildAction(context));
LocalBroadcastManager.getInstance(context).registerReceiver(mReceiver, filter);
}
@OnLifecycleEvent(Lifecycle.Event.ON_DESTROY)
public void onDestroy() {
LocalBroadcastManager.getInstance(context).unregisterReceiver(mReceiver);
}
});
}
原理是不是很简单?暴露给外面的最终就是一个setShareListener()!
4. 如何扩充分享平台
讲到现在,都在讲实现思路且案例有限,那么如果我们扩充别的分享平台该怎么做呢,会不会很麻烦?
分享内容类型的扩充:
上面已经介绍过ShareContent的作用,也示例了其中一个子类:VideoUrl,如果要扩充其他分享内容类型,只要创建新的类并继承ShareContent即可, 定义这个content的必要参数和可选参数即可,必要参数通过构造函数一次性传入,可选参数提供set()方法。分享目标类型的扩充:
上面已经介绍过ShareTo的作用,也示例了其中一个子类:WeChat,如果要扩充其他分享目标类型,只要创建新类并继承ShareTo,然后在share(Context)
中根据mShareContent
判断是哪种分享内容并实现对应的分享。同时在ShareTos.java里,我维护了ShareTo和ID的映射关系,为了确保分享回调里shareTo能对应到具体shareTo这里需要手动维护:
public class ShareTos {
private static final SparseArray<ShareTo> MAPPING = new SparseArray<>();
static {
MAPPING.put(WeChat.ID, new WeChat());
MAPPING.put(Timeline.ID, new Timeline());
MAPPING.put(QQ.ID, new QQ());
MAPPING.put(QZone.ID, new QZone());
MAPPING.put(Sms.ID, new Sms());
}
public static ShareTo parseFrom(int shareToId) {
ShareTo shareTo = MAPPING.get(shareToId);
if (shareTo == null){
throw new IllegalArgumentException("unsupported shareTo: " + shareToId);
}
return shareTo;
}
}
代码实现细节参考这里。