IOS快速集成环信IM - 基于官方的Demo优化,5分钟集成环信IM功能

00.png


 领导说一天内要集成IM功能,我顿时被吓尿了~~

1400864-1.jpg



说明

本项目是基于官方 ChatDemo-UI3.0 (官方Demo源码下载)项目的简化封装,目的是为了让大家更加方便快速地集成环信IM功能。
 
Git地址:https://github.com/mengmakies/ChatDemo-UI3.00-Simple   (本项目会保持与环信的SDK同步更新)

奋斗目标

分离第三方依赖库,避免与开发者现有项目的其它类库发生冲突;
抽象开发者可定制化的方法或配置参数;
其它未确定的封装工作,最终目的:高内聚,低耦合;
整理开发者开始集成时反馈的常见性问题,从实际项目考虑优化SDK集成的简易度。

最终成果

1.便于开发者在新项目或现有项目快速集成环信SDK,实现聊天界面和会话列表功能,而且可以灵活地定制化一些基础模块; 
2.低耦合,用尽可能少的代码集成环信功能,尽量少污染开发者的项目代码;

如有任何问题,请联系QQ: 364223587

注意:由于Git不支持上传大于100MB的文件,所以项目源码中不包含 HyphenateFullSDK 和HyphenateSDK动态库,下载地址https://pan.baidu.com/s/1c1RsUrA ,解压后后将HyphenateFullSDK和HyphenateSDK文件夹拷贝到目录【/ChatDemo-UI3.0-Sample/ChatDemo-UI3.0/ChatSDK/】下才能正常运行。




经过对ChatUIDemo-UI3.0中的源码进行分析可知,用户初次集成EaseUI时,会遇到如下几个常见问题:

问题1

引用Parse.framework、Bolts.framework时项目容易出错或出现Not found问题,其实这两个库并不是必须的,而且Facebook已经确定在2017年1月份停止提供Parse服务。


解决方案:删除Parse相关类,用 UserCacheManager替代管理用户缓存。

问题2

ChatDemoHelper辅助类集成了很多聊天相关界面的操作方法,开发者一般会直接复用,但是ChatDemoHelper对MainViewController的函数依赖度比较高,比如


[weakself.mainVC setupUnreadMessageCount]; 
[self.mainVC networkChanged:connectionState];

解决方案
(1)将ChatDemoHelper中的mainVC类型更换成UIViewController;
(2).将MainController中的几个方法用通知(NSNotificationCenter)实现;

问题3

聊天相关页面与业务逻辑页面放在同一目录中,对于开发者来说,需要分拣; 


解决方案:将环信相关的文件、资源统一放在【ChatUI】和【ChatSDK】目录中,方便开发者直接拖拽这两个文件夹即可快速集成聊天功能。

关于昵称和头像的问题
IOS中如何显示开发者服务器上的昵称和头像 http://community.easemob.com/article/825307855
草草们的忧伤:环信IM昵称和头像  http://www.imgeek.org/article/825308536 
 
>>>>>>>>接下来,我们就一步步教大家如何快速集成环信IM功能:
1.新建一个IOS项目。打开XCode -> 【File】 -> 【New】 -> 【Project...】-> 【Single View Application】 ,如下图所示:
s1.png

项目命名为【HxChatDemo】,然后选择路径保存即可:
s2.png

 
2.加入环信IM相关的SDK以及界面代码。下载源码https://github.com/mengmakies/ChatDemo-UI3.00-Simple,将解压后文件夹中的【3rdparty】、【ChatSDK】和【ChatUI】目录复制到新建项目【HxChatDemo】目录下,然后下载SDK(地址https://pan.baidu.com/s/1c1RsUrA) ,解压后后将HyphenateFullSDK和HyphenateSDK文件夹拷贝到目录【/ChatDemo-UI3.0-Sample/ChatDemo-UI3.0/ChatSDK/】目录下, 然后将【ChatSDK】和【ChatUI】这两个目录拖入Xcode中:
00001.png


3.引入SDK的依赖库。在Xcode中为项目新建一个名为【Frameworks】的group,然后依次按照下面的目录添加依赖库:
SDK 包含实时语音依赖库有:

CoreMedia.framework
AudioToolbox.framework
AVFoundation.framework
MobileCoreServices.framework
ImageIO.framework
libc++.dylib
libz.dylib
libstdc++.6.0.9.dylib
libsqlite3.dylib
libiconv.dylib
 
