性能优化总结1：findbugs :的使用

川长思鸟来 2022-05-31 23:58 193阅读 0赞

### Findbugs ###

基于Bug Patterns概念，查找java bytecode中的潜在bug。在目前版本中，它不检查java源文件。 主要检查bytecode中的bug patterns，也允许用户自定义特定的bug patterns。

以下是findbugs的面板  
![findbugs][]  
performance:性能  
dodgy code: 不符合规范的代码  
multithreaded correctness: 多线程相关  
correctness:代码的正确性  
security:安全性  
bad practice: 不好的习惯  
experimental: 实验性问题  
internationalization:国际化问题  
malicious code vulnerability: 恶意代码

findbugs右侧面板：

![findbugs2][]

priority代表了严重等级，红色最严重，所以我们可以重点关注一下红色。下方是错误详情。

### Bad practice 坏的实践 ###

一些不好的实践，下面列举几个：  
1、类定义了equals()，却没有hashCode()；。  
2、：Statement 的execute方法调用了非常量的字符串；或Prepared Statement是由一个非常量的字符串产生。  
3、： 方法终止或不处理异常，一般情况下，异常应该被处理或报告，或被方法抛出。

### Correctness 一般的正确性问题 ###

可能导致错误的代码，下面列举几个：  
1、： 空指针被引用；在方法的异常路径里，空指针被引用；方法没有检查参数是否null；null值产生并被引用；null值产生并在方法的异常路径被引用；传给方法一个声明为@NonNull的null参数；方法的返回值声明为@NonNull实际是null。  
2、： 类定义了hashcode()方法，但实际上并未覆盖父类Object的hashCode()；类定义了tostring()方法，但实际上并未覆盖父类Object的toString()；很明显的方法和构造器混淆；方法名容易混淆。  
3、：方法尝试访问一个Prepared Statement的0索引；方法尝试访问一个ResultSet的0索引。  
4、：所有的write都把属性置成null，这样所有的读取都是null，这样这个属性是否有必要存在；或属性从没有被write。

### Internationalization 国际化 ###

当对字符串使用upper或lowercase方法，如果是国际的字符串，可能会不恰当的转换。

Malicious code vulnerability 恶意代码  
如果代码公开，可能受到恶意攻击的代码，下面列举几个：  
1、： 一个类的finalize()应该是protected，而不是public的。  
2、：属性是可变的数组；属性是可变的Hashtable；属性应该是package protected的。

### Multithreaded correctness 多线程的正确性 ###

多线程编程时，可能导致错误的代码，下面列举几个：  
1、ESync：空的同步块，很难被正确使用。  
2、MWN：错误使用notify()，可能导致IllegalMonitorStateException异常；或错误的  
使用wait()。  
3、： 使用notify()而不是notifyAll()，只是唤醒一个线程而不是所有等待的线程。  
4、： 构造器调用了Thread.start()，当该类被继承可能会导致错误。

### Performance 性能问题 ###

可能导致性能不佳的代码，下面列举几个：  
1、DM：方法调用了低效的Boolean的构造器，而应该用Boolean.valueOf(…)；用类似  
Integer.toString(1) 代替new Integer(1).toString()；方法调用了低效的float的构造器，应该用静态的valueOf方法。  
2、SIC：如果一个内部类想在更广泛的地方被引用，它应该声明为static。  
3、SS： 如果一个实例属性不被读取，考虑声明为static。  
4、UrF：如果一个属性从没有被read，考虑从类中去掉。  
5、UuF：如果一个属性从没有被使用，考虑从类中去掉。

### Dodgy 不符合规范的，有潜在危险的 ###

