怎样在Python中设计支持链式调用的SQL查询构建器类

落宇小哥_3543

落宇小哥_3543

2026-10-06

365人浏览

原创

链式调用的核心是每个构建方法必须 return self。select()、where() 等方法需追加条件而非覆盖,to_sql() 应返回 sql 字符串与参数元组,并在校验缺失字段或表时抛出明确异常。

怎样在python中设计支持链式调用的sql查询构建器类

链式调用的核心是 return self

Python 中实现链式调用,关键不是语法糖,而是每个修改状态的方法都必须 return self。如果漏掉这句,调用链会在第一次方法后中断。比如 select() 方法内部改了 self._fields,但没返回 self,后续的 where() 就会报 AttributeError: 'NoneType' object has no attribute 'where'。

常见错误是把「执行查询」和「构建查询」混在一起:比如在 execute() 里直接运行 SQL 并返回结果,那它就无法再链式调用。正确做法是把执行单独剥离,让构建类只负责组装,最后用一个明确的 to_sql() 或 run() 收口。

  • select()、from_()、where()、order_by() 这类构建方法,一律 return self
  • 避免在构建方法中做副作用操作(如连接数据库、发 HTTP 请求)
  • 如果需要预校验(比如字段名是否合法),放在方法开头,失败时抛异常,而不是静默吞掉或返回新实例

如何安全地累积查询条件(特别是 where)

where() 是最容易出错的地方:用户可能连续调用多次,期望是 AND 合并,但若每次都覆盖 self._where,就会丢掉前面的条件。必须设计成「追加」而非「重置」。

推荐用列表存原始条件片段(如 [("age > ?", 25), ("status = ?", "active")]),而不是拼接字符串。这样既保留参数化能力,又方便后续生成 SQL 和绑定参数。

python-script-generator
python-script-generator

快速生成专业的 Python 脚本和应用代码。一键创建完整项目结构,支持CLI、API、爬虫、Bot、Django等多种项目类型,包含完整的项目结构、配置文件、依赖管理、测试、README和文档。

下载
  • 每次 where() 调用应向 self._where_clauses 列表追加元组 (sql_snippet, *params)
  • 不要在 where() 内部调用 str.format() 或 % 拼接——这会引入 SQL 注入风险
  • 如果支持 OR 分组,需额外提供 or_where() 或 where_group() 方法,内部用嵌套结构管理逻辑层级

to_sql() 必须分离 SQL 字符串与参数

最终生成的 SQL 不能把参数硬塞进去,否则失去防注入能力。to_sql() 应返回两个值:sql_string 和 params_tuple,由调用方决定怎么交给数据库驱动(比如传给 cursor.execute(sql, params))。

示例行为:

builder = QueryBuilder().select("id", "name").from_("users").where("age > ?", 30).where("active = ?", True)
sql, params = builder.to_sql()
# sql → "SELECT id, name FROM users WHERE age > ? AND active = ?"
# params → (30, True)
  • to_sql() 不应触发实际查询,只做纯字符串组装和参数扁平化
  • 字段名、表名若来自用户输入,需白名单校验或用反引号包裹(如 f"`{table}`"),防止关键字冲突
  • ORDER BY、GROUP BY 的字段也建议走同套校验,避免传入恶意子查询片段

别忽略空状态和边界情况

刚初始化的实例,to_sql() 调用时若没调过 select() 或 from_(),应该明确报错,而不是吐出语法错误的 SQL。这类检查要放在 to_sql() 开头,而不是等数据库驱动报错——后者错误信息难定位。

  • 检查 self._fields 是否为空,是则 raise ValueError("Missing SELECT fields")
  • 检查 self._table 是否为 None,是则 raise ValueError("Missing FROM table")
  • WHERE 条件为空时,to_sql() 不应留着孤立的 WHERE 关键字
  • 如果支持 JOIN,要注意 ON 条件缺失时的默认行为(报错?忽略?)——选报错更安全

链式调用看着流畅,但每一步的隐式状态依赖都很深。最易被忽略的是「中间态合法性」:没人规定用户必须按 select→from→where 顺序调,所以每个构建方法都要能独立容忍不完整状态,而把最终校验压到 to_sql() 这个出口点。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

python

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1651

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

4124

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1669

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

23877

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

2927

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

2947

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1143

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

596

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2283

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程