(本文最初由Torque Magazine發(fā)表，經(jīng)許可轉(zhuǎn)載。)

近年來(lái)，筆者在Torque雜志上撰寫(xiě)了大量關(guān)于面向?qū)ο驪HP和WordPress REST API的文章，也涉及到使用Composer進(jìn)行依賴管理和自動(dòng)加載，以及單元測(cè)試。所有文章的核心觀點(diǎn)是：通過(guò)將已建立的軟件開(kāi)發(fā)最佳實(shí)踐應(yīng)用到WordPress開(kāi)發(fā)中，我們可以創(chuàng)建更好的插件。

這是一系列文章中的第一篇，它將在一個(gè)實(shí)際的、功能性的示例中整合這些概念。我將逐步講解如何創(chuàng)建一個(gè)WordPress插件來(lái)修改WordPress REST API端點(diǎn)的功能，以便更好地優(yōu)化搜索。該插件可在GitHub上找到。您可能需要瀏覽提交日志以了解我的構(gòu)建過(guò)程。

在本系列文章中，我將介紹如何使用現(xiàn)代面向?qū)ο驪HP構(gòu)建插件和類，以及如何使其可測(cè)試，以及如何為其編寫(xiě)自動(dòng)化測(cè)試。我將介紹單元測(cè)試、集成測(cè)試和驗(yàn)收測(cè)試之間的區(qū)別，并向您展示如何編寫(xiě)和自動(dòng)化運(yùn)行每種類型的測(cè)試。本文首先介紹如何使用面向?qū)ο蟮姆椒ㄊ褂眠^(guò)濾器修改WordPress REST API。

關(guān)鍵要點(diǎn)

• 利用面向?qū)ο驪HP增強(qiáng)WordPress REST API端點(diǎn)，從而實(shí)現(xiàn)更好的搜索功能，并與ElasticSearch等高級(jí)搜索工具集成。
• 修改REST API端點(diǎn)參數(shù)和WP_Query交互，繞過(guò)默認(rèn)WordPress搜索的限制，提高復(fù)雜查詢的響應(yīng)質(zhì)量。
• 為健壯且易于維護(hù)的代碼實(shí)現(xiàn)單元測(cè)試、集成測(cè)試和驗(yàn)收測(cè)試，確保每個(gè)組件在WordPress生態(tài)系統(tǒng)中都能正確運(yùn)行。
• 使用依賴注入和PHP Traits來(lái)干凈地管理類依賴關(guān)系，從而實(shí)現(xiàn)更易于維護(hù)和測(cè)試的代碼。
• 自定義REST API端點(diǎn)模式以包含其他參數(shù)，例如post_type，從而實(shí)現(xiàn)更靈活和強(qiáng)大的搜索功能。
• 通過(guò)特定的REST API請(qǐng)求動(dòng)態(tài)調(diào)整WP_Query參數(shù)，利用過(guò)濾器有效地細(xì)化搜索結(jié)果和端點(diǎn)行為。

使用REST API改進(jìn)WordPress搜索

通常使用SearchWP或Relevansi之類的插件，或與ElasticSearch（一種使用與WordPress完全不同的堆棧的技術(shù)）集成（使用Jetpack或ElasticPress），來(lái)改進(jìn)WordPress搜索。這些類型的插件提供更好的搜索結(jié)果，并且通常與多方面搜索界面配合使用，這對(duì)于電子商務(wù)應(yīng)用程序非常有用。

通過(guò)WordPress REST API進(jìn)行搜索繼承了所有這些相同的問(wèn)題和相同的解決方案。在這篇文章中，我將首先介紹搜索的默認(rèn)工作方式以及其局限性。然后，我們將研究如何使用兩種不同的方法修改搜索并與SearchWP集成。

WordPress內(nèi)置的搜索功能通常需要使用外部服務(wù)來(lái)改進(jìn)。雖然本文是關(guān)于修改WordPress REST API帖子路由工作方式的面向?qū)ο蠓椒?，但?shí)際示例將是改進(jìn)搜索。

