如何為Laravel Artisan命令添加基於cli_get_process_title函數的動態進程標題？

M66 2025-06-27

在開發Laravel應用程序時，我們常常會使用Artisan命令來執行各種任務。 Artisan命令是Laravel框架自帶的一個非常強大的命令行工具，它幫助開發者簡化了很多任務的執行，比如數據庫遷移、隊列處理、定時任務等等。

但是，當我們在執行長時間運行的Artisan命令時，可能會有多個命令在後台同時運行。為了區分這些進程，尤其是在使用進程監控工具（如htop或ps命令）時，我們希望能夠為每個進程設置一個易於識別的動態進程標題。幸運的是，我們可以通過PHP的cli_get_process_title函數來實現這個目標。

在本文中，我們將探討如何為Laravel Artisan命令添加基於cli_get_process_title函數的動態進程標題，以便更輕鬆地在命令行界面中查看和識別不同的進程。

1. 什麼是cli_get_process_title ？

cli_get_process_title是一個PHP函數，用於獲取當前PHP進程的標題。它返回一個字符串，代表當前進程在操作系統中的顯示名稱。通過修改這個標題，我們可以讓進程在命令行界面中顯示更具描述性的名稱，從而幫助我們更好地管理和監控進程。

在默認情況下，PHP進程的標題通常是“php”或類似的通用標識符，但使用cli_get_process_title後，我們可以將其改為更具辨識度的名稱，例如當前正在執行的Laravel Artisan命令。

2. 使用cli_get_process_title為Artisan命令設置動態進程標題

為了為Laravel的Artisan命令設置動態進程標題，我們需要在命令的執行過程中修改進程標題。下面是一個簡單的步驟指南：

2.1 創建一個自定義Artisan命令

首先，我們需要創建一個自定義的Artisan命令。可以通過運行以下命令來創建一個新的Artisan命令：

 <span><span>php artisan make:</span><span><span class="hljs-built_in">command</span></span><span> SetProcessTitleCommand
</span></span>

這會在app/Console/Commands目錄下生成一個新的命令類文件SetProcessTitleCommand.php 。

2.2 在命令中使用cli_set_process_title

接下來，我們需要在命令類中使用cli_set_process_title函數來設置進程標題。打開SetProcessTitleCommand.php文件，並在handle方法中添加代碼來動態設置進程標題。

 <span><span><span class="hljs-meta">&lt;?php</span></span><span>

</span><span><span class="hljs-keyword">namespace</span></span><span> </span><span><span class="hljs-title class_">App</span></span><span>\</span><span><span class="hljs-title class_">Console</span></span><span>\</span><span><span class="hljs-title class_">Commands</span></span><span>;

</span><span><span class="hljs-keyword">use</span></span><span> </span><span><span class="hljs-title">Illuminate</span></span><span>\</span><span><span class="hljs-title">Console</span></span><span>\</span><span><span class="hljs-title">Command</span></span><span>;

</span><span><span class="hljs-class"><span class="hljs-keyword">class</span></span></span><span> </span><span><span class="hljs-title">SetProcessTitleCommand</span></span><span> </span><span><span class="hljs-keyword">extends</span></span><span> </span><span><span class="hljs-title">Command</span></span><span>
{
    </span><span><span class="hljs-comment">// 命令的名稱</span></span><span>
    </span><span><span class="hljs-keyword">protected</span></span><span> </span><span><span class="hljs-variable">$signature</span></span><span> = </span><span><span class="hljs-string">'set:process-title {title}'</span></span><span>;
    
    </span><span><span class="hljs-comment">// 命令的描述</span></span><span>
    </span><span><span class="hljs-keyword">protected</span></span><span> </span><span><span class="hljs-variable">$description</span></span><span> = </span><span><span class="hljs-string">'設置當前進程的標題'</span></span><span>;

    </span><span><span class="hljs-comment">// 執行命令的方法</span></span><span>
    </span><span><span class="hljs-keyword">public</span></span><span> </span><span><span class="hljs-function"><span class="hljs-keyword">function</span></span></span><span> </span><span><span class="hljs-title">handle</span></span><span>(</span><span><span class="hljs-params"></span></span><span>)
    {
        </span><span><span class="hljs-comment">// 獲取命令行參數</span></span><span>
        </span><span><span class="hljs-variable">$title</span></span><span> = </span><span><span class="hljs-variable language_">$this</span></span><span>-&gt;</span><span><span class="hljs-title function_ invoke__">argument</span></span><span>(</span><span><span class="hljs-string">'title'</span></span><span>);
        
        </span><span><span class="hljs-comment">// 使用cli_set_process_title設置進程標題</span></span><span>
        </span><span><span class="hljs-keyword">if</span></span><span> (</span><span><span class="hljs-title function_ invoke__">function_exists</span></span><span>(</span><span><span class="hljs-string">'cli_set_process_title'</span></span><span>)) {
            </span><span><span class="hljs-title function_ invoke__">cli_set_process_title</span></span><span>(</span><span><span class="hljs-variable">$title</span></span><span>);
            </span><span><span class="hljs-variable language_">$this</span></span><span>-&gt;</span><span><span class="hljs-title function_ invoke__">info</span></span><span>(</span><span><span class="hljs-string">"進程標題已設置為: <span class="hljs-subst">$title</span></span></span><span>");
        } </span><span><span class="hljs-keyword">else</span></span><span> {
            </span><span><span class="hljs-variable language_">$this</span></span><span>-&gt;</span><span><span class="hljs-title function_ invoke__">error</span></span><span>(</span><span><span class="hljs-string">'當前PHP版本不支持cli_set_process_title函數'</span></span><span>);
        }
    }
}
</span></span>

