如何优化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 条评论
登录 后参与评论

相关文章

来自专栏韩伟的专栏

框架设计原则和规范(一)

此文是《.NET:框架设计原则、规范》的读书笔记,本文内容较多,共分九章,将分4天进行推送,今天推送1-3章。 1. 什么是好的框架 2. 框架设计...

3245
来自专栏数据和云

性能分析:Oracle的CLOB使用与临时段访问及其性能优化

编辑手记:在系统测试、上线和优化的过程中,抓住核心环节、不放过任何可疑,这是DBA的基本要求之一,在这个案例中,高频度调用的存储过程引起了注意。 客户新上线的一...

2755
来自专栏蓝天

走出锁的误区 - 正面认识锁

多线程编程,锁通常是必不可少的保证代码运行安全的工具,一提到锁,最直接想到的是性能问题,给人的印象是锁会影响系统性能。这固然不然。但性能本身并不是锁本身引起的,...

462
来自专栏腾讯Bugly的专栏

【MIG专项测试组】腾讯手机管家实战分析:内存突增是为神马?

应用版本升级后使用内存突增?如何跟踪?这次MIG专项测试组为大家分享内存问题跟踪实战过程! MIG专...

3174
来自专栏技术分享

Redis 数据结构与内存管理策略(上)

Redis 数据结构与内存管理策略(上) 标签: Redis Redis数据结构 Redis内存管理策略 Redis数据类型 Redis类型映射 作者:王清培(...

2747
来自专栏丑胖侠

《Drools 7 规则引擎教程》番外篇-规则条件匹配机制

问题场景 QQ技术群(593177274)中有同学遇到这一个问题场景:在多条规则(比如3条)的when中使用了一个相同的静态方法,并在静态方法中打印相关的日志信...

2038
来自专栏王亚昌的专栏

合理使用const,慎用自运算

    项目最的出了几次运营事故,都是因为使用自乘、自加、自減运算,错改了非局部变量,导致将用户数据写溢出,最终只能进行回档处理。先给大家展示一下,漏出bug的...

601
来自专栏腾讯移动品质中心TMQ的专栏

内存泄漏漫谈

对于C/C++来说,内存泄漏问题一直是个很让人头痛的问题,因为对于没有GC的语言,内存泄漏的概率要比有GC的语言大得多,同时,一旦发生问题,也严重的多,而且,内...

2027
来自专栏程序员互动联盟

【计算机基本概念】如何理解内存?

内存是计算机中重要的部件之一,它是与CPU进行沟通的桥梁。计算机中所有程序的运行都是在内存中进行的,因此内存的性能对计算机的影响非常大。内存(Memory)也被...

3014
来自专栏腾讯移动品质中心TMQ的专栏

测试左移之代码评审

最近两年,品质中心极力推动测试工作左移,以期能提前发现产品的问题,降低成本。笔者自认代码基础能力还不错,就想通过代码 Review 来提前发现一些Bug。

1361

扫描关注云+社区