PHP生成器怎么用

# PHP生成器怎么用

## 1. 生成器簡介

PHP生成器（Generator）是PHP 5.5引入的一項重要特性，它提供了一種更簡單、更高效的方式來處理大數據集合或需要延遲計算的場景。與傳統函數不同，生成器不會一次性返回所有結果，而是按需生成值，這在處理大型數據集時能顯著節省內存。

### 1.1 生成器與傳統函數的區別

- **內存占用**：傳統函數返回數組會占用全部內存，生成器每次只生成一個值
- **執行方式**：函數必須完整執行，生成器可以中途暫停和恢復
- **返回值**：函數只能return一次，生成器可以yield多次

### 1.2 適用場景

- 處理大型文件（如日志分析）
- 生成大數據集（如數據庫查詢結果）
- 實現簡單的協程
- 構建無限序列

## 2. 基本語法

### 2.1 定義生成器函數

生成器函數看起來像普通函數，但使用`yield`關鍵字代替`return`：

```php
function simpleGenerator() {
    yield 'first';
    yield 'second';
    yield 'third';
}

2.2 使用生成器

$generator = simpleGenerator();

foreach ($generator as $value) {
    echo $value . "\n";
}
// 輸出：
// first
// second
// third

2.3 yield關鍵字詳解

yield有兩個主要作用： 1. 暫停函數執行并返回一個值 2. 在下次調用時從暫停處恢復執行

3. 生成器的高級用法

3.1 鍵值對生成

生成器可以同時生成鍵和值：

function keyValueGenerator() {
    yield 'a' => 1;
    yield 'b' => 2;
    yield 'c' => 3;
}

foreach (keyValueGenerator() as $key => $value) {
    echo "$key: $value\n";
}

3.2 生成null值

function nullGenerator() {
    yield; // 產生null值
    yield;
}

3.3 從生成器返回最終值

PHP 7.0+支持在生成器中使用return返回最終值：

function generatorWithReturn() {
    yield 1;
    yield 2;
    return 'done';
}

$gen = generatorWithReturn();
foreach ($gen as $val) {
    echo $val . "\n";
}
echo $gen->getReturn(); // 輸出"done"

3.4 生成器委托

PHP 7.0+支持使用yield from委托給另一個生成器：

function delegateGenerator() {
    yield 1;
    yield from [2, 3];
    yield from anotherGenerator();
}

function anotherGenerator() {
    yield 4;
}

foreach (delegateGenerator() as $val) {
    echo $val . "\n";
}
// 輸出1,2,3,4

4. 實際應用案例

4.1 處理大文件

function readLargeFile($filename) {
    $file = fopen($filename, 'r');
    
    while (!feof($file)) {
        yield fgets($file);
    }
    
    fclose($file);
}

foreach (readLargeFile('huge.log') as $line) {
    // 處理每一行，內存中只保留一行內容
}

4.2 生成無限序列

function infiniteSequence() {
    $i = 0;
    while (true) {
        yield $i++;
    }
}

$gen = infiniteSequence();
echo $gen->current(); // 0
$gen->next();
echo $gen->current(); // 1
// 可以無限繼續...

4.3 數據庫分頁查詢

function paginateResults($query, $perPage = 100) {
    $page = 1;
    
    do {
        $results = DB::query("$query LIMIT ".(($page-1)*$perPage).",$perPage");
        
        if (empty($results)) break;
        
        foreach ($results as $result) {
            yield $result;
        }
        
        $page++;
    } while (count($results) === $perPage);
}

4.4 實現協程

function loggerCoroutine() {
    while (true) {
        echo 'Log: ' . yield . "\n";
    }
}

$logger = loggerCoroutine();
$logger->send('First message');
$logger->send('Second message');

5. 生成器方法詳解

生成器對象實現了Iterator接口，提供以下方法：

5.1 current()

返回當前產生的值

$gen = simpleGenerator();
echo $gen->current(); // 'first'

5.2 next()

恢復生成器執行

$gen->next();
echo $gen->current(); // 'second'

5.3 key()

返回當前產生的鍵

$gen = keyValueGenerator();
echo $gen->key(); // 'a'

5.4 valid()

檢查迭代器是否有效

$gen->valid(); // true
$gen->next();
$gen->next();
$gen->next();
$gen->valid(); // false

5.5 rewind()

重置迭代器（通常不可用）

$gen->rewind(); // 多數情況下會拋出異常

5.6 send() (PHP 5.5+)

向生成器傳入一個值

function receivingGenerator() {
    $value = yield;
    echo "Received: $value";
}

$gen = receivingGenerator();
$gen->send('hello'); // 輸出"Received: hello"

5.7 throw() (PHP 5.5+)

向生成器拋出異常

function exceptionGenerator() {
    try {
        yield;
    } catch (Exception $e) {
        echo "Caught: " . $e->getMessage();
    }
}

$gen = exceptionGenerator();
$gen->throw(new Exception('test')); // 輸出"Caught: test"

6. 性能優化

6.1 內存對比

// 傳統方式
function getLinesFromFile($fileName) {
    return file($fileName, FILE_IGNORE_NEW_LINES);
}

// 生成器方式
function getLinesFromFileGenerator($fileName) {
    $file = fopen($fileName, 'r');
    
    while (!feof($file)) {
        yield fgets($file);
    }
    
    fclose($file);
}

// 測試1GB文件
$fileName = 'large_file.txt';

// 傳統方式會消耗約1GB內存
$lines = getLinesFromFile($fileName);

// 生成器方式只消耗少量內存
foreach (getLinesFromFileGenerator($fileName) as $line) {
    // 處理每行
}

6.2 執行時間對比

對于大數據集，生成器可能比數組稍慢，但內存優勢明顯：

// 測試1000萬數據項
$start = microtime(true);
$array = range(1, 10000000); // 消耗約400MB內存
echo "Array: " . (microtime(true) - $start) . "s\n";

$start = microtime(true);
function xrange($start, $limit) {
    for ($i = $start; $i <= $limit; $i++) {
        yield $i;
    }
}
$generator = xrange(1, 10000000); // 幾乎不占內存
echo "Generator: " . (microtime(true) - $start) . "s\n";

7. 注意事項

7.1 生成器是一次性的

生成器遍歷后不能重新使用：

$gen = simpleGenerator();
foreach ($gen as $val) { /* ... */ }
foreach ($gen as $val) { /* 不會執行 */ }

7.2 不能返回引用

yield不能用于返回引用：

function &referenceGenerator() {
    $value = 1;
    yield $value; // 這樣是可以的
    // yield &$value; // 這樣會報錯
}

7.3 調試限制

生成器不像數組那樣可以直接打印或調試：

var_dump(simpleGenerator()); // 輸出object(Generator)#1 (0) {}

7.4 與數組函數的兼容性

大多數數組函數不能直接用于生成器，需要先轉換為數組：

// 錯誤用法
// count(simpleGenerator());

// 正確用法
count(iterator_to_array(simpleGenerator()));

8. 常見問題解答

Q1: 生成器是線程安全的嗎？

PHP本身是單線程的，生成器在單線程環境下是安全的。

Q2: 生成器可以序列化嗎？

不可以，Generator對象不能被序列化。

Q3: 如何在生成器中使用try-catch？

可以在生成器內部使用try-catch捕獲異常：

function exceptionHandlingGenerator() {
    try {
        yield 1;
        throw new Exception('test');
        yield 2;
    } catch (Exception $e) {
        yield 'Error: ' . $e->getMessage();
    }
}

Q4: 生成器會影響性能嗎？

生成器本身開銷很小，主要性能優勢在于內存節省，對于大數據處理場景非常有利。

9. 總結

PHP生成器是一種強大的工具，特別適合處理大數據集或需要延遲計算的場景。通過yield關鍵字，我們可以創建高效、內存友好的迭代器，而無需實現完整的Iterator接口。雖然生成器有一些限制（如一次性使用、調試不便等），但在合適的場景下，它能帶來顯著的性能提升。

掌握生成器的使用可以讓你寫出更優雅、更高效的PHP代碼，特別是在處理大型數據集、文件流或實現簡單協程等場景中。隨著PHP版本的更新，生成器的功能也在不斷增強（如yield from和return支持），值得每位PHP開發者深入學習和應用。 “`

這篇文章詳細介紹了PHP生成器的各個方面，包括基本語法、高級用法、實際案例、性能優化和注意事項等，總字數約2550字，采用Markdown格式編寫，包含代碼示例和結構化標題。