本文在“扫一扫功用的不断迭代，根据规划形式的基本准则，逐步选用规划形式思维进行代码和架构优化”的布景下，对规划形式在扫一扫中新的应用进行了总结。

布景

扫一扫是淘宝镜头页中的一个重要组成，功用运行长远，其历史代码中较少选用面向目标编程思维，而较多选用面向进程的程序规划。

随着扫一扫功用的不断迭代，咱们根据规划形式的基本准则，逐步选用规划形式思维进行代码和架构优化。本文便是在这个布景下，对规划形式在扫一扫中新的应用进行了总结。

扫一扫原架构

扫一扫的原架构如图所示。其中逻辑&展现层的功用逻辑很多，并没有良好的规划和拆分，举几个比如：

  1. 所有码的处理逻辑都写在同一个办法体里，一个办法就接近 2000 多行。
  2. 庞大的码处理逻辑写在 viewController 中，与 UI 逻辑耦合。

按照现有的代码规划，若要对某种码逻辑进行修改，都必须将所有逻辑全量编译。如果继续沿用此代码，扫一扫的可保护性会越来越低。

淘宝iOS扫一扫架构升级 - 设计模式的应用

因而咱们需求对代码和架构进行优化，在这儿优化遵从的思路是：

  1. 了解事务才能
  2. 了解原有代码逻辑，不确定的当地通过埋点等方法线上验证
  3. 对原有代码功用进行重写/重构
  4. 编写单元测验，供给测验用例
  5. 测验&上线

扫码才能总述

扫一扫的解码才能决议了扫一扫能够处理的码类型，这儿称为一级分类。根据一级分类，扫一扫会根据码的内容和类型，再进行二级分类。之后的逻辑，便是针对不同的二级类型，做相应的处理，如下图为技能链路流程。

淘宝iOS扫一扫架构升级 - 设计模式的应用

规划形式

职责链形式

淘宝iOS扫一扫架构升级 - 设计模式的应用

上述技能链路流程中，码处理流程对应的便是原有的 viewController 里边的巨无霸逻辑。通过梳理咱们看到，码处理其实是一条链式的处理，且有前后依靠联系。优化计划有两个，计划一是拆解成多个办法顺序调用；计划二是参考苹果的 NSOperation 独立核算单元的思路，拆解成多个码处理单元。计划一实质还是没解决开闭准则（对扩展开放，对修改封闭）问的题。计划二是一个比较好的实践方法。那么怎么规划一个简略的结构来完成此逻辑呢？

码处理链路的特色是，链式处理，可操控处理的顺序，每个码处理单元都是单一职责，因而这儿引出改造第一步：职责链形式。

职责链形式是一种行为规划形式， 它将恳求沿着处理者链进行发送。收到恳求后， 每个处理者均可对恳求进行处理， 或将其传递给链上的下个处理者。

本文规划的职责链形式，包括三部分：

  1. 创立数据的 Creator
  2. 办理处理单元的 Manager
  3. 处理单元 Pipeline

三者结构如图所示

淘宝iOS扫一扫架构升级 - 设计模式的应用

创立数据的 Creator

包括的功用和特色：

  1. 由于数据是根据事务的，所以它只被声明为一个 Protocol ，由上层完成。
  2. Creator 对数据做目标化，目标生成后self.generateDataBlock(obj, Id)即开端履行

API 代码示例如下

/// 数据产生协议 <CreatorProtocol>
@protocol TBPipelineDataCreatorDelegate <NSObject>
@property (nonatomic, copy) void(^generateDataBlock)(id data, NSInteger dataId);
@end

上层事务代码示例如下

@implementation TBDataCreator
@synthesize generateDataBlock;
- (void)receiveEventWithScanResult:(TBScanResult *)scanResult                                                        eventDelegate:(id <TBScanPipelineEventDeletate>)delegate {
    //对数据做目标化 
    TBCodeData *data = [TBCodeData new];
    data.scanResult = scanResult;
    data.delegate = delegate;
    NSInteger dataId = 100; 
    //开端履行递归
    self.generateDataBlock(data, dataId);
}
@end

办理处理单元的 Manager

包括的功用和特色：

  1. 办理创立数据的 Creator
  2. 办理处理单元的 Pipeline
  3. 选用支持链式的点语法，便利书写

API 代码示例如下

@interface TBPipelineManager : NSObject
/// 增加创立数据 Creator
- (TBPipelineManager *(^)(id<TBPipelineDataCreatorDelegate> dataCreator))addDataCreator;
/// 增加处理单元 Pipeline
- (TBPipelineManager *(^)(id<TBPipelineDelegate> pipeline))addPipeline;
/// 抛出通过一系列 Pipeline 的数据。当 Creator 开端调用 generateDataBlock 后，Pipeline 就开端履行
@property (nonatomic, strong) void(^throwDataBlock)(id data);
@end

