本教程详细介绍了如何在 datatables 的服务器端处理中，通过 ssp (server-side processing) 类添加非数据库来源的计算列。文章将重点讲解 `formatter` 回调函数的使用，通过实际代码示例演示如何基于现有数据动态生成新列的值，从而实现更灵活的数据展示。
引言：DataTables 服务器端处理与动态列需求
DataTables 是一个功能强大的 JavaScript 库，用于增强 HTML 表格的交互性。当处理大量数据时，服务器端处理（Server-side Processing）是必不可少的，它允许 DataTables 将数据检索、过滤、排序和分页等操作委托给服务器，从而减轻客户端的负担并提高性能。
在实际应用中，我们经常需要展示一些不直接存储在数据库中的列，这些列的值可能需要根据现有数据库字段进行计算、组合或格式化。例如，一个“评分”列可能需要根据“薪资”和“职位”等字段动态计算得出。本文将详细阐述如何在 DataTables 的服务器端处理中优雅地实现这类非数据库计算列。
核心机制：formatter 回调函数
DataTables 的 SSP (Server-side Processing) 类在处理 $columns 数组时提供了一个强大的 formatter 选项。这个 formatter 是一个回调函数，它允许开发者在数据发送到客户端之前，对每一列的每个单元格数据进行自定义处理。
formatter 函数接收两个关键参数：
- $d：当前列的原始数据库值。
- $row：一个关联数组，包含了当前行所有数据库字段的键值对。这个参数对于创建计算列至关重要，因为它允许我们访问同一行的其他数据进行计算。
通过利用 formatter 函数，我们可以完全控制列的输出内容，无论是简单的格式化、复杂的逻辑判断，还是基于其他列数据进行全新值的计算。
实现步骤与示例
要添加一个非数据库来源的计算列，我们需要在服务器端的 PHP 脚本中，修改 $columns 数组的定义。
步骤一：定义服务器端 $columns 数组
首先，回顾 DataTables 服务器端处理中 $columns 数组的基本结构。每个数组元素代表一个表格列，并至少包含 'db' (数据库列名) 和 'dt' (DataTables 列索引) 键。
'first_name', 'dt' => 0 ),
array( 'db' => 'last_name', 'dt' => 1 ),
array( 'db' => 'position', 'dt' => 2 ),
array( 'db' => 'office', 'dt' => 3 ),
array(
'db' => 'start_date',
'dt' => 4,
'formatter' => function( $d, $row ) {
return date( 'jS M y', strtotime($d));
}
),
array(
'db' => 'salary',
'dt' => 5,
'formatter' => function( $d, $row ) {
return '$'.number_format($d);
}
)
);
// ... SSP::simple 调用 ...
?>在上述示例中，start_date 和 salary 列已经使用了 formatter 进行格式化。我们将在此基础上添加一个全新的计算列。
步骤二：添加计算列配置
为了添加一个名为“Rating”（评分）的计算列，我们需要在 $columns 数组中增加一个新的项。
对于非数据库来源的计算列，'db' 键的设置是一个关键点：
- 策略： 将 'db' 键指向一个现有且必然存在的数据库列（例如，主键 id 或任何其他总是被查询的列）。这是因为 SSP 类会根据这些 'db' 键构建 SQL SELECT 语句。如果指向一个不存在的列，SQL 查询会失败。
- 实际值： 即使 'db' 键指向了某个数据库列，我们也会在 'formatter' 函数中完全覆盖其值，所以它实际指向哪个数据库列并不重要，只要它能让 SQL 查询成功即可。
以下是添加“Rating”计算列的完整示例：
'your_db_user',
'pass' => 'your_db_password',
'db' => 'your_db_name',
'host' => 'localhost'
);
// 表名
$table = 'datatables_demo'; // 替换为您的实际表名
// 表的主键
$primaryKey = 'id';
// 定义 DataTables 列
$columns = array(
array( 'db' => 'id', 'dt' => 0 ), // 将 id 作为第一列，或任何您希望的列
array( 'db' => 'first_name', 'dt' => 1 ),
array( 'db' => 'last_name', 'dt' => 2 ),
array( 'db' => 'position', 'dt' => 3 ),
array( 'db' => 'office', 'dt' => 4 ),
array(
'db' => 'start_date',
'dt' => 5,
'formatter' => function( $d, $row ) {
return date( 'jS M y', strtotime($d));
}
),
array(
'db' => 'salary',
'dt' => 6,
'formatter' => function( $d, $row ) {
return '$'.number_format($d);
}
),
// 添加我们的新计算列：Rating
array(
'db' => 'id', // 使用 'id' 作为占位符，确保它会被 SQL 查询选中
'dt' => 7, // 新列在 DataTables 中的索引，确保与客户端匹配
'formatter' => function( $d, $row ) {
// 从 $row 数组中获取其他列的值进行计算
$salary = (int)$row['salary'];
$position = $row['position'];
$firstName = $row['first_name'];
// 执行您的自定义计算逻辑
$rating = 0;
// 基于薪资计算评分
if ($salary > 100000) {
$rating += 5;
} elseif ($salary > 50000) {
$rating += 3;
} else {
$rating += 1;
}
// 基于职位计算评分
if (strpos($position, 'Manager') !== false) {
$rating += 4;
} elseif (strpos($position, 'Developer') !== false) {
$rating += 2;
}
// 也可以基于其他字段，例如姓名的长度
if (strlen($firstName) > 5) {
$rating += 1;
}
// 返回计算出的评分
return $rating;
}
)
);
// 引入 SSP 类
require( 'ssp.class.php' ); // 确保路径正确
// 输出 JSON 响应
echo json_encode(
SSP::simple( $_GET, $sql_details, $table, $primaryKey, $columns )
);
?>在这个示例中，我们添加了一个索引为 7 的新列。它的 db 键被设置为 id，这意味着在服务器端查询时，id 列会被选中。然而，formatter 函数会完全忽略 id 的原始值 $d，而是利用 $row 数组中 salary、position 和 first_name 的值来计算并返回一个全新的“Rating”值。
步骤三：客户端 DataTables 配置 (简述)
在客户端的 JavaScript 中，您需要确保 DataTables 的 columns 配置与服务器端返回的列数和顺序相匹配。
$(document).ready(function() {
$('#example').DataTable({
'processing': true,
'serverSide': true,
'ajax': 'your_server_side_script.php', // 替换为您的服务器端脚本路径
'columns': [
{ 'data': 0 }, // id
{ 'data': 1 }, // first_name
{ 'data': 2 }, // last_name
{ 'data': 3 }, // position
{ 'data': 4 }, // office
{ 'data': 5 }, // start_date (formatted)
{ 'data': 6 }, // salary (formatted)
{ 'data': 7 } // Rating (calculated)
]
});
});注意事项与最佳实践
- 性能考量： formatter 函数会在每一行数据被处理时执行。因此，在其中执行的计算逻辑应尽可能高效。避免在 formatter 中进行额外的数据库查询或耗时过长的操作，这会严重影响服务器端处理的性能。
- 数据访问： 充分利用 $row 数组。它包含了当前行所有被选中的数据库字段。这意味着您无需为计算列单独查询数据库，所有所需数据都已在手。
- 'db' 键的策略： 对于完全由 formatter 生成的计算列，'db' 键虽然其值会被覆盖，但它仍然是 SSP 类构建 SQL SELECT 语句所必需的。因此，务必将其指向一个存在的数据库列（如 id 或任何您希望在 SELECT 语句中出现的列）。
- 可读性与维护性： 如果计算逻辑非常复杂，可以考虑将其封装成一个独立的 PHP 函数，然后在 formatter 中调用该函数，以提高代码的可读性和可维护性。
-
排序与搜索： 默认情况下，DataTables 会尝试对所有列进行排序和搜索。对于计算列，DataTables 无法直接在数据库层面进行排序和搜索。
- 排序： 如果需要对计算列进行排序，您可能需要实现自定义排序逻辑，或者在数据库层面预先计算并存储该值（如果业务允许）。
- 搜索： 同样，直接对计算列进行服务器端搜索是困难的。如果需要，您可能需要在 SSP::simple 之前对 $columns 数组进行更高级的定制，或者在 formatter 中返回一个可搜索的字符串。
总结
通过 DataTables SSP 类的 formatter 回调函数，开发者可以灵活地在服务器端处理中添加非数据库来源的计算列。这一功能极大地增强了 DataTables 的数据展示能力，允许我们在不修改数据库结构的前提下，根据业务需求动态生成和展示复杂的数据。掌握 formatter 的使用，特别是如何利用 $row 参数进行跨列计算，是实现高效且功能丰富的 DataTables 应用的关键。
