GKState在iOS项目中的应用

之前在做公司的项目开发中，有一个模块具有比较多的视频编辑功能，大致画了下面一张图：

如上图，在编辑页面支持剪辑，效果，滤镜功能，每个功能又有若干个子功能。按照常规的做法的话，会创建相对应的剪辑，效果，滤镜view，在创建相对应的子功能view，这样的话，会创建很多视图，性能会受到影响；或者只使用一个view，加入逻辑判断该如何展示具体的视图，但这个逻辑判断就会变得很复杂。

基于以上困扰，在某个版本项目做了次大重构，采用了GKState来管理以上复杂的剪辑功能。效果是理想的。

GKState与GKStateMachine

GKState类是一个被定义了的state类，可以在GKStateMachine中使用。每一个分离的不同的状态GKState子类组成状态机GKStateMachine。GKState类提供了一个可以放置状态依赖类型的逻辑，比如进入或脱离某个状态时的行为，又或者每一帧进行一个有效的状态逻辑。

GKState的相关方法

+ (instancetype)state;
- (instancetype)init;
- (BOOL)isValidNextState:(Class)stateClass;//返回一个布尔值，该值指示当前处于该状态的状态机是否允许转换到指定状态
- (void)didEnterWithPreviousState:(nullable GKState *)previousState;//当从其他状态转换到该状态时触发的方法
- (void)updateWithDeltaTime:(NSTimeInterval)seconds;//状态机更新时触发的方法。
- (void)willExitWithNextState:(GKState *)nextState;//即将从当前状态过渡到其他状态时触发的方法

GKStateMachine的相关方法

+ (instancetype)stateMachineWithStates:(NSArray *)states;
- (instancetype)initWithStates:(NSArray *)states;
- (void)updateWithDeltaTime:(NSTimeInterval)sec;//更新状态机
- (nullable GKState*)stateForClass:(Class)stateClass;//通过stateClass获取GKState
- (BOOL)canEnterState:(Class)stateClass;//判断是否可以进入stateClass
- (BOOL)enterState:(Class)stateClass;//进入stateClass

GKStateMachine管理的是GKState，也就是状态机管理状态。

在接入了GKState之后，上面的示意图就变成了下面这样：

1.编辑的下面有剪辑，效果，滤镜三个子状态，剪辑，效果，滤镜又分别有自己的子状态。
2.编辑(mainState)会有一个实例对象GKStateMachine，管理剪辑，效果，滤镜三个子状态，通过这个实例对象GKStateMachine，可以enterState:进入子状态。
3..剪辑，效果，滤镜属于同一层级的状态，他们互为兄弟状态，被同一个GKStateMachine实例对象管理。如果剪辑状态能访问到这个实例对象GKStateMachine，就可以通过实例对象GKStateMachine实现跳转到效果，滤镜的状态，实现了同层级的状态间的跳转。
4.在状态的进入与退出时，会调用到didEnterWithPreviousState：和willExitWithNextState：,那么相对应状态下的视图创建布局销毁，展示逻辑等就可以在这里开始编写。GKState提供了一套state生命周期的回调方法。

基于以上逻辑，可以在进入状态时，创建对应的UI展示和逻辑，离开状态时，销毁对应的UI。

代码实践：

首先创建继承自GKState的基类XYBaseState。

@interface XYBaseState : GKState
//主vc  
@property (nonatomic, weak) UIViewController *rootVC;
//父视图
@property (nonatomic, weak) UIView *fatherView;

//父状态
@property (nonatomic, weak) GKState *fatherState;
//当前状态下的视图布局都是基于contentView，加在fatherView上
@property (nonatomic, strong) UIView *contentView;

//管理子状态的状态机
@property (nullable, nonatomic, strong) XYBaseStateMachine *childStateMachine;
//管理兄弟状态的状态机
@property (nullable, nonatomic, weak) XYBaseStateMachine *brotherStateMachine;
//全局共享的数据板
@property (nonatomic, strong) id commonDataBoard;

@end

@implementation XYBaseState
- (instancetype)init
{
    if (self = [super init]) {
    }
    return self;
}

- (UIView *)contentView
{
    if (!_contentView) {
        _contentView = [[UIView alloc]init];
    }
    return _contentView;
}

- (void)didEnterWithPreviousState:(XYBaseState *)preState
{
    [self freeChildStates:preState];
    
    [super didEnterWithPreviousState:preState];
    [self.fatherView addSubview:self.contentView];
    [self loadChildStates];
   
}

/*
 前一个状态节点的子状态以及contentView实时释放，从而可以及时
 释放部分内存，尽可能做到内存轻量化
*/
- (void)freeChildStates:(XYBaseState *)preState
{
    [preState.childStateMachine.currentState willExitWithNextState:[XYBaseState new]];
    preState.childStateMachine = nil;
}

- (void)willExitWithNextState:(XYBaseState *)nextState
{
    [super willExitWithNextState:nextState];

     [_contentView removeFromSuperview];
    _contentView = nil;
}

//子类继承实现
- (NSArray *)childViewStates
{
    return @[];
}

- (void)loadChildStates
{
    NSMutableArray *viewStates =  [NSMutableArray array];
    for (NSString *obj in [self childViewStates]) {
        Class class = NSClassFromString(obj);
        if (!class) continue;
        __kindof XYBaseState *state = [[class alloc]init];
        state.rootVC = self.rootVC;
        state.fatherView = self.contentView;
        state.commonDataBoard = self.commonDataBoard;
        [viewStates addObject:state];
    }
    self.childStateMachine = [[XYBaseStateMachine alloc] initWithStates:viewStates];
    //对于每种状态，它的子状态之间，互为兄弟状态
    for (XYBaseViewState *state in viewStates) {
        state.brotherStateMachine = self.childStateMachine;
    }
}

@end

以上图的效果状态为例，创建效果state

@implementation EffectState

- (NSArray *)childStates
{
    self.subStateArray =  @[@"subStickerState",@"subTextState"];
    return  self.subStateArray;
}

- (void)didEnterWithPreviousState:(nullable GKState *)previousState
{
    [super didEnterWithPreviousState:previousState];
    
    [self configData];
    [self configSubviews];
}

- (void) configData {
    NSLog(@"initData");
}

- (void) configSubviews
{
    NSLog(@"configSubviews");
}


- (void)willExitWithNextState:(GKState *)nextState
{
    [super willExitWithNextState:nextState];

    //在这里释放资源,降低内存消耗
    [self removeView];
    
    [self removeData];
}

- (void)collectionView:(UICollectionView *)collectionView didSelectItemAtIndexPath:(NSIndexPath *)indexPath {
     //进入子状态
    [self.childStateMachine enterState:self.subStateArray[indexPath.row]];
}


- (void)removeData {
   
}

- (void) removeView {
    
}

基于此，就可以把效果状态的UI和逻辑进行单独处理，当有很多个state需要管理的时候，在代码维护和功能扩展上就方便了很多。