建议学习！良好的代码规范

男娘i 2022-10-23 08:27 175阅读 0赞

> 微信公众号：**Java随笔录**  
> 关注可了解更多Java相关的技术分享。问题或建议，欢迎公众号留言！

### 文章目录 ###

*   *   *  前言
         *  1、多此一举型
         *  2、瞎命名型
         *  3、if完一定要加else型
         *  4、复制粘贴型
         *  5、又长又臭型
         *  总结
         *  公众号

### 前言 ###

在我们的项目中，开始开发之前，大家都会制定一些规范，根据这些规范来实施。小录也是如此，在开始开发一些新的代码项目之前，不管项目大小，都会先把代码规范过一遍，开发过程中也会注意遵守这些规范，防止给后续的维护带来负担。但是在开发过程中，往往由于进度紧张、人员变动等其他原因，项目不断的迭代之后，其中一些代码就不符合规范了。

一些不符合规范的代码的可能不会影响我们的业务逻辑，这也导致我们容易忽视这些代码的存在，但是这相当于是在项目代码中埋下了不定时炸弹，爆炸的那天，追悔莫及。小录给大家整理了几种不符合规范的代码，希望能给大家带来启发。

### 1、多此一举型 ###

if (a > b) { 
       return true;
    } else { 
       return false;
    }

这段代码确实没毛病，跑得通，逻辑上也没问题，但是可以有更简洁的表达方式：

return a > b;

### 2、瞎命名型 ###

int a;
    String bt; // 标题
    String xingming; // 姓名

有一说一，现在肯定还是会有一些新手用没有意义的符号、拼音或者中西结合的方式给变量命名。良好的变量命名除了见名知意以外，还可以在长时间以后回来阅读代码时，更快的回忆起业务逻辑，不至于在各种无解的命名中乱了手脚，为了一时的方便而随意命名是非常不值得的。建议了解一下驼峰命名的方法，以及常见业务中的命名习惯。

### 3、if完一定要加else型 ###

if (condition) { 
    	// do something
    } else { 
       return ;
    }

if (condition) { 
    	// do something
    } else { 
       throw new Exception();
    }

while (condition1) { 
        if (condition2) { 
           // do something
        } else { 
           continue;    
        }
    }

很多情况下，我们可以通过一些语句的前置来减少不必要的else，让代码看起来更简练清晰，另外还有一些方法可以完美替换if-else代码块，具体可以看这篇文章[如何避免在代码中大量使用if-else？][if-else]

if (!condition) { 
       return ;
    }
    // do something

if (!condition) { 
       throw new Exception();
    }
    // do something

### 4、复制粘贴型 ###

举个简单的例子，项目中A模块引入B模块的身份验证业务，后续C模块也要引入B模块的身份验证业务，由于此时的身份验证业务可能是B模块中的几行代码，很多人就为了贪图方便，直接复制这几行代码直接放到C模块了。so easy，代码完美运行。

看起来似乎又没什么毛病，此时程序员的天敌产品经理过来了，他说在要在身份验证逻辑前面加点新的逻辑，ok，那么此时就要改动A模块、B模块、C模块三份代码，而且要保持一致性… 那如果，后续又有更多的模块要引入这一逻辑，那你的工作量岂不是线性增长？

所以从上面的案例中，如果我们一开始不偷懒，把公共逻辑抽取出来，在各个模块引用的话，不论怎么修改，我们只要维护一份逻辑就可以，不至于手忙脚乱。

### 5、又长又臭型 ###