完成代码示例如下


@implementation TBPipelineManager
- (TBPipelineManager *(^)(id<TBPipelineDataCreatorDelegate> dataCreator))addDataCreator {    
    @weakify
    return ^(id<TBPipelineDataCreatorDelegate> dataCreator) {
        @strongify
        if (dataCreator) {
            [self.dataGenArr addObject:dataCreator]; 
        }
        return self;
    };
}
- (TBPipelineManager *(^)(id<TBPipelineDelegate> pipeline))addPipeline {
    @weakify
    return ^(id<TBPipelineDelegate> pipeline) {
        @strongify
        if (pipeline) {
            [self.pipelineArr addObject:pipeline];
            //每一次add的一起，咱们做链式标记（通过runtime给每个处理加Next）
            if (self.pCurPipeline) {
                NSObject *cur = (NSObject *)self.pCurPipeline;                
                cur.tb_nextPipeline = pipeline;
            }
            self.pCurPipeline = pipeline;
        }
        return self;
    };
}
- (void)setThrowDataBlock:(void (^)(id _Nonnull))throwDataBlock {
    _throwDataBlock = throwDataBlock;
    @weakify
    //Creator的数组，依次对 Block 回调进行赋值，当事务方调用此 Block 时，便是开端处理数据的时分    
    [self.dataGenArr enumerateObjectsUsingBlock:^(id<TBPipelineDataCreatorDelegate>  _Nonnull obj, NSUInteger idx, BOOL * _Nonnull stop) {
        obj.generateDataBlock = ^(id<TBPipelineBaseDataProtocol> data, NSInteger dataId) {                 @strongify
            data.dataId = dataId;
            //开端递归处理数据
            [self handleData:data];
        };
    }];
}
- (void)handleData:(id)data {
    [self recurPipeline:self.pipelineArr.firstObject data:data];
}
- (void)recurPipeline:(id<TBPipelineDelegate>)pipeline data:(id)data {
    if (!pipeline) {
        return;
    }
    //递归让pipeline处理数据
    @weakify
    [pipeline receiveData:data throwDataBlock:^(id  _Nonnull throwData) {
        @strongify 
        NSObject *cur = (NSObject *)pipeline;
        if (cur.tb_nextPipeline) {
            [self recurPipeline:cur.tb_nextPipeline data:throwData];
        } else {
            !self.throwDataBlock?:self.throwDataBlock(throwData);
        }
    }];
}
@end

处理单元 Pipeline

包括的功用和特色：

  1. 由于数据是根据事务的，所以它只被声明为一个 Protocol ，由上层完成。

API 代码示例如下

@protocol TBPipelineDelegate <NSObject>
//如果有错误，直接抛出
- (void)receiveData:(id)data throwDataBlock:(void(^)(id data))block;
@end

上层事务代码示例如下

//以A类型码码处理单元为例
@implementation TBGen3Pipeline
- (void)receiveData:(id <TBCodeDataDelegate>)data throwDataBlock:(void (^)(id data))block {    
    TBScanResult *result = data.scanResult;
    NSString *scanType = result.resultType;
    NSString *scanData = result.data;
    if ([scanType isEqualToString:TBScanResultTypeA]) {
        //跳转逻辑
        ...
        //能够处理，终止递归
        BlockInPipeline();
    } else {
        //不满足处理条件，继续递归：由下一个 Pipeline 继续处理
        PassNextPipeline(data);
    }
}
@end

事务层调用

有了上述的框架和上层完成，生成一个码处理办理就很简略且能到达解耦的意图，代码示例如下

- (void)setupPipeline {
    //创立 manager 和 creator
    self.manager = TBPipelineManager.new;
    self.dataCreator = TBDataCreator.new;
    //创立 pipeline
    TBCodeTypeAPipelie *codeTypeAPipeline = TBCodeTypeAPipelie.new;
    TBCodeTypeBPipelie *codeTypeBPipeline = TBCodeTypeBPipelie.new;
    //... 
    TBCodeTypeFPipelie *codeTypeFPipeline = TBCodeTypeFPipelie.new;
    //往 manager 中链式增加 creator 和 pipeline
    @weakify
    self.manager
    .addDataCreator(self.dataCreator)
    .addPipeline(codeTypeAPipeline) 
    .addPipeline(codeTypeBPipeline)
    .addPipeline(codeTypeFPipeline)
    .throwDataBlock = ^(id data) {
        @strongify 
        if ([self.proxyImpl respondsToSelector:@selector(scanResultDidFailedProcess:)]) {                   [self.proxyImpl scanResultDidFailedProcess:data];
        }
    };
}

