一次模块重构的总结

前言

由于当时项目进度赶得紧,功能相对简单,代码写的随意,到后来的多次小改大改,改到最后以至于不得不重构的地步,
业务逻辑已经相当的复杂,维护起来很是吃力。于是就产生了重构的想法,重构时才发现很多不合理的设计。

写出一个庞然大View,再加上复杂的逻辑代码,这一块的代码很可能就演变成了谁都不敢动的禁区。
另外说一下: 一个ViewController类的有效代码超过500行,这个ViewController就会变得难以维护。

场景说明和重构设计

效果图中的功能为一个上报的模块,该模块需要填写的内容非常的多,上传的字段大约有80-90个,分为多个模块区,
每个模块中都可能使用到上述的这五个类型的控件,
自定义控件化后整个上报模块的页面布局和值的赋值和读取都变得非常清晰简单。
而且本文中的时间的选择、照片的选择、多选框的选择在工程中都是在 BaseViewController中统一处理的,这也是为了复用而做的处理。
#import <UIKit/UIKit.h>
@interface BaseItem : UIView

@property(copy,nonatomic)NSString *itemTitle;//标题
@property(copy,nonatomic)NSString *itemText;
@property(copy,nonatomic)NSString *itemNo;
@property(assign,nonatomic)BOOL isMust;//是否是必填子段

- (void)setLeftStarImage;
- (void)setRightUnit :(NSString *)unitName;
@end
  • BaseItem 是基础父类,定义公共的方法入口
  • BaseItemForText 是文本输入控件,可设置文本框右侧的单位
  • BaseItemForPopView 是下拉弹框控件
  • BaseItemForSelectTime 是点击底部弹出日期选择,选择后展示日期的控件
  • BaseItemForSelectImage 是点击拍照或者选择相册中相片的控件
  • BaseItemForMoreSelect 多选弹框控件
[self.leftLabel setSingleLineAutoResizeWithMaxWidth:Scale_X(150)];//自动根据内容设定宽度。

不同子类通过重写 BaseItem 的公共属性的 set、get 方法来达到初始化组件或者获取所需提交数据等
这一步中把转化的逻辑都写在了自定义控件内部,对外只暴露公共入口,使外部的调用非常的简单。

简化必填子段验证

- (BOOL)backEmptyKeyWarn;
{
    for (int i = 0; i<25; i++) {
        if (baseItem[i].superview) {
            if (baseItem[i].isMust && NilStr(baseItem[i].itemText) ) {
                return NO;
            }
        }
    }
    return YES;
 }

原来的逻辑设置:

1.没有控件话,页面都是基本UILabel、UIButton 等贴的,而且控件之间由于一开始很简单,没有完全相对布局,里面有很多绝对坐标。
2.绝对布局对于需要根据选择的内容不同动态隐藏或者展示某块区域,某个大的模块来说是非常的不友好,大量的硬编码(y值的硬计算)使得修改和维护起来很是吃力。
3.在VC【众多自定义视图是 VC 的View的子视图】中定义所有自定义视图的下拉弹框的数据源和处理所有自定义视图的交互事件,使得代码耦合度更大,不符合开闭原则,很容易造成一处修改,误使其他模块出错的现象。
4.上报时需要一个个判断是否为空来验证必填参数是否已经填写。
5.参数的收集和初始化赋值的时候都是一个一个对应着设置,不同视图需要不同操作,很是麻烦和易错。

重构后

1.绝对布局全部换成相对布局,这样在后续新需求时添加、删除页面元素更方便修改。
2.每个小控件和大的自定义视图都自动设置自身高度,省去手动计算定值高度的麻烦。
3.隐藏/展示某个控件或者自定义视图时可以直接设置其高度,在需要改变的地方调用统一的刷新方法刷新整体布局。
4.每个自定义视图处理自己的下拉弹框的数据源初始化和交互事件,使得职责更加的内聚合。
5.通过 for 循环即可验证必填参数的自定义控件是否为空,节省了一大坨代码并使验证的逻辑更加简明易懂。
6.由于父类的存在,设置统一赋值、取值的公共方法入口,使得对自定义控件的赋值、取值都是一致和简单的。

心得总结

重构中你只能通过设计把逻辑变得更易懂和更易维护及扩展,但是无法减少已有的逻辑,该有的逻辑还是无法省去的。

【1】注释

  #pragma mark------ XXXX---------


清晰的注释对代码的逻辑梳理有非常大的帮助。而且个人固定的代码风格也有助于代码逻辑的理解,没有固定风格的代码随心所欲的写法是很让人头疼的。

【2】类的命名和方法的命名都可以通过名称达到归类和易于理解的效果。

【3】代码复用:

1.公共组件,工程中多处调用。
2.继承,在父类中统一处理。
3.抽象成类中的公用方法,多处调用。

【4】纯代码写页面中,所有的代码布局都应该是 相对布局,可以使用 SDAutolayout 实现完全自动布局,里面有 SC 和 Cell的自动布局,都是设置底部依据试图,设置边距即可。
使用SDAutolayout 可以彻底解决所有情景下的高度自适应问题,而不单单是 cell的高度自适应问题。

PS:重构中一定要注意低级错误。自己在这上面浪费了很多时间和精力。

第一个控件的 get 方法重写时写错了,其他的都是拷贝第一个的,结果一直没有调用子类“重写的get方法” 其实没有重写父类的,因为方法写的都不对。

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 155,871评论 24 680
  • 以前在历史课本上看到的李斯都是正面的形象,但今天看到了李斯的一些故事,改变了我对他的印象,让我看到了,他...
    张怡YouZi阅读 251评论 3 1
  • 写在前面:看过了那么多童话,也是不能浪费,但是你也别嫌弃我的图。 在广袤的蓝天下, 生活着一只兔子, 一只只要有胡...
    默默roserest阅读 650评论 0 1
  • 2018年5月9日 星期三 晴 雷震早上难得在楼下等着,程昱看他一副踌躇满志的样子,不由对着他多看几眼...
    米垛阅读 1,604评论 45 55
  • 皮皮说:失去一个朋友容易,要新交一个朋友很难。 我知道跑出去要和你说去哪儿,我当时很生气所以跑了出去,但是我只跑到...
    c8f44ba60206阅读 48评论 0 0