模型参数设置最佳实践


Model Parameter Setup Best Practice?

我有一个模型,在SQL中运行具有一堆条件的查询。因此,模型需要接受大量参数,即:

this->model_name->method($param1, $param2, ... )
在模型端,我通常将其设置为
function method($param1 = NULL, $param2 = NULL, ... )

这些参数中的每一个都是可选的,用例会因应用程序而异。所以我的问题是:在什么时候(如果有的话)开始通过数组将这些参数传递给方法是有意义的,比如:

$params = [
'param1' => 'whatever',
'param2' => 'whatever',
...
]
this->model_name->method($params)

我想,最终的目标是代码更干净,method(null, null, null, null, $param)的实例更少,除非这样做是可以的。

大多数回答都支持数组方法(一般来说,我也同意),但我要唱反腔,列出一些否定的意见:

文档不太清楚

大多数记录函数/方法的方法将单独列出该函数的参数。例如,一个带有基本DocBlock的函数看起来像这样:

/**
 * A function that accepts an array of params
 * @param array $param_array An array of key=>value arguments
 */
function accept_array($param_array = array('key1' => 'first_val', 'key2' => 'second_val')) {
    var_dump($param_array);
}

注意DocBlock不直接支持$param_array的各个部分,只支持整个数组。相反,单独列出所有参数看起来像这样:

/**
 * A function that 'normal' params
 * @param string $key1 First argument
 * @param string $key2 Second argument
 */
function accept_normal($key1 = 'first_val', $key2 = 'second_val') {
    echo $key1;
    echo $key2;
}

这也是一个问题,如果你希望你的函数是相当自文档化的,因为在第一个例子中,你不需要在函数本身中实际列出你期望的参数。


默认值可能无法按预期工作

"As expected"可能是一个有点夸张的短语(这可能是一个更明显的问题),但以以下内容为例:

function accept_array($param_array = array('key1' => 'first_val', 'key2' => 'second_val')) {
    var_dump($param_array);
}
accept_array(array('key2' => 'a_different_val'));

有些人可能期望var_dump包含key1的默认值和key2的新值,但是整个数组被替换了,这意味着您需要记住在每个函数中手动设置每个键的默认值,如下所示:

function accept_array($param_array = array()) {
    if (!isset($param_array['key1'])) { $param_array['key1'] = 'first_val'; }
    if (!isset($param_array['key2'])) { $param_array['key2'] = 'second_val'; }
    var_dump($param_array);
}
accept_array(array('key2' => 'a_different_val'));

无自动过滤

以"正常"方式列出参数也为您提供了一组内置过滤器。以下面这个快速的用户搜索为例:

/**
 * We want to allow searching for users by user_id or email only!
 * @param array $param_array
 */
function find_user($param_array = array('user_id' => 0, 'email' => '')) {
    foreach ($param_array as $field => $value) {
        $this->db->or_where($field, $value);
    }
    $this->db->get('users');
}
find_user(array('first_name' => 'Joe', 'last_name' => 'Bloggs'));

无需在$param_array上手动添加一些"可接受的键"类型验证,对find_user()函数的调用基本上可以使用它喜欢的任何字段。更简单的版本显然是这样的:

/**
 * We want to allow searching for users by user_id or email only!
 * @param int $user_id
 * @param string $email
 */
function find_user($user_id = 0, $email = '') {
    $this->db->or_where('user_id', $user_id);
    $this->db->or_where('email', $email);
    $this->db->get('users');
}
// No way for me to submit any other fields, they'll just fail when they get to the query
find_user('Joe', 'Bloggs')); 

我接受其中一些是入门级的,可能还有更多的我错过了(请随意评论更多,我会把它们复制到回复中并附上署名),但希望有足够的东西让人们在不考虑手动验证和文档等的情况下,重新考虑自动使用"数组方法"。

传递参数数组为自定义代码提供了更好的选择。

当我使用许多参数时,我经常发现自己使用这样的样式:

// do_something_model($enable_option1,$enable_option2,$enable_option3) 
   do_something_model(FALSE,          TRUE,           FALSE)

中,我携带了一个带有参数名称的注释行,以提醒我自己的状态使用模型。

在这种情况下,使用具有有意义命名键的数组提供了有用的助记符。

最近,我也在使用更多的包装器函数。例如,我可能有我的基本模型方法从表中获取我所有的数据,这个方法将有几个选项。

然后定义一个执行特定任务的新方法,然后使用正确的选项调用其中的基本方法。

脚注
我发现,如果我的方法有"太多的选项",最好重新考虑方法的目的,并将其分解为两个或更多更容易使用的专门方法。

我也推荐数组版本。Symfony2也大量使用这种模式,例如在呈现模板、创建表单类和创建http响应中。你只需要确保你清楚地记录了所有可能的参数。

两种方法都可以,但是数组肯定会使方法更简洁。将参数作为数组传递是完全有意义的。