Go io.Reader 包装器实现指南：解密 Read 方法中的常见陷阱

package main

import (
    "io"
    "os"
    "strings"
)

// rot13Reader 结构体包装了一个 io.Reader
type rot13Reader struct {
    r io.Reader // 底层的 io.Reader
}

// cipher 函数实现 rot13 编码逻辑
// 它接收一个字节，如果是字母则进行 ROT13 转换，否则原样返回
func cipher(in byte) (out byte) {
    out = in
    switch {
    case in >= 'A' && in <= 'Z': // 大写字母 A-Z
        out = ((in - 'A' + 13) % 26) + 'A'
    case in >= 'a' && in <= 'z': // 小写字母 a-z
        out = ((in - 'a' + 13) % 26) + 'a'
    }
    return
}

// 错误的 Read 方法实现示例
func (reader rot13Reader) Read(p []byte) (n int, err error) {
    // 错误：先对 p 缓冲区中的数据进行加密
    // 此时 p 中可能包含未初始化或上次读取的旧数据
    for index := range p {
        p[index] = cipher(p[index])
    }

    // 然后从底层 reader 读取数据，并覆盖了 p 中刚才加密过的内容
    n, err = reader.r.Read(p)
    return
}

// Read 方法是 rot13Reader 实现 io.Reader 接口的关键
// 它的职责是从底层读取数据，并对数据进行 rot13 转换
func (reader rot13Reader) Read(p []byte) (n int, err error) {
    // 1. 首先从底层 reader 读取数据到 p 缓冲区
    // n 是实际读取的字节数，err 是读取过程中遇到的错误
    // 这一步确保了 p 中包含了来自底层 reader 的最新数据
    n, err = reader.r.Read(p)

    // 2. 遍历实际读取到的 n 个字节，并进行 rot13 转换
    // 注意：只对 n 个字节进行操作，因为只有这 n 个字节是有效数据
    for i := 0; i < n; i++ {
        p[i] = cipher(p[i])
    }

    // 3. 返回实际读取的字节数 n 和任何潜在的错误 err
    // 包装器应该透传底层 reader 的错误
    return n, err
}

package main

import (
    "io"
    "os"
    "strings"
)

// rot13Reader 结构体包装了一个 io.Reader
type rot13Reader struct {
    r io.Reader
}

// cipher 函数实现 rot13 编码逻辑
func cipher(in byte) (out byte) {
    out = in
    switch {
    case in >= 'A' && in <= 'Z': // 大写字母 A-Z
        out = ((in - 'A' + 13) % 26) + 'A'
    case in >= 'a' && in <= 'z': // 小写字母 a-z
        out = ((in - 'a' + 13) % 26) + 'a'
    }
    return
}

// Read 方法是 rot13Reader 实现 io.Reader 接口的关键
func (reader rot13Reader) Read(p []byte) (n int, err error) {
    // 1. 从底层 reader 读取数据
    n, err = reader.r.Read(p)

    // 2. 对实际读取到的 n 个字节进行 rot13 转换
    for i := 0; i < n; i++ {
        p[i] = cipher(p[i])
    }

    // 3. 返回结果
    return n, err
}

func main() {
    // 创建一个 strings.Reader 作为底层数据源。
    // "Lbh penpxrq gur pbqr!\n" 是 "You cracked the code!\n" 的 rot13 编码。
    // 因此，使用 rot13Reader 再次转换会将其解码回原始文本。
    s := strings.NewReader(
        "Lbh penpxrq gur pbqr!\n")

    // 创建 rot13Reader 实例，包装 s
    r := rot13Reader{s}

    // 使用 io.Copy 将 rot13Reader 的内容（解码后的文本）复制到标准输出
    // io.Copy 会反复调用 r.Read 方法直到数据读取完毕或发生错误
    io.Copy(os.Stdout, &r)
}

You cracked the code!