當(dāng)WordPress用作解耦前端（例如原生移動(dòng)應(yīng)用程序或Web應(yīng)用程序，可能使用Vue、React或Angular構(gòu)建）的后端時(shí)，通過(guò)REST API進(jìn)行高質(zhì)量搜索非常重要。本文介紹的代碼將有助于您，如果您的應(yīng)用程序用戶需要查找正確的產(chǎn)品變體或根據(jù)基于多個(gè)分類法的復(fù)雜算法搜索內(nèi)容，并且您正在編寫(xiě)自定義代碼，而不僅僅是安裝插件。

使用WordPress REST API搜索帖子

如果您想在一個(gè)站點(diǎn)上搜索所有帖子類型為“product”的帖子，使用搜索詞“Taco Shirts”，您將向/wp/v2/product?s=Taco Shirt端點(diǎn)發(fā)出請(qǐng)求。如果您想提高結(jié)果的質(zhì)量，上面列出的解決方案將有所幫助。

如上所述，WP_Query（WordPress REST API的帖子端點(diǎn)使用的東西）并不是一個(gè)很好的搜索工具。更具體地說(shuō)，WP_Query可能由于其對(duì)MySQL的依賴性，不如那些傾向于使用NoSQL數(shù)據(jù)庫(kù)構(gòu)建的專用搜索工具。

首先，讓我們看看如何在進(jìn)行REST API請(qǐng)求時(shí)繞過(guò)WP_Query與WordPress數(shù)據(jù)庫(kù)的交互。

這是許多搜索插件用來(lái)替換其自身搜索系統(tǒng)結(jié)果（對(duì)于WP_Query默認(rèn)生成的）的策略。搜索系統(tǒng)可以使用相同的數(shù)據(jù)庫(kù)。它也可以連接到其他數(shù)據(jù)庫(kù)，可能通過(guò)API請(qǐng)求，例如到ElasticSearch或Apache Solr服務(wù)器。

如果您查看WordPress核心代碼，您會(huì)發(fā)現(xiàn)過(guò)濾器“posts_pre_query”在WP_Query查詢數(shù)據(jù)庫(kù)之前運(yùn)行，但在SQL查詢準(zhǔn)備之后運(yùn)行。此過(guò)濾器默認(rèn)返回null。如果該值為null，WordPress將繼續(xù)其默認(rèn)行為：查詢WordPress數(shù)據(jù)庫(kù)并將結(jié)果作為簡(jiǎn)單的WP_Post對(duì)象數(shù)組返回。

另一方面，如果此過(guò)濾器的返回值是一個(gè)數(shù)組（希望包含WP_Post對(duì)象），則不使用WordPress的默認(rèn)行為。

讓我們看看如何使用posts_pre_query返回一個(gè)模擬WP_Post。此策略對(duì)于測(cè)試非常有用，但相同模式的更復(fù)雜版本可用于將單獨(dú)的數(shù)據(jù)庫(kù)與您的WordPress站點(diǎn)集成：

// ... (代碼示例與原文相同) ...

在此示例中，我們使用的是模擬數(shù)據(jù)，但我們可以使用SearchWP的查詢類或其他任何東西。關(guān)于這段代碼需要注意的另一件事是，它將在任何WP_Query上運(yùn)行，而不僅僅是WordPress REST API創(chuàng)建的WP_Query對(duì)象。讓我們對(duì)其進(jìn)行修改，以便除非它是WordPress REST API請(qǐng)求，否則我們不使用過(guò)濾器：

// ... (代碼示例與原文相同) ...

修改WordPress REST API端點(diǎn)參數(shù)

我們剛剛研究了如何更改WordPress REST API請(qǐng)求的搜索結(jié)果生成方式。這允許我們優(yōu)化查詢以獲得更好的搜索效果，但它可能會(huì)暴露出對(duì)端點(diǎn)不同模式的需求。

例如，如果您希望允許對(duì)產(chǎn)品端點(diǎn)的搜索可選地允許將其他帖子類型包含在搜索中，我去年介紹了另一種解決同一問(wèn)題的方法。

橫切關(guān)注點(diǎn)

