浅谈代码优化

文章结构

1. 实例
2. 引经据典
3. 总结

实例

首先引入一个代码优化的实例,请参读以下代码:

- (void)sdkAuthSetServerUrlBase:(NSString *)url isAuthTest:(NSNumber *)test {
  if (test.boolValue) {
    _isSDKAuthTest = test.boolValue;
    if (url && url.length > 0) {
      SdkAuth_setServerUrlBase([url cStringUsingEncoding:NSUTF8StringEncoding]);
    }
  } else {
    if (!_isSDKAuthTest) {
      if (url && url.length > 0) {
        SdkAuth_setServerUrlBase([url cStringUsingEncoding:NSUTF8StringEncoding]);
      }
    }
    _isSDKAuthTest = test.boolValue;
  }
}

代码格式整齐,变量和函数名命名规范,可以从第一眼看下去,能难理清楚其中的逻辑。该函数是一个供内部测试使用的接口,有两个标准位进行控制。

首先可以把函数的大致逻辑理清楚一下,其主要功能应该是设置sdkAuth的url,于是先把设置url的功能单独拿出来一下,这是在url存在而且有效的时候进行设置,于是函数可以调整为如下:

- (void)sdkAuthSetServerUrlBase:(NSString *)url isAuthTest:(NSNumber *)test {
  if (test.boolValue) {
    [self setServerUrlBase:url];
  } else {
    if (!_isSDKAuthTest) {
      [self setServerUrlBase:url];
    }
  }
  _isSDKAuthTest = test.boolValue;
}

- (void)setServerUrlBase:(NSString *)url {
  if (url && url.length > 0) {
    SdkAuth_setServerUrlBase([url cStringUsingEncoding:NSUTF8StringEncoding]);
  }
}

再审视我们的代码,视乎关系变得清楚了一些,但其控制逻辑可以再优化一下,我从满足什么条件的情况下设置url这个角度进行分析。

test.boolValue _isSDKAuthTest setServerUrlBase
1 0 true
1 1 true
0 0 true
0 1 false

从组合情况来看,只有当 test.boolValue 为 false ,_isSDKAuthTest 为 true 的情况下,会不调用 setServerUrlBase 接口,即:

if(!test.boolValue && _isSDKAuthTest)

的情况下,不设置。
最终调整版本为:

- (void)sdkAuthSetServerUrlBase:(NSString *)url isAuthTest:(NSNumber *)test {
  BOOL obsoleteStatus = (!test.boolValue && _isSDKAuthTest);
  if (!obsoleteStatus) {
    [self setServerUrlBase:url];
  }
  _isSDKAuthTest = test.boolValue;
}

- (void)setServerUrlBase:(NSString *)url {
  if (url && url.length > 0) {
    SdkAuth_setServerUrlBase([url cStringUsingEncoding:NSUTF8StringEncoding]);
  }
}

引经据典

以下编程建议,为总结一本经典书籍上的知识点,文章末尾揭示这本书名

  1. 要编写整洁的代码,必须先写肮脏代码,然后再清理它。不会一开始写出来的代码就会整洁规范,逻辑清晰的,需要经过不断的修改,优化。先让代码能工作,然后再重构。

  2. 今天写的代码,可能在下一版本中被修改,但可读性对以后将要发生的修改有着深远的影响,格式对代码质量很重要;

    垂直格式:

     1. 学习报纸的排版,相关性较大的代码放一起
     2. 若某个函数调用了另外一个,就应该把它们放在一起,而且调用者应该尽可能放在被调用者上面
    

    水平格式:

     1. 尽力保持代码行简短
     2. 使用空格字符将彼此紧密相关的事物连接到一起,也用空格把相关性较弱的事物隔开
     3. 代码对齐不是硬性要求,但要保证每行代码的长度
    
  3. 函数只专注于一件事情,保持代码量少,参数尽量少,没有返回值更好,有返回值的话不要反回空。

  4. 函数命名要富有表达性,使被人使用的时候更好理解其作用,多使用专业相关的词汇。

  5. 注释方面,要注意不要写得太啰嗦,同时要把自己的意思表达清楚,在需要添加的地方添加

  6. 多线程的调用的接口,应该尽量使代码量少,在使用多线程相关的API时要注意:

     1. 使用类库提供的线程安全的群集
     2. 尽可能使用非锁定解决方案
     3. 要注意有哪些类是非线程安全的
    

总结

一方面,需要养成一个在编程中不断学习的习惯,多总结一些好的编程习惯,在平时review代码的时候去实践,发现有不合理的地方,立马修改。有时候可能是一个函数命名或者参数的命名不好,或者在哪里多了一行空格,注释太老了没有更新。

另一方面,多去看看其他人写的代码,学习他人的有点,有不合理的地方提出自己的观点,相互学习共同进步。

程序员代码质量的提高,是一个循序渐进的过程,并不是参考一本书上的编程样式就能马上适应。要在平时的编程中多去实践,提升自己的水平。

参考书籍:《Clean Code》

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,496评论 6 501
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,407评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,632评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,180评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,198评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,165评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,052评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,910评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,324评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,542评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,711评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,424评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,017评论 3 326
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,668评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,823评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,722评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,611评论 2 353

推荐阅读更多精彩内容