如何编写良好的Java代码?为什么?

引言:对于程序员来说,写出良好的代码是至关重要的,所以我们要时刻提醒自己:今天你的代码写的好吗?

我们常常会忽略什么?

往往程序员都有项目上的压力,以至于仓促的完成某些功能,于是:

1.命名的不规范(比如有一个参数 a,有一个方法 b)

2.方法的代码量很大,一个方法的代码长达几百行甚至几千行

3.没有注释或者几乎没有注释

4.没有形成一定的代码风格,如换行、缩进、括号等

5.没有日志打印(日志打印有助于我们发现、调试问题)

下面就来针对问题做一些分析

一、规范命名

命名的原则:要让我们一看到名称,基本就能够明白这个参数是什么意思,这个方法是做什么的

比如: b() 和 insert()  这两个方法,我们很容易就知道后者是“插入”的方法,前者的话当时写的时候知道是干什么用的,半年甚至更久以后呢?那你只能去看实现的代码了(如果你跟我说:“我时间多的很,我就喜欢这样看”,那我就给你竖大拇指)

二、方法的小巧化(代码的重构)

原则:将方法的大小限制为可在一页的屏幕上看到

方法:如果说我们的某个方法超过了一页很多那就要考虑重构它,将某些功能转移到另一个方法中,做好命名和传参。

程序员通常会在完成工作后去分析自己的代码,然后做重构工作,如果你注重并且擅长重构,你写出的代码将会更加干净、更加强健。

三、合理的使用注释

原则:请使用注释(就是这么朴实无华的5个字)

误区:我的代码写的那么用心,那么完美,还需要注释吗?

实际:

1.你写的代码往往没有那么用心,你或许只是为了完成工作

2.尽管我们很努力,但是代码并没有我们想象的那么完美,或者说只是自己觉得完美。

未来:如果你做好了注释,你自己、你的同事、朋友、阅读你代码的人 可能都会感谢你!

四、代码风格的统一

原则:用统一的风格(比如公司统一的代码风格,如果没有就用 Java的标准写法吧)

误区:编码风格是一种个人偏好,我想怎么写就怎么写

实际:你同事看了你写的代码,默默的握紧了拳头(你自己去想吧)

如:

public static void main(String[] args) {

}

不建议用以下两种

public static void main(String[] args)
{
}
public static void main(String[] args)
  {
  }

再比如:

for(int i=0;i<10;i++){
   System.out.println(i);
   System.out.println(i);
   System.out.println(i);
   System.out.println(i);
   System.out.println(i);
}

不建议写成:

for(int i=0;i<10;i++){
System.out.println(i);
System.out.println(i);
System.out.println(i);
System.out.println(i);
System.out.println(i);
}

甚至于这样:

for(int i=0;i<10;i++){
System.out.println(i);System.out.println(i);System.out.println(i);System.out.println(i);System.out.println(i);
}

五、日志的打印

原则:合理的打印日志(建议用Log4j,它分了好几种打印级别,非常适合)

误区:打印日志干嘛?我代码很完美、很健壮、测试通过没问题,就是这么自信

实际:

1.如之前所说你的代码或许并没有那么完美,那么健壮

2.上生产的时候,有些问题你没预料到的,需要日志通过日志来呈现

3.一些运行时的意外情况

建议:我们需要在比较关键的位置打印日志,可以用来分析流程走向、分析错误

其他:采用用数据库来记录日志也是一种不错的方式,比如接口的往返报文记录到表里面,可以很有效的提高我们日常维护的效率。(日志打印有时候比较多,日志不好查;又或者服务器比较多,你得一个个的翻,可能会哭)

最后:一个软件产品的80%的生命期是在维护,而维护他的人往往是其他人,并不是作者,可想而知良好的代码是多么的重要了。

猜你喜欢

转载自blog.csdn.net/dkm123456/article/details/114139832