我們即將研究如何修改允許的端點(diǎn)參數(shù)以及如何使用它們來(lái)創(chuàng)建WP_Query參數(shù)。這是兩個(gè)單獨(dú)的關(guān)注點(diǎn)，單一職責(zé)原則指出我們需要為每個(gè)關(guān)注點(diǎn)創(chuàng)建一個(gè)類。但是這兩個(gè)類將具有共享的關(guān)注點(diǎn)。

例如，如果我們想允許按不同的帖子類型進(jìn)行查詢，我們需要知道哪些是公共帖子類型，以及它們的slug和rest_base參數(shù)是什么。所有這些信息都可以從函數(shù)get_post_types中獲得。

該函數(shù)的輸出并不完全是我們需要的。因此，讓我們?cè)O(shè)計(jì)一個(gè)類來(lái)根據(jù)我剛才列出的需求格式化數(shù)據(jù)，并為我們提供訪問(wèn)它的輔助方法。

將其視為所有我們需要在可用容器中使用的帖子類型數(shù)據(jù)的通用形狀：

// ... (代碼示例與原文相同) ...

請(qǐng)注意，我們沒(méi)有在類中調(diào)用get_post_types()，而是將其用作依賴項(xiàng)，通過(guò)構(gòu)造函數(shù)注入。因此，此類可以在不加載WordPress的情況下進(jìn)行測(cè)試。

這就是為什么我會(huì)將此類描述為“單元可測(cè)試”的原因。它不依賴于任何其他API，我們也不擔(dān)心副作用。我們可以將其作為一個(gè)單獨(dú)的、隔離的單元進(jìn)行測(cè)試。將關(guān)注點(diǎn)分離并將其功能隔離成小的部分，一旦我們有了單元測(cè)試覆蓋率，就可以使代碼易于維護(hù)。我將在我的下一篇文章中介紹如何測(cè)試這種類型的類。

請(qǐng)記住，此類確實(shí)依賴于WP_Post_Type。我的單元測(cè)試將沒(méi)有定義該類，因?yàn)橹挥屑蓽y(cè)試才可以使用WordPress或任何其他外部依賴項(xiàng)。該類僅用于表示數(shù)據(jù)，而不是執(zhí)行任何操作。因此，我們可以說(shuō)它的使用不會(huì)產(chǎn)生任何副作用。因此，我很樂(lè)意在單元測(cè)試中使用模擬來(lái)代替真實(shí)的WP_Post_Type。

說(shuō)到依賴注入，那些需要此新類的對(duì)象的類，我們想遵循相同的模式。我們不會(huì)在需要它們的類中實(shí)例化PreparedPostTypes，而是傳入一個(gè)實(shí)例。這意味著使用PreparedPostTypes和PreparedPostType的類保持隔離，并且可以單獨(dú)測(cè)試。

它還可以導(dǎo)致代碼重用，因?yàn)槲覀儽仨毷挂蕾囎⑷氤蔀榭赡?，并為此?duì)象設(shè)置一個(gè)屬性。我們可以使用剪切和粘貼，或者我們可以使用PHP Trait，這是一種更高級(jí)、更可擴(kuò)展的方法，用于在類之間復(fù)制方法和屬性。

這是一個(gè)Trait，它建立了將PreparedPostTypes對(duì)象注入其他類的模式：

// ... (代碼示例與原文相同) ...

我們的另一個(gè)關(guān)注點(diǎn)是，我們需要在多個(gè)地方了解帖子類型的一些信息。例如帖子類型的slug。這與之前的橫切關(guān)注點(diǎn)略有不同。我們解決的最后一個(gè)問(wèn)題涉及動(dòng)態(tài)數(shù)據(jù)。現(xiàn)在我們只需要在一個(gè)地方更改我們?cè)诙鄠€(gè)地方使用的字符串即可。

一個(gè)具有類常量的類為我們簡(jiǎn)單地解決了這個(gè)問(wèn)題：

// ... (代碼示例與原文相同) ...

現(xiàn)在我們可以使這些字符串在整個(gè)代碼中保持一致。這似乎是不必要的步驟。但是我的示例代碼適用于帖子帖子類型。如果您想更改使用的帖子類型，則此類需要更改，而無(wú)需更改其他任何內(nèi)容。這是遵循Tom McFarlin在他撰寫(xiě)“一個(gè)類應(yīng)該只有一個(gè)更改原因”時(shí)對(duì)單一職責(zé)原則的首選定義。

