一次 Hyperf 註解失效問題分析

来源:https://www.cnblogs.com/her-cat/archive/2023/03/18/hyperf-annotation-failure-problem-analysis.html
-Advertisement-
Play Games

本文講述了我排查「Hyperf 註解失效」問題的過程,整個排查過程看似一氣呵成,但實際上要曲折得多,甚至一度覺得這是個玄學問題。 ...


問題環境

PHP: 8.0.13
Swoole: 4.6.2
Hyperf: 2.2.33
運行環境: Docker Desktop on WSL2  

文章會持續修訂,轉載請註明來源地址:https://her-cat.com/posts/2023/03/02/hyperf-annotation-failure-problem-analysis/

問題背景

有同事說我之前使用註解實現的某個功能有問題,具體表現就是有部分使用了註解的類沒有被 Hyperf 收集到註解收集器中,導致出現了不符合預期的結果。

由於這個功能已經運行了一段時間,並且我在自己的電腦(Mac)上測試是正常的,找另外一個跟他同樣使用 Windows + Docker 開發的同事進行測試也是正常的,所以可以排除業務代碼和環境的問題。

簡化後的代碼如下:

#[Attribute(Attribute::TARGET_CLASS)]  
class CustomAnnotation extends AbstractAnnotation
{
}  
  
#[CustomAnnotation]  
class Foo
{  
}  
  
#[CustomAnnotation]  
class Bar
{  
}  

在上面的代碼中,定義了一個註解類 CustomAnnotation,並且在兩個類上使用了這個註解。期望的結果是 FooBar 都能夠被 Hyperf 收集到註解收集器中,但實際上只有 Foo 被收集到了。

Foo 和 Bar 分別在不同的文件中,但是都在同一個目錄下,該目錄下的文件數量有 60+。

於是我倆開始在他的電腦上排查是不是 Hyperf 的問題。

源碼分析

在 Hyperf 啟動時, ClassLoader 類載入器會掃描項目中所有的類文件,並將元數據(註解與類之間的關係)收集到相應的註解收集器中,如果沒有自定義註解收集器,則預設統一收集到 Hyperf\Di\Annotation\AnnotationCollector 類中。

下麵是完成收集註解的主要邏輯:

  • 使用 symfony/finder 組件提供的 Finder 類遍歷指定目錄下所有的 PHP 類文件。
  • 通過反射讀取每個文件中的類及其屬性、方法上使用的註解。
  • 依次檢查這些註解是否實現了 Hyperf\Di\Annotation\AnnotationInterface 介面,該介面定義了三個方法分別用於收集類、方法、屬性的元數據。
  • 如果註解實現了該介面,根據註解使用位置調用相應的方法將其收集到註解收集器中。

完成收集後,我們就能使用註解收集器提供的靜態方法的獲取對應的元數據用於實現一些自定義的邏輯和功能。

第一步就是先檢查類文件是否被 Finder 類讀取到了,這部分的邏輯在 ReflectionManager::getAllClasses() 靜態方法中。

public static function getAllClasses(array $paths): array  
{  
    $finder = new Finder();  
    // 設置讀取指定目錄下的 PHP 文件
    $finder->files()->in($paths)->name('*.php');  
    $parser = new Ast();  
  
    $reflectionClasses = [];  
    foreach ($finder as $file) {  
        try {  
	        // 解析文件內容獲取類名稱
            $stmts = $parser->parse($file->getContents());  
            if (! $className = $parser->parseClassByStmts($stmts)) {
	            // 沒獲取到說明沒有定義類
                continue;  
            }
            $reflectionClasses[$className] = static::reflectClass($className);  
        } catch (\Throwable) {  
        }    
    }    
    return $reflectionClasses;  
}

將獲取目錄下文件的這段代碼提出來單獨進行測試。由於 Finder 類實現了 IteratorAggregate 介面,所以在上面的代碼中可以直接對 Finder 類進行遍歷,也可以使用 iterator_to_array() 函數直接獲取迭代器的結果。

$finder = new Finder();  
// 設置讀取指定目錄下的 PHP 文件
$finder->files()->in('出現問題的目錄路徑')->name('*.php'); 
var_dump(iterator_to_array($finder));

通過觀察列印的結果就發現了問題所在:沒有讀取到 Bar 的類文件。

