二进制文件.Read不按预期处理结构体填充

Question

在最近的一个Go项目中，我需要读取由Python生成的二进制数据文件，但由于填充，Go中的binary.Read不能正确读取。下面是我的问题的一个最小的例子:

结构体I处理以下格式

type Index struct{
    A int32
    B int32
    C int32
    D int64
}

可以看到结构体的大小是4+4+4+8=20，但是Python为对齐增加了额外的4个字节。所以尺寸实际上是24。

下面是我用来编写这个结构体的可运行Python代码:

#!/usr/bin/env python
# encoding=utf8
import struct
if __name__ == '__main__':
    data = range(1, 13)
    format = 'iiiq' * 3
    content = struct.pack(format, *data)
    with open('index.bin', 'wb') as f:
        f.write(content)

iiiq格式意味着结构体中有三个32位整数和一个64位整数，这与我之前定义的Index结构体相同。运行这段代码将生成一个名为index.bin的文件，大小为72，等于24 * 3。

下面是我用来读取index.bin的Go代码:

package main
import (
        "encoding/binary"
        "fmt"
        "os"
        "io"
        "unsafe"
)
type Index struct {
        A int32
        B int32
        C int32
        D int64
}
func main() {
        indexSize := unsafe.Sizeof(Index{})
        fp, _ := os.Open("index.bin")
        defer fp.Close()
        info, _ := fp.Stat()
        fileSize := info.Size()
        entryCnt := fileSize / int64(indexSize)
        fmt.Printf("entry cnt: %dn", entryCnt)
        readSlice := make([]Index, entryCnt)
        reader := io.Reader(fp)
        _ = binary.Read(reader, binary.LittleEndian, &readSlice)
        fmt.Printf("After read:n%#vn", readSlice)
}

输出:

entry cnt: 3
After read:
[]main.Index{main.Index{A:1, B:2, C:3, D:17179869184}, main.Index{A:0, B:5, C:6, D:7}, main.Index{A:8, B:0, C:9, D:47244640266}}

显然，从Python生成的文件中读取时，输出是混乱的。

所以我的问题是，我怎么能读python生成的文件(填充)在Go正确?

Answer 1

你可以填充你的Go结构来匹配:

type Index struct {
    A int32
    B int32
    C int32
    _ int32
    D int64
}

生产:

[]main.Index{main.Index{A:1, B:2, C:3, _:0, D:4}, main.Index{A:5, B:6, C:7, _:0, D:8}, main.Index{A:9, B:10, C:11, _:0, D:12}}

binary.Read知道跳过_字段:

当读入结构体时，字段名为空(_)的字段数据将被跳过;例如，空白字段名可用于填充。

(所以_的0值不是因为文件中的填充设置为零，而是因为struct字段初始化为0并且从未更改，并且文件中的填充被跳过而不是读取。)

Answer 2

例如

package main
import (
    "bufio"
    "encoding/binary"
    "fmt"
    "io"
    "os"
)
type Index struct {
    A int32
    B int32
    C int32
    D int64
}
func readIndex(r io.Reader) (Index, error) {
    var index Index
    var buf [24]byte
    _, err := io.ReadFull(r, buf[:])
    if err != nil {
        return index, err
    }
    index.A = int32(binary.LittleEndian.Uint32(buf[0:4]))
    index.B = int32(binary.LittleEndian.Uint32(buf[4:8]))
    index.C = int32(binary.LittleEndian.Uint32(buf[8:12]))
    index.D = int64(binary.LittleEndian.Uint64(buf[16:24]))
    return index, nil
}
func main() {
    f, err := os.Open("index.bin")
    if err != nil {
        fmt.Fprintln(os.Stderr, err)
        return
    }
    defer f.Close()
    r := bufio.NewReader(f)
    indexes := make([]Index, 0, 1024)
    for {
        index, err := readIndex(r)
        if err != nil {
            if err == io.EOF {
                break
            }
            fmt.Fprintln(os.Stderr, err)
            return
        }
        indexes = append(indexes, index)
    }
    fmt.Println(indexes)
}

输出:

[{1 2 3 4} {5 6 7 8} {9 10 11 12}]

输入:

00000000  01 00 00 00 02 00 00 00  03 00 00 00 00 00 00 00  |................|
00000010  04 00 00 00 00 00 00 00  05 00 00 00 06 00 00 00  |................|
00000020  07 00 00 00 00 00 00 00  08 00 00 00 00 00 00 00  |................|
00000030  09 00 00 00 0a 00 00 00  0b 00 00 00 00 00 00 00  |................|
00000040  0c 00 00 00 00 00 00 00                           |........|

Answer 3

@Barber的解决方案是可行的，但我发现添加填充字段不是那么舒服。我发现了一个更好的方法。

下面是新的golang read代码，它工作得很好:

package main
import (
    "fmt"
    "os"
    "io"
    "io/ioutil"
    "unsafe"
)
type Index struct {
    A int32
    B int32
    C int32
    // Pad int32
    D int64
}
func main() {
    indexSize := unsafe.Sizeof(Index{})
    fp, _ := os.Open("index.bin")
    defer fp.Close()
    info, _ := fp.Stat()
    fileSize := info.Size()
    entryCnt := fileSize / int64(indexSize)
    reader := io.Reader(fp)
    allBytes, _ := ioutil.ReadAll(reader)
    readSlice := *((*[]Index)(unsafe.Pointer(&allBytes)))
    realLen := len(allBytes) / int(indexSize)
    readSlice = readSlice[:realLen]
    fmt.Printf("After read:n%#vn", readSlice)
}

输出:

After read:
[]main.Index{main.Index{A:1, B:2, C:3, D:4}, main.Index{A:5, B:6, C:7, D:8}, main.Index{A:9, B:10, C:11, D:12}}

此解决方案不需要显式填充字段。

这里的本质是，如果您让golang将整个字节转换为Index结构体的切片，它似乎能够很好地处理填充。