如何优化coding

如何优化coding

前言

最近一直在做修改bug工作,修改bug花费时间最多的不是如何解决问题而是怎样快速读懂代码。如果代码写的好的,不用debug就可以一眼看出来哪里出了问题。实际上,我都要debug好多遍才能差不多理解这个业务逻辑,进而分析原因以及修改修复的代价。这项工作花费了我绝大部分的时间,而且并没有什么意义,因为fix bug之后就再也不会处理这些代码了。

因此,易读性应该放在代码的首要位置,如果长期维护的话。

1.好的命名规范和良好的注释

什么样的命名才是好的?可以表明这个方法的功能,而且名字长度不要太长。如果名字无法完整的表述含义,则应该添加注释。我debug的代码从来没看到过注释。

2.讨厌的if

if用的真不要太多,debug的时候发现一个if又一个if,if里面嵌套if。也许这是为了逻辑的完整性,但是千万要在每个if分支里都给出一个结束的定义,即这个if结束了,主要做了什么。经常debug if之后还没有理解这个分支是干嘛的,然后去看下一个分支。

不应该鄙视if,因为这是业务发展过程中代码的补充。突然换了需求,又不能丢掉原来的代码,只能if。随着时间推移,问题也就出来了。应该想着去换个设计模式去重构这段代码,而不是赶时间加一个if,这个在后期维护中是代价极大。

3.太多的try catch

exception的处理基本都是try catch, 然后基于当时的想法决定是否抛出去。当我重新debug的时候,我不知道这个位置抛出去了对上一级是否有影响,不抛出去又会怎么样。

4.肆无忌惮的重构

遇到大块的代码就提取出来,这是最简单的重构。然而,当你debug从一个方法进入另一个方法再进入另一个方法,回头又跳回来,绝对懵逼。

重构的时候一定要在该方法领域内完整的阐述功能,而不要为了重构而重构,结果语义不完整,代码很分散。

5.处理json数据

项目大了之后,服务分拆成各种微服务。于是,各种调用webservice. webservice返回xml或者json。返回xml的烧了,暂且不提。返回json的,我们明明有jackson/gson等各种json序列化工具,只要建立好model,直接映射过来就好。甚至还有JsonInclude,JsonPropertyIgnore等条件配置。而偏偏很多接口使用一个JsonObject来接收response。然后来一个map方法,调用JsonObject的各个属性的来获取各个值,再手动丢进一个model里。

到这里,项目中使用org.codehaus.jettison.json来处理json数据,这个框架有个问题,JsonObject.get(key)的时候,如果key不存在,则不是返回null,而是抛出一个exception。我最近修改了两个bug都是因为response中没有这个key而抛出的异常。而response之所以没有这个key是因为webservice那边处理返回结果model不一定。正确的则返回这样,失败了则返回其他字段。而client的这端,没有预料到失败的结果映射,或者说以不变应万变,用exception来反映失败。

因此,webservice一定要定义好返回的model,失败了,不要一下是warning,一下是message。这样也可以,但要有文档说明你们返回的结果是什么model,client好做映射。client这边最好还是不要手动映射了,妈的出错了debug也很烦。client可以封装多个model,比如正常的model,失败的model。先序列化为正常的,序列化失败则序列化为失败的model。

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏哈雷彗星撞地球

设计模式中的设计原则

翻了三本书《设计模式之禅》、《设计模式:可复用的面向对象软件元素》、《Head First 设计模式》,也看了不少博客和关于设计模式原则的文章。关于设计模式有几...

613
来自专栏精讲JAVA

优化 Java 中的多态代码

Oracle的Java是一个门快速的语言,有时候它可以和C++一样快。编写Java代码时,我们通常使用接口、继承或者包装类(wrapper class)来实现多...

942
来自专栏java一日一条

程序中减少使用if语句的方法集锦

大约十年前,我听说了反if的活动,觉得这个概念非常荒谬。如果不用if语句,又怎么能写出有用的程序呢?这简直太荒谬了。

862
来自专栏微信公众号:Java团长

写好Java代码的30条经验总结

成为一个优秀的Java程序员,有着良好的代码编写习惯是必不可少的。下面就让我们来看看代码编写的30条建议吧。

702
来自专栏java一日一条

程序员你为什么这么累【续】:编码习惯之接口定义

工作中,少不了要定义各种接口,系统集成要定义接口,前后台掉调用也要定义接口。接口定义一定程度上能反应程序员的编程功底。列举一下工作中我发现大家容易出现的问题:

782
来自专栏進无尽的文章

设计模式| 创建型模式

GOF23种设计模式中创建型模式共五种:工厂方法模式、抽象工厂模式、单例模式、建造者模式、原型模式。

702
来自专栏.NET技术

面向对象基础

通过封装、继承、多态把程序的耦合度降低,用设计模式使程序更加的灵活,容易修改,并且易于复用。缩短开发周期,重用性和继承性高,降低了重复的工作量,但缺点是,程序的...

722
来自专栏Python攻城狮

设计模式1.设计模式2.工厂设计模式3.__new__的使用 4.单例设计模式

设计模式(Design pattern)代表了最佳的实践,通常被有经验的面向对象的软件开发人员所采用。设计模式是软件开发人员在软件开发过程中面临的一般问题的解决...

543
来自专栏斑斓

当函数成为一等公民时,设计模式的变化

GOF提出的设计模式,其本质思想是封装变化。故而,创建型模式封装的是对象创建的变化,结构型模式封装的是对象之间的协作与组合结构,行为型模式则封装了对象行为的变化...

2915
来自专栏Golang语言社区

【翻译】为什么 goroutine 的栈内存无穷大?

一些 Go 语言的新学习者总是会对 goroutine 栈内存占用大小感到非常好奇。这一般是由于程序员进行无限的函数循环调用导致的。为了说明这个问题,请思考以下...

3386

扫码关注云+社区