Python安全操作PostgreSQL查询方法

本篇文章主要是结合我之前面试的各种经历和实战开发中遇到的问题解决经验整理的，希望这篇《Python安全执行PostgreSQL查询指南》对你有很大帮助！欢迎收藏，分享给更多的需要的朋友学习~

本文详细介绍了在Python中使用`psycopg2`库与PostgreSQL数据库交互时，如何安全有效地将Python变量嵌入到SQL查询语句中。通过避免直接字符串拼接，我们将重点讲解使用SQL占位符（`%s`）和`execute()`方法的参数化查询机制，这不仅能解决常见的`TypeError`，更能有效防范SQL注入攻击，提升代码的健壮性和安全性。

引言：在Python中执行带变量的SQL查询

在开发数据库驱动的Python应用时，经常需要根据程序运行时的数据动态构建SQL查询。例如，根据用户输入查询特定记录，或者更新某个字段的值。初学者常犯的一个错误是直接将Python变量拼接到SQL字符串中，这不仅可能导致语法错误或运行时异常，更重要的是，它会为SQL注入攻击打开大门，严重威胁应用程序的安全性。

本教程将以psycopg2库为例，演示如何在Python中正确且安全地使用变量执行PostgreSQL查询。

错误的实践：直接拼接变量

让我们首先看看一个常见的错误示例。假设我们想根据一个Python变量inputed_email查询用户的密码：

import psycopg2

inputed_email = "test@example.com" # 假设这是从用户输入获取的变量

conn = None
cur = None
try:
    conn = psycopg2.connect("dbname=postgres user=postgres password=postgres")
    cur = conn.cursor()

    # 错误的用法：直接将变量作为execute的独立参数，或进行字符串拼接
    # cur.execute("SELECT password FROM user WHERE email = ", inputed_email, ";")
    # 这种方式会导致 TypeError: function takes at most 2 arguments (3 given)
    # 即使使用字符串拼接，如 f"SELECT password FROM user WHERE email = '{inputed_email}';"
    # 也存在SQL注入风险且易出错

    print("尝试执行查询...")
    # 假设这里是错误的代码，为了演示问题，我们不会运行它
    # cur.execute("SELECT password FROM user WHERE email = ",inputed_email,";")
    # print(cur.fetchone())

except TypeError as e:
    print(f"捕获到错误: {e}")
    print("错误提示：execute() 函数最多接受两个参数，但您提供了三个。")
except Exception as e:
    print(f"发生其他错误: {e}")
finally:
    if cur:
        cur.close()
    if conn:
        conn.close()
    print("数据库连接已关闭。")

上述代码中，cur.execute("SELECT password FROM user WHERE email = ", inputed_email, ";") 尝试将SQL语句、变量和分号作为三个独立的参数传递给execute()函数。然而，psycopg2的execute()方法最多只接受两个参数：SQL查询字符串和可选的参数序列（用于占位符）。因此，这会导致TypeError: function takes at most 2 arguments (3 given)。

即使我们尝试通过Python的f-string或字符串连接来直接构建SQL，例如 cur.execute(f"SELECT password FROM user WHERE email = '{inputed_email}';")，虽然解决了参数数量的问题，但这是一种非常危险的做法，因为它容易受到SQL注入攻击。

正确的实践：使用占位符进行参数化查询

psycopg2（以及大多数Python数据库API）提供了一种安全且推荐的方式来处理变量：参数化查询。其核心思想是在SQL语句中使用占位符，然后将变量的值作为单独的参数传递给execute()方法。psycopg2会负责正确地转义这些值，防止SQL注入。

对于psycopg2，标准的占位符是 %s。

单个变量的参数化查询

当查询中只有一个变量时，我们这样使用：

import psycopg2

inputed_email = "test@example.com" # 假设这是从用户输入获取的变量