當時就在想,這麼流行的一個組件包總不能出現這麼低級的 Bug 吧?抱著懷疑的心態繼續分析 Finder 類實現迭代器的代碼,最後將問題定位到了 PHP 內置的 RecursiveDirectoryIterator 類上,Finder 類實際上就是對 PHP 的這些類做了一層封裝。

RecursiveDirectoryIterator 提供了一個用於遞歸迭代文件系統目錄的功能,用這個類再次進行上面的測試,依然沒有讀取到 Bar 的類文件。

$iter = new RecursiveDirectoryIterator('出現問題的目錄路徑');
var_dump(iterator_to_array($iter));

於是,我又一次陷入了懷疑中,難道 PHP 實現的這個類有問題?還得繼續看 PHP 的源碼?我在猶豫了一會後打開了 Google,抱著肯定有人也遇到過這個問題的想法輸入了「RecursiveDirectoryIterator bug」,按下回車,在短暫的頁面載入後...

嘿,還真有人已經遇到過這個問題。

真相大白

在前幾條搜索結果中,赫然發現有人在 PHP 官方的 Bug 系統反饋了這個問題:RecursiveDirectoryIterator returns incorrect results for Docker Desktop on WSL2,並貼心的附帶了可以復現問題的代碼。

下麵是精簡過後的復現代碼。

$filesPath = __DIR__.'/files';  
  
if (! mkdir($filesPath) && ! is_dir($filesPath)) {  
    throw new \RuntimeException(sprintf('Directory "%s" was not created', 'files'));  
}  
  
$max = 1;  
$stop = 5000;  
  
// 生成測試文件,模擬目錄中文件較多的情況  
foreach(range(1, $stop) as $index) {  
    $message = sprintf("creating %s\n", $index);  
    echo $message;  
    file_put_contents(__DIR__ . '/files/file' . $index, str_repeat('A', 100));  
}  
  
$iter = new \RecursiveDirectoryIterator($filesPath, FilesystemIterator::KEY_AS_PATHNAME|FilesystemIterator::CURRENT_AS_FILEINFO|FilesystemIterator::SKIP_DOTS);  
var_dump(iterator_count($iter));
// 列印出來的數字小於 5000 說明復現成功了

PHP 官方給出了回覆:這是 WSL 的 Bug,並提供了相關的 issue:WSL2: Seek of directory entry by lseek does not work on v9fs。裡面的實際輸出跟我們發現這個問題時的列印結果幾乎一模一樣,感興趣的可以去看看。

有人可能會問,lseek() 函數跟 RecursiveDirectoryIterator 類有什麼關係嗎 ?

當然有!將上面的代碼保存到 test.php 文件,然後執行 strace php test.php 命令查看 PHP 代碼的系統調用情況。

...省略其他部分...
openat(AT_FDCWD, "/home/ubuntu/files", O_RDONLY|O_NONBLOCK|O_CLOEXEC|O_DIRECTORY) = 4
fstat(4, {st_mode=S_IFDIR|0775, st_size=135168, ...}) = 0
brk(0x55d84733f000)                     = 0x55d84733f000
getdents(4, /* 1024 entries */, 32768)  = 32752
lseek(4, 0, SEEK_SET)                   = 0
getdents(4, /* 1024 entries */, 32768)  = 32752
getdents(4, /* 1024 entries */, 32768)  = 32768
getdents(4, /* 1024 entries */, 32768)  = 32768
getdents(4, /* 1024 entries */, 32768)  = 32768
getdents(4, /* 906 entries */, 32768)   = 28992
getdents(4, /* 0 entries */, 32768)     = 0
write(1, "int(5000)\n", 10int(5000)
)             = 10
close(3)                                = 0
close(4)                                = 0
...省略其他部分...

可以看到,RecursiveDirectoryIterator 類在底層中調用了 lseek() 函數,它的作用是設置文件偏移量。lseek(4, 0, SEEK_SET) 表示將文件偏移量設置為 0,即文件開頭的位置,該函數無法工作會導致下次操作依然使用的是原來的文件偏移量。

Linux 中萬物皆為文件,包括目錄。

用 PHP 代碼來舉個例子,這裡使用 PHP 的 rewinddir() 函數代替 lseek() 函數,實際上底層調用的還是 lseek() 函數。

$dh = opendir(__DIR__ . '/files');  
  