状况形式

淘宝iOS扫一扫架构升级 - 设计模式的应用

淘宝iOS扫一扫架构升级 - 设计模式的应用

回头来看下码展现的逻辑，这是咱们用户体会优化的一项重要内容。码展现的意思是对于当时帧/图片，识别到码位置，咱们进行锚点的高亮并跳转。这儿包括三种状况：

  1. 未识别到码的时分，无锚点展现
  2. 识别到单码的时分，展现锚点并在指定时间后跳转
  3. 识别到多码额时分，展现锚点并等待用户点击

能够看到，这儿涉及到简略的展现状况切换，这儿就引出改造的第二步：状况形式

淘宝iOS扫一扫架构升级 - 设计模式的应用

状况形式是一种行为规划形式， 能在一个目标的内部状况变化时改动其行为， 使其看上去就像改动了自身所属的类相同。

本文规划的状况形式，包括两部分：

  1. 状况的信息 StateInfo
  2. 状况的基类 BaseState

两者结构如图所示

淘宝iOS扫一扫架构升级 - 设计模式的应用

状况的信息 StateInfo

包括的功用和特色：

  1. 当时上下文仅有一种状况信息流通
  2. 事务方能够保存多个状况键值对，状况根据需求履行相应的代码逻辑。

状况信息的声明和完成代码示例如下

@interface TBBaseStateInfo : NSObject {
    @private 
    TBBaseState<TBBaseStateDelegate> *_currentState; //记载当时的 State
}
//运用当时的 State 履行
- (void)performAction;
//更新当时的 State
- (void)setState:(TBBaseState <TBBaseStateDelegate> *)state;
//获取当时的 State
- (TBBaseState<TBBaseStateDelegate> *)getState;
@end
@implementation TBBaseStateInfo
- (void)performAction {
    //当时状况开端履行 
    [_currentState perfromAction:self];
}
- (void)setState:(TBBaseState <TBBaseStateDelegate> *)state {
    _currentState = state;
}
- (TBBaseState<TBBaseStateDelegate> *)getState {
    return _currentState;
}
@end

上层事务代码示例如下

typedef NS_ENUM(NSInteger,TBStateType) {
    TBStateTypeNormal, //空状况
    TBStateTypeSingleCode, //单码展现态
    TBStateTypeMultiCode, //多码展现态
};
@interface TBStateInfo : TBBaseStateInfo
//以 key-value 的方法存储事务 type 和对应的状况 state
- (void)setState:(TBBaseState<TBBaseStateDelegate> *)state forType:(TBStateType)type;
//更新 type，并履行 state
- (void)setType:(TBStateType)type;
@end
@implementation TBStateInfo
- (void)setState:(TBBaseState<TBBaseStateDelegate> *)state forType:(TBStateType)type {    
    [self.stateDict tb_setObject:state forKey:@(type)];
}
- (void)setType:(TBStateType)type {
    id oldState = [self getState]; 
    //找到当时能响应的状况
    id newState = [self.stateDict objectForKey:@(type)];
    //如果状况未发生变更则忽略
    if (oldState == newState) 
        return;
    if ([newState respondsToSelector:@selector(perfromAction:)]) {
        [self setState:newState];
        //转态根据当时的状况信息开端履行
        [newState perfromAction:self];
    }
}
@end

状况的基类 BaseState

包括的功用和特色：

  1. 界说了状况的基类
  2. 声明了状况的基类需求遵从的 Protocol

Protocol 如下，基类为空完成，子类继承后，完成对 StateInfo 的处理。

@protocol TBBaseStateDelegate <NSObject>
- (void)perfromAction:(TBBaseStateInfo *)stateInfo;
@end

上层（以单码 State 为例）代码示例如下

@interface TBSingleCodeState : TBBaseState
@end
@implementation TBSingleCodeState
//完成 Protocol
- (void)perfromAction:(TBStateInfo *)stateAction {
    //事务逻辑处理 Start
    ...
    //事务逻辑处理 End
}
@end

事务层调用

以下代码生成一系列状况，在适宜时分进行状况的切换。

