PHP多参数方法的重构

假设我们要完成一个保存文章的功能,如果采用函数编程的方式,大概会是下面这个样子:

<?php
function saveArticle($title, $content, $categoryId)
{
    // ...
}
?>

每个参数代表一个属性,但带来一个问题,参数列表会变得很长。此时采用对象编程的技术会是个好方法

<?php
class Article
{
    var $title;
    var $content;
    var $categoryId;

    function save()
    {
        // ...
    }
}
?>

在这里,原来的方法参数都转换为以对象的属性方式存在,从而大大降低了方法的参数数量。多数时候这个方法是不错的,不过并不是所有的参数都适合以对象属性的方式存在,区分的原则是,看这些参数是属于对象的内在属性还是外在特征,如果不加区分的统统转换为对象属性,这会让对象本身失去意义。

举个例子,比如说我们的Article对象还有一个名为find的方法,使用它时可能会涉及limit, offset, order等参数:

<?php
class Article
{
    var $title;
    var $content;
    var $categoryId;

    var $limit = 10;
    var $offset = 0;
    var $order = 'created DESC';

    function save()
    {
        // ...
    }

    function find($categoryId)
    {
        // ...
    }
}
?>

如上所示,一旦我们把limitoffsetorder等参数转换为对象的属性,这个对象本身就变得不伦不类了,因为虽然title,content,categoryId可以算作是对象的内在属性,而limitoffsetorder却不是,顶多也只能算作是外部特征,不加区分的结果基本是噩梦的开始。所以,还是老老实实的把外在特征放到方法的参数里好些(更严格的说,find方法应该是一个static类型的方法,不过文本就是一个简单的说明,不必细究):

<?php
class Article
{
    var $title;
    var $content;
    var $categoryId;

    function save()
    {
        // ...
    }

    function find($categoryId, $limit = 10, $offset = 0, $order = 'created DESC')
    {
        // ...
    }
}
?>

可惜如此一来又出现了文章开头所说的问题,find方法的参数太多了,缺乏可读性,所以还得重构:

<?php
class Article
{
    var $title;
    var $content;
    var $categoryId;

    function save()
    {
        // ...
    }

    function find($categoryId, $options = array())
    {
        $default = array(
            'limit' => 10,
            'offset' => 0,
            'order' => 'created DESC'
        );

        $options = array_merge($default, (array)$options);

         // ...
    }
}
?>

看上去还不错,调用时可以使用类似下面的方法:

$article->find(123, array('limit' => 20));

简单的说,就是用数组方式的参数,来模拟一种类似关键字参数的效果,采用这种方式的话,可以通过数组的键名来描述参数的作用,从而增加代码的可读性。类似这样的重构方法在CakePHP等项目里被大量使用,仔细体会,以后再写代码的时候就可以本能的写出高可读性的代码来。

补充:相对array_merge来说,使用$options += $default;也是不错的选择。另外,如果options的逻辑很复杂的话,也可以不用数组的方式,转而使用一个专门的对象来封装逻辑操作。

标签:

发表评论

电子邮件地址不会被公开。 必填项已用*标注

昵称 *