GORM：将PostgreSQL bytea类型序列化为十六进制字符串

针对你遇到的PostgreSQL bytea字段返回Base64格式、需要转为带0x前缀十六进制格式的问题，提供三个可行方案：

方案一：自定义JSON序列化方法 #

直接修改Transaction结构体的JSON序列化逻辑，将[]byte类型的Hash转换为带0x前缀的十六进制字符串，无需改动查询代码。

import (
    "encoding/hex"
    "encoding/json"
)

type Transaction struct {
    Hash []byte `gorm:"column:hash"`
}

// MarshalJSON 自定义JSON序列化逻辑
func (t Transaction) MarshalJSON() ([]byte, error) {
    // 将[]byte转为十六进制字符串并添加0x前缀
    hashHex := "0x" + hex.EncodeToString(t.Hash)
    // 构造临时结构体用于序列化
    return json.Marshal(struct {
        Hash string `json:"hash"`
    }{
        Hash: hashHex,
    })
}

修改后，c.JSON返回的结果会自动将Hash字段转为你期望的格式。

方案二：查询时直接用SQL函数转换 #

在GORM查询中使用PostgreSQL的encode函数，直接将bytea转为带0x前缀的字符串，同时修改结构体的Hash字段类型为string。

1. 修改结构体 #

type Transaction struct {
    Hash string `gorm:"column:hash_hex" json:"hash"`
}

2. 修改查询代码 #

func GetAllTransactions(c *gin.Context) {
    var transactions []models.Transaction
    // 使用Select指定转换后的字段别名
    initializers.Database.Select("'0x' || encode(hash, 'hex') as hash_hex").Limit(10).Find(&transactions)

    c.JSON(http.StatusOK, gin.H{"result": transactions})
}

这个方案直接在数据库层面完成转换，适合不需要在Go程序中操作原始[]byte数据的场景。

方案三：正确实现Scanner/Valuer接口 #

通过实现sql.Scanner和driver.Valuer接口，实现数据库读写时自动转换格式，同时满足程序内字符串与字节数组的转换需求。

import (
    "database/sql/driver"
    "encoding/hex"
    "fmt"
)

type Transaction struct {
    Hash string `json:"hash"`
}

// Scan 实现sql.Scanner接口，读取数据库bytea时转为带0x的十六进制字符串
func (t *Transaction) Scan(value interface{}) error {
    b, ok := value.([]byte)
    if !ok {
        return fmt.Errorf("invalid hash type: expected []byte, got %T", value)
    }
    t.Hash = "0x" + hex.EncodeToString(b)
    return nil
}

// Value 实现driver.Valuer接口，写入数据库时将带0x的字符串转为bytea
func (t Transaction) Value() (driver.Value, error) {
    // 校验格式，去掉0x前缀
    if len(t.Hash) < 2 || t.Hash[:2] != "0x" {
        return nil, fmt.Errorf("hash must start with 0x")
    }
    b, err := hex.DecodeString(t.Hash[2:])
    if err != nil {
        return nil, fmt.Errorf("failed to decode hash: %w", err)
    }
    return b, nil
}

这个方案适用于需要同时处理数据库读写、且希望在程序中以字符串形式操作Hash的场景。

内容的提问来源于stack exchange，提问作者Meldum