PHP的类型提示（Type Hinting）与类型安全：在函数签名中强制参数与返回值类型 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

PHP 类型提示与类型安全：在函数签名中强制参数与返回值类型

大家好，今天我们来深入探讨PHP中的类型提示（Type Hinting）以及它对类型安全的重要性。作为一名PHP开发者，你可能已经接触过类型提示，但你真的理解它背后的机制以及如何有效地利用它来提升代码质量吗？本次讲座将通过丰富的代码示例，详细讲解PHP类型提示的使用方法、优势、以及一些需要注意的最佳实践。

什么是类型提示？

类型提示是一种在函数或方法的签名中声明参数和返回值预期数据类型的机制。它允许你告诉PHP解释器，函数期望接收什么类型的参数，以及期望返回什么类型的数据。如果传入的参数类型或返回值的类型与声明的类型不匹配，PHP将会抛出一个TypeError异常。

类型提示的语法

PHP的类型提示语法相对简单，它位于参数名称或返回值类型声明之前。下面是一些常见的类型提示示例：

1. 标量类型提示（Scalar Type Hints）：

int: 声明参数或返回值必须是整数。
float: 声明参数或返回值必须是浮点数。
string: 声明参数或返回值必须是字符串。
bool: 声明参数或返回值必须是布尔值。

<?php

function add(int $a, int $b): int {
  return $a + $b;
}

echo add(1, 2); // 输出 3

try {
  echo add("1", 2); // 抛出 TypeError 异常
} catch (TypeError $e) {
  echo "Error: " . $e->getMessage();
}

?>

在这个例子中，add 函数声明了两个 int 类型的参数 $a 和 $b，并且声明了返回值也必须是 int 类型。当我们传入字符串 "1" 作为参数时，PHP会抛出一个 TypeError 异常，因为类型不匹配。

2. 类/接口类型提示（Class/Interface Type Hints）：

允许指定参数必须是特定类或接口的实例。

<?php

interface LoggerInterface {
  public function log(string $message);
}

class FileLogger implements LoggerInterface {
  public function log(string $message) {
    echo "Logging to file: " . $message . "n";
  }
}

class DatabaseLogger implements LoggerInterface {
  public function log(string $message) {
    echo "Logging to database: " . $message . "n";
  }
}

function processLog(LoggerInterface $logger, string $message) {
  $logger->log($message);
}

$fileLogger = new FileLogger();
$databaseLogger = new DatabaseLogger();

processLog($fileLogger, "This is a file log message."); // 输出: Logging to file: This is a file log message.
processLog($databaseLogger, "This is a database log message."); // 输出: Logging to database: This is a database log message.

try {
  processLog("not a logger", "This will cause an error."); // 抛出 TypeError 异常
} catch (TypeError $e) {
  echo "Error: " . $e->getMessage();
}

?>

在这个例子中，processLog 函数声明了第一个参数必须是 LoggerInterface 的实例。任何实现了 LoggerInterface 接口的类都可以作为参数传递给 processLog 函数。如果我们尝试传递一个字符串作为参数，PHP会抛出一个 TypeError 异常。

3. 数组类型提示（Array Type Hint）：

声明参数必须是数组。

<?php

function processArray(array $data) {
  foreach ($data as $item) {
    echo $item . "n";
  }
}

$myArray = [1, 2, 3];
processArray($myArray);

try {
  processArray("not an array"); // 抛出 TypeError 异常
} catch (TypeError $e) {
  echo "Error: " . $e->getMessage();
}

?>

4. 可调用类型提示（Callable Type Hint）：

声明参数必须是可调用的，例如函数或方法。

<?php

function applyFunction(callable $callback, int $value) {
  return $callback($value);
}

function square(int $x): int {
  return $x * $x;
}

echo applyFunction('square', 5); // 输出 25
echo applyFunction(function($x) { return $x * 3; }, 5); // 输出 15

