代码评审——程序中流、连接等关闭问题

问题描述：

在程序开发过程中，必然面临着与文件、数据库等进行交互。使用流等方式来建立连接，并进行操作，也成为了开发者的日常。但在开发过程中，对连接的回收、关闭等操作的管理，经常会被遗忘，从而引发问题。

可以看下这个举例的代码：

Connection con;
try {
    con = JDBC.createConnection("XXXX", prop);
    String query = "SELECT * FROM TABLENAME";
    Statement stat = con.createStatement();
    ResultSet res = stat.executeQuery(query);
    res.close();
    stat.close();
} catch (SQLException e) {
    e.printStackTrace();
} finally{
 	if(stat != null){
 		stat.close();
 	}
 	if(con != null){
 		con.close();
 	}
}

此时，使用静态代码扫描工具，会出现以下提示：
Use try-with-resources or close this “ResultSet” in a “finally” clause.

---

原因分析：

静态工具代码扫描工具给出的解释为：

Connections, streams, files, and other classes that implement the Closeable interface or its super-interface, AutoCloseable, needs to be closed after use. Further, that close call must be made in a finally block otherwise an exception could keep the call from being made. Preferably, when class implements AutoCloseable, resource should be created using “try-with-resources” pattern and will be closed automatically.
Failure to properly close resources will result in a resource leak which could bring first the application and then perhaps the box it’s on to their knees.

其实，从开发者的角度来说，这个问题非常常见，处理也很简单。但是经常会忽视这个问题，可能是遗忘，可能是漏写。上面的示例代码就可以看出，是漏写了，仅关闭了Statement和Connection。如果不进行关闭，非常容易造成资源的泄露。

---

解决方案：

解决方案也很简单，只需要在finally中增加对ResultSet的关闭即可。

Connection con;
try {
    con = JDBC.createConnection("XXXX", prop);
    String query = "SELECT * FROM TABLENAME";
    Statement stat = con.createStatement();
    ResultSet res = stat.executeQuery(query);
    res.close();
    stat.close();
} catch (SQLException e) {
    e.printStackTrace();
} finally{
	if(res != null){
 		res.close();
 	}
 	if(stat != null){
 		stat.close();
 	}
 	if(con != null){
 		con.close();
 	}
}

---

项目实际意义：

在项目开发过程中，最常使用的连接包括以下3项：

• 文件流，包括字节流、字符流等等。
• 数据库连接，redis等连接。
• HTTP连接。

不关闭连接，很容易造成严重的结果。

• 针对文件流等，如果不关闭，会造成文件写入错误，别的文件也无法读取这个文件。
• 针对数据库连接，如果不关闭，会直接造成数据库的连接数暴涨（和访问这个服务的次数有关），最终造成数据库无法读写。虽然大多数情况下，会由对应的连接池（DB连接池或Redis连接池），来进行回收，但在业务实现上，也存在需要自己构建连接的情况。此时不关闭，甚至会造成项目的大型事故。
• 针对HTTP连接的情况，需要根据实际情况。如果需要不断交互，就不需要直接回收，否则就需要回收。

后面两种情况，因为有连接池的存在，经常会由连接池来进行销毁或回收等。

开发者在处理上述连接的过程中，如果不使用连接池等组件的情况，一定要及时关闭，否则很容易引起事故。