当前位置:Gxlcms > PHP教程 > PHP一种友好的函数传参模式设计

PHP一种友好的函数传参模式设计

时间:2021-07-01 10:21:17 帮助过:21人阅读

PHP一种友好的函数传参模式设计,有需要的朋友可以参考下。


当一个类的构造函数函数中,需要传入的参数较多时,程序员在编码时由于传参的顺序和写法难记忆,容易出现编译错误,或者出现值传给错误参数(弱类型语言)的情况.


友好的功能设计

程序员在实例化一个class时,传入的参数应该满足以下 友好性目标:
1. 能够只传入部分参数
2. 能够不按顺序传入参数
3. 能够不区分参数的大小写
4. 能够及时准确的提示传参时产生的错误


改进流程 例1-在成员变量中赋默认值 请看以下代码,函数的默认值在成员变量中赋予,这样在只传入部分参数时,系统会产生notice,即不满足"友好性目标"中的第一条.
  1. class FileUpload
  2. {
  3. private $filepath; //指定文件保存的路径
  4. private $allowtype = array("gif", "jpg", "jpeg", "png"); //允许的类型
  5. private $maxsize = 1000000; //允许上传的文件大小 1M
  6. private $israndname = true; //是否重命名文件
  7. function __construct($filepath, $allowtype, $maxsize, $israndname)
  8. {
  9. $this->filepath = $filepath;
  10. $this->allowtype = $allowtype;
  11. $this->maxsize = $maxsize;
  12. $this->israndname = $israndname;
  13. var_dump($this);
  14. }
例2-在构造函数中赋默认值

这一次,为了消除上例的notice,实现可以传入任意数量的参数,没有传入的参数使用默认值,将程序改为:在构造函数中设定默认值.

又一个问题出现:当程序员传入参数为(“/upload”,array(“jpg”,”gif”),false)时,即程序员忘记传入了maxsize参数,这时系统会错误的将false赋值给maxsize而不是israndname,系统没有任何错误输出,为后续工作留下隐患!

  1. class FileUpload
  2. {
  3. private $filepath;
  4. private $allowtype;
  5. private $maxsize;
  6. private $israndname;
  7. function __construct(
  8. $filepath = "/upload",
  9. $allowtype = array("gif", "jpg", "jpeg", "png"),
  10. $maxsize = 1000000,
  11. $israndname = true)
  12. {
  13. $this->filepath = $filepath;
  14. $this->allowtype = $allowtype;
  15. $this->maxsize = $maxsize;
  16. $this->israndname = $israndname;
  17. var_dump($this);
  18. }
例3-使用数组封装参数

为解决例2的问题,我们可以对传入的值进行检查来防止赋值错位的情况发生(反正一般情况下我们都会对传入的值进行检查).然而这并不是解决问题的方法,因为我们要实现的功能还有使程序员可以不按顺序传值.

在弱类型语言中,解决这个问题可以使用 数组 的特殊性,将所有传递的参数封装到数组中,以key=>value键值对的形式保存.请看如下代码:

  1. class FileUpload
  2. {
  3. private $filepath;
  4. private $allowtype;
  5. private $maxsize;
  6. private $israndname;
  7. function __construct($options=array([默认值]))
  8. {
  9. //解析传入的数组
  10. foreach($options as $key=>$value){
  11. $this->$key = $value;
  12. }
  13. }

这样就解决了传入参数的顺序问题,同时也解决了只传部分参数的问题.

然而新的问题出现了,这时程序员需要输入一个数组作为参数,如下:

  1. $up = new $FileUpload(array(
  2. "filepath" => "/upload",
  3. "israndname" => false,
  4. "maxsize" => 2000000
  5. ));
例4-解决参数的大小写

在使用数组封装参数之后,这时需要程序员手动输入变量的名字,这就会因风格不同导致MaxSize, maxSize, maxsize 这样的写法问题,解决这个问题只需要在声明成员变量时都统一用小写,然后在构造函数里加一行:

  1. foreach($options as $key=>$value){
  2. $key = strtolower($key);
  3. ...
  4. }

到这里,我们的设计已经满足了 友好性目标 中的前三点,整体代码如下:

  1. class FileUpload {
  2. private $filepath;
  3. private $allowtype;
  4. private $maxsize;
  5. private $israndname;
  6. function __construct($options=array(
  7. "$filepath" => "./",
  8. "$allowtype" => array("txt","jpg"),
  9. "$maxsize" => 1000000,
  10. "$israndname" => true
  11. )){
  12. //解析传入的数组
  13. foreach($options as $key=>$value){
  14. $key = strtolower($key);
  15. $this->$key = $value;
  16. }
  17. }
  18. }
例5-处理传入key的错误

在上例中,如果程序员传入了一个类中根本没有的参数,系统会报错,这里我们有两种处理方案:
1. 忽略无效参数,仅执行有效参数
2. 友好的提示出你传入的某个参数无效

个人认为为了程序的健壮性,不能轻易容许错误的代码存在,故选择第二者,我们将这个错误友好的提示给调用者.

  1. foreach($options as $key=>$value){
  2. $key = strtolower($key);
  3. //判断类中是否有这个变量
  4. if(in_array($key, get_class_vars(get_class($this)))) {
  5. $this->$key = $value;
  6. }else{ //提示错误位置和参数
  7. echo "Error when init class ".get_class($this)." with key: ".$key." in array !";
  8. exit;
  9. }
  10. }
例6-检查传入value是否合法

至此,预期的4个目标均已实现,且为了使__construct()函数具有复用性,使用时可以直接paste,我们将对value的检查抽象成一个函数,请看修改后的代码:

  1. class FileUpload {
  2. //变量名均使用小写
  3. private $filepath;
  4. private $allowtype;
  5. private $maxsize;
  6. private $israndname;
  7. //在构造函数中赋予默认值
  8. function __construct($options=array(
  9. "$filepath" => "./",
  10. "$allowtype" => array("txt","jpg"),
  11. "$maxsize" => 1000000,
  12. "$israndname" => true
  13. )){
  14. //解析传入的数组
  15. foreach($options as $key=>$value){
  16. $key = strtolower($key);
  17. //判断key是否在类中声明
  18. if(in_array($key, get_class_vars(get_class($this)))) {
  19. //检查value是否符合要求
  20. if(checkValue($key,$value)) {
  21. $this->$key = $value;
  22. } else {
  23. //提示错误位置和参数
  24. echo "Invalid value".$value."found when init class ".get_class($this)." with key: ".$key." in array !";
  25. exit;
  26. }
  27. }else{
  28. //提示错误位置和参数
  29. echo "Error when init class ".get_class($this)." with key: ".$key." in array !";
  30. exit;
  31. }
  32. }
  33. }
  34. function checkValue{
  35. if(){
  36. ...
  37. return true;
  38. }
  39. return false;
  40. }
  41. }
PHP

人气教程排行