结合使用 Golang Validator 和 SqlC 的方法

通过利用 SQLC 的 `overrides` 配置，可以将验证规则直接添加到表结构中。这使得可以在使用表结构进行查询时自动应用验证，而无需创建单独的验证结构。这种方法简化了代码，提高了可维护性，并确保在处理数据库操作时始终进行数据验证。

有没有办法将 json 验证 [github.com/go-演示/validator/v10] 和 json 查询 [sqlc] 结合起来，而不必创建两个不同的结构？

我有下表定义

create table table1 (
   columnname1 varchar(200) not null primary key,
   columnname2 varchar(200) not null
)

以及以下查询

-- name: gettable1:one
select * from table1
where columnname1 = $1 limit 1;

执行sqlc生成以下代码

...
// 
// this struct is created automatically by sqlc
//
type createtable1params struct {
    columnname1 string                `json:"columnname1"`
    columnname2 string                `json:"columnname2"`
}

func (q *queries) createtable1(ctx context.context, arg createtable1params ) (table1, error) {
...
}

现在，我需要验证 createtable1 的 rest 参数，假设需要 columnname2，因此我有一个如下所示的控制器包

table1controller.go

import (
    ...
    validator "github.com/go-playground/validator/v10"
)

type Table1Controller struct {
    Validate   *validator.Validate
}

//
// This struct is created manually for validation
//
type InT1Param struct {
    ColumnName1 string `validate:"required" form:"columnName1" json:"columnName1" db:"columnname1"`
    ColumnName2 string `validate:"required" form:"columnName2" json:"columnName2" db:"columnname2" binding="required"`
}

func (c *Table1Controller) validateInput(t1 InT1Param) error {
    err := service.Validate.Struct(t1)
    if err != nil {
        errStr := ""
        for _, mapErr := range err.(validator.ValidationErrors) {
            errStr = fmt.Sprintf("%s%s\n", errStr, mapErr.Translate(service.Translator))
        }
        return errors.New(errStr)
    }

    return nil
}

func (c *Table1Controller) Insert(ctx *gin.Context, dbQueries *dbModel.Queries, t1 InT1Param) error {
    err := c.validateInput(t1)
    if err != nil {
        return err

    inParam = dbModel.CreateTable1Param {
        Columnname1: t1.columnName1,
        Columnname2: t2.ColumnName2
    }

    outParam, err := dbQueries.CreateTable1(ctx, inParam)
    if err != nil {
        return err

    return nil
}

正确答案

使用 sqlc.yaml 配置的 overrides 键，我能够将以下字段添加到列中。

version: 2
sql:
  - schema: "./dbmodel/migration/schema_20221008.sql"
    queries: "./dbmodel/query/query.sql"
    engine: "postgresql"
    gen:
      go:
        package: "dbmodel"
        out: "dbmodel"
        emit_json_tags: true
        emit_db_tags: true
        emit_prepared_queries: false
        emit_interface: false
        emit_exact_table_names: false
        json_tags_case_style: camel
        overrides:
          - column: table1.column_name1
            go_struct_tag: validate:"required" x:"y,z"
          - column: table1.column_name2
            go_struct_tag: validate:"required"

此配置为表生成了以下结构：

type table1 struct {
    ColumnName1 string `db:"column_name1" json:"columnName1" validate:"required" x:"y,z"`
    ColumnName2 string `db:"column_name2" json:"columnName2" validate:"required"`

我无法更改 param 结构，但我猜想使用表主结构来进行验证。

好了，本文到此结束，带大家了解了《结合使用 Golang Validator 和 SqlC 的方法》，希望本文对你有所帮助！关注golang学习网公众号，给大家分享更多Golang知识！