（每日持续更新）jdk api之BufferedReader基础

1.8 BufferedReader

BufferedReader 是 Java 中 Reader 的缓冲流实现，用于提高读取字符数据的性能。它提供了一些额外的属性和方法，以增强对字符流的操作。

以下是 BufferedReader 的一些常用属性和方法：

属性：

1. protected char[] cb：
   • 用于存储缓冲数据的字符数组。可以通过构造函数指定缓冲区大小，也可以通过 getBuf() 方法获取。
2. protected int nChars：
   • 缓冲区中当前有效字符的数量。
3. protected int nextChar：
   • 下一个要被读取的字符的索引。当达到缓冲区末尾时，会触发填充缓冲区的操作。
4. protected Reader in：
   • 内部原始的字符输入流。可以通过构造函数传入或通过 getIn() 方法获取。

构造函数：

1. BufferedReader(Reader in)：
   • 使用默认缓冲区大小创建 BufferedReader 对象。
2. BufferedReader(Reader in, int size)：
   • 使用指定缓冲区大小创建 BufferedReader 对象。

方法：

1. void close()：
   • 关闭字符输入流及其底层流。
2. void mark(int readAheadLimit)：
   • 在当前流位置设置标记，最多允许跳过 readAheadLimit 个字符。
3. boolean markSupported()：
   • 判断此流是否支持 mark 和 reset 操作。
4. int read()：
   • 读取单个字符。返回读取的字符的 Unicode 值，如果已到达流的末尾，则返回 -1。
5. int read(char[] cbuf, int off, int len)：
   • 将字符读入数组 cbuf，从偏移量 off 开始，最多读取 len 个字符。返回实际读取的字符数，如果已到达流的末尾，则返回 -1。
6. String readLine()：
   • 读取一行文本。返回包含行内容的字符串，不包括行终止符（\r、\n 或 \r\n）。
7. boolean ready()：
   • 判断是否可以从流中读取数据，而不会被阻塞。
8. void reset()：
   • 将流的位置重置到最后一次调用 mark 方法设置的位置。
9. long skip(long n)：
   • 跳过输入流中的 n 个字符。

使用示例：

javaCopy code
import java.io.BufferedReader;
import java.io.FileReader;
import java.io.IOException;

public class BufferedReaderExample {

