代码诊所的第二次诊断

几年前,我有机会负责一个项目的咨询。团队很小,目标是对旧有系统的后端用Java改写,而团队的开发人员全为C程序员。我的工作职责是负责项目设计、开发,以及担任项目开发过程敏捷化的教练,并培养Java开发人员。

我在团队工作室的墙角落,开了一个小小的诊所,广而告之——“每日一贴,包治百病”。这是当时我在项目上的第二次诊断。

01

变量的声明应尽量与使用放在一起

本规则与代码的可读性有关,倘若方法还没有保持短小,这个问题就更要命。或许这是C语言开发者容易犯的毛病。当然也有许多Java程序员从前辈程序员处继承了这一陋习。我曾经在一个遗留项目中看到过一个长达几千行的Java方法,在方法头部堆砌了数十个变量定义,让人目不暇给!

除了影响代码的可读性之外,还可能导致隐藏的缺陷。很多程序员之所以习惯在一开始就声明变量,就是将这种局部变量当做了存储中间状态的容器,在方法内部反复使用该变量,这种中间结果的变迁未必符合开发者意图,又或者后来的代码维护者没有理清这种变化,从而做出变量值的误判。

02

对常量和枚举的使用

本规则本不足道,写在这里,为了进一步惊醒一下团队成员。在咨询过程中,我看到有这段代码:

Integer.parseInt(freeFlash, 16);

这个16,究竟是什么鬼?Magic Number,很多时候会让人感到困惑。

在JDK没有提供枚举之前,很多Java程序员喜欢使用接口类型来包装一大堆常量。如果常量存在内聚的分类意义,还是使用枚举为佳。

03

进行合理封装,避免方法调用顺序错误

封装是非常有必要的。有时候,暴露太多的细节会让调用者感到无可适从。

对于TelnetService类,我们需要依序调用connect()、login()、enterUShell(),然后在执行命令后,必须依序执行exitUShell(),disconnect()。这让我想起事务处理,FTP访问等与资源有关的逻辑,都需要在执行逻辑前后包裹一些基础设施的处理逻辑。为了避免在执行命令前后忘记连接或断开telnet,最好能将此过程封装。

这是从调用安全性来考虑。

如果从调用的简洁性考虑,封装亦有必要。当我们需要通过TelnetService发送telnet命令时,为何还需要了解内部的执行逻辑呢?

那么,该如何封装才能两全其美,既满足对执行逻辑顺序的重用,又满足对命令逻辑的扩展?

通常做法是将真正的执行逻辑提取为接口,如Java中Runnable的方式。这其实可以看作Command模式的运用。当然,我更愿意看做是对函数的封装,例如Guva中的tranform()、filter()之类的方法,接受更具有函数气质的Function或者Predicate接口(当时,Java 8还未问世呢)。

因此,我的做法如下:

public class TelnetService {
    public T withCommand(ExecutionCommand<T> command) {
        connect();
        login();
        enterUShell();
        T result = command.send();
        exitUShell();
        disconnect();
        return result;
    }
}

可以这样调用:

String result = telnetService.withCommand(new ExecutionCommand<String>() {
        @Override
        public String send() {
            return telnetService.transfer();
        }
    }
);

04

遵循异常处理的架构规则

团队成员对异常极为陌生,面对java的受控异常、非受控异常,不知如何选择;也不知道该何时捕获异常,何时抛出异常。因而我针对该项目确定了异常处理的架构原则,其目的是为了让整个架构变得更简单,让异常处理更加一致。

我的目的是减轻开发人员的负担,但同时又不降低代码质量,并利于未来对代码的维护。规则如下:

请输入标题 bcdef

同层之间的调用不做try-catch,上层调用下层的对象,必须try-catch。即使对象抛出了异常,只要不是checked exception(我们尽量避免使用checked exception,以避免它对接口的污染),就无需考虑去捕获这个异常。这样的设计并不会导致异常泄露,因为我们要求在上一层捕获。至于最顶端的Application Layer,则只做捕获异常的事儿,不干抛异常的活儿。

为各层(即领域层和基础设施层)定义各自的异常超类。其中,领域层定义的异常要求提供Error Code。Error Code并非我所愿,但对于本系统的上游系统,却需要该值,不得不为。

领域层。若是结合实际情况由自己抛出异常,则只需考虑异常消息和错误码;若是捕获了异常再抛出,则在捕获时记录日志,再度抛出的异常需要包裹原始异常对象。

请输入标题 abcdefg

在代码诊所中诊断出来的疾病,可以作为代码评审的一个标准,同时这些处方则可以当做团队内部分享与交流的知识库。长期累积下来,非常有利于团队成员编码能力的成长。

原文发布于微信公众号 - 逸言(YiYan_OneWord)

原文发表时间:2017-03-24

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

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏java工会

深度思考编程的艺术

1768
来自专栏我的博客

街灯说javascript学习笔记一

这是我学习javascript这门语言的第二周,下面是心得。 我这两周都是在看教程,然后做实例,但是实例都是一个html文件,不停地预览覆盖,所以没有保存,从下...

2825
来自专栏Java帮帮-微信公众号-技术文章全总结

Java基础-day05-超市收银系统案例题

Java基础-day05-超市收银系统案例题 案例描述 将超市购物小票案例中,键盘录入部分封装为方法。 将switch语句完成的三个分支代码逻辑封装为3个方法 ...

6044
来自专栏Java技术分享圈

给一些想要学习Java同学的一些建议

最近在授课过程中,发现了各式各样学生在学习Java时遇到的问题。有同学会问我:“杨老师,Java可以自学吗”,这就好像一千个人心中有一千个哈利波特一样,这个答案...

1961
来自专栏java一日一条

Java函数式开发——优雅的Optional空指针处理

空闲时会抽空学习同在jvm上运行的Groovy和Scala,发现他们对null的处理比早期版本Java慎重很多。在Java8中,Optional为函数式编程的n...

2031
来自专栏编程

Java 最困扰你的那些事

啊哈Reddit(某知名国外在线问答社区),没了你我们还能在哪里从鱼目混珠的网络中提炼真正的精华?就在这杂乱无章的论坛中,的的确确存在着这样一些精辟的讨论。 比...

2218
来自专栏静默虚空的博客

如何学习一门编程语言

前言 很多人喜欢争论什么什么编程语言好,我认为这个话题如果不限定应用范围,就毫无意义。 每种编程语言必然有其优点和缺点,这也决定了它有适合的应用场景和不适合的应...

4335
来自专栏姬小光

正则表达式是个啥

前些天有运营 MM 问小鸡君,正则表达式是个啥啊?懂技术的同学可能会想,你个运营管啥是正则表达式干啥?

1132
来自专栏Crossin的编程教室

【Python 第59课】 正则表达式(5)

听说有人已经开始国庆假期了,甚至还有人中秋之后就请了年假一休到底,表示羡慕嫉妒恨!今天发完这课,我也要进入休假状态,谁也别拦着我。 来说上次的习题: (021...

3298
来自专栏阿杜的世界

《重构》阅读笔记-代码的坏味道

开发者必须通过实践培养自己的经验和直觉,培养出自己的判断力:学会判断一个类内有多少个实例变量算是太大、学会判断一个函数内有多少行代码才算太长。

742

扫码关注云+社区

领取腾讯云代金券