ChatGPT幫我看下這段代碼有什么問題

更新時間：2023年02月16日 08:37:27 作者：程序猿阿朗

今天一個很簡單的功能，觸發(fā)了一個 BUG，處理后我想起了最近爆火的 ChatGPT，于是我嘗試測試 ChatGPT 能否發(fā)現(xiàn)這個 BUG，這篇文章會先介紹功能代碼，然后手動分析 BUG 原因,需要的朋友可以參考下

今天一個很簡單的功能，觸發(fā)了一個 BUG，處理后我想起了最近爆火的 ChatGPT，于是我嘗試測試 ChatGPT 能否發(fā)現(xiàn)這個 BUG。這篇文章會先介紹功能代碼，然后手動分析 BUG 原因；接著測試 ChatGPT 能否發(fā)現(xiàn)這個 BUG。

先說下結(jié)論，測試結(jié)束，ChatGPT 今后可能是我編程路上的好幫手。

前言

今天在測試一個準(zhǔn)備上線的新功能時，里面有一段簡單的函數(shù)，出現(xiàn)了一個 BUG。我先說一下這個函數(shù)的功能，看下你會怎么寫。

功能描述

輸入：一個文件夾路徑。

輸出：這個文件夾中的文件夾數(shù)量。

這是一個實現(xiàn)起來比較簡單的函數(shù)，我順手寫了下面的代碼：

String pathString = "/Users/darcy/";
File fileDir = new File(pathString);
if (!fileDir.exists() || !fileDir.isDirectory()) {
    throw new RuntimeException("xxx....");
}
String[] fileList = fileDir.list();
int count = 0;
for (String filePath : fileList) {
    if (new File(pathString + filePath).isDirectory()) {
        count++;
    }
}
System.out.println(count);

功能是實現(xiàn)了，但是很明顯，代碼比較繁瑣，于是我又順手優(yōu)化了一下。

Path path = Paths.get("/Users/darcy/");
if (!Files.exists(path) || !Files.isDirectory(path)) {
    throw new RuntimeException("xxx....");
}
long dirCount = Files.list(path).filter(Files::isDirectory).count();
System.out.println(dirCount);

效果是一樣的，因為使用了 JDK 7 引入的 Files 類，讓代碼簡單了不少。

不過正是這段代碼，觸發(fā)了 BUG，我先賣個關(guān)子，你先看下 BUG 在什么地方。

問題分析

你看出問題了嗎？改造后的代碼運(yùn)行少量次數(shù)的情況下，都是可以正常輸出的。但是它有一個問題，就是 Files.list 返回的 Stream 流沒有進(jìn)行關(guān)閉，這就導(dǎo)致如果這段代碼被頻繁的調(diào)用，一段時間后將會因為打開的文件過多而報錯，可以測試出這種異常情況。

問題復(fù)現(xiàn)

在循環(huán)中不斷運(yùn)行這段代碼：

 while (true){
     Path path = Paths.get("/Users/darcy/");
     if (!Files.exists(path) || !Files.isDirectory(path)) {
         throw new RuntimeException("xxx....");
     }
     long dirCount = Files.list(path).filter(Files::isDirectory).count();
     System.out.println(dirCount);
 }

一段時間后控制臺收到報錯：Too many open files

問題原因

報錯的原因是因為每個進(jìn)程可以打開的文件數(shù)量是有限制的，如果一直打開不進(jìn)行關(guān)閉，在達(dá)到限制時會報出這個錯誤。

不妨讓代碼運(yùn)行速度降低，然后監(jiān)控下隨著程序的運(yùn)行，運(yùn)行進(jìn)程持有的文件數(shù)是否不斷增加。

while (true){
    Path path = Paths.get("/Users/darcy/");
    if (!Files.exists(path) || !Files.isDirectory(path)) {
        throw new RuntimeException("xxx....");
    }
    long dirCount = Files.list(path).filter(Files::isDirectory).count();
    System.out.println(dirCount);
    Thread.sleep(1000);
}

下面是用到的命令。

## 查找進(jìn)程 ID
?  ~ jps -mlVv | grep testFileList
## 查看指定進(jìn)程引用的文件數(shù)量
?  ~ lsof -p 62248 | wc -l

從測試結(jié)果中可以看到隨著程序的運(yùn)行，進(jìn)程持有的文件數(shù)量不斷上升。

問題解決

原因已經(jīng)知道了，既然 Files.list 返回的 Stream 流沒有進(jìn)行關(guān)閉，那么進(jìn)行關(guān)閉就可以解決問題。

while (true){
    Path path = Paths.get("/Users/darcy/");
    if (!Files.exists(path) || !Files.isDirectory(path)) {
        throw new RuntimeException("xxx....");
    }
    // 方式1：手動關(guān)閉流
    // Stream<Path> pathStream = Files.list(path);
    // long dirCount = pathStream.filter(Files::isDirectory).count();
    // pathStream.close();
    // 方式2：使用 try resource 自動關(guān)閉流
    try (Stream<Path> pathStream = Files.list(path);){
        long dirCount = pathStream.filter(Files::isDirectory).count();
        System.out.println(dirCount);
    }
    Thread.sleep(1000);
}