echo '開始讀取目錄中的所有文件:' . PHP_EOL;  
while (($file = readdir($dh)) !== false) {  
    echo 'filename:' . $file . PHP_EOL;  
}
  
echo '再次讀取目錄中的所有文件:' . PHP_EOL;  
// 這時文件偏移量已經到達文件的末尾,再次讀取目錄將不會有任何輸出,模擬 lseek() 函數無法工作的情況 
while (($file = readdir($dh)) !== false) {  
    echo 'filename:' . $file . PHP_EOL;  
}  
  
// 將文件偏移量重置到文件的開頭  
rewinddir($dh);  
  
echo '重置偏移量後讀取目錄中的所有文件:' . PHP_EOL;  
// 與第一次讀取的結果相同,模擬 lseek() 函數正常工作的情況
while (($file = readdir($dh)) !== false) {
    echo 'filename:' . $file . PHP_EOL;  
}  
  
closedir($dh);

在 WSL2 以外的系統中運行以上代碼,可以得到與預期一致的結果。那麼在 WSL2 中運行的結果是什麼?

解決問題

當然,最好是 WSL 官方能夠修複這個問題,但是從有人提出這個問題到現在已經快三年了依然沒有被解決的情況來看,不知道得等到猴年馬月。

提問的作者也給出了一種解決方案,開啟 Hyper V。但是經過測試後發現開啟 Hyper V 依然會出現這個問題,所以最後直接從 WSL2 回滾到 WSL1,從另一種「根本上」解決這個問題。

總結

等等,文章開頭不是說已經排除是環境的問題了嗎?怎麼最後又是環境的問題了?

是的,這是由於我當時並沒有問清楚,只是確認了另一個同事是用 Docker 運行的,我怎麼也沒想到他是本地運行了個虛擬機,然後在虛擬機裡面運行 Docker...

當然,後面的源碼分析也不是一點作用都沒有,至少將問題的範圍從 Hyperf 框架縮小到了 Finder 類,再到 RecursiveDirectoryIterator 類。否則直接 Google 搜索「Hyperf 註解失效」是很難找到正確答案的。

在這篇文章中,講述了我排查「Hyperf 註解失效」問題的過程,整個排查過程看似一氣呵成,但實際上要曲折得多,甚至一度覺得這是個玄學問題。

最後,沒有 Bug 的程式是不存在的,不要過度迷信那些看似很可靠的系統。

博客地址:她和她的貓,歡迎關註。
您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 此內容包含: html基礎 列表、表格 媒體元素 表單(重點) 1、HTML 基礎 目標: 會使用HTML5的基本結構創建網頁 會使用文本相關標簽排版文本信息 會使用圖像相關標簽實現圖文並茂的頁面 會使用標簽創建超鏈接、錨鏈接及功能性鏈接 1.1、什麼是HTML HTML:Hyper Text Ma ...
  • 定義 如果希望動態給某個類添加一些屬性或者方法,但是你又不希望這個類派生的對象受到影響,那麼裝飾器模式就可以給你帶來這樣的體驗。 它的定義就是在不改變原對象的基礎上,通過對其進行包裝拓展,使得原有對象可以動態具有更多功能,從而滿足用戶的更複雜需求。 舉個例子,一部手機,你可以買各種花里胡哨的手機殼等 ...
  • MVVM M:模型(Model):data V:視圖(View):模板 VM:視圖模型(ViewModel):Vue實例對象 Vue收到了MVVM模型的啟發,MVVM是vue實現數據驅動視圖和雙向數據綁定的核心原理,通過ViewModel監聽DOM和數據源的變化。 Object.defineProp ...
  • 這篇文章主要關註分散式鎖,包括加鎖和解鎖的過程,鎖的用法,加鎖帶來的代價,對性能的影響以及如何避免死鎖。 ...
  • 1. 巨型對象 1.1. humongous object 1.2. 大於等於區域一半大小的對象 1.3. 巨型對象被直接分配在老年代,所以它在新生代回收期間不會被釋放 1.4. G1區域的大小是2的冪,最小值是1 MB 1.5. 如果堆的最大值和初始值差別很大,就會有過多的G1區域,這種情況下應該 ...
  • Java基礎複習筆記 第01章:Java語言概述 1. Java基礎學習的章節劃分 第1階段:Java基本語法 Java語言概述、Java的變數與進位、運算符、流程式控制制語句(條件判斷、迴圈結構)、break\continue、 IDEA開發工具的使用、數組 第2階段:面向對象編程(基礎、進階、高級) ...
  • php-fpm下讀取到is_cli為true,不知道你們是否遇到過,我是遇到了。。。。 有人會說,即使為true又怎麼了,你是沒遇到有些根據is_cli來走不同邏輯判斷的,如果讀取的是錯的就會引起很大的問題。。。。 ...
  • 工作中會遇到需要監控程式運行過程數據的情況,比如定時執行監控的cmd並記錄執行結果,本文提供一種實現方式,便於後續排查問題。 ...
