一个需求
做的某项目有一个“转账”的功能,但是转账的类型有很多种,对应每种转账需要的参数也不同,举个例子一种转账是由系统转账给用户,那么就只有接收方和金额两个参数,另一种转账是用户之间的转账且支持留言,那么就有发送方接收方金额和留言四个参数。当然最简单的思路就是采用四个参数,对于第一种转账将不用的两个参数留空,这种方法的问题在于,考虑到未来可能增加的新的转账类型,可能会引入新的参数,那么代码很可能需要推倒重来,有没有更优雅的解决方式呢?
一个例子
其实Laravel里就有实现类似需求的例子,那就是查询构造器(Query Builder),它的一个使用的例子如下:
$users = DB::table('users')
->select(DB::raw('count(*) as user_count, status'))
->where('status', '<>', 1)
->groupBy('status')
->get();
这个方法和我们的需求就很像了,对于查询这一功能,传入哪些参数是未知的,例如某次具体的查询,可能需要调用groupBy也可能调用orderBy,也可能两者需要同时调用或者都不调用。一个思路就是针对每一个参数都写一个方法,需要时则调用,不需要时则不调用。
解决方案
整体的解决思路是写两个类,一个叫Transfer,一个叫Builder,每个参数对应的方法写在Builder里,由Transfer去调用Builder构造我们需要的转账类型,完成相关操作。这样当需求更新时(要增加新的参数时),只要在Builder里添加相应的方法即可,而不用改动现有代码。下面先贴一下对应的代码再做详细解释。
Transfer类代码:
class Transfer
{
public function __call($method, $parameters)
{
$builder = new Builder();
return call_user_func_array([$builder, $method], $parameters);
}
public static function __callStatic($method, $parameters)
{
$instance = new static;
return call_user_func_array([$instance, $method], $parameters);
}
}
Builder类实际上只涉及到具体的功能实现,就贴部分代码意思意思看看就行:
class Builder
{
protected $from = 0; // 0 represents system
protected $to = 0;
protected $amount = 0;
protected $comments = '';
protected $related = [];
public function from($user)
{
if ($user instanceof User) {
$this->from = $user->getAuthIdentifier();
} elseif (is_int($user)) {
$this->from = $user;
} else {
throw new InvalidArgumentException(sprintf('%s excepts $user parameter to be \App\User or integer, %s given.', __METHOD__, gettype($user)));
}
return $this;
}
public function to($user){...}
public function amount(int $amount){...}
public function comments($comments){...}
public function related(int $type, int $id, $extra = null){...}
public function transfer(){...}
}
具体调用Transfer功能的代码:
Transfer::from($sender)->to($receiver)->amount($amount)->comments($comments)->related($related_type, $related_id, $related_extra)->transfer();
需要的储备知识:
- PHP魔术方法__call()和__callStatic()
- PHP面向对象基础知识
下面我们来走一遍调用Transfer的流程来看看。首先调用了Transfer
类中的静态方法from
,然而Transfer
中并不存在这个静态方法,则会自动调用__callStatic()
这个魔术方法。这个方法首先实例化了一个static
对象。注意这里的static是一个类名,new出来的$instance
是属于static
这个类的一个实例化对象,有点拗口(:з」∠)然后返回时调用了call_user_func_array
这个方法,这个方法具体可以参考php的手册,实际上它完成了类似$instance->method($parameters)
这样的操作,放到我们当前的情境下实际执行了$transfer_instance->from($user)
这样的操作。
然后发觉Transfer
中并不存在这个动态方法,于是又会自动调用__call()
这个魔术方法。这个方法首先创建了一个Builder
类的实例,之后调用call_user_func_array
这个方法,实际上相当于执行了$builder->from($user)
方法,然后终于得Builder
类里找到了这个from()
方法,注意它的返回值是$this
。(补充阅读:self vs. this in PHP)
然后当前这个Builder
这个对象继续调用to
方法,发觉又不存在又去调用__call()
这个魔术方法,之后的过程同上,反复调用Builder
中的方法把所有需要的参数都处理过以后最后调用了transfer()
方法最终完成转账操作。