java 代码审查规范

java 代码审查

1.工具类或者常量类里面的方法都是静态的,建议直接用类名调用,不用创建对象,所以将构造方法私有化,禁止创建对象

//error example:
public  class StringUtils{
    /**
     * 判断一个字符串是否为英文中文或数字
     * 
     * @param str
     * @return
     */
    public static boolean isLetterDigitOrChinese( String str ) {
        String regex = "^[a-z0-9A-Z\u4e00-\u9fa5]+$";
        return str.matches( regex );
    }
}
 //right example:
 public  class StringUtils{
  //添加构造私有构造方法
    private StringUtils{
    }
    /**
     * 判断一个字符串是否为英文中文或数字
     * 
     * @param str
     * @return
     */
    public static boolean isLetterDigitOrChinese( String str ) {
        String regex = "^[a-z0-9A-Z\u4e00-\u9fa5]+$";
        return str.matches( regex );
    }
}

2.NPE(空指针异常)-equals

//error 
String testString="abc";
if(testString.equals("abc")){

}else{

}
//right
String testString="abc";
if("abc".eqauls(testString)){
    //code
}else{
    //code
}

3.map list 新建 (java 1.7 )

// Noncompliant
List<String> strings = new ArrayList<String>();  
Map<String,List<Integer>> map = new HashMap<String,List<Integer>>();  

//Compliant Solution
List<String> strings = new ArrayList<>();
Map<String,List<Integer>> map = new HashMap<>();

4.使用isEmpty 来判断集合是否为空

//Noncompliant
if(data.size==0){

}

//compliant
if(data.isEmpty){

}

5.数组定义 (“[]” 在变量名字前面)

//Noncompliant
int arr[]={};

//compliant
int[] arr={};

6.字符串转换为数字

//Noncompliant
String numString="12222222";
long numLong=Long.valueOf(numString);
//compliant
String numString="12222222";
long posNum=Long.parseLong( posMap.get( "num" ).toString());

7.公共静态成员应该加上final,也就是public static final 一般不分家

  • 2
    点赞
  • 4
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Java代码审查规范是一组规范和指南,用于指导开发人员在进行代码审查时应遵循的准则。以下是关于Java代码审查规范的一些要点: 1. 命名规范代码中的命名应具有描述性和一致性。应使用有意义的变量、方法和类名,并遵循驼峰命名法或下划线命名法。 2. 注释规范代码中应包含适当的注释以解释代码的功能、目的和逻辑。注释应该清晰、明确,并与代码保持同步更新。 3. 代码结构规范代码应具有良好的结构和层次,使用适当的包和类组织代码。类和方法应该只负责一种功能,遵循单一职责原则。 4. 格式规范代码应采用统一的格式,包括缩进、空格、括号的使用等。这样可以提高代码的可读性,并使代码在不同开发人员之间保持一致。 5. 错误处理规范代码应具有适当的错误处理机制,包括异常处理和错误日志记录。应该避免捕获所有异常,而是根据具体情况选择处理或传播异常。 6. 性能规范代码应考虑性能问题,避免使用低效的算法和数据结构。应避免重复计算和不必要的资源消耗。 7. 安全规范代码应具备一定的安全性,避免潜在的安全漏洞。应当对输入进行验证和过滤,以防止注入攻击和其他安全威胁。 8. 单元测试规范代码应具备适当的单元测试覆盖率,确保代码的正确性和健壮性。每个方法和类都应有相应的测试用例。 代码审查的目的是找出代码中的潜在问题,并提供改进建议,以优化代码的质量。遵循Java代码审查规范可以帮助团队成员在开发过程中共同遵循一致的标准和最佳实践,提高代码的可读性、可维护性和可靠性。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值