java程序员如何编写出优美的代码-java编程规范

ゝ一世哀愁。 2022-10-30 11:22 242阅读 0赞

**目录**

写在前面

java编程规范

规范一、避免在程序中使用无意义的名称（变量名、方法名等），必须用有意义的名称来标识。

规范二、明确方法的功能，一个方法仅完成一个功能。

1.注释提炼法（如果一段代码上有注释，那么就可以提炼出来）

2.条件表达式和循环（应该将循环和其内的代码提炼到单独的函数中）

3.重复代码

规范三、方法参数不能过多（最好不超过5个）

规范四、你需要再三检查某对象是否为null

规范五、少用switch

规范六、方法尽量不要返回null

规范七、在进行数据库操作或IO操作时，必须确保资源在使用完毕后得到释放，并且必须确保释放操作在finally中进行

规范八、异常捕获不要直接catch (Exception ex) ，应该把异常细分处理

规范九、使用if一定要在最后包含一个else

规范十、线程最好使用线程池管理

规范十一、金钱操作，最好使用BigDecimal

规范十二、异常捕获一定要打印异常，否则根本不知道异常出在哪里

规范十三、添加必要且不啰嗦的注释

--------------------

# 写在前面 #

作为一个java程序员，编程规范是非常重要的。

工作三年了，回头再看看自己一两年之前编写的代码，简直就是不忍直视。。

尤其是最近，跟一些大佬一起编码，看着他们那些漂漂亮亮的代码，真的是从心里升起一股子佩服。

于是乎，就诞生了这一篇，java编程的规范。

我在这一篇文章中提到过，[我的代码为什么看起来像shit？][shit]程序员写的代码有三重境界，让自己看懂-让机器看懂-让别人看懂，当你写的代码能够轻易的移交给别人，那说明你写的代码已经非常规范了。

# java编程规范 #

规范其实并不是“必须要这样做”，而是一种公认的比较合理的东西。

就像是坐着不能抖腿，不是说抖腿就会影响健康，而是不雅观~

## 规范一、避免在程序中使用无意义的名称（变量名、方法名等），必须用有意义的名称来标识。 ##

//例如，以下代码是万万不能出现的
    public static void bbb(String aaa){
        int a = 0;
        if("张三".equals(aaa)){
            a = 1;
        }
        String ccc = "";
    }

## 规范二、明确方法的功能，一个方法仅完成一个功能。 ##

方法不能过长，确保一个方法仅完成一个功能是最好的效果。如果方法过长，对长方法进行分解，是每个程序员都应该会做的。

刚开始可能都不太清楚该怎么将一个方法进行分解，这里有几种分解方法的技巧：

### 1.注释提炼法（如果一段代码上有注释，那么就可以提炼出来） ###

通常写一段注释，就意味着以下的代码代表着一种功能，这个时候就可以将这段代码提炼出来。

### 2.条件表达式和循环（应该将循环和其内的代码提炼到单独的函数中） ###

通常这部分比较啰嗦，单独提炼出来可以提高代码可读性。

### 3.重复代码 ###

将重复代码提炼出来，可以增加代码的复用性。

## 规范三、方法参数不能过多（最好不超过5个） ##

方法参数过多，可以封装一个实体类，将实体类作为参数进行传参。

切记，不要使用map作为方法参数，这样的代码可读性非常差！

## 规范四、你需要再三检查某对象是否为null ##

使用某对象时，一定要再三检查某对象是否为null，否则非常容易造成空指针。

## 规范五、少用switch ##

switch可以用枚举替代，或者用单个类来替代，或者单独抽取出来。

## 规范六、方法尽量不要返回null ##

取而代之以抛出异常，或是返回特例对象（代表null意义的自定义对象）；对于以集合或数组类型作为返回值的方法，取而代之以空集合或0长度数组。

## 规范七、在进行数据库操作或IO操作时，必须确保资源在使用完毕后得到释放，并且必须确保释放操作在finally中进行 ##

## 规范八、异常捕获不要直接catch (Exception ex) ，应该把异常细分处理 ##

## 规范九、使用if一定要在最后包含一个else ##