具有潜在危险的代码，可能运行期产生错误，下面列举几个：  
1、CI： 类声明为final但声明了protected的属性。  
2、DLS：对一个本地变量赋值，但却没有读取该本地变量；本地变量赋值成null，却没有读取该本地变量。  
3、ICAST： 整型数字相乘结果转化为长整型数字，应该将整型先转化为长整型数字再相乘。  
4、INT：没必要的整型数字比较，如X <= Integer.MAX\_VALUE。  
5、NP： 对readline()的直接引用，而没有判断是否null；对方法调用的直接引用，而方法可能返回null。  
6、REC：直接捕获Exception，而实际上可能是RuntimeException。  
7、ST： 从实例方法里直接修改类变量，即static属性。

举几个常见的例子：  
bad practice:

### 1、返回值没有检查的 ###

例:  
File f = new File(path + “/capture.json”);  
f.delete();  
public boolean delete() \{  
SecurityManager security = System.getSecurityManager();  
if (security != null) \{  
security.checkDelete(path);  
\}  
if (isInvalid()) \{  
return false;  
\}  
return fs.delete(this);  
\}

类似的还有：f.createNewFile();f.mkdirs();f.setLastModified(currentTime);  
f.renameTo(journalFile);等，在使用系统的一些api的时候一定要检查是否有返回值，然后根据返回值判断是否操作成功。

### 2、流没有关闭的 ###

所有的流都要在finally块里关闭，以确保不会出现内存泄漏  
例：  
try \{  
BufferedReader bf = new BufferedReader(new InputStreamReader(  
mContext.getAssets().open(fileName)));  
String line;  
while ((line = bf.readLine()) != null) \{  
stringBuilder.append(line);  
\}  
\} catch (IOException e) \{  
e.printStackTrace();  
\}  
这样是不规范的，应该如下：  
try \{  
bf = new BufferedReader(new InputStreamReader(  
mContext.getAssets().open(fileName)));  
String line;  
while ((line = bf.readLine()) != null) \{  
stringBuilder.append(line);  
\}  
\} catch (IOException e) \{  
e.printStackTrace();  
\} finally \{  
if (bf!=null)\{  
try \{  
bf.close();  
\} catch (IOException e) \{  
e.printStackTrace();  
\}  
\}  
\}

### 3、定义了equals却没有定义hascode ###

如图：  
![findbugs][findbugs 1]

### 4、字符串比较要用equals而不是等于号 == ###

### 5、序列化的类里面定义了一个非序列化的字段，没有定义序列化ID ###

public class SaveCoverInfo implements Serializable \{  
private static final long serialVersionUID = 1L;  
private String apiVersion;  
private DataBean data;

public String getApiVersion() {
        return apiVersion;
    }
    
    public void setApiVersion(String apiVersion) {
        this.apiVersion = apiVersion;
    }
    
    public DataBean getData() {
        return data;
    }
    
    public void setData(DataBean data) {
        this.data = data;
    }
    
    public static class DataBean implements Serializable{
     
        private String img1;
    
        public String getImg1() {
            return img1;
        }
    
        public void setImg1(String img1) {
            this.img1 = img1;
        }
    }

### 6、get/set方法没有用到的 ###

### 7、调用parsexxx比valueof效率高： ###

long date = Long.valueOf(dataMap.get(columnName));  
应该写成：  
long date = Long.parseLong(dataMap.get(columnName));

### 8、频繁装箱拆箱的 ###

public Boolean getFieldValue(String fieldStringValue) \{  
if (TextUtils.isEmpty(fieldStringValue)) return null;  
return fieldStringValue.length() == 1 ? “1”.equals(fieldStringValue) : Boolean.valueOf(fieldStringValue);  
\}

### 9、使用对象前没有判断空指针的 ###

### 10、switch语句没有定义default的 ###

还有很多其它类型的优化建议，就不再举例了，大家可以在使用findbugs的过程中慢慢发现总结(\#.\#)

[findbugs]: /images/20220601/6608b52cebcc42f2a864020fb231239d.png
[findbugs2]: /images/20220601/eeb9b8ce08614eda8193c8e24db68633.png
[findbugs 1]: /images/20220601/1008d1b33a3042bab015c27d36d6abd4.png