修改REST API端點(diǎn)模式

現(xiàn)在我們需要修改帖子類型端點(diǎn)的模式。通過(guò)這樣做，WordPress將向REST API端點(diǎn)傳達(dá)帖子類型參數(shù)是允許的，并且在解析請(qǐng)求時(shí)，允許新的端點(diǎn)參數(shù)。

這是我們的類，用于添加post_type屬性。請(qǐng)注意，它使用了我們剛才討論過(guò)的trait UsesPreparedPostTypes：

// ... (代碼示例與原文相同) ...

在此屬性的設(shè)置中，我們告訴WordPress此屬性是一個(gè)數(shù)組屬性，我們使用數(shù)組的“enum”索引指定允許的值。

在“enum”中，我們枚舉允許的值。在這種情況下，PreparedPostTypes類提供了允許值的數(shù)組，因?yàn)檫@是一個(gè)先前解決的橫切關(guān)注點(diǎn)。

請(qǐng)注意，此類沒(méi)有與任何帖子類型甚至此特定用例耦合。我們將很快回到使用哪些鉤子來(lái)使此類適用于特定帖子類型。

修改REST API WP_Query參數(shù)

上一節(jié)介紹了如何使新的端點(diǎn)屬性post_type可用。這實(shí)際上并沒(méi)有更改WordPress REST API生成的WP_Query參數(shù)。除了最后一個(gè)過(guò)濾器之外，我們已經(jīng)擁有所需的一切。

帖子類型是核心代碼專門(mén)不允許通過(guò)REST API請(qǐng)求更改的一個(gè)WP_Query參數(shù)。我們有一個(gè)動(dòng)態(tài)命名的過(guò)濾器——rest_{$post_type}_query——可以覆蓋任何WP_Query參數(shù)。

這是我們的類，它注入我們的post_type參數(shù)，這些參數(shù)以前是不允許的：

// ... (代碼示例與原文相同) ...

大部分內(nèi)容只是驗(yàn)證我們是否應(yīng)該進(jìn)行更改，然后使用WP_Rest_Request的get_param方法從請(qǐng)求中獲取值。大部分是自動(dòng)的，因?yàn)槲覀兪紫刃薷哪Ｊ揭云ヅ洹?/p>

修改WordPress REST API請(qǐng)求的WP_Query對(duì)象

我已經(jīng)在本文的第一部分介紹了如何做到這一點(diǎn)。這是一個(gè)實(shí)現(xiàn)相同模式的類：

// ... (代碼示例與原文相同) ...

我希望您注意到這段代碼與WordPress緊密相關(guān)，并且不可測(cè)試。它使用來(lái)自WordPress的WP_Post，它正在檢查WordPress的常量，并與WordPress的插件API交互。我們可以模擬WP_Post，并且我們可以自己設(shè)置常量。但是插件的API——這是需要測(cè)試的重要功能。在我的接下來(lái)的幾篇文章中，我將介紹如何重構(gòu)此類，以便我們可以使用單元測(cè)試來(lái)涵蓋除刪除該過(guò)濾器的效果之外的所有內(nèi)容，并使用集成測(cè)試來(lái)檢查該效果。

我選擇使用靜態(tài)方法有兩個(gè)原因。首先，它使在多個(gè)位置添加和刪除它變得很容易。例如，在ModifyQuery類中，我只在需要時(shí)才掛鉤此過(guò)濾器：

// ... (代碼示例與原文相同) ...

此外，在使用此過(guò)濾器時(shí)很容易創(chuàng)建遞歸循環(huán)。能夠像在此示例代碼中一樣輕松地刪除它非常不錯(cuò)。

我選擇使用靜態(tài)方法的另一個(gè)原因是該函數(shù)與其他API交互。它永遠(yuǎn)不會(huì)真正可進(jìn)行單元測(cè)試。這種模式，一個(gè)具有靜態(tài)方法的類，使得在集成測(cè)試中模擬該類變得非常容易，從而最大限度地減少了在這個(gè)系統(tǒng)的一個(gè)部分中缺乏強(qiáng)隔離的影響。

