java开发中常见的不良习惯

最新推荐文章于 2024-11-15 19:36:45 发布

原创最新推荐文章于 2024-11-15 19:36:45 发布 · 284 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#java #代码规范

java 专栏收录该内容

8 篇文章

订阅专栏

本文强调了代码规范的重要性，列举了常见的代码不规范问题，如多余的引用、未使用的变量、不格式化的代码、错误注释等，并提供了相应的解决建议，如使用IDE快捷键进行优化、避免NPE、正确使用日志及比较操作。同时提醒开发者注意类的组织结构、注释清晰性和避免复制粘贴式开发。

缺少规范意识

缺少规范意识，缺少规范意识，缺少规范意识，说三遍

多余的类引用

IDEA快捷键：Ctrl+Alt+O，可自动删除多余引用

在这里插入图片描述

java引入使用 import …*

参考配置：
在这里插入图片描述

单行代码长度超过120个字符

参考配置：

在这里插入图片描述

定义了未使用的变量、对象

在这里插入图片描述

代码不格式化

快捷键：Ctrl+Alt+L，自动格式化代码

在这里插入图片描述

多余的分号、括号

在这里插入图片描述

保留无效/弃用的代码/空方法

注释掉的内容或临时代码等

属性无必要的文档注释

汉语博大精深，定义同一个意义的属性，不同的人可能用不同的单词，为避免歧义，最好加上注释说明

在这里插入图片描述

错误注释、无注释

出于【迎合】文档规范，有的同学会复制其他类的注释给另一个类，对应的说明信息、作者、时间等要素也奉行拿来主义不做改动

单词拼写错误、错别字

在这里插入图片描述

复杂交易无必要的日志打印

排查定位问题时将无从下手

Logger使用不是自身类

复制的锅，不怪我

在这里插入图片描述

日志打印参数时使用字符串拼接、System.out.println

应使用日志类配合占位符

在这里插入图片描述

不太恰当的方法使用

易引发NPE、逻辑取反等

//反例，存在NPE的集合判空
if (req.getBillIds().size() == 0) {
    //todo
}
//存在NPE的字符串判空
if (req.getAcctNo.isEmpty()) {
    //todo
}
// ---------------------------分割线
//正例
if (CollectionUtils.isEmpty(req.getBillIds())) {
     //todo
}
if (StringUtils.isEmpty(req.getAcctNo)) {
    //todo
}
if (ObjectUtils.isEmpty(obj)) { // 可通用于集合、字符串、数组等的判空
    //todo
}
//----------------------------分割线
//反例，非空判断，容易丢失的惊叹号
if (!CollectionUtils.isEmpty(req.getBillIds())) {
     //todo
}
//正例，易于理解的非空判断
if (CollectionUtils.isNotEmpty(req.getBillIds())) {
     //todo
}

`BigDecimal` 比较相等

//反例
if (new BigDecimal("1").equals(new BigDecimal("1.0"))) {
    //todo
}
//正例
if (new BigDecimal("1").compareTo(new BigDecimal("1.0")) == 0) {
    //todo
}