TeamTalk 之 Mac 客户端架构分析

这个周末本打算做点更有意义的事情，但，觉得花点时间对这个开源的IM客户端进行一番分析或许会对后续的工作内容有点帮助。那么，先安抚下内心中那惴惴不安，暂时放下原定的宏伟计划，静下心来，看看别人是怎么来做这个IM的。

TeamTalk是什么？它是蘑菇街开源的一整套IM解决方案，包括服务端和各种客户端，相关地址如下：

说起来，我和蘑菇街还是有点渊源的，但，这个故事，这里就不做过多展开了（_说多了都是泪啊_），我们直接进入今天的正题吧。

项目结构

在软件架构中，一个项目的目录结构至关重要，它决定了整个项目的架构风格。通过一个规范的项目结构，我们应该能够很清楚的定位相应逻辑存放位置，以及能够没有歧义的在指定目录中进行新代码的撰写。项目结构便是项目的骨架，如果存在畸形和缺陷，项目的整体面貌就会受到很大影响。我们来看看TeamTalk的项目根结构：

从整个项目结构图中，我们大致能猜出一些目录中存放的是什么，以下是这些目录的主要意图：

html：存放着一些HTML相关文件，用于项目中一些用户界面与HTML进行Hybrid。
customView：一些公共的自定义视图，同样与用户界面相关。
Services：封装了两个服务，应用更新检测，和用户搜索。
HelpLib：一些公共的帮助库。
Category：顾名思义，这里存放的都是现有类的Category。
Modules：按照功能和业务进行划分的一系列模块。
DDLogic：这里面主要存放着一个模块化框架。
teamtalk：这里面是和TeamTalk应用级别相关的东西。
views：视图，原本应该是存放应用所有视图的地方。
Libraries：第三方库。
utilities：一些通用的帮助类和组件。

思考与分析

首先，从总体来说，这样的目录结构划分，似乎可以涵盖到整个项目开发的所有场景，但它存在以下几个很明显的问题：

命名不够规范，对于有态度的人来说，看到这样的目录结构，可能首先就会将它们的大小写进行统一，然后单复数进行统一。虽然这可能并不会对最终应用有任何的提升，但我说过，态度决定一切，既然开源了，这样的规范更应该值得注重。

除了大小写之外，DDLogic也是让人非常费解的命名，Logic是什么？它是逻辑？那么似乎整个应用的源码都可以放置到这里了。这里的问题，就跟我们建立了一个Helper.h和Common.h一样，包罗万象，但这不应该是我们遵从的。命令体现的是抽象能力，它应该是明确的，模棱两可会导致它在项目的迭代中要么被淘汰，要么膨胀到让人无法忍受。
类别划分有歧义，HelpLib和Utilities，似乎根本就无法去辨别它们之间的区别，这两者应该进行合并。并且Helper类本身就不是很好的设计方式，可以通过Category来尽量减少Helper，无法通过Category扩展的，应该按照类的实际行为进行更好的命名和划分。
含有退化的类别，所谓退化的类别，就是项目初期原本的设定，在后续的迭代重构中渐渐失去作用或者演化为另外的形式。这里的Views和Services是很好的例子，这两个目录存放在根目录下非常鸡肋，既然已经按模块化进行划分，那么Services可以拆分到相应的模块里；Views也是类似，应该拆分到相应模块和CustomView中。
含有臃肿的类别，这一点也是显而易见的，之所以臃肿，是因为里面放了不应该放的东西。这里主要体现在Modules这个目录，我们应该把不属于模块实现的东西提取出来，包括数据存储、系统配置、一些通用组件。这些应该安置到根目录相应分类中，而明显层次化的东西，应该提取到单独库或目录中，比如网络API相关的东西。
没有意义的单独归类，这里体现在Html这个目录，应该和Supporting Files目录中的资源进行合并，统一归类为Resources，然后再按照资源的类别进行细分。

项目结构的划分应该做到有迹可循，也就是说是按照一定的规则进行划分。这里主要的划分依据是逻辑模块化，这样的方式我还是比较赞同的，虽然有很多细节没有处理好，但主线还是很好的。

网络数据处理

在任何需要联网的应用中，网络数据处理都是非常重要的，这点在IM中更是毋庸置疑。IM与很多其它应用相比，更具挑战，它需要处理很多即时消息，并且很多时候需要自己去构建一套通讯机制。

TeamTalk中，主要使用HTTP和TCP进行通讯，我们知道HTTP是基于TCP的更高层协议，而这里的TCP通讯是指用TCP协议发送自定义格式的报文。TeamTalk在HTTP通讯中使用的是RESTful API，并使用JSON格式与服务器进行交换数据；而在TCP这里，主要是通过ProtocolBuffer序列化协议，加上自定义的包头与服务器进行通信。

HTTP数据处理

HTTP的数据处理，在TeamTalk中显得非常简单，并没有做过多的设计。主要是使用AFNetworking封装了一个HTTP模块：

DDHttpModule.h

