IOS快速集成环信IM - 基于官方的Demo优化，5分钟集成环信IM功能
领导说一天内要集成IM功能，我顿时被吓尿了~~
说明
本项目是基于官方 ChatDemo-UI3.0 (官方Demo源码下载)项目的简化封装，目的是为了让大家更加方便快速地集成环信IM功能。
环信IOS简版DemoGit地址：https://github.com/mengmakies/ChatDemo-UI3.00-Simple （本项目会保持与环信的SDK同步更新）
环信Android简版Demo地址：
https://github.com/mengmakies/ChatDemo-UI3.00-Simple-Android
奋斗目标
分离第三方依赖库，避免与开发者现有项目的其它类库发生冲突；
抽象开发者可定制化的方法或配置参数；
其它未确定的封装工作，最终目的：高内聚，低耦合；
整理开发者开始集成时反馈的常见性问题，从实际项目考虑优化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】 ，如下图所示：
项目命名为【HxChatDemo】，然后选择路径保存即可：
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中：
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 中添加依赖库.【千万别漏了这个步骤！！！】
注意：在【Linked Frameworks and Libraries】中，找到【HyphenateLite.framework】和【Hyphenate.framework】，然后将【Required】改为【Optional】。
5.增加预编译头文件pch，保证头文件的全局引用。在【Supporting Files】目录上单机右键 -> 【New File...】 -> 【Other】 -> 【PCH File】 -> 命名为【HxChatDemo-Prefix.pch】，加入如下代码：
#import
#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
#import
#import "ChatUIDefine.h"
#import "EMAlertView.h"
#import "TTGlobalUICommon.h"
#import "EaseUI.h"
#if DEMO_CALL == 1
#import // 包含音视频通话功能
#else
#import // 不包含音视频通话功能
#endif
#import "AVOSCloud/AVOSCloud.h"// 后端云LeanCloud
#import "UserCacheManager.h"
#import "UserWebManager.h"
#endif
效果如下图：
关联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
如下图所示：
记得将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;------》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》
盆友，先别急关掉页面~~~~彩蛋往往都是最后才隆重登场的~~~
不信？那我们就举个例子，一分钟内快速集成单聊功能：
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_duruiqi_fx.jpg";// 用户头像（绝对路径）
// 登录成功后，如果后端云没有缓存用户信息，则新增一个用户
[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];
}];
}效果图如下：
注意：IOS9以上系统如果头像不显示，是因为IOS9禁止了非https的请求，只要在Info.plist中增加App Transport Security Settings子项Allow Arbitrary Loads设置为YES。
要不你也动手试试，看看能否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】
4.登录的时候界面一直显示【loading】，或者音视频通话时，安卓端无法收到通话请求。
解决：一般都是漏了这个步骤【4.向General → Embedded Binaries 中添加依赖库】引起的，此外，在【Linked Frameworks and 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人，如无特殊问题，请到群里询问）
61 个评论
你的联系人昵称是不是数字了？联系人列表需要获取昵称的中文拼音首字母来排序，所以如果不是中英文昵称的话，是无法获取到首字母的，用户也就无法显示出来。之前官方demo会出现空值引用的异常，所以我在ContactListViewController第481行加了一句代码if(!firstLetter) continue;来修复这个问题。
请问为什么联系人不显示，官方的没问题，我试了在ContactListViewController第481行加了一句代码if(!firstLetter) continue，还是不显示联系人，通讯录列表显示不全,好像总是会少一个联系人,添加新联系人后没有立即刷新，请问怎么解决呢？求助啊
楼主，环信更新了3.2.2 说是支持2017年1月1号以后的HTTPS更新，估计我也得跟着更新才行啊，但是我直接把下的3.2.2的SDK的esaeUI拖进去就报错，你能说说怎么集成3.2.2以后的版本吗？估计到时候大家都要弄
libHyphenateFullSDK.a拷贝到【/ChatDemo-UI3.0-Sample/ChatDemo-UI3.0/ChatSDK/HyphenateFullSDK/lib】下, 但HyphenateFullSDK下面没有lib这个文件夹啊,要自己建一个吗?
你好：1️⃣按照你的方法集成点击好友单聊的时候崩溃了。
+[NSBundle RedpacketBundle]: unrecognized selector sent to class 0x10f740098
2017-08-02 21:49:03.570 chatDemo[3694:157952] *** Terminating app due to uncaught exception 'NSInvalidArgumentException', reason: '+[NSBundle RedpacketBundle]: unrecognized selector sent to class 0x10f740098'
*** First throw call stack:
(
0 CoreFoundation 0x00000001104bf34b __exceptionPreprocess + 171
2️⃣/*!
@method
@brief
@discussion
@param
@result
*/上面的都报警告了command used in a comment that is attached to a method returning void [-Wdocumentation]怎么解决啊？
ld: truncated fat file. Slice from 12886016 to 25691680 is past end of file with length 7037483 file '/Users/Mac/Downloads/ChatDemo-UI3.00-Simple-master/ChatDemo-UI3.0/ChatDemo-UI3.0/ChatSDK/HyphenateFullSDK/Hyphenate.framework/Hyphenate' for architecture x86_64
clang: error: linker command failed with exit code 1 (use -v to see invocation) 为什么我添加了从百度云盘下载的两个framework，还报这个错误？
大佬!
DemoCallManager中的
// 请求语音通话时，将昵称头像通过扩展属性传递过去
NSString *ext = [[UserCacheManager getMyMsgExt] jsonStringEncoded];
报No vasible @interface for 'NSMutableDictionary' declares the selector 'jsonStringEncoded'的错误,求解决!!!@江南孤鹜
*** Terminating app due to uncaught exception 'NSInvalidArgumentException', reason: '-[EMClient callManager]: unrecognized selector sent to instance 0x6040001a9f40' 简版Demo中 运行到开屏画面的时候报错了!!!!!!!! 求大神详细指导.......
集成完成之后，一直崩溃在 明杰的MJRefreshStateHeader self.lastUpdatedTimeLabel.text = NSEaseLocalizedString(@"ui.lastUpdateNoRecords", @"Last update: no records"); 这行代码，百度查了方法，但是还是没有解决掉，求助啊
解决办法如下:我想你用的是Xcode9吧,Xcode9有个bug,就是自己拖到工程的文件或者代码,没有被引用到,你需要targets->Build Phases->Copy Bundle Resources中添加MJRefresh.bundle;这样就不会报错了.同样的拖进项目的.m文件也需要在Commpile Sources中添加,希望能帮到你.
直接使用 环信 大表哥 的demo文件移植到新项目中， 依赖库 都添加了， 运行后， 点击聊天界面就报这个 错是什么原因啊？？
*** Terminating app due to uncaught exception 'NSInvalidArgumentException', reason: '+[NSBundle RedpacketBundle]: unrecognized selector sent to class 0x10b6fa348'
*** First throw call stack:
(
0 CoreFoundation 0x000000010c2c81ab __exceptionPreprocess + 171
1 libobjc.A.dylib 0x000000010b959f41 objc_exception_throw + 48
2 CoreFoundation 0x000000010c348974 +[NSObject(NSObject) doesNotRecognizeSelector:] + 132
3 CoreFoundation 0x000000010c24b0a8 ___forwarding___ + 1432
4 CoreFoundation 0x000000010c24aa88 _CF_forwarding_prep_0 + 120
5 HXLehandIM 0x0000000106d7dcdd +[RPSoundPlayer urlPathWithSoundName:] + 61
6 HXLehandIM 0x0000000106d7dc3a +[RPSoundPlayer regisitSoundId] + 42
7 HXLehandIM 0x0000000106d6cf25 -[RedpacketViewControl init] + 117
8 HXLehandIM 0x0000000106c7dfdb -[RedPacketChatViewController viewDidLoad] + 187
9 UIKit 0x000000010f6e58a5 -[UIViewController loadViewIfRequired] + 1235
10 UIKit 0x000000010f6e5cf2 -[UIViewController view] + 27
11 UIKit 0x000000010f717d4e -[UINavigationController _startCustomTransition:] + 954
12 UIKit 0x000000010f72e5a4 -[UINavigationController _startDeferredTransitionIfNeeded:] + 686
13 UIKit 0x000000010f72f8c3 -[UINavigationController __viewWillLayoutSubviews] + 150
14 UIKit 0x000000010f988a49 -[UILayoutContainerView layoutSubviews] + 231
15 UIKit 0x000000010f6116f5 -[UIView(CALayerDelegate) layoutSublayersOfLayer:] + 1439
16 QuartzCore 0x000000010d9453ee -[CALayer layoutSublayers] + 153
17 QuartzCore 0x000000010d9494dd _ZN2CA5Layer16layout_if_neededEPNS_11TransactionE + 401
18 QuartzCore 0x000000010d8d1ded _ZN2CA7Context18commit_transactionEPNS_11TransactionE + 365
19 QuartzCore 0x000000010d8fd704 _ZN2CA11Transaction6commitEv + 500
20 UIKit 0x000000010f56aca3 _afterCACommitHandler + 272
21 CoreFoundation 0x000000010c26ad37 __CFRUNLOOP_IS_CALLING_OUT_TO_AN_OBSERVER_CALLBACK_FUNCTION__ + 23
22 CoreFoundation 0x000000010c26ac8e __CFRunLoopDoObservers + 430
23 CoreFoundation 0x000000010c24f254 __CFRunLoopRun + 1572
24 CoreFoundation 0x000000010c24e9b9 CFRunLoopRunSpecific + 409
25 GraphicsServices 0x000000010e6d59c6 GSEventRunModal + 62
26 UIKit 0x000000010f5405e8 UIApplicationMain + 159
27 HXLehandIM 0x0000000106cacd4f main + 111
28 libdyld.dylib 0x00000001122a7d81 start + 1
)
Apple Mach-O Linker Error Group
Undefined symbols for architecture x86_64:
"_utf8_nextCharSafeBody", referenced from:
-[AVSRWebSocket _innerPumpScanner] in AVOSCloud(AVSRWebSocket.o)
"_OBJC_CLASS_$_CMMotionManager", referenced from:
objc-class-ref in AlipaySDK
ld: symbol(s) not found for architecture x86_64
clang: error: linker command failed with exit code 1 (use -v to see invocation)
请问这个 bug是什么原因, 第三方库检查了一遍,都导入了呀