在上面的代碼中，我們做了以下幾件事：

創建了一個新的Artisan命令set:process-title ，它接受一個命令行參數title ，即我們希望為進程設置的標題。
在handle方法中，我們使用cli_set_process_title來動態設置進程標題。
如果cli_set_process_title函數不可用（例如，PHP環境不支持此函數），則會提示用戶當前環境不支持該功能。

2.3 註冊命令

然後，我們需要在app/Console/Kernel.php文件中註冊這個新的命令。在$commands數組中添加對新命令的引用：

 <span><span><span class="hljs-keyword">protected</span></span><span> </span><span><span class="hljs-variable">$commands</span></span><span> = [
    </span><span><span class="hljs-title class_">Commands\SetProcessTitleCommand</span></span><span>::</span><span><span class="hljs-variable language_">class</span></span><span>,
];
</span></span>

2.4 運行命令

現在，我們可以通過運行以下命令來測試進程標題的設置：

 <span><span>php artisan </span><span><span class="hljs-built_in">set</span></span><span>:process-title </span><span><span class="hljs-string">"My Custom Process Title"</span></span><span>
</span></span>

如果一切正常，你可以通過系統的ps命令或類似工具查看進程標題。你應該能夠看到進程的標題已經被成功設置為“ My Custom Process Title ”。

3. 進階：在長時間運行的命令中動態更新標題

如果你需要在長時間運行的命令中動態更新進程標題，可以在命令的執行過程中周期性地調用cli_set_process_title 。例如，在處理任務隊列時，你可能希望根據當前處理的任務動態更新進程標題。

下面是一個示例，展示如何在執行一個長時間運行的命令時動態更新進程標題：

 <span><span><span class="hljs-keyword">public</span></span><span> </span><span><span class="hljs-function"><span class="hljs-keyword">function</span></span></span><span> </span><span><span class="hljs-title">handle</span></span><span>(</span><span><span class="hljs-params"></span></span><span>)
{
    </span><span><span class="hljs-variable">$tasks</span></span><span> = </span><span><span class="hljs-variable language_">$this</span></span><span>-&gt;</span><span><span class="hljs-title function_ invoke__">getTasks</span></span><span>(); </span><span><span class="hljs-comment">// 假設獲取一組任務</span></span><span>
    
    </span><span><span class="hljs-keyword">foreach</span></span><span> (</span><span><span class="hljs-variable">$tasks</span></span><span> </span><span><span class="hljs-keyword">as</span></span><span> </span><span><span class="hljs-variable">$index</span></span><span> =&gt; </span><span><span class="hljs-variable">$task</span></span><span>) {
        </span><span><span class="hljs-variable">$title</span></span><span> = </span><span><span class="hljs-string">"處理任務 <span class="hljs-subst">$index</span></span></span><span> / " . </span><span><span class="hljs-title function_ invoke__">count</span></span><span>(</span><span><span class="hljs-variable">$tasks</span></span><span>);
        
        </span><span><span class="hljs-keyword">if</span></span><span> (</span><span><span class="hljs-title function_ invoke__">function_exists</span></span><span>(</span><span><span class="hljs-string">'cli_set_process_title'</span></span><span>)) {
            </span><span><span class="hljs-title function_ invoke__">cli_set_process_title</span></span><span>(</span><span><span class="hljs-variable">$title</span></span><span>);
        }

        </span><span><span class="hljs-comment">// 處理任務</span></span><span>
        </span><span><span class="hljs-variable language_">$this</span></span><span>-&gt;</span><span><span class="hljs-title function_ invoke__">processTask</span></span><span>(</span><span><span class="hljs-variable">$task</span></span><span>);
        
        </span><span><span class="hljs-comment">// 為了展示效果，我們這裡模擬一下每個任務的處理時間</span></span><span>
        </span><span><span class="hljs-title function_ invoke__">sleep</span></span><span>(</span><span><span class="hljs-number">1</span></span><span>);
    }
}
</span></span>

在上面的代碼中，命令會遍歷一組任務，並在處理每個任務時動態更新進程標題。通過這種方式，你可以在命令行中實時看到當前進程的狀態。

4. 總結

通過cli_get_process_title和cli_set_process_title函數，我們可以為Laravel Artisan命令設置動態的進程標題。這對於在命令行中運行多個後台進程時區分不同的進程非常有幫助，尤其是在開發和生產環境中使用長時間運行的命令時。

雖然cli_set_process_title函數並不是所有PHP版本都支持，但它對於需要進程管理和監控的開發者來說，是一個非常有用的工具。希望這篇文章能幫助你在自己的Laravel項目中實現這一功能，提升工作效率和系統管理體驗。