    public static void main(String[] args) {
        String filePath = "example.txt";

        try (FileReader fileReader = new FileReader(filePath);
             BufferedReader bufferedReader = new BufferedReader(fileReader)) {

            String line;
            while ((line = bufferedReader.readLine()) != null) {
                // 处理读取的每一行文本
                System.out.println(line);
            }

        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

在这个例子中，BufferedReader 被用来包装一个 FileReader，以提供缓冲功能。通过 readLine 方法逐行读取文本文件内容。这种方式能够提高读取性能，减少与底层输入流的直接交互次数。

应用场景

BufferedReader 主要用于提高读取字符数据的性能，特别是在读取文本文件时。以下是一些适合使用 BufferedReader 的应用场景：

1. 文本文件读取：

   • 当从文本文件中逐行读取数据时，使用 BufferedReader 可以提高读取效率。

   javaCopy code
   try (FileReader fileReader = new FileReader("example.txt");
        BufferedReader bufferedReader = new BufferedReader(fileReader)) {
       String line;
       while ((line = bufferedReader.readLine()) != null) {
           // 处理读取的每一行文本
           System.out.println(line);
       }
   } catch (IOException e) {
       e.printStackTrace();
   }
   

2. 网络数据读取：

   • 在从网络连接中读取字符数据时，使用 BufferedReader 可以减少网络 I/O 操作，提高读取性能。

   javaCopy code
   try (Socket socket = new Socket("example.com", 80);
        InputStream socketInputStream = socket.getInputStream();
        InputStreamReader reader = new InputStreamReader(socketInputStream);
        BufferedReader bufferedReader = new BufferedReader(reader)) {
       String line;
       while ((line = bufferedReader.readLine()) != null) {
           // 处理读取的每一行文本
           System.out.println(line);
       }
   } catch (IOException e) {
       e.printStackTrace();
   }
   

3. 日志文件分析：

   • 当分析大型日志文件时，使用 BufferedReader 可以逐行读取日志信息，方便进行分析和处理。

   javaCopy code
   try (FileReader fileReader = new FileReader("application.log");
        BufferedReader bufferedReader = new BufferedReader(fileReader)) {
       String line;
       while ((line = bufferedReader.readLine()) != null) {
           // 分析日志信息
           // ...
       }
   } catch (IOException e) {
       e.printStackTrace();
   }
   

4. 配置文件解析：

   • 在解析配置文件时，使用 BufferedReader 可以方便地逐行读取配置信息。

   javaCopy code
   try (FileReader fileReader = new FileReader("config.properties");
        BufferedReader bufferedReader = new BufferedReader(fileReader)) {
       String line;
       while ((line = bufferedReader.readLine()) != null) {
           // 解析配置信息
           // ...
       }
   } catch (IOException e) {
       e.printStackTrace();
   }
   

总体而言，当需要频繁读取字符数据时，尤其是逐行读取文本文件时，使用 BufferedReader 可以减少 I/O 操作的次数，提高读取性能。在实际应用中，可以根据具体的场景和性能需求选择是否使用缓冲流。

实战例子

在实际项目中，BufferedReader 可以用于处理文本文件的读取。下面是一个简化的例子，模拟一个日志分析系统，从日志文件中读取数据并进行分析。

日志实体类：

javaCopy code
import java.util.Date;

public class LogEntry {
    private Date timestamp;
    private String message;

    // 构造方法、getter 和 setter 省略
}

日志分析器：

javaCopy code
import java.io.BufferedReader;
import java.io.FileReader;
import java.io.IOException;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.List;

public class LogAnalyzer {

    private static final String LOG_FILE_PATH = "application.log";

    public static void main(String[] args) {
        List<LogEntry> logEntries = readAndAnalyzeLogs();
        
        // 在实际项目中，可以进一步对 logEntries 进行分析和处理
        for (LogEntry entry : logEntries) {
            System.out.println(entry.getTimestamp() + " - " + entry.getMessage());
        }
    }

    private static List<LogEntry> readAndAnalyzeLogs() {
        List<LogEntry> logEntries = new ArrayList<>();

        try (FileReader fileReader = new FileReader(LOG_FILE_PATH);
             BufferedReader bufferedReader = new BufferedReader(fileReader)) {

            String line;
            while ((line = bufferedReader.readLine()) != null) {
                LogEntry logEntry = parseLogEntry(line);
                if (logEntry != null) {
                    logEntries.add(logEntry);
                }
            }

        } catch (IOException e) {
            e.printStackTrace();
        }

        return logEntries;
    }

    private static LogEntry parseLogEntry(String logLine) {
        try {
            // 假设日志的格式为 "yyyy-MM-dd HH:mm:ss - Log message"
            SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
            int timestampEndIndex = logLine.indexOf(" - ");
            if (timestampEndIndex != -1) {
                String timestampString = logLine.substring(0, timestampEndIndex);
                Date timestamp = dateFormat.parse(timestampString);
                String message = logLine.substring(timestampEndIndex + 3);
                return new LogEntry(timestamp, message);
            }
        } catch (ParseException e) {
            e.printStackTrace();
        }
        return null;
    }
}

在这个例子中，LogAnalyzer 类使用了 BufferedReader 从日志文件中读取数据。每一行日志都被解析为一个 LogEntry 对象，然后将这些对象存储在 logEntries 列表中。在实际项目中，你可以在 readAndAnalyzeLogs 方法中添加更多的日志分析逻辑。这个例子仅仅是一个演示，实际的日志分析系统可能会更加复杂。