perl - 单一职责原则 : Write data to file after running a query

Question

我必须将运行 sql 查询后生成的行写入文件。

# Run the SQL script.
my $dbh = get_dbh($source);
my $qry = $dbh->prepare("$sql_data");
$qry->execute();

# Dump the data to file.
open(my $fh_write, ">", "$filename");
while (my @data = $qry->fetchrow_array())
{
  print {$fh_write} join("\t", @data) . "\n";
}
close($fh_write);

显然我在函数中做了两件事:

1. 运行 sql 查询。
2. 将数据写入文件。

有没有办法使用 SRP 来做到这一点？

数据中有很多行，因此从单独的函数返回行数组可能不是个好主意。

Answer 1

您可以将其拆分为两个不同的函数。一个查询数据库，另一个将数据写入文件。

sub run_query {
    my ( $sql, @args ) = @_;

    # if you truly want separation of concerns,
    # you need to connect $dbh somewhere else

    my $sth = $dbh->prepare($sql);
    $sth->execute(@args);

    # this creates an iterator
    return sub {
        return $sth->fetchrow_arrayref;
    };
}

此函数接受一个 SQL 查询和一些参数(请记住使用占位符!)并运行该查询。它返回一个代码引用，关闭$sth。每次调用该引用时，都会获取一行结果。当语句句柄$sth为空时，会返回undef，传递过来，迭代结束。这可能看起来有些矫枉过正，但请稍等片刻。

接下来，我们创建一个将数据写入文件的函数。

sub write_to_file {
    my ( $filename, $iter ) = @_;

    open my $fh, '>', $filename or die $!;

    while ( my $data = $iter->() ) {
        print $fh join( "\t", @{$data} ), "\n";
    }

    return;
}

这需要一个文件名和一个迭代器，它是一个代码引用。它打开文件，然后迭代，直到没有更多数据为止。每一行都写入文件。我们不需要 close $fh，因为它是一个词法文件句柄，一旦 $fh 在函数末尾超出范围，它就会被隐式关闭。

您现在所做的是定义一个接口(interface)。您的 write_to_file 函数的接口(interface)是它接受一个文件名和一个始终返回字段数组引用的迭代器。

让我们把它放在一起。

my $iter = run_query('SELECT * FROM orders');
write_to_file( 'orders.csv', $iter );

两行代码。一个运行查询，另一个写入数据。对我来说看起来很分离。

这种方法的好处是现在您还可以使用相同的代码将其他内容写入文件。例如，以下代码可以与某些 API 对话。它再次返回的迭代器每次调用都会为我们提供一行结果。

sub api_query {
    my ($customer_id) = @_;

    my $api = API::Client->new;
    my $res = $api->get_orders($customer_id); # returns [ {}, {}, {}, ... ]

    my $i = 0;
    return sub {
        return if $i == $#{ $res };
        return $res->[$i++];
    }
}

您可以将它放到上面的示例中而不是 run_query() 中，它会起作用，因为此函数返回遵循相同接口(interface) 的内容。您也可以创建具有相同部分接口(interface)的 write_to_api 或 write_to_slack_bot 函数。其中一个参数是同一种迭代器。现在这些也可以交换了。

---

当然，整个例子都非常人为。实际上，它在很大程度上取决于程序的大小和复杂性。

如果它是一个作为 cronjob 运行的脚本，每天只创建一次此报告，那么您不应该关心这种关注点分离。务实的方法可能是更好的选择。

一旦你有了很多这样的东西，你就会开始更加关心了。那么我的上述方法可能是可行的。但前提是您真的需要让事情变得灵活。

并非每个概念都始终适用，也并非每个概念都始终有意义。

---

请记住，有些工具更适合这些工作。您可以使用 Text::CSV_XS 而不是制作自己的 CSV 文件.或者你可以使用像 DBIx::Class 这样的 ORM并将 ResultSet 对象作为您的界面。