使所有內(nèi)容協(xié)同工作

到目前為止，我們看到的代碼與WordPress非常脫鉤。這有很多好處。但這意味著它本身什么也不做。這很好。我們到目前為止只處理了業(yè)務(wù)邏輯需求?，F(xiàn)在我們需要考慮集成。

這并不難，只需要添加一些鉤子即可。哪些鉤子？與我們?yōu)镸odifyQuery和ModifySchema類設(shè)計(jì)的完全相同的兩個(gè)鉤子。對(duì)解耦業(yè)務(wù)邏輯的渴望并不意味著我們?cè)谠O(shè)計(jì)其公共接口時(shí)不能考慮編寫(xiě)代碼的實(shí)際原因。否則，我們只會(huì)毫無(wú)理由地為我們的代碼增加額外的復(fù)雜性。

一般來(lái)說(shuō)，我盡量只在它使生活更輕松時(shí)才增加軟件復(fù)雜性。我過(guò)去偏離了這條道路。我們都有過(guò)，沒(méi)關(guān)系，練習(xí)寬恕。

我們即將掛鉤的類中的方法與鉤子使用完全相同的參數(shù)和返回類型。它們的工作是將這些值分派給其他組件。

// ... (代碼示例與原文相同) ...

下一步：測(cè)試

這已經(jīng)足夠接近了。它會(huì)起作用。由于缺乏添加鉤子的正式系統(tǒng)，這是我們可以為初始化做的最好的事情。這很好。我將在未來(lái)關(guān)于WordPress集成測(cè)試的文章中介紹如何創(chuàng)建一個(gè)更復(fù)雜和可擴(kuò)展的引導(dǎo)過(guò)程。

在這篇文章中，我們研究了創(chuàng)建代碼來(lái)修改模式、WP_Query參數(shù)生成和帖子類型的底層WP_Query。我鼓勵(lì)您將此代碼轉(zhuǎn)換為插件，使用Composer進(jìn)行自動(dòng)加載。在我的下一篇文章中，我們將研究單元測(cè)試以涵蓋這些類。

(以下為原文FAQ部分，已根據(jù)原文內(nèi)容進(jìn)行偽原創(chuàng))

關(guān)于WordPress中高級(jí)OOP和自定義REST API端點(diǎn)的常見(jiàn)問(wèn)題解答

面向?qū)ο缶幊?OOP)在WordPress中的意義是什么？

面向?qū)ο缶幊?OOP)是一種使用“對(duì)象”設(shè)計(jì)應(yīng)用程序和軟件的編程范式。在WordPress環(huán)境中，OOP為開(kāi)發(fā)復(fù)雜的應(yīng)用程序提供了一種簡(jiǎn)潔、高效和健壯的方法。它允許開(kāi)發(fā)人員將相關(guān)任務(wù)分組到類和對(duì)象中，使代碼更易于閱讀、重用和維護(hù)。OOP還通過(guò)封裝數(shù)據(jù)并防止外部直接訪問(wèn)來(lái)增強(qiáng)應(yīng)用程序的安全性。

如何在WordPress中自定義REST API端點(diǎn)？

WordPress REST API提供了一組用于不同類型數(shù)據(jù)的默認(rèn)端點(diǎn)。但是，您可以自定義這些端點(diǎn)或創(chuàng)建新的端點(diǎn)以滿足您的特定需求。這可以通過(guò)在您的插件或主題中使用register_rest_route()函數(shù)來(lái)完成。此函數(shù)允許您指定端點(diǎn)的路由或URL，并定義它應(yīng)該響應(yīng)的方法(GET、POST等)。

自定義WordPress REST API端點(diǎn)的優(yōu)勢(shì)是什么？

自定義WordPress REST API端點(diǎn)允許您創(chuàng)建更高效、更靈活和更安全的應(yīng)用程序。您可以調(diào)整端點(diǎn)返回的數(shù)據(jù)，減少通過(guò)網(wǎng)絡(luò)發(fā)送的不必要數(shù)據(jù)量。您還可以創(chuàng)建執(zhí)行特定任務(wù)的端點(diǎn)，例如處理表單提交或生成報(bào)告，從而使您的應(yīng)用程序更具交互性和用戶友好性。