try {
  applyFunction("not a function", 5); // 抛出 TypeError 异常
} catch (TypeError $e) {
  echo "Error: " . $e->getMessage();
}

?>

5. object 类型提示 (PHP 7.2+)

声明参数必须是一个对象。

<?php

class MyClass {}

function processObject(object $obj) {
  echo "Object received.n";
}

$myObject = new MyClass();
processObject($myObject);

try {
  processObject("not an object"); // 抛出 TypeError 异常
} catch (TypeError $e) {
  echo "Error: " . $e->getMessage();
}

?>

6. iterable 类型提示 (PHP 7.1+)

声明参数必须是可迭代的，例如数组或实现了 Traversable 接口的对象。

<?php

function processIterable(iterable $data) {
  foreach ($data as $item) {
    echo $item . "n";
  }
}

$myArray = [1, 2, 3];
processIterable($myArray);

class MyIterator implements Iterator {
  private $position = 0;
  private $array = array(
      "first"  => 1,
      "second" => 2,
      "third"  => 3
  );

  public function rewind(): void {
      $this->position = 0;
  }

  public function current(): mixed {
      return $this->array[array_keys($this->array)[$this->position]];
  }

  public function key(): mixed {
      return array_keys($this->array)[$this->position];
  }

  public function next(): void {
      ++$this->position;
  }

  public function valid(): bool {
      return isset($this->array[array_keys($this->array)[$this->position]]);
  }
}

$myIterator = new MyIterator();
processIterable($myIterator);

try {
  processIterable("not iterable"); // 抛出 TypeError 异常
} catch (TypeError $e) {
  echo "Error: " . $e->getMessage();
}

?>

7. void 返回值类型提示 (PHP 7.1+)

声明函数没有返回值。

<?php

function doSomething(): void {
  echo "Doing something...n";
}

doSomething();

// 不允许返回任何值，即使是 null
function doSomethingElse(): void {
  echo "Doing something else...n";
  // return null; // 抛出 TypeError
}

?>

8. 可为空类型提示 (Nullable Type Hints) (PHP 7.1+)

允许参数或返回值可以为指定类型或 null。使用 ? 符号。

<?php

function processString(?string $name) {
  if ($name === null) {
    echo "Name is null.n";
  } else {
    echo "Name is: " . $name . "n";
  }
}

processString("John"); // 输出: Name is: John
processString(null); // 输出: Name is null.

// 可以省略参数，因为它是 nullable
function greet(?string $name = null): string {
    if ($name === null) {
        return "Hello, guest!";
    }
    return "Hello, " . $name . "!";
}

echo greet();       // 输出: Hello, guest!
echo greet("Alice"); // 输出: Hello, Alice!

?>

9. 联合类型 (Union Types) (PHP 8.0+)

允许参数或返回值可以是多种类型之一。使用 | 符号。

<?php

function processData(int|string $data) {
  if (is_int($data)) {
    echo "Data is an integer: " . $data . "n";
  } else {
    echo "Data is a string: " . $data . "n";
  }
}

processData(123); // 输出: Data is an integer: 123
processData("hello"); // 输出: Data is a string: hello

try {
  processData(1.23); // 抛出 TypeError 异常
} catch (TypeError $e) {
  echo "Error: " . $e->getMessage();
}

function returnIntOrString(): int|string {
    if (rand(0, 1)) {
        return 123;
    } else {
        return "hello";
    }
}

echo returnIntOrString();
?>

10. mixed 类型 (PHP 8.0+)

<?php

function processMixed(mixed $data) {
  var_dump($data);
}

processMixed(123); // 输出: int(123)
processMixed("hello"); // 输出: string(5) "hello"
processMixed(null); // 输出: NULL
processMixed(new stdClass()); // 输出: object(stdClass)#1 (0) { }

?>

类型提示的优势

使用类型提示可以带来许多好处：

