Java语言编程规范——编码规范

2023年4月1日 169次阅读 来源: Rance935

  • 明确方法功能，精确（而不是近似）地实现方法设计。一个函数仅完成一件功能，即使简单功能也应该编写方法实现。
    说明：虽然为仅用一两行就可完成的功能去编方法好象没有必要，但用方法可使功能明确化，增加程序可读性，亦可方便维护、测试。

  • 对方法参数的合法性检查由方法本身负责，方法调用者不负责。
    说明：对于模块间接口方法的参数的合法性检查这一问题，往往有两个极端现象，即：要么是调用者和被调用者对参数均不作合法性检查，结果就遗漏了合法性检查这一必要的处理过程，造成问题隐患；要么就是调用者和被调用者均对参数进行合法性检查，这种情况虽不会造成问题，但产生了冗余代码，降低了效率。

  • 明确类的功能，精确（而非近似）地实现类的设计。一个类仅实现一组相近的功能。
    说明：划分类的时候，应该尽量把逻辑处理、数据和显示分离，实现类功能的单一性。
    示例：
    数据类不能包含数据处理的逻辑。
    通信类不能包含显示处理的逻辑。

  • 数据库操作、IO操作等需要使用结束close()的对象必须在try -catch-finally 的finally中close()。
    示例：

try
{
    // ... ...
}
catch(IOException ioe)
{
    //... ...
}
finally
{
    try
    {
        out.close();
    }
    catch (IOException ioe)
    {
        //... ...
    }
}
  • 异常捕获后，应该纪录日志或者ex.printStackTrace() 。
    说明：若有特殊原因必须用注释加以说明。
    示例：
try
{
    //.... ...
}
catch (IOException ioe)
{
    ioe.printStackTrace ();
}
  • 采用错误返回码代替抛出异常。一个函数必须在其内部对所有异常进行处理， 禁止主动抛出的异常（禁止使用throw new IOException()），采用错误返回码代替抛出异常。
  • 注意运算符的优先级，并用括号明确表达式的操作顺序，避免使用默认优先级。
    说明：防止阅读程序时产生误解，防止因默认的优先级与设计思想不符而导致程序出错。
    示例：
    下列语句中的表达式
word = (high << 8) | low     (1)
if ((a | b) && (a & c))      (2)
if ((a | b) < (c & d))       (3)

如果书写为

high << 8 | low
a | b && a & c
a | b < c & d

虽然不会出错，但语句不易理解；造成了判断条件出错。

  • 避免使用不易理解的数字，用有意义的标识来替代。涉及物理状态或者含有物理意义的常量，不应直接使用数字，必须用有意义的静态变量来代替。
    示例：如下的程序可读性差。
if (state == 0)
{
    state = 1;
    ...  // program code
}

应改为如下形式：

private final static int TRUNK_IDLE = 0;
private final static int TRUNK_BUSY = 1;
private final static int TRUNK_UNKNOWN = -1;    
if (state == TRUNK_IDLE)
{
    state = TRUNK_BUSY;
    ...  // program code
}
  • 数组声明的时候使用int index[]，而不要使用int[] index。但函数返回值为数值类型时应使用int[] getIndex()，而不要使用int getIndex()[]。
    示例：
    如下程序可读性差：
public int getIndex()[]
{
    ....
}
如下程序可读性好：
public int[] getIndex()
{
    ....
}

  • 调试代码的时候，禁止使用 System.out 和 System.err 进行打印，应该使用log4j统一打印。
    说明：代码发布的时候可以统一关闭调试代码，定位问题的时候又可以打开开关。

  • 禁止在版本正式代码中写测试代码。测试代码应使用junit单独编写。

  • 一个函数除注释、空行外的代码行数不得超过50行。如果一个函数的代码行数超过50行，必须把它拆分为多个函数，直到每个函数的代码行数小于等于50行为止。

  • 禁止使用难懂的技巧性很高的语句。禁止使用不常用的语法。
    说明：高技巧语句不等于高效率的程序，实际上程序的效率关键在于算法。

建议

  • 记录异常不要保存exception.getMessage()，而要记录exception.toString()。
    示例：NullPointException抛出时常常描述为空，这样往往看不出是出了什么错。

  • 异常捕获尽量不要直接 catch (Exception ex)，应该把异常细分处理。

  • 如果多段代码重复做同一件事情，那么在方法的划分上可能存在问题。
    说明：若此段代码各语句之间有实质性关联并且是完成同一件功能的，那么可考虑把此段代码构造成一个新的方法。

  • 源程序中关系较为紧密的代码应尽可能相邻。
    说明：便于程序阅读和查找。
    示例：矩形的长与宽关系较密切，放在一起。

rect.length = 10;
rect.width = 5;
    原文作者：Rance935
    原文地址: https://www.jianshu.com/p/9e2b4655b27c
    本文转自网络文章，转载此文章仅为分享知识，如有侵权，请联系博主进行删除。
点赞