typedef void(^SuccessBlock)(NSDictionary *result);
typedef void(^FailureBlock)(StatusEntity* error);

@interface DDHttpModule : DDModule
 
-(void)httpPostWithUri:(NSString *)uri params:(NSDictionary *)params success:(SuccessBlock)success failure:(FailureBlock)failure;
-(void)httpGetWithUri:(NSString *)uri params:(NSDictionary *)params success:(SuccessBlock)success failure:(FailureBlock)failure;

@end

extern DDHttpModule* getDDHttpModule();

这样一个模块会被其它模块进行使用，直接传递uri请求服务器，并解析响应，以下是一个使用场景：

DDHttpServer.m

- (void)loginWithUserName:(NSString*)userName
                 password:(NSString*)password
                  success:(void(^)(id respone))success
                  failure:(void(^)(id error))failure
{
    DDHttpModule* module = getDDHttpModule();
    NSMutableDictionary* dictParams = [NSMutableDictionary dictionary];
    
    ...(省略参数赋值)
    
    [[NSURLCache sharedURLCache] removeAllCachedResponses];
    [module httpPostWithUri:@"user/zlogin/" params:dictParams
                    success:^(NSDictionary *result) { success(result); }
                    failure:^(StatusEntity *error) { failure(error.msg); }
    ];
}

即便是这样的一个封装，在后续的迭代中似乎也慢慢失去了作用，目前大部分所使用到HTTP的代码里，都是直接使用AFNetworking，那么这样的一个封装已经没有存在的必要了。

TCP数据处理

在TeamTalk里，针对TCP的数据处理略显复杂，因为没有类似AFNetworking这样的类库，所以需要自己封装一套处理机制。大致类图如下：

通过这样的一个类图，我们大致可以推断出设计者的抽象思维，他把所有网络操作抽象为API。基于这样思路，这里有三个最核心的类：

DDSuperAPI：这个类是对所有Request/Response这种模式网络的请求进行的抽象，所有遵循这种模式的API都需要继承这个类。
DDUnrequestSuperAPI：这个和DDSuperAPI相对应，也就是所有非Request/Response模式的网络请求，基本上都是服务端推送过来的消息。
DDAPISchedule：API调度器（_应该改名为DDAPIScheduler_），顾名思义，是用来调度所有注册进来的API，这个类主要做了以下几件事情：
1. 通过DDTcpClientManager接收和发送数据包。
2. 通过seqNo和数据包标识符（_ServiceID和CommandID，这里源码中CommandID拼写有误哦_），映射Request和Response，并将服务端的响应派发到正确的API中。
3. 管理响应超时，确保每一个Request都会有应答。

基于这样一个设计，我们来看一个基本的登录操作序列图：

所有基于请求响应模式的操作，都是与上图类似，而服务端推送过来的消息，也是类似，只是没有了请求的过程。通过我的分析，大家觉得这样的设计怎么样？首先从扩展性的角度考虑，每一个API都相对独立，增加新的API非常容易，所以扩展性还是很不错的；其次从健壮性的角度考虑，每一个API都由调度器管理，调度器可以对API进行一些容错处理，API本身也可以做一些容错处理，这一点也还是可以的；最后从使用者的角度考虑，API对外暴露的接口非常简单，并且对于异步操作使用Block返回，对于组织代码还是非常有用的，所以使用者也觉得良好。

那么，这是一个完美的设计了么？我说过，没有完美的设计，只有符合特定场景的设计。针对这个设计，撇开它一些命名问题，以下是我觉得它不足的地方：

子类膨胀，恰恰是为了更好的扩展性，而带来了这样的问题，由于一个API最多只能处理两个协议包（_Request，Response_），所以协议众多时，导致API子类泛滥，而所做的基本都是相似事情。TeamTalk这种形式的封装，本质上是采用了Command模式，这个模式在面向对象的设计中本身就充满争议，因为它是封装行为（_面向过程的设计_），但也有它适用的场景，比如事务回滚、行为组合、并发执行等，但这里似乎都用不到。所以，我觉得TeamTalk这样的设计并不是特别合适，或许使用管道设计会更好点。
调度器职责不单一，为什么说它的职责不单一呢？因为引起它的变化点不止一处，很显然的，发送数据不应该纳入调度器的职责中。另外DDSuperAPI和DDUnrequestSuperAPI全部由这一个调度器来调度，也是有点别扭的，前者响应分发完后必须要从列表中移除，后者又绝对不能被移除，这样鲜明的差异性在设计中是不应该存在的，因为它会导致一些使用上的问题。

总体来说，这样的一个框架还是不错的，因为它的抽象层次不高，很容易去理解和维护，并且完成了大家的预期，这样或许就已经足够了。

本地持久化

本地持久化是个可以有很多设计的地方，但在APP中，进行设计的情况并不是很多，因为APP本身对于持久化的要求没有MIS高，一般只是做些离线缓存，而在IM中，它还负责存储历史消息等结构化数据。