conn = None
cur = None
try:
    conn = psycopg2.connect("dbname=postgres user=postgres password=postgres")
    cur = conn.cursor()

    # 正确的用法：使用 %s 占位符，并将变量作为 execute() 的第二个参数（一个列表或元组）
    sql_query = "SELECT password FROM public.user WHERE email = %s" # 注意：这里移除了末尾的分号，通常不是必需的
    cur.execute(sql_query, [inputed_email]) # 第二个参数必须是可迭代对象（如列表或元组）

    result = cur.fetchone()
    if result:
        print(f"找到用户密码: {result[0]}")
    else:
        print(f"未找到邮箱为 '{inputed_email}' 的用户。")

    conn.commit() # 对于SELECT语句通常不需要commit，但对于INSERT/UPDATE/DELETE是必需的

except psycopg2.Error as e:
    print(f"数据库操作错误: {e}")
    if conn:
        conn.rollback() # 发生错误时回滚事务
except Exception as e:
    print(f"发生其他错误: {e}")
finally:
    if cur:
        cur.close()
    if conn:
        conn.close()
    print("数据库连接已关闭。")

关键点解释：

1. 占位符 %s: 在SQL查询字符串中，任何你想插入变量值的地方，都用 %s 代替。
2. execute() 的第二个参数: execute() 方法的第二个参数必须是一个可迭代对象（如列表或元组），其中包含按顺序对应占位符的值。即使只有一个值，也必须将其放在列表或元组中，例如 [inputed_email]。

多个变量的参数化查询

如果查询中需要使用多个变量，execute() 方法的第二个参数就包含相应数量的变量，顺序与SQL语句中的 %s 占位符一致。

import psycopg2

user_email = "jane.doe@example.com"
user_lastname = "Doe"

conn = None
cur = None
try:
    conn = psycopg2.connect("dbname=postgres user=postgres password=postgres")
    cur = conn.cursor()

    # 多个变量的参数化查询
    sql_query = "SELECT firstname, password FROM public.user WHERE email = %s AND lastname = %s"
    cur.execute(sql_query, (user_email, user_lastname)) # 可以使用元组或列表

    result = cur.fetchone()
    if result:
        print(f"找到用户: {result[0]}, 密码: {result[1]}")
    else:
        print(f"未找到邮箱为 '{user_email}' 且姓氏为 '{user_lastname}' 的用户。")

    conn.commit()

except psycopg2.Error as e:
    print(f"数据库操作错误: {e}")
    if conn:
        conn.rollback()
except Exception as e:
    print(f"发生其他错误: {e}")
finally:
    if cur:
        cur.close()
    if conn:
        conn.close()
    print("数据库连接已关闭。")

注意事项与最佳实践

1. SQL注入防护: 参数化查询是防止SQL注入攻击的黄金法则。psycopg2会自动转义传递给占位符的所有值，确保它们被视为数据而不是可执行的SQL代码。
2. execute() 参数类型: 始终记住，execute() 的第二个参数必须是一个可迭代对象（列表或元组），即使只有一个变量。
3. SQL语句末尾的分号: 在psycopg2中，SQL语句末尾的分号通常不是必需的，并且在某些情况下可能会导致问题。建议省略它，除非数据库要求或你正在执行多个语句。
4. 事务管理: 对于INSERT、UPDATE、DELETE等修改数据的操作，务必在操作成功后调用 conn.commit() 来保存更改。如果发生错误，应调用 conn.rollback() 来撤销未提交的更改。对于SELECT操作，通常不需要commit。
5. 资源管理: 始终确保在操作完成后关闭游标（cur.close()）和数据库连接（conn.close()），以释放数据库资源。使用 try...except...finally 块是实现这一点的标准模式。
6. 错误处理: 捕获psycopg2.Error异常可以更具体地处理数据库相关的错误。

总结

在Python中使用psycopg2执行PostgreSQL查询并嵌入变量时，核心原则是采用参数化查询。通过在SQL语句中使用%s占位符，并将变量值作为execute()方法的第二个参数（一个列表或元组）传递，我们不仅能避免TypeError等常见错误，更能有效地防止SQL注入攻击，从而编写出更安全、更健壮的数据库交互代码。遵循这些最佳实践，将大大提高您Python数据库应用的可靠性。

今天关于《Python安全操作PostgreSQL查询方法》的内容就介绍到这里了，是不是学起来一目了然！想要了解更多关于的内容请关注golang学习网公众号！