Go types.Struct 怎样配合 Sizes 生成字段偏移报告

如果你正在做 Go 源码分析、静态检查或代码生成，想知道一个结构体的每个字段从第几个字节开始，可以把 go/types.Struct 当作字段模型，把 go/types.Sizes 当作布局计算器。核心做法是：先用 types.NewStruct 保存字段顺序，再用与目标编译器和架构匹配的 Sizes.Offsetsof 取得字节偏移，最后用 Alignof 和 Sizeof 补齐对齐与总大小。

先分清 Struct、Sizes 和运行时偏移

go/types.Struct 表示一个结构体类型，能够按索引取字段、读取字段数量和字段标签。它保存的是“有哪些字段、字段顺序是什么”，并不会独自决定不同架构下的字节布局。

go/types.Sizes 才是布局计算的接口。它提供 Alignof、Offsetsof 和 Sizeof 三组能力，分别对应类型对齐、字段偏移和类型大小。SizesFor 可以按 compiler 与 arch 取得常用实现；如果组合未知，返回值可能是 nil。

这个模型和运行时的 unsafe.Offsetof 解决的问题不完全相同。unsafe.Offsetof 需要一个实际的 Go 类型表达式，而这里的报告可以来自解析器或类型检查器构造出的字段模型，适合做静态分析和代码生成。

用 types.NewStruct 构造可分析的字段集合

为了让示例集中在布局计算上，先手工创建四个字段：int32、bool、string 和 []byte。字段顺序故意混合不同的对齐要求，这样更容易观察 padding。

package main

import (
    "go/token"
    "go/types"
)

func buildRecord() *types.Struct {
    fields := []*types.Var{
        // 保留字段名，报告可以直接面向源码阅读者。
        types.NewVar(token.NoPos, nil, "Count", types.Typ[types.Int32]),
        // bool 的尺寸和对齐通常小于后面的字符串字段。
        types.NewVar(token.NoPos, nil, "Flag", types.Typ[types.Bool]),
        // string 与切片都能体现字长对布局的影响。
        types.NewVar(token.NoPos, nil, "Name", types.Typ[types.String]),
        types.NewVar(token.NoPos, nil, "Data", types.NewSlice(types.Typ[types.Byte])),
    }

    // tags 可以传 nil；这里不需要伪造结构体标签。
    return types.NewStruct(fields, nil)
}

NewStruct 接收字段切片和对应标签。字段的索引就是后续报告中的稳定顺序，因此不要在计算完偏移后再无序地放入 map。若分析的是源码中的空白字段或嵌入字段，NumFields 也会把它们计入字段数量。

选择 SizesFor，再调用 Offsetsof 取得字节偏移

报告必须先声明目标环境。下面以 gc 编译器的 amd64 布局为例；如果你的分析对象来自 arm64、wasm 或其他架构，应传入对应架构，并把架构信息一起写入报告。

type FieldOffset struct {
    // Name 和 Type 让报告脱离内部索引后仍然可读。
    Name   string
    Type   string
    Offset int64
}

func collectOffsets(st *types.Struct, sizes types.Sizes) []FieldOffset {
    fields := make([]*types.Var, st.NumFields())
    for i := 0; i 

上面的完整程序还需要在 import 中加入 fmt；这里把关键函数拆开，是为了突出数据流。实际项目中要保留 nil 检查，避免未知架构导致后续调用崩溃。

在常见 64 位布局假设下，这组字段的结果可以理解为：Count 从 0 开始，Flag 接在其后，Name 为满足更大对齐要求而向后移动，Data 再按切片布局开始。具体数字应由所选 Sizes 实现决定，报告中不要把一个架构的数字硬编码成所有环境都成立。

把 Alignof 和 Sizeof 一起写进报告

只有字段偏移还不够。读者还需要知道结构体自身的对齐和总大小，才能判断它是否会在数组中留下尾部 padding，也才能比较字段排序是否改变了布局。

type LayoutReport struct {
    // Compiler 和 Arch 说明这些数字适用于哪个布局模型。
    Compiler string
    Arch     string
    Align    int64
    Size     int64
    Fields   []FieldOffset
}

func makeLayoutReport(st *types.Struct) (LayoutReport, error) {
    const compiler = "gc"
    const arch = "amd64"

    sizes := types.SizesFor(compiler, arch)
    if sizes == nil {
        // 调用方可以把错误交给命令行或编辑器，而不是输出半份报告。
        return LayoutReport{}, fmt.Errorf("unknown sizes for %s/%s", compiler, arch)
    }

    // Alignof 说明结构体在数组元素或外层结构体中的对齐要求。
    return LayoutReport{
        Compiler: compiler,
        Arch:     arch,
        Align:    sizes.Alignof(st),
        Size:     sizes.Sizeof(st),
        Fields:   collectOffsets(st, sizes),
    }, nil
}

StdSizes 的文档说明了几个重要假设：字符串和接口按两个 word 计算，切片按三个 word 计算，结构体大小是最后字段结束位置再结合对齐得到的结果。因而在 64 位模型里，string 和 []byte 都会明显影响总大小。

为什么报告中会出现 padding

偏移不是简单地把前一个字段的大小相加。当前字段开始前，布局实现会把位置向上取整到该字段要求的对齐边界。例如一个 4 字节字段后面放置需要 8 字节对齐的字段，中间就可能出现空洞；这个空洞不对应某个源码字段，却会反映在下一个字段的偏移上。

字段顺序本身可能影响总大小。一个偏移报告可以让工具先展示当前布局，再对候选字段顺序计算另一份报告；但不要只按“总大小变小”自动重排，还需要考虑源码可读性、序列化协议、反射标签和兼容性。

把报告做成可比较的输出

建议至少保存以下信息：compiler、arch、结构体名称、字段名、字段类型、偏移、结构体对齐和总大小。这样当 CI 从 amd64 切到 arm64 时，差异会明确显示为布局模型变化，而不是被误认为源码字段发生变化。

func printReport(r LayoutReport) {
    // 输出固定列，便于人工阅读，也便于后续改成 JSON 编码。
    fmt.Printf("layout: %s/%s align=%d size=%d\n", r.Compiler, r.Arch, r.Align, r.Size)
    for _, field := range r.Fields {
        // 偏移直接使用字节单位，避免把 word 和 byte 混在一起。
        fmt.Printf("%-8s %-12s offset=%d\n", field.Name, field.Type, field.Offset)
    }
}

如果要输出 JSON，可以把同样的结构交给 encoding/json，但要在字段旁边保留单位和架构元数据。不要只输出一串数字，否则下游无法判断数字来自哪个编译器布局，也无法区分字段偏移和结构体总大小。

常见问题

为什么不直接用 reflect.Type.Field(i).Offset？

reflect 面向运行时 Go 类型；go/types 面向类型检查和源码分析。若字段来自尚未构建成运行时类型的源码模型，使用 Struct 和 Sizes 更自然。

Offsetsof 返回的是地址吗？

不是。它返回相对于结构体起点的字节偏移，属于布局描述；它不包含某个对象在堆或栈上的实际地址。

换成 arm64 只改报告里的 arch 字符串可以吗？

不建议只改字符串。应重新调用 SizesFor("gc", "arm64")，并用这份 Sizes 重新计算偏移、对齐和总大小。

字段中间的 padding 可以从 Offsetsof 单独拿到吗？

Offsetsof 直接给字段起点；padding 通常通过当前字段偏移减去前一个字段结束位置推导，尾部 padding 则通过 Sizeof(st) 与最后字段结束位置比较。