// **********官方漏了以下这些系统库********************
CoreMotion.framework   
UserNotifications.framework 
AssetsLibrary.framework
MapKit.framework
Photos.framework
libbz2.1.0.dylib
// **********官方漏了以下这些系统库*****end***************
 
后端云LeanCloud需要引入的依赖库:
libicucore.dylib
SystemConfiguration.framework
CoreTelephony.framework
CoreLocation.framework

(如果使用的是 xcode7+,后缀为 tbd。)
4.向General → Embedded Binaries 中添加依赖库.
ios_import_dynamic_3.0sdk_.jpg

注意:在【Linked Frameworks and Libraries】中,找到【HyphenateLite.framework】和【Hyphenate.framework】,然后将【Required】改为【Optional】。

5.增加预编译头文件pch,保证头文件的全局引用。在【Supporting Files】目录上单机右键 -> 【New File...】 -> 【Other】 -> 【PCH File】 -> 命名为【HxChatDemo-Prefix.pch】,加入如下代码:
#import <Availability.h>

#ifndef __IPHONE_3_0
#warning "This project uses features only available in iOS SDK 3.0 and later."
#endif

// 如果不需要红包功能,直接把这个REDPACKET_AVALABLE宏注释掉,然后:

// 1.删掉红包相关代码:注释掉后,建议在xcode中搜索“REDPACKET_AVALABLE”,然后删掉相关代码;

#define REDPACKET_AVALABLE

// 如果不需要语音通话功能,直接把这个宏注释掉或者改成0,然后:
// 1.删掉音视频相关代码:注释掉后,建议在xcode中搜索“DEMO_CALL”,然后删掉相关代码;
// 2.隐藏音视频通话按钮:EaseChatBarMoreView.m  第115-131行代码注释掉。
#define DEMO_CALL 1 // 1:启用音视频通话;0:禁用音视频通话

#ifdef __OBJC__

    #import <UIKit/UIKit.h>
    #import <Foundation/Foundation.h>
    #import "ChatUIDefine.h"
    #import "EMAlertView.h"
    #import "TTGlobalUICommon.h"
    #import "EaseUI.h"

#if DEMO_CALL == 1
    #import <Hyphenate/Hyphenate.h>// 包含音视频通话功能
#else
    #import <HyphenateLite/HyphenateLite.h>// 不包含音视频通话功能
#endif

    #import "AVOSCloud/AVOSCloud.h"// 后端云LeanCloud
    #import "UserCacheManager.h"
    #import "UserWebManager.h"

#endif





效果如下图:
00002.png


关联PCH文件,打开【Build Settings】,在【Apple LLVM7.1- language】组中进行如下设置:
1.将【Precompile Prefix Header】设置为YES,预编译后的pch文件会被缓存起来,可以提高编译速度;
2.修改pch文件路径按照如下格式:将【Building setting】中的【Prefix Header】选项的路径设置为“$(SRCROOT)/项目名称/pch文件名”,例如:
$(SRCROOT)/HxChatDemo/HxChatDemo-Prefix.pch
 
如下图所示:
s7.png

记得将ENABLE_BITCODE设置为NO


OK~编译运行成功!!!大功告成!经过如上几个步骤,环信IM功能所需要的SDK以及EaseUI界面代码都被成功导入项目了。
 
--------->>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
如果需要引入单聊、群聊、联系人列表等界面功能,你就要参考简版Demo项目中的代码一步步操作了,比如:
1.在项目中注册环信APPKEY,参考Appdelegate.m中的代码
2.注册【接收消息】、【好友通知消息】、【网络变化】等回调事件,参考MainViewController.m中的代码
NOTIFY_ADD(setupUntreatedApplyCount, kSetupUntreatedApplyCount);
NOTIFY_ADD(setupUnreadMessageCount, kSetupUnreadMessageCount);
NOTIFY_ADD(networkChanged, kConnectionStateChanged);

3.注意,某些回调事件已经在ChatUIHelper.m里实现,所以需要在适当的位置初始化相关的ViewController:
[ChatUIHelper shareHelper].contactViewVC = _contactsVC;
[ChatUIHelper shareHelper].conversationListVC = _chatListVC;
[ChatUIHelper shareHelper].mainVC = self.mainController;

------》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》
盆友,先别急关掉页面~~~~彩蛋往往都是最后才隆重登场的~~~

QQ图片20160927164924.jpg


