Yao 在 url 请求中使用 QueryParam 查询语法

QueryParam可以理解为查询参数，用于构建数据查询条件。使用结构化的思维把 url 参数转换成SQL查询条件。是Yao应用开发中使用比较频繁的对象，需要掌握理解。

QueryParam的主要使用场景是转换url api中的查询参数为数据库sql条件。一个QueryParam对象代表了一个 url 查询请求对象。

QueryParam的源代码学习：/gou/query.url.go

比如下面的url包含了一个where查询条件：http://localhost:5099/api/pet/search?where.kind.match=狗

url的查询参数where.kind.match=狗会被解析成以下的where条件kind = 狗,这是一个最简单的使用例子。QueryParam还可以包含其它复杂的使用方法。

源代码学习

QueryParam结构定义：

type QueryParam struct {
    Model    string          `json:"model,omitempty"` //关联模型
    Table    string          `json:"table,omitempty"` //关联表
    Alias    string          `json:"alias,omitempty"` //别名
    Export   string          `json:"export,omitempty"` // 导出前缀
    Select   []interface{}   `json:"select,omitempty"` // string | dbal.Raw
    Wheres   []QueryWhere    `json:"wheres,omitempty"` // where条件列表
    Orders   []QueryOrder    `json:"orders,omitempty"` // 排序
    Limit    int             `json:"limit,omitempty"` //限制
    Page     int             `json:"page,omitempty"` //翻页
    PageSize int             `json:"pagesize,omitempty"`//页数据大小
    Withs    map[string]With `json:"withs,omitempty"`//关联表查询
}

QueryParam对象有一个重要的方法NewQuery()，这个方法会根据传入结构体的参数组合成一个查询堆栈：stack，

// gou/query.go
// NewQuery 新建查询栈
func (param QueryParam) NewQuery() *QueryStack {
    return param.Query(nil)
}

在源代码：gou/query.url.go中的函数URLToQueryParam会把url转换成QueryParam对象中的select,order,where|orwhere|wherein|orwherein,group,with,select。

select查询字段
order 排序
where where 条件
group 分组
with 关联查询
.select 关联查询字段

const reURLWhereStr = "(where|orwhere|wherein|orwherein)\\.(.+)\\.(eq|gt|lt|ge|le|like|match|in|null|notnull)"

var reURLWhere = regexp.MustCompile("^" + reURLWhereStr + "$")
var reURLGroupWhere = regexp.MustCompile("^group\\.([a-zA-Z_]{1}[0-9a-zA-Z_]+)\\." + reURLWhereStr + "$")


// URLToQueryParam url.Values 转换为 QueryParams
func URLToQueryParam(values url.Values) QueryParam {
    param := QueryParam{
        Withs:  map[string]With{},
        Wheres: []QueryWhere{},
    }

    whereGroups := map[string][]QueryWhere{}
    for name := range values {
        if name == "select" {
            param.setSelect(values.Get(name))
            continue
        } else if name == "order" {
            param.setOrder(name, values.Get(name))
            continue
        } else if reURLWhere.MatchString(name) {
            param.setWhere(name, getURLValue(values, name))
            continue
        } else if strings.HasPrefix(name, "group.") {
            param.setGroupWhere(whereGroups, name, getURLValue(values, name))
            continue
        } else if name == "with" {
            param.setWith(values.Get(name))
            continue
        } else if strings.HasSuffix(name, ".select") {
            param.setWithSelect(name, values.Get(name))
            continue
        }
    }

    // WhereGroups
    for _, wheres := range whereGroups {
        param.Wheres = append(param.Wheres, QueryWhere{
            Wheres: wheres,
        })
    }
    return param
}

函数URLToQueryParam返回的是一个结构对象。在api里可以通过:params，或是使用:query-param把 url 中查询参数转换成QueryParam对象。

json

{
  "paths": [
    {
      "path": "/search",
      "method": "GET",
      "process": "models.user.Get",
      "in": [":params"],
      "out": {
        "status": 200,
        "type": "application/json"
      }
    }
  ]
}

参考

QueryDSL的文档请参考官网说明QueryDSL。

Yao 在 url 请求中使用 QueryParam 查询语法 ​

源代码学习 ​

参考 ​

Yao 在 url 请求中使用 QueryParam 查询语法

源代码学习

参考