##Welcome to OpenShare.
Travis [CocoaPods Version][cocoadocs] [License][cocoadocs] [Platform][cocoadocs] [cocoadocs]: http://cocoadocs.org/docsets/OpenShare
##TODO
- 没有安装客户端情况下的fallback
- 支付宝和微信支付
- Facebook和twitter等国外社交平台的支持
- Readme国际化
##Introduction
注: 为方便书写,如无特殊说明,下文中的「客户端」指的是QQ、微信、微博这样的社交软件官方开发的客户端;「app」特指我们自己开发的应用。
楼主做iOS开发的过程中遇到这样的问题:自己app中的信息需要分享到QQ、微信、微博等社交网络。现在的客户端越做越强大,直接集成了分享功能,比如用户手机上安装了微信,只需要app调起微信,并且给微信传入相应的参数就可以了,完全不需要自己操作REST API。这样如果实现分享, 一般情况下要去官方下载SDK,然后按照官方翔一样的Demo代码和文档来改造自己的程序。这样做不仅增大了代码量(想象一下引入的官方类库,有时候,光这些第三方的SDK都要比我自己的app还大),而且使用还很繁琐(SDK一般没有源代码,想象Apple强制app支持64位的时候)。所以楼主调试了一下各个平台的SDK,研究了各个厂商实现的应用程序间通信的规则,把功能封装成了OpenShare。
OpenShare的功能就是替代官方的SDK向各个平台的移动客户端(比如QQ)发起请求(分享、OAuth),然后接收返回结果。
OpenShare非常小,目前支持QQ、微信、微博、人人,只有几百行代码。即使你不在项目中使用OpenShare,也可以clone下来研究一下app和客户端之间的通信机制,所以给个star是值得的。
##设计思路
比如分享功能,OpenShare有一个 OSMessage类,保存OpenShare向客户端发送的消息。分享的消息基本上有以下几种情况:
- 纯文本
- 图片
- 链接
- 其他格式多媒体(声音、视频、文件等)
这样对应OSMessage中的属性:
@property NSString* title; @property NSString* desc; @property NSString* link; @property NSData* image; @property NSData* thumbnail; @property OSMultimediaType multimediaType; //for 微信 @property NSString* extInfo; @property NSString* mediaDataUrl; @property NSString* fileExt;
比如一个文本消息,可以只设置title,其他不管;发送一个图片,只需要设置image/thumbnail/title/desc,其他不用设置。对于其他多媒体消息,可以用multimediaType来标示。所以OSMessage可以封装所有app向客户端发的各类分享请求。
另外,还需要解决的是,客户端分享完成以后回调app的功能。我们熟悉的是block方法。而不是每个平台都到application:openURL:sourceApplication:annotation:中判断。比如最好是这样的:
OSMessage *msg=[[OSMessage alloc] init]; msg.title=@"Hello World"; //分享到微信 [OpenShare shareToWeixinSession:msg Success:^(OSMessage *message) { ULog(@"微信分享到会话成功:\n%@",message); } Fail:^(OSMessage *message, NSError *error) { ULog(@"微信分享到会话失败:\n%@\n%@",error,message); }]; //分享到QQ [OpenShare shareToQQFriends:msg Success:^(OSMessage *message) { ULog(@"分享到QQ好友成功:%@",msg); } Fail:^(OSMessage *message, NSError *error) { ULog(@"分享到QQ好友失败:%@\n%@",msg,error); }];
基于以上考虑,楼主用category实现了OpenShare。
##Demo
把项目clone下来以后,直接open OpenShareDemo/openshare.xcodeproj就可以运行了。注意sina微博的key没有通过sina的审核,直接分享会提示错误,可以替换成自己的key。
##如何使用
OpenShare已经支持CocoaPods。所以您可以用:
pod 'OpenShare', '~> 0.0'
引入OpenShare。
第零步: 修改Info.plist添加URLSchemes,让客户端可以回调app
<!-- OpenShare添加回调urlschemes --> <key>CFBundleURLTypes</key> <array> <dict> <key>CFBundleURLName</key> <string>OpenShare</string> <key>CFBundleURLSchemes</key> <array> <!-- 微信 --> <string>wxd930ea5d5a258f4f</string> <!-- QQ --> <string>tencent1103194207</string> <string>tencent1103194207.content</string> <string>QQ41C1685F</string> <!--微博--> <string>wb402180334</string> <!--人人--> <string>renrenshare228525</string> <!--facebook--> <string>fb776442542471056</string> </array> </dict> </array>
第一步:到AppDelegate中的application:didFinishLaunchingWithOptions:中全局注册appId/appKey
//全局注册appId,别忘了#import "OpenShareHeader.h" [OpenShare connectQQWithAppId:@"1103194207"]; [OpenShare connectWeiboWithAppKey:@"402180334"]; [OpenShare connectWeixinWithAppId:@"wxd930ea5d5a258f4f"]; [OpenShare connectRenrenWithAppId:@"228525" AndAppKey:@"1dd8cba4215d4d4ab96a49d3058c1d7f"];
第二步:到AppDelegate中的application:openURL:sourceApplication:annotation:中添加整体回调:
//如果OpenShare能处理这个回调,就调用block中的方法,如果不能处理,就交给其他(比如支付宝)。 if ([OpenShare handleOpenURL:url]) { return YES; }
第三步:在需要分享、OAuth的地方调用:
//比如微信登录,其他登录可以参考文档或者代码,或者让Xcode自动提示。 [OpenShare WeixinAuth:@"snsapi_userinfo" Success:^(NSDictionary *message) { ULog(@"微信登录成功:\n%@",message); } Fail:^(NSDictionary *message, NSError *error) { ULog(@"微信登录失败:\n%@\n%@",message,error); }]; //分享纯文本消息到微信朋友圈,其他类型可以参考示例代码 OSMessage *msg=[[OSMessage alloc]init]; msg.title=@"Hello msg.title"; [OpenShare shareToWeixinTimeline:msg Success:^(OSMessage *message) { ULog(@"微信分享到朋友圈成功:\n%@",message); } Fail:^(OSMessage *message, NSError *error) { ULog(@"微信分享到朋友圈失败:\n%@\n%@",error,message); }];
##扩展支持更多平台
现在的社交网络各种各样,如何把这些平台集成到OpenShare中呢?就像插件一样,可以把自己实现的OpenShare+foobar.h和OpenShare+foobar.m添加进来就可以了。这里提供了一个模板工具,只需要输入你想扩展的平台的名称,就会自动生成.h和.m文件,然后基于这个模板修改即可。
##Authors and Contributors
由于每个厂商的通信协议都不一样,所以hack的时候还是走了一些弯路,如果想了解整个实现过程,可以看看我的博客:http://www.gfzj.us/series/openshare/
现在行业急需要像OAuth一样的标准,来实现app和客户端之间的分享,登录。这样就不用为每一个客户端实现一遍了。比如这个协议标准就叫做「OpenShare」(大言不惭、捂脸中)。客户端只需要声明支持OpenShare的某个版本,app就能很简单的调用了。如果您对实现OpenShare标准有任何想法,欢迎交流。
##Support or Contact
在OpenShare使用过程中有任何问题,都可以添加一个issues,我会及时解决。如果您想贡献代码,欢迎Pull Requests。其他任何问题可以在下面留言,或者通过邮箱gf@gfzj.us联系我。
##update 20150605
支持支付宝/微信支付
对于微信支付,首先要去申请开通支付能力。如果app已经「获得微信支付能力」,那么请去配置pay.php。同样对于支付宝,也需要配置,否则demo是无法运行的。
我强烈反对把密钥等放在app客户端里面,我相信一般人也不会这么干!所以OpenShare支付只支持服务器端计算签名。pay.php是用「世界上最好的语言」写成,当然你可以很方便的把它转化为其他语言实现。