进阶 yourls.org 2026-11-19 17:39:56 · 2 阅读

第3章 YOURLS 数据库查询指南

# 数据库查询 本指南介绍在 YOURLS 中查询数据库的正确方式。 ## 不要手写 SQL 查询 说真的,你多半用不着手写 SQL。几乎所有常见操作都有封装函数可用(比如存取选项,用 yourls_add_option() 和 yourls_get_option() 即可,别直接操作数据库)。 所以,在动手写 SQL 之前,先确认是否已有现成函数可以帮你搞定。 ## YDB 对象 如果你的场景没有对应的封装函数,那就需要直接查询数据库。这时要使用全局 $ydb 对象,通过辅助函数 yourls_get_db() 获取: ```php function my_plugin_get_stuff_from_database() { $stuff = yourls_get_db('some context')->some_SQL_method('some SQL query'); // 细节见下文 ... } ``` 不要硬编码表名。为了保证代码兼容任何 YOURLS 环境,请不要硬编码表名(如 yourls_url),而应使用用户自定义常量:
  • YOURLS_DB_TABLE_URL
  • YOURLS_DB_TABLE_OPTIONS
  • YOURLS_DB_TABLE_LOG
## 1.7.3 及以上版本 从 1.7.3 开始,YOURLS 通过 Aura.SQL 库使用 PDO。核心思路是:绑定参数、获取结果。 所谓绑定参数,就是在 SQL 查询中用占位符代替变量,然后再指明哪些变量替换哪些占位符。 示例: ```php $table = YOURLS_DB_TABLE_URL; $sql = "SELECT * FROM `$table` WHERE `keyword` = :keyword"; // 注意 ":keyword" 占位符 $binds = array('keyword', $some_keyword); $infos = yourls_get_db('read-some_info')->fetchObject($sql, $binds); ``` 示例: ```php $table = YOURLS_DB_TABLE_URL; $sql = "UPDATE `$table` SET `title` = :title WHERE `keyword` = :keyword"; $binds = array('title' => $title, 'keyword' => $keyword); $update = yourls_get_db('write-some_info')->fetchAffected($sql, $binds); ``` 核心原则:切勿将 SQL 语句与变量直接混合。正确做法是,编写包含硬编码占位符的 SQL 语句(除表名外,其余内容均为硬编码),定义一个由(占位符、变量)对组成的数组,并让底层机制自动完成所有转义处理。 这样操作可确保你永远不会执行包含潜在恶意内容的变量查询,从而有效避免 SQL 注入风险。 可用方法如下: $ydb->fetchAll($sql, $binds): 返回包含结果集中所有行的数组 $ydb->fetchAssoc($sql, $binds): 返回关联数组,其中键为第一列的值 $ydb->fetchGroup($sql, $binds): 类似 fetchAssoc(),但值不被包裹在数组中 $ydb->fetchObject($sql, $binds): 将第一行作为对象返回 $ydb->fetchObjects($sql, $binds): 返回对象数组 $ydb->fetchOne($sql, $binds): 将第一行作为关联数组返回 $ydb->fetchPairs($sql, $binds): 返回关联数组,键为第一列的值,值为第二列的内容 $ydb->fetchValue($sql, $binds): 返回第一行第一列的值 $ydb->fetchAffected($sql, $binds): 返回受影响的行数 这些方法已在 Aura.SQL 中完整记录,以下是部分方法的示例输出。 1.7.3 之前 在 1.7.2 及更早版本中,YOURLS 使用 ezSQL 的一个自制扩展版本。ezSQL 是一款老牌流行的 SQL 包装库,但它不自动转义 SQL 语句,因此在执行查询前必须仔细手动转义变量。例如: $table = YOURLS_DB_TABLE_URL;
$keyword = yourls_escape($keyword);
$title = yourls_escape($title);
$update = $ydb->query("UPDATE `$table` SET `title` = '$title' WHERE `keyword` = '$keyword';"); // 查询中包含变量内容
当时提供的方法包括: $ydb->get_col($query): 获取一列 $ydb->get_row($query): 获取一行 $ydb->get_var($query): 获取一个值 $ydb->get_results($query): 获取多行 $ydb->query($query): 执行查询并返回受影响的行数 出于兼容性考虑,这些已废弃的方法在 YOURLS 1.7.3 及更高版本中仍然可用,但在启用调试模式(编写代码时建议始终开启)时会发出弃用通知。 为 1.7.3 升级代码 在 1.7.2 及更早版本中,你的插件或代码片段可能包含类似以下的内容: $table = YOURLS_DB_TABLE_URL;
$keyword = [ ... somedata coming from somewhere ... ];
$keyword = yourls_escape($keyword); // 对任意内容做转义
$sql = "SELECT `url` FROM `$table` WHERE `keyword` = '$keyword'"; // SQL 查询中包含变量内容
$url = $ydb->get_var($sql);
套路是这样的:拿到数据,先用 yourls_escape() 转义,再拼进 SQL 查询里。 从 1.7.3 开始,同样的代码改成了这样: $table = YOURLS_DB_TABLE_URL;
$keyword = [ ... somedata coming from somewhere ... ];
$sql = "SELECT `url` FROM $table WHERE `keyword` = :keyword"; // SQL 查询只包含硬编码的参数
$binds = array('keyword' => $keyword); // 参数名 => 参数值的数组
$url = $ydb->fetchValue($sql, $binds);
现在的新套路是:不用操心转义任意内容了,不管是字符串、数组还是别的什么,直接绑定参数,剩下的交给引擎处理。

评论 (0)