提高代码可读性： 类型提示使代码更易于理解，因为它可以清晰地表明函数期望接收什么类型的数据。
减少错误： 类型提示可以在开发阶段捕获类型错误，避免在运行时出现意外情况。这可以显著提高代码的健壮性。
改善代码维护性： 类型提示使代码更易于维护，因为它可以帮助开发者更快地理解代码的意图，并减少引入错误的风险。
增强IDE支持： 类型提示可以帮助IDE提供更准确的代码补全、错误检测和重构功能。
提升性能: 虽然类型提示主要目的是增强类型安全和代码可读性，但某些情况下，它可以帮助PHP引擎进行优化，从而略微提升性能。

类型提示的注意事项

强制性： 类型提示是强制性的。如果传入的参数类型与声明的类型不匹配，PHP将会抛出一个 TypeError 异常。
类型转换： PHP不会自动将参数转换为声明的类型。例如，如果函数声明了一个 int 类型的参数，而你传入了一个字符串，PHP不会尝试将该字符串转换为整数，而是会抛出一个 TypeError 异常。
父类和子类： 如果函数声明了一个父类类型的参数，你可以传入该父类的实例或任何子类的实例。这符合面向对象编程中的里氏替换原则。
接口： 如果函数声明了一个接口类型的参数，你可以传入任何实现了该接口的类的实例。
null 值： 默认情况下，类型提示不允许传入 null 值。要允许传入 null 值，可以使用可为空类型提示（?string，?int 等）。
mixed 类型： 谨慎使用 mixed 类型。虽然它可以接受任何类型的值，但它也降低了类型安全性，并可能导致运行时错误。尽可能使用更具体的类型提示。

一个更复杂的例子

假设我们正在开发一个电商网站，我们需要一个 Product 类和一个 ShoppingCart 类。我们可以使用类型提示来确保代码的类型安全。

<?php

class Product {
  private string $name;
  private float $price;

  public function __construct(string $name, float $price) {
    $this->name = $name;
    $this->price = $price;
  }

  public function getName(): string {
    return $this->name;
  }

  public function getPrice(): float {
    return $this->price;
  }
}

class ShoppingCart {
  private array $items = [];

  public function addItem(Product $product, int $quantity = 1): void {
    if ($quantity <= 0) {
      throw new InvalidArgumentException("Quantity must be greater than zero.");
    }
    $this->items[] = ['product' => $product, 'quantity' => $quantity];
  }

  public function getTotal(): float {
    $total = 0.0;
    foreach ($this->items as $item) {
      $total += $item['product']->getPrice() * $item['quantity'];
    }
    return $total;
  }

  public function getItems(): array {
    return $this->items;
  }
}

// 使用示例
$product1 = new Product("Laptop", 1200.00);
$product2 = new Product("Mouse", 25.00);

$cart = new ShoppingCart();
$cart->addItem($product1, 1);
$cart->addItem($product2, 2);

echo "Total: $" . $cart->getTotal() . "n";

foreach ($cart->getItems() as $item) {
  echo $item['product']->getName() . " - Quantity: " . $item['quantity'] . "n";
}

try {
  $cart->addItem("not a product", 1); // 抛出 TypeError 异常
} catch (TypeError $e) {
  echo "Error: " . $e->getMessage() . "n";
}

try {
    $cart->addItem($product1, -1); // 抛出 InvalidArgumentException 异常
} catch (InvalidArgumentException $e) {
    echo "Error: " . $e->getMessage() . "n";
}

?>

在这个例子中，ShoppingCart::addItem 方法声明了第一个参数必须是 Product 类的实例。这可以确保只有 Product 对象才能添加到购物车中，从而避免类型错误。我们还添加了数量大于0的校验，可以避免业务逻辑错误。

类型提示与文档生成

类型提示不仅仅是为了类型安全，它们还可以用于自动生成API文档。许多文档生成工具 (例如，phpDocumentor) 可以解析代码中的类型提示，并自动生成文档，描述函数的参数和返回值类型。这可以大大提高API文档的质量和可维护性。

类型提示的最佳实践

