GoLang中如何扫描包含空关联的SQL查询结果？

问题背景 #

我正在构建一个基于SQL数据库的API，Order类型在完成前其关联的Key ID为null。通过LEFT JOIN关联Key表查询所有订单时，期望在Key ID非空时填充密钥详情，为空时将finalizedKey设为null。现有代码直接扫描到*keyDb字段会报错，且不想为每个订单单独查询密钥（避免N+1查询问题）。

相关结构体 #

type orderDb struct {
    id             int
    certificate    certificateDb
    location       string
    status         string
    knownRevoked   bool
    err            sql.NullString // stored as json object
    expires        sql.NullInt32
    dnsIdentifiers commaJoinedStrings // will be a comma separated list from storage
    authorizations commaJoinedStrings // will be a comma separated list from storage
    finalize       string
    finalizedKey   *keyDb
    certificateUrl sql.NullString
    pem            sql.NullString
    validFrom      sql.NullInt32
    validTo        sql.NullInt32
    createdAt      int
    updatedAt      int
}

type keyDb struct {
    id             int
    name           string
    description    string
    algorithmValue string
    pem            string
    apiKey         string
    apiKeyViaUrl   bool
    createdAt      int
    updatedAt      int
}

现有SQL与扫描代码片段 #

query := `
SELECT
    ao.id, ao.status, ao.known_revoked, ao.error, ao.dns_identifiers, ao.valid_from,
    ao.valid_to, ao.created_at, ao.updated_at, 
    pk.id, pk.name, pk.description, pk.algorithm_value, pk.pem, pk.api_key, pk.api_key_via_url, pk.created_at, pk.updated_at,
    c.id, c.name, c.subject,
    aa.id, aa.name, aa.is_staging
FROM
    acme_orders ao
    LEFT JOIN private_keys pk on (ao.finalized_key_id = pk.id)
    LEFT JOIN certificates c on (ao.certificate_id = c.id)
    LEFT JOIN acme_accounts aa on (c.acme_account_id = aa.id)
`

// 原扫描代码会因finalizedKey为nil而panic
err = rows.Scan(
    &oneOrder.id,
    &oneOrder.status,
    &oneOrder.knownRevoked,
    &oneOrder.err,
    &oneOrder.dnsIdentifiers,
    &oneOrder.validFrom,
    &oneOrder.validTo,
    &oneOrder.createdAt,
    &oneOrder.updatedAt,
    &oneOrder.finalizedKey.id, // 当pk.id为null时，此处指针为空导致panic
    &oneOrder.finalizedKey.name,
    // ... 其他字段
)

解决方案 #

核心思路是先用临时变量接收LEFT JOIN返回的可能为null的字段，再根据字段是否有效决定是否初始化关联对象，具体步骤如下：

1. 定义临时变量接收Key表字段：使用sql.NullXXX类型处理可能为null的数据库字段，确保扫描时不会panic。
2. 扫描到临时变量：将LEFT JOIN返回的Key字段扫描到这些临时变量中，而非直接关联到orderDb的finalizedKey指针。
3. 判断并初始化关联对象：如果Key的ID字段有效（即存在关联记录），则初始化finalizedKey并赋值；否则将其设为nil。

完整实现代码 #

// 声明临时变量，对应Key表的所有字段，用sql.NullXXX处理null
var pkID sql.NullInt32
var pkName sql.NullString
var pkDesc sql.NullString
var pkAlg sql.NullString
var pkPem sql.NullString
var pkApiKey sql.NullString
var pkApiKeyViaUrl sql.NullBool
var pkCreatedAt sql.NullInt32
var pkUpdatedAt sql.NullInt32

// 扫描所有字段到对应变量，包括临时变量
err = rows.Scan(
    &oneOrder.id,
    &oneOrder.status,
    &oneOrder.knownRevoked,
    &oneOrder.err,
    &oneOrder.dnsIdentifiers,
    &oneOrder.validFrom,
    &oneOrder.validTo,
    &oneOrder.createdAt,
    &oneOrder.updatedAt,
    &pkID,
    &pkName,
    &pkDesc,
    &pkAlg,
    &pkPem,
    &pkApiKey,
    &pkApiKeyViaUrl,
    &pkCreatedAt,
    &pkUpdatedAt,
    // ... 扫描certificate和acme_accounts的字段到对应变量或结构体
)
if err != nil {
    return err
}

// 根据Key ID是否有效，决定初始化finalizedKey还是设为nil
if pkID.Valid {
    oneOrder.finalizedKey = &keyDb{
        id:             int(pkID.Int32),
        name:           pkName.String,
        description:    pkDesc.String,
        algorithmValue: pkAlg.String,
        pem:            pkPem.String,
        apiKey:         pkApiKey.String,
        apiKeyViaUrl:   pkApiKeyViaUrl.Bool,
        createdAt:      int(pkCreatedAt.Int32),
        updatedAt:      int(pkUpdatedAt.Int32),
    }
} else {
    oneOrder.finalizedKey = nil
}

关键注意事项 #

• SQL查询要包含所有需要的Key字段：确保SELECT语句中列出keyDb结构体的所有字段，否则无法完整填充对象。
• 其他关联对象同理处理：比如certificate字段如果是LEFT JOIN的结果，也需要用相同的方式处理，避免因关联记录不存在导致的panic。
• 保持字段顺序一致：Scan的变量顺序必须严格对应SQL SELECT的字段顺序，否则会出现赋值错误。

内容的提问来源于stack exchange，提问作者Greg T. Wallace