不信?那我们就举个例子,一分钟内快速集成单聊功能:
1.在AppDelegate.m加入如下代码:
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {

// 注册环信SDK以及推送证书

    [[EaseSDKHelper shareHelper] hyphenateApplication:application
                        didFinishLaunchingWithOptions:launchOptions
                                             appkey:@"easemobdemo#chatdemoui"
                                         apnsCertName:@""// 推送证书名称
                otherConfig:@{kSDKConfigEnableConsoleLogger:[NSNumber numberWithBool:YES],@"easeSandBox":@NO}];

  
    [ChatUIHelper shareHelper];// 初始化环信相关回调

    // 初始化web缓存配置, appkey需要自己去LeanCloud官网注册存储服务
    // http://www.imgeek.org/article/825308536
    [UserWebManager config:launchOptions
                     appId:@"utUG5ot9Y64dqJIFG9Ir2rqu-gzGzoHsz"
                    appKey:@"IbHhNkPo4gfrFFc3epCw3eG2"];
return YES;
}
2.然后,在ViewController.m中添加一个按钮,并加入按钮响应代码,实现环信登录成功后自动打开单聊页面的功能:
// 登录环信并打开单聊界面
- (IBAction)doChat:(id)sender {

NSString *userName = @"martin1234";

    NSString *pwd = @"martin1234";

    // 因为设置了自动登录模式:[[EMClient sharedClient].options setIsAutoLogin:YES];
    // 所以,登录之前要先注销之前的用户,否则重复登录会抛异常
    EMError *error = [[EMClient sharedClient] logout:YES];

    if (!error) {
        NSLog(@"退出成功");
    }
    
    [self showHudInView:self.view hint:@"Loading..."];
    [[EMClient sharedClient] loginWithUsername:userName password:pwd completion:^(NSString *aUsername, EMError *aError) {

        [self hideHud];

        if (error) {
            [self showHint:aError.errorDescription];
            NSLog(@"登录报错了:%@",aError.errorDescription);
            return ;
        }
        // 测试:登录成功后,自动添加martin1234为好友
        EMError *error = [[EMClient sharedClient].contactManager addContact:@"martin12345" message:@"我想加您为好友"];

        if (!error) {
            NSLog(@"添加成功");
        }
        
        NSString *userOpenId = userName;// 用户环信ID
        NSString *nickName = [NSString stringWithFormat:@"小草%d", arc4random_uniform(100)];// 用户昵称
        NSString *avatarUrl = @"http://avatar.csdn.net/E/8/5/2 ... %3B// 用户头像(绝对路径)

        
        // 登录成功后,如果后端云没有缓存用户信息,则新增一个用户
        [UserWebManager createUser:userOpenId nickName:nickName avatarUrl:avatarUrl];

        //设置是否自动登录
        [[EMClient sharedClient].options setIsAutoLogin:YES];
        [[ChatUIHelper shareHelper] asyncGroupFromServer];
        [[ChatUIHelper shareHelper] asyncConversationFromDB];
        [[ChatUIHelper shareHelper] asyncPushOptions];

        //发送自动登陆状态通知
        [[NSNotificationCenter defaultCenter] postNotificationName:KNOTIFICATION_LOGINCHANGE object:@([[EMClient sharedClient] isLoggedIn])];

        ChatViewController *vc = [[ChatViewController alloc]initWithConversationChatter:@"admin" conversationType:EMConversationTypeChat];

        vc.title = @"江南孤鹜";
        [self.navigationController pushViewController:vc animated:YES];
    }];
}
效果图如下:
IMG_6441_meitu_1.jpg


注意:IOS9以上系统如果头像不显示,是因为IOS9禁止了非https的请求,只要在Info.plist中增加App Transport Security Settings子项Allow Arbitrary Loads设置为YES。
22334.png


要不你也动手试试,看看能否5分钟内集成环信IM功能?记得在文章底下留言告诉我们花了多长时间哦 ~.~
 
相关问题:
1.环信MJRefresh与自己项目已有的MJRefresh冲突,怎么办?
答:保留自己项目的MJRefresh,删除环信里的MJRefresh文件夹即可。MBProgressHUD也是同样的情况,但是不能直接删除环信里的MBProgressHUD目录,只需删除MBProgressHUD.h和MBProgressHUD.m即可。
 
2.环信EaseUI里将SDWebImage改名为EMSDWebImage,与自己项目中的SDWebImage冲突,怎么办?
答:删除环信里的EMSDWebImage文件夹,去掉EaseUI中引用SDWebImage中的【EM】前缀,例如:
(1).#import "UIImageView+EMWebCache.h"  换成  #import "UIImageView+WebCache.h";
(2).#import "UIImage+EMGIF.h"  换成 #import "UIImage+GIF.h";
(3).#import "EMSDWebImageDecoder.h"  换成 #import "SDWebImageDecoder.h"
(4).EMSDImageCache改为SDImageCache;
 