再次運(yùn)行后，引用的文件數(shù)量不再上漲，BUG 解決。

?  ~ lsof -p 62879 | wc -l
     321
?  ~ lsof -p 62879 | wc -l
     321
?  ~ lsof -p 62879 | wc -l
     321
?  ~ lsof -p 62879 | wc -l
     321
?  ~ lsof -p 62879 | wc -l
     321
?  ~ lsof -p 62879 | wc -l
     321

ChatGPT 分析

如果這段代碼使用 ChatGPT 分析，它能發(fā)現(xiàn)問題嗎？我先告訴你答案，它能發(fā)現(xiàn)，而且描述的很好，并且給出了修復(fù)建議。

ChatGPT 分析代碼

我問：

下面這段 Java 代碼有什么問題嗎？

Path path = Paths.get("/Users/darcy/");
if (!Files.exists(path) || !Files.isDirectory(path)) {
    throw new RuntimeException("fileDir.isDirectory() error");
}
long dirCount = Files.list(path).filter(Files::isDirectory).count();
System.out.println(dirCount);

ChatGPT：

這段代碼首先會檢查 /Users/darcy/ 目錄是否存在并且是一個目錄，如果不是，則會拋出 RuntimeException。接著，它會計算 /Users/darcy/ 目錄下的子目錄數(shù)量并將其打印到控制臺。

這段代碼看起來沒有語法錯誤，但是在運(yùn)行時可能會拋出 IOException，因為對文件系統(tǒng)進(jìn)行操作時可能會出現(xiàn)各種異常情況。特別是，如果指定的路徑不存在，則會拋出 NoSuchFileException。因此，在代碼中最好捕獲可能發(fā)生的異常并進(jìn)行處理，或者在方法簽名中聲明拋出異常以通知調(diào)用方。

此外，還需要注意的是，Files.list(path) 方法返回的是一個 Stream<Path> 對象，需要注意其資源釋放問題，以避免潛在的資源泄漏問題。通常情況下，可以使用 try-with-resources 語句來自動關(guān)閉流，例如：

try (Stream<Path> stream = Files.list(path)) {
    long dirCount = stream.filter(Files::isDirectory).count();
    System.out.println(dirCount);
} catch (IOException e) {
    // 處理異常
}

下面是對話截圖：

ChatGPT 實現(xiàn)功能

問：

幫我用 Java 寫一串代碼。功能描述。

輸入：一個文件夾路徑。

輸出：這個文件夾中的文件夾數(shù)量。

ChatGPT 回答：

以下是 Java 代碼示例，用于計算指定文件夾路徑下的文件夾數(shù)量：

import java.io.File;

public class FolderCount {
    public static void main(String[] args) {
        String path = "path/to/folder"; // 替換成你的文件夾路徑
        File folder = new File(path);
        int count = 0;
        if (folder.isDirectory()) {
            File[] files = folder.listFiles();
            for (File file : files) {
                if (file.isDirectory()) {
                    count++;
                }
            }
        }
        System.out.println("該文件夾中的文件夾數(shù)量為：" + count);
    }
}

該程序首先接收一個文件夾路徑作為輸入，然后創(chuàng)建一個 File 對象來代表該文件夾。然后它遍歷該文件夾中的所有文件，如果找到一個文件夾，則將計數(shù)器加一。最后，它輸出計數(shù)器的值作為結(jié)果。

下面是對話截圖：

總結(jié)

在本文中，我們介紹了一個簡單功能的 Java 代碼 BUG，即未關(guān)閉 Files.list() 返回的流對象，導(dǎo)致程序運(yùn)行時可能會打開過多的文件而出現(xiàn)異常。我們通過手動分析代碼和測試，找出了問題所在，并提供了兩種解決方案，一種是手動關(guān)閉流，另一種是使用 try-with-resources 自動關(guān)閉流。最后，我們還使用 ChatGPT 測試了是否可以用 AI 自動識別代碼中存在的問題，結(jié)果表明 ChatGPT 可以幫助我們發(fā)現(xiàn)這類問題，為我們的編程工作提供了有力的支持。

上面這個總結(jié)，也是 ChatGPT 幫我寫的，相對于 ChatGPT 能給出具體的代碼，我更震驚于 ChatGPT 對于語義的理解，不僅能理解我的輸入，還能對代碼意思進(jìn)行自然語言描述。今后你很可能分辨不出你所閱讀的文章是人類寫的，還是 ChatGPT 自動生成的。

附錄：ChatGPT 寫代碼測試

以下測試結(jié)果都是 ChatGPT 的具體回答，我沒有改動一個字符。

問1

幫我用 Java 寫一段代碼。

輸入：一個時間字符串，這個時間信息包含年月日時分秒。

處理：提取時間字符串中的月份輸出：這個月份有多少天

ChatGPT 回答：

以下是一個示例Java代碼，它接受一個時間字符串作為輸入，并從中提取出月份并計算該月有多少天：

import java.time.*;
import java.time.format.DateTimeFormatter;