//状况初始化
- (void)setupState {
    TBSingleCodeState *singleCodeState =TBSingleCodeState.new; //单码状况
    TBNormalState *normalState =TBNormalState.new; //正常状况
    TBMultiCodeState *multiCodeState = [self getMultiCodeState]; //多码状况
    [self.stateInfo setState:normalState forType:TBStateTypeNormal];
    [self.stateInfo setState:singleCodeState forType:TBStateTypeSingleCode];
    [self.stateInfo setState:multiCodeState forType:TBStateTypeMultiCode];
}
//切换惯例状况
- (void)processorA {
    //...
    [self.stateInfo setType:TBStateTypeNormal];
    //...
}
//切换多码状况
- (void)processorB {
    //...
    [self.stateInfo setType:TBStateTypeMultiCode];
    //...
}
//切换单码状况
- (void)processorC {
    //...
    [self.stateInfo setType:TBStateTypeSingleCode];
    //...
}

最好根据状况机图编写状况切换代码，以保证每种状况都有对应的流通。

次态→ 初态↓ 状况A 状况B 状况C
状况A 条件A … …
状况B … … …
状况C … … …

署理形式

淘宝iOS扫一扫架构升级 - 设计模式的应用

在开发进程中，咱们会在越来越多的当地运用到上图才能，比如「淘宝拍照」的相册中、「扫一扫」的相册中，用到解码、码展现、码处理的才能。

因而，咱们需求把这些才能封装并做成插件化，以便在任何当地都能够运用。这儿就引出了咱们改造的第三步：署理形式。

署理形式是一种结构型规划形式，能够供给目标的替代品或其占位符。署理操控着对于原目标的拜访， 并允许在将恳求提交给目标前后进行一些处理。 本文规划的状况形式，包括两部分：

  1. 署理单例 GlobalProxy
  2. 署理的办理 ProxyHandler

两者结构如图所示

淘宝iOS扫一扫架构升级 - 设计模式的应用

署理单例 GlobalProxy

单例的意图主要是减少署理重复初始化，能够在适宜的机遇初始化以及清空保存的内容。单例形式对于 iOSer 再了解不过了，这儿不再赘述。

署理的办理 Handler

保护一个目标，供给了对署理增修改查的才能，完成对署理的操作。这儿完成 Key – Value 的 Key 为 Protocol ，Value 为具体的署理。

代码示例如下


+ (void)registerProxy:(id)proxy withProtocol:(Protocol *)protocol {
    if (![proxy conformsToProtocol:protocol]) {
        NSLog(@"#TBGlobalProxy, error"); 
        return;
    }
    if (proxy) {
        [[TBGlobalProxy sharedInstance].proxyDict setObject:proxy forKey:NSStringFromProtocol(protocol)];
    }
}
+ (id)proxyForProtocol:(Protocol *)protocol {
    if (!protocol) {
        return nil;
    }
    id proxy = [[TBGlobalProxy sharedInstance].proxyDict objectForKey:NSStringFromProtocol(protocol)];
    return proxy;
}
+ (NSDictionary *)proxyConfigs {
    return [TBGlobalProxy sharedInstance].proxyDict;
}
+ (void)removeAll {
    [TBGlobalProxy sharedInstance].proxyDict = [[NSMutableDictionary alloc] init];
}

事务层的调用

所以不管是什么事务方，只要是需求用到对应才能的当地，只需求从单例中读取 Proxy，完成该 Proxy 对应的 Protocol，如一些回调、获取当时上下文等内容，就能够获取该 Proxy 的才能。

//读取 Proxy 的示例
- (id <TBScanProtocol>)scanProxy {
    if (!_scanProxy) {
        _scanProxy = [TBGlobalProxy proxyForProtocol:@protocol(TBScanProtocol)];
    }
    _scanProxy.proxyImpl = self;
    return _scanProxy;
}
//写入 Proxy 的示例（解耦调用）
- (void)registerGlobalProxy {
    //码处理才能
    [TBGlobalProxy registerProxy:[[NSClassFromString(@"TBScanProxy") alloc] init]                                   withProtocol:@protocol(TBScanProtocol)]; 
    //解码才能
    [TBGlobalProxy registerProxy:[[NSClassFromString(@"TBDecodeProxy") alloc] init]                                 withProtocol:@protocol(TBDecodeProtocol)];}

扫一扫新架构

根据上述的改造优化，咱们将原扫一扫架构进行了优化：将逻辑&展现层进行代码分拆，分为属现层、逻辑层、接口层。已到达层次分明、职责清晰、解耦的意图。

淘宝iOS扫一扫架构升级 - 设计模式的应用

总结

上述沉淀的三个规划形式作为扫拍事务的 Foundation 的 Public 才能，应用在镜头页的事务逻辑中。

通过此次重构，提高了扫码才能的复用性，结构和逻辑的清晰带来的是保护成本的下降，不必再大海捞针从代码“巨无霸”中寻觅问题，下降了开发人日。