3.编译运行时报错:Reason: image not found
解决:【Build Phases】-> 【Link Binary With Libraries】->找到【HyphenateLite.framework】和【Hyphenate.framework】->将【Required】改为【Optional】



本文HxChatDemo项目下载地址:http://git.oschina.net/markies/HxChatDemo
简版Demo下载地址:https://github.com/mengmakies/ChatDemo-UI3.00-Simple​ 
如有任何问题,请咨询【环信IM互帮互助群】,群号:340452063
或者加本人QQ:[b]364223587 (好友数已达1000人,如无特殊问题,请到群里询问)[/b]











38 个评论

怒赞!
虽然我还没试呢 但是看着就很容易接受 给你32个赞!
领导怎么不说赶紧出一个Android版本开源啊
集成之后发现一个问题,通讯录列表显示不全,好像总是会少一个联系人,添加新联系人后没有立即刷新
这篇文章是基于官方demo基础上封装的,这些细节问题请咨询官方技术支持
大神,666,看了好几遍,感觉爽死了
互相交流,给楼主赞!
very nice
very nice
very nice
你好,我想问一下这个集成到app里面,app上架后大小会加多少啊??
好像是10M
联系人不显示,官方的没问题啊,这个怎么解决啊请问??
你的联系人昵称是不是数字了?联系人列表需要获取昵称的中文拼音首字母来排序,所以如果不是中英文昵称的话,是无法获取到首字母的,用户也就无法显示出来。之前官方demo会出现空值引用的异常,所以我在ContactListViewController第481行加了一句代码if(!firstLetter) continue;来修复这个问题。
  要是用自己的界面就只需要ChantSDK 吗?
请问为什么联系人不显示,官方的没问题,我试了在ContactListViewController第481行加了一句代码if(!firstLetter) continue,还是不显示联系人,通讯录列表显示不全,好像总是会少一个联系人,添加新联系人后没有立即刷新,请问怎么解决呢?求助啊
还是不显示联系人列表呢?
自己搜索一下代码:if(!firstLetter) continue;在这里打一个断点就知道为什么了?官方原来的demo代码有bug,所以我加上这句。
这个问题在最新版本的简版demo里已经修复了。
请问一下,为什么我这边还是无法看到对方的头像呢?我另一个设备登对方的账号上传头像,然而在chatVC和会话列表中只能看到自己的头像
请支持cocoapods 方便开发,不至于 每次集成的时候 会出这样或者那样的问题了
请支持cocoapods 方便开发,不至于 每次集成的时候 会出这样或者那样的问题了,支持我的请点赞
环信官方支持pods,我也想封装成framwork
出错一般都是环信里的thirdparts与原有项目的第三方类库冲突引起的,即使用pods,也依然解决不了冲突问题
谢谢大神精彩的分分享
10月份的版本已经解决。
10月份发布的最新简版demo已解决这个问题。
楼主,环信更新了3.2.2 说是支持2017年1月1号以后的HTTPS更新,估计我也得跟着更新才行啊,但是我直接把下的3.2.2的SDK的esaeUI拖进去就报错,你能说说怎么集成3.2.2以后的版本吗?估计到时候大家都要弄
最关键的是我对你给的easeUI里面ViewController下的控制器都自行修改了一些东西,不知道这些是不是也要必须跟着改...求教了
我今天上传了最新版本,同步更新官方SDK
libHyphenateFullSDK.a拷贝到【/ChatDemo-UI3.0-Sample/ChatDemo-UI3.0/ChatSDK/HyphenateFullSDK/lib】下, 但HyphenateFullSDK下面没有lib这个文件夹啊,要自己建一个吗?
对,要自己创建lib文件夹。因为git不会上传空文件夹,所以漏了lib文件夹。
项目集成中FMDB重复冲突,能删除SDK中的FMDB吗,里面有没有特别的封装
可以
请问大大,问什么无法使用音视频啊
我这边因为只要单聊的界面,但是音视频也需要,然后我点击了demo里的音视频,只是弹出了提示框,而且提示框里什么也没有,打印的信息又看不太懂,求指点。
pch文件里需要将DEMO_CALL这个宏定义为1,而且要求对方在线。
可以

要回复文章请先登录注册

知识价值的认可,源自您的赞赏

扫描二维码,你的支付将由imGeek代收后转给对方

×