对于if „ else if „(后续可能有多个else if …)这种类型的条件判断，最后必须包含一个else分支，避免出现分支遗漏造成错误；每个switch-case语句都必须保证有default，避免出现分支遗漏，造成错误。

## 规范十、线程最好使用线程池管理 ##

## 规范十一、金钱操作，最好使用BigDecimal ##

## 规范十二、异常捕获一定要打印异常，否则根本不知道异常出在哪里 ##

## 规范十三、添加必要且不啰嗦的注释 ##

[shit]: https://blog.csdn.net/A_art_xiang/article/details/110520636

发表评论取消回复

表情：

评论列表（有 0 条评论，242人围观）

还没有评论，来说两句吧...

相关阅读

相关代码规范：如何编写更符合Java编程习惯的代码

编写符合Java编程习惯的代码，需要遵循以下几个原则： 1. **命名规则**： - 类名首字母大写（如`MyClass`），且一般以名词形式表述。 - 方法、变

谁借莪１个温暖的怀抱￠/ 2024年11月27日 21:36/ 0 赞/ 23 阅读

相关 Java代码规范问题：如何编写清晰、可维护的代码

编写清晰、可维护的Java代码，需要遵循以下几个原则： 1. **命名规范**：变量和函数名应具有描述性，并使用小驼峰命名（如myVariable）。 2. **结构清晰*

Bertha 。/ 2024年10月17日 10:00/ 0 赞/ 46 阅读

相关代码规范问题：如何编写符合Java Bean规范的类

Java Bean（Java Bean Pattern）是Java中一种常见的对象模型，它遵循一定的规范。以下是编写符合Java Bean规范的类的一些步骤： 1. **命名

待我称王封你为后i/ 2024年10月14日 15:36/ 0 赞/ 54 阅读

相关代码规范：如何遵循Java最佳实践编写代码？

遵循Java最佳实践可以帮助你编写更清晰、更可维护的代码。以下是一些主要的最佳实践： 1. **命名约定**： - 类名首字母大写，驼峰命名。 - 变量和方法名应

谁践踏了优雅/ 2024年10月12日 10:51/ 0 赞/ 82 阅读

相关 Java编码规范与最佳实践：如何编写出可读性高、易于维护的Java代码?

编写高质量的Java代码需要遵循一些编码规范和最佳实践。以下是一些建议： 1. **命名规则**： - 类名首字母大写，全名使用驼峰式命名。 - 变量和方法名称首

忘是亡心i/ 2024年09月04日 09:06/ 0 赞/ 73 阅读

相关 Java编程规范与最佳实践：如何写出高质量的Java代码?

编写高质量的Java代码需要遵循一些基本的编程规范和最佳实践。以下是几个关键方面： 1. **命名规范**： - 类名首字母大写，全名使用驼峰式命名。 - 变量、

曾经终败给现在/ 2024年09月04日 08:33/ 0 赞/ 73 阅读

相关 Java入门者：如何写出规范美观的Java代码

前言在帮助各位同学远程解决代码问题的时候，发现很多同学的代码都有一个共同问题：代码书写格式不规范。虽然代码书写规范对程序性能及运行并不影响，但影响着别人对你编程习惯或能

川长思鸟来/ 2023年10月11日 15:18/ 0 赞/ 39 阅读

相关 java程序员如何编写出优美的代码-java编程规范

目录写在前面 java编程规范规范一、避免在程序中使用无意义的名称（变量名、方法名等），必须用有意义的名称来标识。规范二、明确方法的功能，一个方法仅完成一个功能。

ゝ一世哀愁。/ 2022年10月30日 11:22/ 0 赞/ 243 阅读

相关如何写出优美的 C 代码

面向对象的语言更接近人的思维方式，而且在很大程度上降低了代码的复杂性，同时提高了代码的可读性和可维护性，传统的 C 代码同样可以设计出比较易读，易维护，复杂度较低的优美代码，本

男娘i/ 2022年08月21日 00:22/ 0 赞/ 208 阅读

相关 idea Java 代码编写规范

1.[阿里巴巴Java开发手册][Java] -------------------- 2.基于上面的idea代码检查插件打开idea file–>

Dear 丶/ 2021年10月06日 12:46/ 0 赞/ 518 阅读