iOS Code Review 1.0

2018/05/10 19:45
阅读数 52

转载:原地址https://www.jianshu.com/p/9d9b78ab8b60

 

1、Review模块:留言模块

2、代码位置:KSStory -> Moudles -> Story -> Other -> Comment 。

3、代码结构示意图

4、目录说明:

【Cell】UITableView相关UIView。
【Model】留言相关的数据模型。
【Category】按功能对模块进行分解,eg:分享,通知处理,网络请求,tableView代理回调。
【Manager】工具类,用于语音等的处理。
【View】留言模块自定义的View。
【ViewController】留言模块的ViewController

5、代码中出现的问题或不合理的地方

 

头文件的导入优化前

 

1、这里的头文件暂时比较少,如果特别多,堆放在一起,如果想删除或查找某个.h文件,就会变的非常麻烦。
2、还有在.h中尽可能减少头文件的导入,必要时可以使用@class前向声明
3、不只有.h,所有的文件,导入头文件都应该划分模块

建议修改如下:

 

头文件导入优化后

这样做的好处就是查找,增加或者删除某个头文件时,可以快速方便的定位。

typedef void (^CommentNumberBlock)(NSString *str);

在这里声明了一个block,但是项目中没有使用,这代码应该是以前使用过,后期改版,忘记了删除,在做模块改版,或者代码优化时,应该及时的删除。

 

属性声明

1、属性没有按功能分块。
2、在.h中声明的属性,如果在被的地方没有赋值操作,建议在.h中将其读写操作声明为readonly。
3、命名全部统一采用驼峰命名法。
4、如果这个属性只在本模块内使用,建议将其放到extension中。不要暴露在.h,保证其封装性。
5、命名要有意义,没有意义的,需要加注释说明。
6、每个属性,书写请留空行,不要一个接一个。eg:@interface 之后需要留空行,每个property之后也留空行。

@interface KSStoryCommentViewController () {
    BOOL _wasKeyboardManagerEnabled;
}

减少成员变量的声明和使用,能用属性,统一用属性。
这种完全可以用属性代替。

 

书写格式问题

1、 图中箭头所示的地方,都应该留换行。
2、dealloc中的移除kvo的方法应该统一封装到一个方法中,而不应该在堆在一起,eg:viewWillAppear中的方法
3、多余的注释不要添加,像【NOTICFICATIONCENTER_REMOVEOBSERVER】这种宏定义,大家都看得懂。

 

Block的使用

见解在图上。

 

代码需要封装

 

 

代码位置不对

 

网络请求不应该出来在主类中。应该放到对应的模块的request的category中去。

 

UI刷新需要放到主线程

 

代码需要封装

 

 

1、tableview等属于vc.view的子view,所以,方法名参考其他页面,configSubviews。
2、 不同的view的配置需要换行。
3、对table的处理可以单独封装一个方法。

不要添加不必要的注释

 

1、无用的注释请删除。
2、下面两个方法的注释也可以去掉。从方法名就能看懂。

合理的使用pragma -mark

pragma mark - config 这种要放在合适的地方。

 

特殊的代码,需要加注释

这种奇怪的魔法数字,和代码逻辑,需要加注释,为什么这么写。

使用统一的代码处理

 

1、isExistInTable 的查询判断直接封装到clearTable这个方法中。防止忘记判断而造成错误。
2、weak和strong请使用项目中同一的宏定义。

容器类的使用

1、数据源的初始化,直接放在viewdidload中去 一行代码实现,self.dataArr = @[].mutableCopy;并且容器类的属性,建议用字面量语法, 原因自己去查。
2、setter方法,需要和getter分开。

 

没必要创建一个文件

1、 这种工具类,如果不是一个单例,建议命名为XxxTool。
2、有clear,应该有对应的save。
3、或者这种建议直接写到对应的category中去。

使用字符串常量

 

1、iden3 是什么情况。而且这种Cell的Identifier 应该用常量字符串,声明在最前面。在多处使用时,可以复用,防止手动拼写的错误。

UI和请求分开

UI空间在这里创建完,buttonIndex的点击事件,请分离出去,封装一个方法。不要将网络请求直接,丢里面。

 

 

config的代码拆分到单独的Category

关于config view,单独放到,vc+config这样的category中。

字符串判空,统一处理

字符串判空,用对应的全局的宏

 

 

字典最好做判断

字典的添加数据时,最好做个判空处理。

不要放在table的代理中

对留言的cell的删除,点赞等操作,拆分到category中,不要都放在table的delegate的category中。

 

toast的合理使用

关于toast,不要把不想关的toast展示给用户,使用jy_show_toast_error(error.code);即可。

不要使用blockkit

 

不要使用blockkit三方框架。

url使用统一的工具处理

这种对URL的处理,使用统一的工具类进行处理。

网络请求放到网络模块

share模块不应该出现网络请求,应该拆分到对的request模块。

 

网络请求参数多的处理

参数处理,如果参数较多,可以放到一个方法处理。可以放在网络请求方法的后面。

 

block使用前,需要做判断

1、 block 的回调请做判断。
2、可变数组,添加完数据后,最好copy后再传给block。
3、网络请求error回调,如果不需要做特殊的处理,不用回调,直接在网络请求中做error的toast即可。

 

通用的功能,放到公共的拓展

这种类的拓展,如果公共的拓展没有,需要放到公共的地方。不要放在这里。

自定义view初始化

 

 

1、添加subviews封装一个方法。
2、layoutsubviews,也封装一个方法。

方法名有歧义

1、方法名有点歧义。

类型强制转换的需要做判断

 

 

这种类型强制转换的,做个判断,防止在调用后面的方法,造成crash

代码复用

重复的事干一次。

6、一些建议

1、请合理的利用extension和category,做到对代码的完美拆分。
2、减少对单例的使用。
3、有遗漏的地方欢迎补充。

 

 

 

展开阅读全文
打赏
0
1 收藏
分享
加载中
更多评论
打赏
0 评论
1 收藏
0
分享
在线直播报名
返回顶部
顶部