Ecto动态查询构建指南：灵活构建数据库查询的艺术-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00113/article/details/148486952

Ecto动态查询构建指南：灵活构建数据库查询的艺术

ecto A toolkit for data mapping and language integrated query. 项目地址: https://gitcode.com/gh_mirrors/ec/ecto

前言

在Elixir生态系统中，Ecto作为数据库包装器和查询生成器，提供了强大而灵活的查询构建能力。本文将深入探讨Ecto中的动态查询构建技术，帮助开发者掌握在不同场景下灵活构建查询语句的方法。

基础查询构建方式

Ecto提供了两种主要的查询构建语法：关键字语法和管道语法。

关键字语法示例

import Ecto.Query

from p in Post,
  where: p.author == "José" and p.category == "Elixir",
  where: p.published_at > ^minimum_date,
  order_by: [desc: p.published_at]

管道语法示例

import Ecto.Query

Post
|> where([p], p.author == "José" and p.category == "Elixir")
|> where([p], p.published_at > ^minimum_date)
|> order_by([p], desc: p.published_at)

这两种语法都支持查询的组合与复用，开发者可以根据个人偏好选择使用。

数据结构优先的查询构建

Ecto提供了更简洁的API，使数据结构成为查询构建的一等公民：

Post
|> where(author: "José", category: "Elixir")
|> where([p], p.published_at > ^minimum_date)
|> order_by(desc: :published_at)

这种方式的优势在于：

减少了绑定变量的重复声明
查询条件可以动态构建和组合
代码更加简洁易读

动态片段（Dynamic Fragments）

对于更复杂的动态查询场景，Ecto提供了Ecto.Query.dynamic/2宏：

filter_published_at =
  if published_at = params["published_at"] do
    dynamic([p], p.published_at < ^published_at)
  else
    true
  end

Post
|> where(^where)
|> where(^filter_published_at)
|> order_by(^order_by)

动态片段的优势包括：

条件逻辑与查询构建分离
支持复杂表达式的动态构建
可组合性强，动态片段可以嵌套使用

实战：构建复杂动态查询

让我们通过一个完整的搜索功能示例来展示动态查询的强大之处：

def filter(params) do
  Post
  |> order_by(^filter_order_by(params["order_by"]))
  |> where(^filter_where(params))
end

def filter_order_by("published_at_desc"), do: [desc: dynamic([p], p.published_at)]
def filter_order_by("published_at"), do: [asc: dynamic([p], p.published_at)]
def filter_order_by(_), do: []

def filter_where(params) do
  Enum.reduce(params, dynamic(true), fn
    {"author", value}, dynamic ->
      dynamic([p], ^dynamic and p.author == ^value)
    {"category", value}, dynamic ->
      dynamic([p], ^dynamic and p.category == ^value)
    {"published_at", value}, dynamic ->
      dynamic([p], ^dynamic and p.published_at > ^value)
    {_, _}, dynamic -> dynamic
  end)
end

这种模式的优势：

将复杂查询分解为小函数
每个函数职责单一，易于测试
使用模式匹配处理不同参数
通过reduce逐步构建复杂条件

动态查询中的表连接

动态查询同样适用于包含表连接的复杂场景：

def filter(params) do
  Post
  |> join(:inner, [p], assoc(p, :authors), as: :authors)
  |> order_by(^filter_order_by(params["order_by"]))
  |> where(^filter_where(params))
end

def filter_order_by("author_name_desc"), 
  do: [desc: dynamic([authors: a], a.name)]
  
def filter_where(params) do
  Enum.reduce(params, dynamic(true), fn
    {"author", value}, dynamic ->
      dynamic([authors: a], ^dynamic and a.name == ^value)
    # ...其他条件处理
  end)
end

测试动态查询

动态查询的测试可以采用字符串匹配的方式：

test "filter published at based on the given date" do
  assert dynamic_match?(
           filter_where(%{"published_at" => "2010-04-17"}),
           "true and q.published_at > ^\"2010-04-17\""
         )
end

defp dynamic_match?(dynamic, string) do
  inspect(dynamic) == "dynamic([q], #{string})"
end