一个简单的代码风格优化的小案例

简介: 最近 review 了一些代码,其中有一个函数的写法看着别扭,而且对应同学不太清楚还可以怎么优化。由于案例比较典型,值得分享一下。本文给出对应的伪代码和自己的修改建议,并推荐可以提交代码质量的图书,以便能够帮助大家养成良好的编码风格。

一、背景

最近 review 了一些代码,其中有一个函数的写法看着别扭,而且对应同学不太清楚还可以怎么优化。由于案例比较典型,值得分享一下。


本文给出对应的伪代码和自己的修改建议,并推荐可以提交代码质量的图书,以便能够帮助大家养成良好的编码风格。


二、伪代码


publicvoiddoSomething(){
// 构造参数(后无空格)// 调用二方服务(后无空格)if(result.success&&result.getXXXMap() !=null&&result.getXXXMap().get("aaa") !=null){
// 执行一大段逻辑}
}


存在的问题


- 代码行数有点多

- 构造参数、调用二方服务、结构判断并执行大段逻辑之前没有任何空行,导致看着不够清晰

- if 判断部分搞得有些复杂,需要多看几眼才能看懂



三、修改

修改意见

- 每个步骤中间加个空格,提升段落感

- 将成功后的处理提取成一个独立的函数,降低函数长度

- 将判断所需的map 提取成局部变量,让判断更加简洁

- 将防御性判断写在代码执行之前,逻辑更清晰


/

publicvoiddoSomething(xxx){
// 构造参数(后空格一行)// 调用二方服务(后空格一行)if(result.success ){
other();
    }
}
// other 只是一个demo, 实操时命名符合意图privatevoidother(yyy){
Map<K,V>map=result.getXXXMap() ;
if( null==map&&null==map.get("aaa")){
return;
}
// 执行业务逻辑}


当然,如果有必要 前面的 result.success 也可以反向判断直接  return 。

这里的 “aaa” 只是一个举例,实际并不是简单的字符串,所以暂时不处理。

如果是普通字符串的话,建议定义为常量。


这样修改完毕可读性就提高了很多,代码非常清晰。


四、总结

这个案例非常简单,希望能够帮助大家养成良好的代码风格,提高代码可读性,让读者看起来更清爽。


另外《代码精进之路 从码农到工匠》中有提到【写代码是两次创作】

优雅的代码很少是一次形成的,大部分情况下要经过两次创造:第一遍实现功能,第二遍重构优化。


因此,实现功能以后,在代码审查阶段,如果有时间建议尽量对代码进行优化。



另外推荐阅读《阿里巴巴Java 开发手册》、《重构 -改善既有代码的逻辑》、《代码整洁之道》,代码质量应该可以上升到一个新的台阶。



相关文章
|
安全 程序员 C++
代码规范:函数设计
除非告诉人们“危险”是什么,否则这个警告牌难以起到积极有效的作用。难以理解的断言常常被程序员忽略,甚至被删除。 ↩︎
108 0
|
3月前
|
设计模式 安全 测试技术
Swift代码审查的关键点及最佳实践,涵盖代码风格一致性、变量使用合理性、函数设计、错误处理、性能优化、安全性、代码注释等方面,旨在提升代码质量和项目管理水平
本文深入探讨了Swift代码审查的关键点及最佳实践,涵盖代码风格一致性、变量使用合理性、函数设计、错误处理、性能优化、安全性、代码注释等方面,旨在提升代码质量和项目管理水平。通过实际案例分析,展示了如何有效应用这些原则,确保代码的高可读性、可维护性和可靠性。
51 2
|
7月前
|
测试技术
代码可读性问题之使用代码生成工具帮助我们提升代码可读性,如何解决
代码可读性问题之使用代码生成工具帮助我们提升代码可读性,如何解决
|
8月前
|
测试技术 持续交付 API
Airtest脚本的重构与优化:提升测试效率和可读性
通过对Airtest脚本的重构与优化,我们不仅能提升测试效率,还能增强脚本的可读性和可维护性。这些改进将有助于应对不断变化的测试需求,为保证软件质量提供坚实的支持。记住,优化是一个持续的过程,定期回顾和调整测试脚本是保持测试项目健康的关键。希望以上分享能帮助大家在自动化测试的道路上更进一步。
|
9月前
|
算法 程序员 PHP
编写魅力十足的代码:优化可读性、维护性和性能的关键
本篇汇总了平时在工作开发中常遇到的业务逻辑的优雅写法,也汇总了自己还是新人时,拿到一个业务不知道怎么下手的痛点,依稀记得那时候总感觉自己写的代码不规范。 写完之后,感觉还是美好的,又学到东西了。
|
9月前
|
存储 算法 C语言
【编程陷阱】编写出色C++代码:遵循的注意事项和最佳实践
【编程陷阱】编写出色C++代码:遵循的注意事项和最佳实践
77 0
|
存储
十种高级的代码书写方式,提高代码质量和工作效率
十种高级的代码书写方式,提高代码质量和工作效率
103 0
|
IDE 编译器 程序员
C++ 最佳实践 | 2. 代码风格
C++ 最佳实践 | 2. 代码风格
223 0
|
数据库
高质量代码优化!谈谈重构项目中if-else代码的几点建议
本篇文章探讨了代码的重构以及优化,主要针对代码中大量的条件判断if-else语句问题提出了具体的优化建议。介绍了优化if-else语句的几种有效的方法,包括switch,接口interface以及数据库实现对条件语句进行的优化。
201 0
高质量代码优化!谈谈重构项目中if-else代码的几点建议
|
安全 前端开发 Java
如何写出健壮的代码?
关于代码的健壮性,其重要性不言而喻。那么如何才能写出健壮的代码?阿里文娱技术专家长统将从防御式编程、如何正确使用异常和 DRY 原则等三个方面,并结合代码实例,分享自己的看法心得,希望对同学们有所启发。
2907 0
如何写出健壮的代码?