TeamTalk对于持久化这块，也没有做什么设计，只是依托于FMDB封装了一个MTDatabaseUtil，这是一个类似于Helper的存在，里面聚集了所有APP会用到的存储方法。毋庸置疑，这样的封装会导致类比较庞大，好在TeamTalk中存储方法并不多，并且使用了Catagory对方法进行了分类，所以总体感觉也还是可以的。另外，从残存的目录结构中可以看出，TeamTalk原本可能是想采用CoreData，但最终放弃了，或许是觉得CoreData整体不够轻量级吧。

MTDatabaseUtil和API一样，都只能算是基础设施（Infrastructure），给高层模块提供支持，高层模块会使用这些基础设施根据业务逻辑进行封装，可以看一个具的代码片段：

MTGroupModule.m

- (void)getOriginEntityWithOriginIDsFromRemoteCompletion:(NSArray*)originIDs completion:(DDGetOriginsInfoCompletion)completion{
    
    ...（省略）
    
    DDGroupInfoAPI *api = [[DDGroupInfoAPI alloc] init];
    [api requestWithObject:param Completion:^(id response, NSError *error) {
        if (!error) {
            NSMutableArray* groupInfos = [response objectForKey:@"groupList"];
            [self addMaintainOriginEntities:groupInfos];
            [[MTDatabaseUtil instance] insertGroups:groupInfos];
            completion(groupInfos,error);
        }else{
            DDLog(@"erro:%@",[error domain]);
        }
    }];
}

理想中，只会在业务模块里依赖持久化操作库，但从TeamTalk总体使用情况中看，并不是这么理想，很多Controller里面直接对MTDatabaseUtil进行了操作，这样就削弱了模块化封装的意义。显然，Controller的职责不应该牵扯到数据持久化，这些都应该放置在相应的业务模块里，统一对外屏蔽这些实现细节。

模块化设计

模块化设计是更高层次的抽象和复用，也是业务不断发展后必然的设计趋势。在进入目前公司的第二周例会上，我便分享了一个亲手设计的模块化框架，这个框架和TeamTalk模块化框架有很多类似之处，好坏暂不做对比，我们先看看TeamTalk中的一个模块化架构。

在TeamTalk的DDLogic目录下，隐藏着一个模块化的设计，这也是整个项目中模块设计的基础构件，以下是这个设计的核心类图：

DDModule：最基础的模块抽象，所有模块的基类，包含自己的生命周期方法，并提供一些模块共有方法。
DDTcpModule：拥有TCP通讯能力的模块，监听网络数据，子类化模块可以就此进行业务封装。
DDModuleDataManager：按照模块的粒度进行持久化操作，负责持久化和反持久化所有模块。
DDModuleManager：管理所有模块，负责调用模块生命周期方法，并对外提供模块获取方法。

整个设计还是很简单明了的，但不知是TeamTalk设计者更换了，还是原设计者变心了，导致这个模块化设计没有起到它预期的作用。具体原因就不细究了，但这样的设计还是值得去推演的，就目前这样的设计而言，也还是缺少了一些东西：

DDModule应该通过DDModuleManager注入一些基础设施，比如数据库访问组件、缓存组件、消息组件等。
DDModule应该有获取到其它模块的能力，这里面不应该反依赖与DDModuleManager，可以抽象一个ModuleProvider注入到DDModule中。
可通过Objective-C对象的load方法，在模块实现类中直接注册模块到模块管理器里，这样会更加内聚。

虽然我觉得有点缺失，但还是很欣慰的看到了这样的模块化设计，又让我想起一些往事，这种心情，就像遇见了一个和初恋很像的人。

UI相关设计

整个UI设计也没什么特别之处，主要还是采用了xib进行布局，然后连线到相应的Controller中，这里主要的WindowController是DDMainWindowController，它是在登录窗口消失后出现的，也就是DDLoginWindowController所控制的窗口消失后。

值得一提的是，这里将所有的UI都放置到了相应的业务模块中，这也是我比较推崇的做法。一个模块本就应该能够自成一系，它应该有自己的Model，有自己的View，也有自己的Controller，还可以有自己的Service等。这样设计下的模块才会显得更加内聚，其实设计就是这么简单，小到类，大到组件都应该遵循内聚的原则。

其它组件

TeamTalk中还使用了一些个第三方组件，具体罗列如下：

CrashReporter：用于崩溃异常收集。
Sparkle：用于软件自动更新。
Adium：OSX下的一个开源的IM，TeamTalk中使用了其中的一些框架和类。

总结

TeamTalk作为一个敢于开源出来的IM，还是非常值得赞扬的，国内的技术氛围一直提高不起来，大家似乎都在闭门造车。如果多一些像蘑菇街这样的开源行为，应该能够更好的促进圈子里的技术生态。虽然，这篇博文里提出了很多TeamTalk Mac客户端架构的不足之处，但，设计本身就是如此，根本没有最好的设计，而，每个设计者的眼光也不相同，或许我说得都不正确也不见得。

所以，只要有颗敢于尝试设计的心，开放的态度，一切问题都不是问题。