一周排行
    -Advertisement-
    Play Games
  • 背景 在瀏覽器中訪問本地靜態資源html網頁時,可能會遇到跨域問題如圖。 是因為瀏覽器預設啟用了同源策略,即只允許載入與當前網頁具有相同源(協議、功能變數名稱和埠)的內容。 WebView2預設情況下啟用了瀏覽器的同源策略,即只允許載入與主機相同源的內容。所以如果我們把靜態資源發佈到iis或者通過node ...
  • 最近看幾個老項目的SQL條件中使用了1=1,想想自己也曾經這樣寫過,略有感觸,特別拿出來說道說道。編寫SQL語句就像炒菜,每一種調料的使用都會影響菜品的最終味道,每一個SQL條件的加入也會影響查詢的執行效率。那麼 1=1 存在什麼樣的問題呢?為什麼又會使用呢? ...
  • 好久不見,我又回來了。 給大家分享一個我最近使用c#代碼操作ftp伺服器的代碼示例: 1 public abstract class FtpOperation 2 { 3 /// <summary> 4 /// FTP伺服器地址 5 /// </summary> 6 private string f ...
  • 一:背景 1. 講故事 過年喝了不少酒,腦子不靈光了,停了將近一個月沒寫博客,今天就當新年開工寫一篇吧。 去年年初有位朋友找到我,說他們的系統會偶發性崩潰,在網上也發了不少帖子求助,沒找到自己滿意的答案,讓我看看有沒有什麼線索,看樣子這是一個牛皮蘚的問題,既然對方有了dump,那就分析起來吧。 二: ...
  • 自己製作的一個基於Entity Framework Core 的資料庫操作攔截器,可以列印資料庫執行sql,方便開發調試,代碼如下: /// <summary> /// EF Core 的資料庫操作攔截器,用於在資料庫操作過程中進行日誌記錄和監視。 /// </summary> /// <remar ...
  • 本文分享自華為雲社區《Go併發範式 流水線和優雅退出 Pipeline 與 Cancellation》,作者:張儉。 介紹 Go 的併發原語可以輕鬆構建流數據管道,從而高效利用 I/O 和多個 CPU。 本文展示了此類pipelines的示例,強調了操作失敗時出現的細微之處,並介紹了乾凈地處理失敗的 ...
  • 在上篇文章中,我們介紹到在多線程環境下,如果編程不當,可能會出現程式運行結果混亂的問題。出現這個原因主要是,JMM 中主記憶體和線程工作記憶體的數據不一致,以及多個線程執行時無序,共同導致的結果。 ...
  • 1、下載安裝包首先、進入官網下載安裝包網址:https://www.python.org/downloads/windows/下載步驟:進入下載地址,根據自己的電腦系統選擇相應的python版本 選擇適配64位操作系統的版本(查看自己的電腦操作系統版本), 點擊下載安裝包 也可以下載我百度雲分享的安 ...
  • 簡介 git-commit-id-maven-plugin 是一個maven 插件,用來在打包的時候將git-commit 信息打進jar中。 這樣做的好處是可以將發佈的某版本和對應的代碼關聯起來,方便查閱和線上項目的維護。至於它的作用,用官方說法,這個功能對於大型分散式項目來說是無價的。 功能 你 ...
  • 序言 在數字時代,圖像生成技術正日益成為人工智慧領域的熱點。 本討論將重點聚焦於兩個備受矚目的模型:DALL-E和其他主流AI繪圖方法。 我們將探討它們的優勢、局限性以及未來的發展方向。通過比較分析,我們期望能夠更全面地瞭解這些技術,為未來的研究和應用提供啟示。 Q: 介紹一下 dall-e Ope ...