[关闭]
@xifenglang-33250 2018-12-03T09:36:49.000000Z 字数 6458 阅读 865

代码Review-2018.12.1

森特网

1、--------------方法命名习惯------------------------------

例子：

  1. -(void)viewWillAppear:(BOOL)animated {
  2.     [super viewWillAppear:animated];
  3.     self.api.queryName = @"";
  4.     [self loadData];
  5. }
  7. - (void) didSelectedRecentWithRow:(NSInteger)row {
  8.     self.api.docType = row * 10;
  9.     [self.tableView.mj_header beginRefreshing];
  10. }

方法命名中使用空格的标准写法

  1. "-"后面接一个空格
  2. "(void)"后不接空格
  1. - (void)viewDidLoad {
  2.     [super viewDidLoad];
  3.     [self setupUI];
  4.     [self.tableView.mj_header beginRefreshing];
  5. }

2、--------------属性命名习惯----------------------------

例子：

  1. @property (nonatomic, strong) NSArray <HTRegionModel *> *streets;
  3. @property (nonatomic, assign) NSInteger index0;
  4. @property (nonatomic, assign) NSInteger index1;
  5. @property (nonatomic, assign) NSInteger index2;
  6. @property (nonatomic, assign) NSInteger index3;
  8. - (void)setStreets:(NSArray<HTRegionModel *> *)streets
  9. {
  10.     _streets = streets;
  11.     if (_streets.count > 0) {
  12.         [self addBtnAndTableView];
  13.         [self moveLine];
  14.         self.lastBtn.selected = NO;
  15.         UITableView *tableView = (UITableView *)self.areaScrollView.subviews[self.lastBtn.tag];
  16.         [tableView reloadData];
  17.     }else {
  18.         [self moveLine];
  19.         self.lastBtn.selected = NO;
  20.         dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(0.5 * NSEC_PER_SEC)), dispatch_get_main_queue(), ^{
  21.             [self hidenAreaView];
  22.             if (self.delegate) {
  23.                 [self.delegate selectedIndexProvice:_index0 city:_index1 district:_index2 street:-1];
  24.             }
  25.         });
  26.     }
  27. }

1、方法名尾部不应在“ {”前面换行，而是“ {”后换行，并且"{"前有个空格
2、声明NSArray、NSDictionary、NSString等不可变容器类型属性，应用copy修饰
3、重写NSArray、NSDictionary、NSString等不可变容器类型属性，setter里面应该赋值copy后的值，ARC声明block属性建议用copy，尽可能跟MRC写法逻辑保持一致。
4、在Block实现中调用成员变量_index0、_index1、_index2编译时会有警告，应改成self.proviceIndex
5、声明成员变量避免使用123等数字，可读性差，命名应追求顾名思义，适当的添加注释。index0应改成proviceIndex

修改后

  1. @property (nonatomic, copy) NSArray <HTRegionModel *> *streets;
  2. @property (nonatomic, assign) NSUInteger proviceIndex;
  5. - (void)setStreets:(NSArray<HTRegionModel *> *)streets {
  7.     _streets = streets.copy;
  9.     if (streets.count > 0) {
  10.         [self addBtnAndTableView];
  11.         [self moveLine];
  12.         self.lastBtn.selected = NO;
  13.         UITableView *tableView = (UITableView *)self.areaScrollView.subviews[self.lastBtn.tag];
  14.         [tableView reloadData];
  15.     } else {
  16.         [self moveLine];
  17.         self.lastBtn.selected = NO;
  18.         dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(0.5 * NSEC_PER_SEC)), dispatch_get_main_queue(), ^{
  20.             [self hidesAreaView];
  22.             if (self.delegate) {
  23.                 [self.delegate selectedIndexProvice:self.proviceIndex city:self.cityIndex district:self.districtIndex street:-1];
  24.             }
  25.         });
  26.     }
  27. }

其中涉及到的协议方法还可以再改

  1. @protocol HTSelectedAddrViewDelegate
  3. /// 选择后的下标
  4. - (void) selectedIndexProvice:(NSInteger)index0 city:(NSInteger)index1 district:(NSInteger)index2 street:(NSInteger)index3;
  5. @end

业务处理层需要的是直接可用的结果（HTRegionModel），而不是拿到下标去查数据。
应改成

  1. @protocol HTSelectedAddrViewDelegate
  3. - (void)didSelectedProvice:(HTRegionModel *)provice city:(HTRegionModel *)city district:(HTRegionModel *)district street:(HTRegionModel *)street;
  6. /// 或者
  7. - (void)addressSelectorView:(HTSelectedAddrView *)selectorView didSelectedProvice:(HTRegionModel *)provice city:(HTRegionModel *)city district:(HTRegionModel *)district street:(HTRegionModel *)street;
  8. @end

3、--------------避免使用透明背景色------------------------------------

渲染透明色和layer.cornerRadius倒圆角会明显降低FPS，初始化View应当设置背景色，XIB亦然,列表中出现圆角view尽量用贝塞尔曲线绘制图片。

  1. [[UILabel alloc] init]
  2. [[UIImageView alloc] init];
  3. ...

4、--------------利用函数实现跨类跨模块复用代码-----------------------------