OOP如何增強(qiáng)WordPress應(yīng)用程序的安全性？

OOP通過(guò)將數(shù)據(jù)和方法封裝在對(duì)象中來(lái)增強(qiáng)WordPress應(yīng)用程序的安全性。這意味著對(duì)象的屬性(數(shù)據(jù))和方法(函數(shù))對(duì)應(yīng)用程序的其余部分隱藏，并且只能通過(guò)對(duì)象的方法訪問(wèn)。這可以防止未經(jīng)授權(quán)訪問(wèn)和操作數(shù)據(jù)，從而降低安全漏洞的風(fēng)險(xiǎn)。

OOP可以與舊版本的WordPress一起使用嗎？

是的，您可以將OOP與舊版本的WordPress一起使用。但是，需要注意的是，較新版本的WordPress對(duì)OOP的支持有所改進(jìn)，并且包含許多功能，使使用此范式進(jìn)行開(kāi)發(fā)更容易。因此，雖然可以使用OOP與舊版本一起使用，但通常建議使用最新版本的WordPress以獲得最佳的開(kāi)發(fā)體驗(yàn)。

類和對(duì)象在OOP中的作用是什么？

在OOP中，類是創(chuàng)建對(duì)象的藍(lán)圖或模板。它定義了對(duì)象應(yīng)該具有的屬性(數(shù)據(jù))和方法(函數(shù))。另一方面，對(duì)象是類的實(shí)例。它具有自己的一組屬性和方法，這些屬性和方法可能與同一類的其他對(duì)象不同。類和對(duì)象的使用使代碼更具組織性、可重用性和易于維護(hù)性。

如何在WordPress中創(chuàng)建一個(gè)新類？

您可以使用class關(guān)鍵字，后跟類名和一組花括號(hào){}來(lái)在WordPress中創(chuàng)建一個(gè)新類。在括號(hào)內(nèi)，您可以定義類的屬性和方法。要?jiǎng)?chuàng)建類的對(duì)象，您可以使用new關(guān)鍵字，后跟類名。

WordPress中的REST API是什么？

WordPress中的REST API是一個(gè)接口，允許您使用HTTP請(qǐng)求與WordPress站點(diǎn)交互。它為不同類型的數(shù)據(jù)(例如帖子、評(píng)論和用戶)提供了一組端點(diǎn)，您可以使用標(biāo)準(zhǔn)HTTP方法(如GET、POST、PUT和DELETE)來(lái)訪問(wèn)這些端點(diǎn)。REST API使您可以更輕松地從外部應(yīng)用程序創(chuàng)建、讀取、更新和刪除WordPress站點(diǎn)中的數(shù)據(jù)。

如何在WordPress中訪問(wèn)REST API？

您可以通過(guò)向相應(yīng)的端點(diǎn)發(fā)送HTTP請(qǐng)求來(lái)訪問(wèn)WordPress中的REST API。每個(gè)端點(diǎn)對(duì)應(yīng)于特定類型的數(shù)據(jù)，并支持某些HTTP方法。例如，要檢索帖子列表，您可以向/wp/v2/posts端點(diǎn)發(fā)送GET請(qǐng)求。REST API將以JSON格式返回?cái)?shù)據(jù)，然后您可以在應(yīng)用程序中處理和顯示這些數(shù)據(jù)。

我可以將REST API與非WordPress應(yīng)用程序一起使用嗎？

是的，您可以將REST API與非WordPress應(yīng)用程序一起使用。REST API是平臺(tái)無(wú)關(guān)的，這意味著它可以與任何可以發(fā)送HTTP請(qǐng)求和處理JSON數(shù)據(jù)的應(yīng)用程序一起使用。這使其成為將WordPress站點(diǎn)與其他應(yīng)用程序(例如移動(dòng)應(yīng)用程序、桌面應(yīng)用程序和其他Web服務(wù))集成的強(qiáng)大工具。

以上是WordPress的高級(jí)OOP：自定義REST API端點(diǎn)的詳細(xì)內(nèi)容。更多信息請(qǐng)關(guān)注PHP中文網(wǎng)其他相關(guān)文章！