尽可能使用类型提示： 在函数和方法的签名中尽可能使用类型提示，以提高代码的可读性、健壮性和可维护性。
使用具体的类型提示： 尽可能使用具体的类型提示，例如 int、string、Product 等。避免过度使用 mixed 类型，因为它会降低类型安全性。
考虑使用可为空类型提示： 如果参数或返回值可以为 null，请使用可为空类型提示。
遵循里氏替换原则： 如果函数声明了一个父类类型的参数，请确保可以传入该父类的任何子类的实例。
在开发阶段进行充分的测试： 使用类型提示可以在开发阶段捕获类型错误。进行充分的测试可以确保代码在运行时不会出现意外情况。
拥抱 Union Types (PHP 8+): 联合类型提供了更大的灵活性，在需要接受多种类型的情况下，优先考虑使用联合类型而不是 mixed。
利用静态分析工具: 静态分析工具 (例如，PHPStan 和 Psalm) 可以分析代码中的类型提示，并检测潜在的类型错误。将静态分析工具集成到你的开发流程中，可以进一步提高代码质量。

总结

类型提示是 PHP 中一个强大的特性，它可以帮助你编写更健壮、可读和可维护的代码。通过在函数和方法的签名中声明参数和返回值的预期数据类型，你可以及早发现类型错误，并提高代码的质量。充分利用类型提示，并结合最佳实践，可以使你的 PHP 代码更加出色。

深入理解类型提示机制

类型提示不仅仅是语法糖，它涉及到PHP引擎内部的类型检查机制。当PHP执行到一个带有类型提示的函数调用时，它会进行以下操作：

参数类型检查: 引擎会检查传入的参数类型是否与函数签名中声明的类型匹配。
类型不匹配处理: 如果类型不匹配，引擎会抛出一个 TypeError 异常。异常信息会包含详细的错误描述，例如：期望的类型、实际传入的类型以及出错的文件和行号。
返回值类型检查: (如果声明了返回值类型) 在函数返回之前，引擎会检查返回值的类型是否与函数签名中声明的类型匹配。如果类型不匹配，也会抛出一个 TypeError 异常。

理解这个机制有助于我们更好地利用类型提示，并在出现类型错误时快速定位问题。

关于强制模式（Strict Types）

PHP提供了一种更严格的类型检查模式，称为强制模式（Strict Types）。默认情况下，PHP处于弱类型模式（Coercive Types），这意味着它会尝试将传入的参数转换为声明的类型。例如，如果函数声明了一个 int 类型的参数，而你传入了一个字符串 "123"，PHP会尝试将该字符串转换为整数 123。

要启用强制模式，需要在文件的开头添加 declare(strict_types=1); 指令。启用强制模式后，PHP将不再进行类型转换。如果传入的参数类型与声明的类型不匹配，PHP将会抛出一个 TypeError 异常，即使在弱类型模式下可以进行类型转换。

<?php
declare(strict_types=1); // 启用强制模式

function add(int $a, int $b): int {
  return $a + $b;
}

echo add(1, 2); // 输出 3

try {
  echo add("1", 2); // 抛出 TypeError 异常 (即使在弱类型模式下可以转换为整数)
} catch (TypeError $e) {
  echo "Error: " . $e->getMessage();
}

?>

强烈建议在新的 PHP 项目中启用强制模式，以提高代码的类型安全性和可预测性。强制模式可以帮助你及早发现类型错误，并避免在运行时出现意外情况。但是，需要注意的是，启用强制模式可能会导致现有代码出现兼容性问题，因此在现有项目中启用强制模式时需要进行充分的测试。

类型提示让编码更规范

类型提示不仅是语法层面的约束，更是一种编码规范的体现。它鼓励开发者在设计函数和类的时候，明确地思考输入和输出的数据类型，从而提高代码的可读性、可维护性和可测试性。好的类型提示设计可以使代码更加清晰、易于理解，并降低维护成本。

类型提示增强代码的鲁棒性，编码时多加注意吧