修改前：

  1.         NSInteger docType = [stockOutModel.docType integerValue];
  2.         if (docType == 0) {
  3.             self.stateLabel.text= @"待处理";
  4.         }else if (docType == 10) {
  5.             self.stateLabel.text= @"待拣货";
  6.         }else if (docType == 20) {
  7.             self.stateLabel.text= @"复核完成";
  8.         }else if (docType == 30) {
  9.             self.stateLabel.text= @"已发运";
  10.         }else if (docType == 40) {
  11.             self.stateLabel.text= @"已取消";
  12.         }else if (docType == 50) {
  13.             self.stateLabel.text= @"已关闭";
  14.         }else {
  15.             self.stateLabel.text= @"未知";
  16.         }

修改后:
优势：
1、方便改文案，不用多个地方改，容易出BUG
2、复用代码，减少垃圾代码
3、提炼更专一的函数，职能细分，方便重构

  1. *.h
  2. /**    根据状态码获取出库状态描述    */
  3. UIKIT_EXTERN NSString * ERPStockOutStatusNameWith(NSUInteger status);
  5. *.m
  7. NSString * ERPStockOutStatusNameWith(NSUInteger status) {
  8.     switch (status) {
  9.         case 0:return @"待处理";
  10.         case 10:return @"待拣货";
  11.         case 20:return @"复核完成";
  12.         case 30:return @"已发运";
  13.         case 40:return @"已取消";
  14.         case 50:return @"已关闭";
  15.         default:return [NSString stringWithFormat:@"未知状态%ld",status];
  16.     }
  17. }
  19. 其它.m
  20.         NSInteger docType = [stockOutModel.docType integerValue];
  21.         self.stateLabel.text = ERPStockOutStatusNameWith(docType);

5、--------------ERPStockReportItemView.h修改案例-------------------

修改前：

  1. @protocol ERPStockReportItemViewDelegate <NSObject>
  3. - (void) didItemWithRow:(NSInteger)row;
  5. @end
  7. @interface ERPStockReportItemView : UIView
  9. - (instancetype)initWithTitles:(NSArray *)titles;
  11. @property (nonatomic, weak) id <ERPStockReportItemViewDelegate> delegate;
  13. @end

修改后

  1. @protocol ERPStockReportItemViewDelegate <NSObject>
  3. /// 通过方法名不能看懂方法的作用时，就应该修改命名或者补加注释
  4. /// 以stockReportItemView开头，主要是为了表明协议方法的调用者，在实现方法的类可以明显的区分。仿UITableViewDelegate
  5. - (void)stockReportItemView:(ERPStockReportItemView *)itemView didSelectedItemAtRow:(NSInteger)row;
  7. @end
  9. @interface ERPStockReportItemView : UIView
  11. // NS_UNAVAILABLE会禁用外部调用实例化，NS_DESIGNATED_INITIALIZER 即指定的实例化方法
  12. - (instancetype)init NS_UNAVAILABLE;
  13. - (instancetype)initWithFrame:(CGRect)frame NS_UNAVAILABLE;
  14. - (instancetype)initWithTitles:(NSArray *)titles NS_DESIGNATED_INITIALIZER;
  16. @property (nonatomic, weak) id <ERPStockReportItemViewDelegate> delegate;
  18. @end

5、--------------注册监听和移除监听-------------------

案例

  1. ERPStockTransferViewController.m
  3. - (void)viewDidAppear:(BOOL)animated {
  4.     [super viewDidAppear:animated];
  5.     [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(freshNotification) name:stockAllotNotifacation object:nil];
  6. }

缺点：在viewDidAppear中多次注册监听，.m文件里面没有移除监听的代码

使用KVO时一定要移除监听，Notification大多数情况不移除监听不会闪退，但不代表绝对安全，而应本着谁添加谁移除的原则写相关代码，这块的关注点是代码习惯和代码质量。
修改方向：
1. 在viewDidLoad中注册一次监听，在控制器生命周期将结束时移除监听，比如以下2个方法

  1. - (void)stw_viewControllerWillDismissFromStack {}
  3. - (void)dealloc {}

  1. 如果在viewWillAppear、viewDidAppear添加监听，就应该在viewWillDisappear、viewDidDisappear移除监听，监听和结束监听的时机应该是对应的。

  2. 将KVO或者Notification做成自动化移除

6、--------------轻量化ViewController-------------------

参考：
1. objc china的一篇译文《Lighter View Controllers》
2. iOS 开发中的 Self-Manager 模式

尽量将控制器的代码控制在500行以内，甚至300行以内，避免重复写无营养的代码。有个同行说过一句话:把垃圾代码放在一起

n、--------------其它-------------------

n.1

  1. @property (nonatomic, strong) NSArray*storeExportDetailAppResDtos;

修改后：
1、NSArray*类型，strong换成copy；
2、storeExportDetailAppResDtos命名过长，去掉无意义的字段，改成storeExportDetail，这个地方甚至涉及到字段的前后端分离。
3、声明Array的元素类型

  1. @property (nonatomic, copy) NSArray <ERPStockOutGoodModel *> *storeExportDetail;

n.2

添加新批注
在作者公开此批注前，只有你和作者可见。
回复批注