public class MonthDays {
    public static void main(String[] args) {
        String dateString = "2023-02-14 12:34:56"; // 輸入時間字符串
        DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");
        LocalDateTime dateTime = LocalDateTime.parse(dateString, formatter);
        int daysInMonth = YearMonth.from(dateTime).lengthOfMonth(); // 提取月份并計算該月有多少天
        System.out.println(daysInMonth); // 輸出該月天數(shù)
    }
}

在這個示例中，我們使用了Java 8引入的java.time包來處理日期和時間。首先，我們將輸入時間字符串解析為一個LocalDateTime對象。然后，我們從LocalDateTime對象中提取出年月，并使用YearMonth類的lengthOfMonth()方法計算該月份有多少天。最后，我們將該天數(shù)輸出到控制臺。

下面是測試截圖：

問2

幫我用 Java 寫一段代碼。

輸入：一個時間字符串，這個時間信息包含年月日時分秒。

輸出：把這個時間字符串進(jìn)行轉(zhuǎn)換。獲取這個時間當(dāng)天的第三小時第一秒

ChatGPT 回答：

以下是用 Java 實現(xiàn)獲取輸入時間當(dāng)天第三小時第一秒的代碼示例：

import java.time.LocalDateTime;
import java.time.LocalTime;
import java.time.format.DateTimeFormatter;

public class Main {
    public static void main(String[] args) {
        String timeString = "2023-02-14 12:34:56"; // 代表輸入的時間字符串
        DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");
        LocalDateTime dateTime = LocalDateTime.parse(timeString, formatter); // 解析時間字符串

        // 獲取當(dāng)天的3:00:01
        LocalDateTime targetDateTime = LocalDateTime.of(dateTime.toLocalDate(), LocalTime.of(3, 0, 1));
        System.out.println(targetDateTime);
    }
}

解釋：

首先，定義一個代表輸入時間的字符串 timeString。
然后，使用 DateTimeFormatter 類創(chuàng)建一個日期時間格式化器，以便將時間字符串轉(zhuǎn)換為 LocalDateTime 對象。此處使用的格式化器模式字符串為 "yyyy-MM-dd HH:mm:ss"，其中：

yyyy 代表四位數(shù)的年份，例如 2023。
MM 代表兩位數(shù)的月份，例如 02。
dd 代表兩位數(shù)的日期，例如 14。
HH 代表兩位數(shù)的小時數(shù)（24 小時制），例如 12。
mm 代表兩位數(shù)的分鐘數(shù)，例如 34。
ss 代表兩位數(shù)的秒數(shù)，例如 56。

使用 LocalDateTime.parse() 方法將時間字符串解析為 LocalDateTime 對象。
接下來，使用 LocalDateTime.toLocalDate() 方法獲取輸入時間所在的日期，并使用 LocalTime.of() 方法創(chuàng)建一個 LocalTime 對象，代表目標(biāo)時間當(dāng)天的 3:00:01。
最后，使用 LocalDateTime.of() 方法將日期和時間組合成一個 LocalDateTime 對象，即獲取了輸入時間當(dāng)天的第三小時第一秒。打印該對象即可。

注意：這里的代碼示例假設(shè)輸入時間字符串的格式是固定的。如果輸入時間的格式可能會發(fā)生變化，需要根據(jù)實際情況調(diào)整格式化器模式字符串。

問3

幫我用 Java 寫一段代碼。
輸入：一個長度為10的全是小寫字母的字符串
處理1：把這個字符串按字母逆序
處理2：把這個字符串第3,6,9位字母轉(zhuǎn)換成大寫
處理3：截取字符串的前7位進(jìn)行輸出

ChatGPT 回答：

以下是用 Java 實現(xiàn)對輸入字符串進(jìn)行處理的代碼示例：

public class Main {
    public static void main(String[] args) {
        String inputStr = "abcdefghij"; // 輸入的字符串

        // 處理1：按字母逆序
        String reverseStr = new StringBuilder(inputStr).reverse().toString();

        // 處理2：第3,6,9位字母轉(zhuǎn)換成大寫
        StringBuilder resultStrBuilder = new StringBuilder(reverseStr);
        resultStrBuilder.setCharAt(2, Character.toUpperCase(reverseStr.charAt(2)));
        resultStrBuilder.setCharAt(5, Character.toUpperCase(reverseStr.charAt(5)));
        resultStrBuilder.setCharAt(8, Character.toUpperCase(reverseStr.charAt(8)));
        String resultStr = resultStrBuilder.toString();

        // 處理3：截取前7位進(jìn)行輸出
        String outputStr = resultStr.substring(0, 7);

        System.out.println(outputStr);
    }
}

解釋：

首先，定義一個代表輸入字符串的變量 inputStr。
處理1：使用 StringBuilder 類的 reverse() 方法將字符串逆序，并使用 toString() 方法轉(zhuǎn)換為普通字符串。將逆序后的字符串保存在 reverseStr 變量中。
處理2：使用 StringBuilder 類創(chuàng)建一個新的字符串構(gòu)建器，將逆序后的字符串 reverseStr 作為初始字符串。