久久久精品午夜免费不卡,欧美激情视频一区二区三区免费

鑰匙要點

關(guān)于靈活的API設(shè)計和PHP掛鉤的常見問題（常見問題解答）

> PHP API管道中掛鉤在PHP API管道中的重要性是什么？它們允許開發(fā)人員在程序執(zhí)行中的特定點插入自定義代碼，而無需更改核心代碼。這使得在不破壞整個系統(tǒng)的情況下更容易添加，修改或刪除功能。鉤子本質(zhì)上是由特定動作觸發(fā)的事件，可以用來以干凈且有條理的方式擴(kuò)展應(yīng)用程序。

>設(shè)計靈活的API的最佳實踐是什么？幾種最佳實踐。首先，保持API簡單而直觀非常重要，從而使開發(fā)人員易于理解和使用。其次，應(yīng)將API設(shè)計為可擴(kuò)展的，從而允許添加新功能而不會破壞現(xiàn)有功能。第三，提供清晰，全面的文檔至關(guān)重要，幫助開發(fā)人員了解如何有效使用API??。最后，使用標(biāo)準(zhǔn)的HTTP方法和狀態(tài)代碼可以使API更容易預(yù)測，更易于使用。

> API設(shè)計中有哪些共同的挑戰(zhàn)，如何解決？

>測試您的API涉及向API端點和API的請求驗證響應(yīng)。這可以使用郵遞員等工具手動完成，也可以自動使用測試框架來完成。測試API的各個方面，包括功能，性能和安全性很重要。

>處理API中的處理錯誤涉及返回適當(dāng)?shù)腍TTP狀態(tài)代碼和錯誤消息。這有助于開發(fā)人員了解出了什么問題以及如何解決問題。記錄錯誤和分析的錯誤也很重要。

首頁

后端開發(fā)

php教程

靈活的API設(shè)計：為您的PHP API管道創(chuàng)建鉤子

Joseph Gordon-Levitt

Feb 08, 2025 am 10:57 AM

靈活的API設(shè)計：為您的PHP API管道創(chuàng)建鉤子

設(shè)計應(yīng)用程序編程接口（API）可能是一項具有挑戰(zhàn)性的努力。良好的API具有簡單易用的簡單接口。在這個簡單的接口背后可以是許多復(fù)雜的系統(tǒng)交互，這些交互實際上可能會使原本明確定義的端點任務(wù)的水域變得混亂。隨著時間的流逝，可能會要求開發(fā)人員為現(xiàn)有終點“了解”其他業(yè)務(wù)邏輯。然后，在您不知不覺中，作為主要流程的一部分，一個API調(diào)用正在與十幾個系統(tǒng)進(jìn)行交互。

>如果我們可以開發(fā)一個簡單的管道，但是可以在以后添加其他任務(wù)而不掩蓋主流量的情況下添加其他任務(wù)，那不是很好嗎？本文將向您展示如何從WordPress和編程中調(diào)整一個想法，以使您的API能夠進(jìn)行更強(qiáng)大的互動。

鑰匙要點

>利用PHP API中的掛鉤來增強(qiáng)靈活性并通過允許在不更改核心端點代碼的情況下動態(tài)添加其他功能來保持干凈的主流量。> 通過定義添加，刪除和觸發(fā)這些鉤子的全局函數(shù)來實現(xiàn)掛鉤，這些鉤可在API的不同部分中使用，從而確保對主要應(yīng)用程序邏輯的最小破壞。
> 通過保持與掛鉤相關(guān)的回調(diào)精益，以避免性能瓶頸，隔離回調(diào)功能以簡化調(diào)試，并注意維持API響應(yīng)的主動回調(diào)數(shù)量。
>
什么是掛鉤/動作？
>鉤子（又稱操作/過濾器）是WordPress社區(qū)給事件及其相關(guān)回調(diào)的名稱。如果您在編程方面有任何經(jīng)驗，那么您可能熟悉回調(diào)和發(fā)布者 - subscriber模式。在處理過程中，系統(tǒng)可能會觸發(fā)一個事件，該事件將零歸為零，以訂閱該事件的許多功能。例如，在響應(yīng)加載頁面時，WordPress呼吁加載標(biāo)題，加載標(biāo)題，列出帖子或查找正確模板的功能。這些任務(wù)是在不混亂生成頁面的主要過程的情況下運(yùn)行的。

鉤背后的想法并不是什么新鮮事物，也不是WordPress發(fā)明的。但是，WordPress在其服務(wù)器端處理生命周期期間實現(xiàn)了它們，做得很好。在我看來，這種鉤子的使用可能是平臺擁有的最大功能。使用這些掛鉤，用戶可以編寫自己的功能（無論是插件還是主題），可以將其連接到WordPress中，并在需要時運(yùn)行您想要的任何代碼。您需要更改發(fā)送給用戶的標(biāo)頭嗎？沒問題：進(jìn)入WP_headers事件，您可以在發(fā)現(xiàn)合適的情況下更改標(biāo)題。

為什么在API中使用鉤？

構(gòu)建基本機(jī)制

>現(xiàn)在我們已經(jīng)創(chuàng)建了hooks.php文件，我們只需要將其包含在我們的API中，以便可以看到這些功能。完成此操作后，這只是使用DO_HOOK將鉤子插入我們的API的問題。

<span>// Global array which will hold all of our hooks
</span><span>// We will reference this array in each function to add/remove/call our hooks
</span><span>// The code below should also be seen by any callbacks we write for the system later.
</span><span>$hooks = [];
</span>
<span>// Below are global functions that can be seen from our API code
</span><span>// The add_hook method will allow us to attach a function (callback) to a given event name 
</span><span>function add_hook($event_name, $callback) {
</span>    <span>global $hooks;
</span>
    <span>if ($callback !== null) {
</span>        <span>if ($callback) {
</span>          <span>// We can set up multiple callbacks under a single event name
</span>            <span>$hooks[$event_name][] = $callback;
</span>        <span>}
</span>    <span>}
</span><span>}
</span>
<span>// Super easy to implement, we remove the given hook by its name
</span><span>function remove_hook($event_name) {
</span>    <span>global $hooks;
</span>
    <span>unset($hooks[$event_name]);
</span><span>}
</span>
<span>// When we want to trigger our callbacks, we can call this function 
</span><span>// with its name and any parameters we want to pass.
</span><span>function do_hook($event_name, ...$params) {
</span>    <span>global $hooks;
</span>
    <span>if (isset($hooks[$event_name])) {
</span>      <span>// Loop through all the callbacks on this event name and call them (if defined that is)
</span>      <span>// As we call each callback, we given it our parameters.
</span>        <span>foreach ($hooks[$event_name] as $function) {
</span>            <span>if (function_exists($function)) {
</span>                <span>call_user_func($function, ...$params);
</span>            <span>}
</span>        <span>}
</span>    <span>}
</span><span>}
</span>

作為一個簡單的例子，假設(shè)我們有一個用于使用系統(tǒng)注冊新用戶的API。我們可能有一個REST API端點，稱為 /adduser。以簡單性的名義，我們還假設(shè)這里的目標(biāo)是將新用戶的名稱和年齡插入我們的數(shù)據(jù)庫用戶表中。很簡單，對嗎？

<span>// Global array which will hold all of our hooks
</span><span>// We will reference this array in each function to add/remove/call our hooks
</span><span>// The code below should also be seen by any callbacks we write for the system later.
</span><span>$hooks = [];
</span>
<span>// Below are global functions that can be seen from our API code
</span><span>// The add_hook method will allow us to attach a function (callback) to a given event name 
</span><span>function add_hook($event_name, $callback) {
</span>    <span>global $hooks;
</span>
    <span>if ($callback !== null) {
</span>        <span>if ($callback) {
</span>          <span>// We can set up multiple callbacks under a single event name
</span>            <span>$hooks[$event_name][] = $callback;
</span>        <span>}
</span>    <span>}
</span><span>}
</span>
<span>// Super easy to implement, we remove the given hook by its name
</span><span>function remove_hook($event_name) {
</span>    <span>global $hooks;
</span>
    <span>unset($hooks[$event_name]);
</span><span>}
</span>
<span>// When we want to trigger our callbacks, we can call this function 
</span><span>// with its name and any parameters we want to pass.
</span><span>function do_hook($event_name, ...$params) {
</span>    <span>global $hooks;
</span>
    <span>if (isset($hooks[$event_name])) {
</span>      <span>// Loop through all the callbacks on this event name and call them (if defined that is)
</span>      <span>// As we call each callback, we given it our parameters.
</span>        <span>foreach ($hooks[$event_name] as $function) {
</span>            <span>if (function_exists($function)) {
</span>                <span>call_user_func($function, ...$params);
</span>            <span>}
</span>        <span>}
</span>    <span>}
</span><span>}
</span>

上面的代碼是我們?nèi)绾翁砑有掠脩舻倪^度簡單和普遍的視圖。這個想法是，如果某人打電話給我們的API /Adduser端點，他們最終將在此功能中得出此功能，從而將用戶的名稱和年齡從已發(fā)布的數(shù)據(jù)中提取出來。我們首先檢查以確保他們發(fā)布（作為適當(dāng)?shù)男菹⒁?guī)則規(guī)定），然后嘗試將用戶插入用戶表中。

接下來，如果成功插入了用戶，我們想調(diào)用鉤子，以使任何創(chuàng)建用戶的代碼偵聽（這類似于用其他語言提出事件）。

當(dāng)需求變化時該怎么辦

幾個月后，我們讓我們的營銷部門堅持認(rèn)為，當(dāng)創(chuàng)建新用戶時，應(yīng)將電子郵件發(fā)送給用戶的詳細(xì)信息。我們可能傾向于將助手功能寫入API，然后從此端點代碼中調(diào)用它。太好了……如果這就是要求的。但是，如果支持團(tuán)隊后來來到您身邊，并希望您還將用戶添加到他們的Zendesk系統(tǒng)中。因此，您還編寫另一個功能，并將其撥打到此端點。

接下來，您知道，此端點不僅是將用戶添加到我們的網(wǎng)站數(shù)據(jù)庫中，而且還呼吁發(fā)送電子郵件，將用戶添加到Zendesk，Jira和Microsoft Cloud，然后處理其成功/失敗結(jié)果。所有這些其他東西確實從將用戶添加到我們的數(shù)據(jù)庫的清晰點中。我們想調(diào)用一個事件，并讓其他代碼在創(chuàng)建用戶并做自己的事情時聆聽 - 而無需我們修改此端點。也許沒有其他服務(wù)在乎添加新用戶，因此沒有人被要求做任何事情。終點不必關(guān)心。很棒，對

>讓我們以鉤子的名字來繼續(xù)我們的榜樣。這是所有回調(diào)代碼都需要使用的名稱。同樣，其他語言將此設(shè)置稱為“事件”，因此請務(wù)必用給定的語言查找它以了解更多信息。

我們將調(diào)用hook add_user。簡單而直截了當(dāng)，你不覺得嗎？一旦有名，我們就可以決定要在哪里稱呼此鉤子。我認(rèn)為成功插入后是個好主意：

<span>// POST endpoint for adding a user (part of a larger API class)
</span><span>public function addUser($name, $age) {
</span>  <span>if ($this->request->method === 'post') {
</span>    <span>try {
</span>      <span>$this->db->insert('users', ['name' => $name, 'age' => $age]);
</span>      <span>return new Response(200, 'User created successfully!');
</span>    <span>} catch (Exception $e) {
</span>      <span>// Oops, something went wrong.
</span>      <span>// Do some logging or whatever.
</span>    <span>}
</span>  <span>}
</span>
  <span>// If not a POST request, return http status 400
</span>  <span>return new Response(400, 'Bad request');
</span><span>}
</span>

>現(xiàn)在，我們可以有數(shù)十個回調(diào)函數(shù)收聽添加_user鉤或根本沒有。也許我們有一個回調(diào)，負(fù)責(zé)將用戶插入Zendesk，而另一個將插入姓名和年齡并為營銷生成電子郵件。只要可以在API項目中看到hooks.php代碼，就可以在代碼庫中的其他地方生活。我通常將回調(diào)函數(shù)放在單獨(dú)的文件中，并將該文件也包括在API中。以下是回調(diào)的一個示例，現(xiàn)在可以利用我們創(chuàng)建的這個新鉤子：

<span>// Global array which will hold all of our hooks
</span><span>// We will reference this array in each function to add/remove/call our hooks
</span><span>// The code below should also be seen by any callbacks we write for the system later.
</span><span>$hooks = [];
</span>
<span>// Below are global functions that can be seen from our API code
</span><span>// The add_hook method will allow us to attach a function (callback) to a given event name 
</span><span>function add_hook($event_name, $callback) {
</span>    <span>global $hooks;
</span>
    <span>if ($callback !== null) {
</span>        <span>if ($callback) {
</span>          <span>// We can set up multiple callbacks under a single event name
</span>            <span>$hooks[$event_name][] = $callback;
</span>        <span>}
</span>    <span>}
</span><span>}
</span>
<span>// Super easy to implement, we remove the given hook by its name
</span><span>function remove_hook($event_name) {
</span>    <span>global $hooks;
</span>
    <span>unset($hooks[$event_name]);
</span><span>}
</span>
<span>// When we want to trigger our callbacks, we can call this function 
</span><span>// with its name and any parameters we want to pass.
</span><span>function do_hook($event_name, ...$params) {
</span>    <span>global $hooks;
</span>
    <span>if (isset($hooks[$event_name])) {
</span>      <span>// Loop through all the callbacks on this event name and call them (if defined that is)
</span>      <span>// As we call each callback, we given it our parameters.
</span>        <span>foreach ($hooks[$event_name] as $function) {
</span>            <span>if (function_exists($function)) {
</span>                <span>call_user_func($function, ...$params);
</span>            <span>}
</span>        <span>}
</span>    <span>}
</span><span>}
</span>

我們可以在哪里放置這些鉤子？

在上面的代碼中，我們在單個端點中使用鉤子演示。僅在調(diào)用 /adduser端點時才觸發(fā)此鉤子，并且只有在插入成功后才觸發(fā)。但這不是您唯一可以使用這些鉤子的地方。也許您在API類中有一些路由代碼，可以通過檢查API密鑰是否有效，或者您甚至收到某種類型的請求。

>您可以在API中的全球級別上放置一個鉤子，以便每個請求觸發(fā)它。然后，在以后的某個時間，有人可以編寫一個記錄器，將其附加到您創(chuàng)建的API_Init掛鉤上，然后突然開始記錄對API的所有請求，同樣，不是觸摸主API類代碼。同樣的鉤子還可能附加一個回調(diào)，如果它開始看到有人用請求猛擊您的API，則可以檢查API濫用并將其報告給您的信息技術(shù)部門。

下面的圖像是所有這些圖表的圖表。

靈活的API設(shè)計：為您的PHP API管道創(chuàng)建鉤子 >由于您可以在多個位置使用此機(jī)制，因此您甚至可以在API端點的開頭，中間和結(jié)尾處使用鉤子。您還可以在處理請求的整個API生命周期的各個點上有鉤子。這實際上取決于您在插入這些do_hook呼叫的位置上的設(shè)計。

最佳實踐

>現(xiàn)在讓我們介紹一些最佳實踐，以供您和您的開發(fā)人員遵循。

>提示1：保持鉤子瘦弱和平均

>要記住的一件事是，這些掛鉤仍然會呼喚將在單個線程中執(zhí)行的代碼。除非您在回調(diào)中觸發(fā)某些內(nèi)容將任務(wù)踢到某些背景過程或其他服務(wù)，否則API仍將運(yùn)行此額外的代碼（觸發(fā)鉤子時）。這意味著我們應(yīng)該盡最大努力保持任何回調(diào)代碼精益和卑鄙。長期運(yùn)行的回調(diào)代碼將減慢端點或整個API。

>提示2：使每個回調(diào)隔離且易于調(diào)試

>但是，通過設(shè)計該結(jié)構(gòu)的方式，為您的鉤子添加和刪除回調(diào)功能很容易做，并且調(diào)試同樣容易。查找哪個回調(diào)是罪犯（也許每個回調(diào)記錄一些數(shù)據(jù)），并找出卡住的位置。然后，在錯誤修復(fù)或通過回調(diào)代碼工作之前，根本沒有訂閱鉤子，又不觸摸端點/API代碼中的任何內(nèi)容，而不會阻止您的API代碼在生產(chǎn)中運(yùn)行。

提示3：考慮性能，不要濫用鉤子

>請注意您在鉤子上附加多少個回調(diào)也很重要。少數(shù)幾個快速回調(diào)是可以的，但是單個掛鉤上的100個回調(diào)，每秒鐘執(zhí)行一秒鐘確實可以阻止您的API。我們需要快速的API調(diào)用，并且每個回調(diào)都可以輕松拖動響應(yīng)時間。同樣，如果您發(fā)現(xiàn)回調(diào)速度慢，請將任務(wù)扔到背景過程或隊列系統(tǒng)中，以后將由另一個服務(wù)撿起。我經(jīng)常在Laravel之類的系統(tǒng)中使用工作來處理此類任務(wù)。也許將用戶任務(wù)添加到Laravel作業(yè)隊列中，然后繼續(xù)進(jìn)行API處理。

提示4：與您的開發(fā)社區(qū)保持聯(lián)系最后，確保您與可能使用這些掛鉤的開發(fā)人員保持聯(lián)系。通常，開發(fā)人員使用您的鉤子和編寫回調(diào)，與創(chuàng)建API中創(chuàng)建鉤子的人并不是一開始。隨著API的成熟，您可能會開始看到在不同地方添加更多鉤子和更精細(xì)的粒度的請求。他們可能會要求在插入用戶之前和之后插入用戶之前/之后的掛鉤之前/之后。他們還可能要求將其他信息傳遞給他們的回調(diào)（不僅是他們的名稱和年齡，還包括插入用戶的新ID）。以這些要求為一個好兆頭，表明您的開發(fā)人員發(fā)現(xiàn)該機(jī)制有用，并看到擴(kuò)大API在相關(guān)系統(tǒng)中的影響的潛力。擁有一個非常容易“掛接”并執(zhí)行一小塊代碼以產(chǎn)生巨大影響的系統(tǒng)真的感覺很好。

使用這種方法，天空是您可以擁有的API所做的限制。在與其他系統(tǒng)打交道時，這一切都可以實現(xiàn)，同時保持端點的主要流量清晰，沒有噪音。

結(jié)論

在本文中，我們討論了什么是鉤子/動作以及如何使用它們。我們提供了一些示例PHP代碼，您可以在PHP API中使用這些代碼來實現(xiàn)“鉤”，以及如何使用回調(diào)將其綁在該鉤子中。我們還討論了在一般API級別（全球范圍內(nèi)更多）以及端點上添加鉤子。除此之外，我們還討論了該系統(tǒng)的一些缺點，并且可以使您的回調(diào)變得精明和卑鄙，這是一個好主意。但是，如果您確實有一個長期運(yùn)行的回調(diào)，我們提到了一些處理此類流程以防止它們影響您的API管道的策略。

如果您實現(xiàn)了此系統(tǒng)，則您也可以獲得WordPress社區(qū)（以及總體程序員）多年來所享受的一些最大功能。您還可以節(jié)省很多時間和頭痛，從必須直接修改API代碼，并且可以專注于小回調(diào)代碼。您還可以添加和刪除可能與其他系統(tǒng)的整個集成在一起的回調(diào)。所有這些功能 - 不必重新發(fā)布您的API管道代碼！這是一個很好的交易，對吧？有了這個系統(tǒng)，我一天都設(shè)法進(jìn)行了一些簡單的集成，現(xiàn)在您也可以做到。

感謝您的閱讀！

關(guān)于靈活的API設(shè)計和PHP掛鉤的常見問題（常見問題解答）

> PHP API管道中掛鉤在PHP API管道中的重要性是什么？它們允許開發(fā)人員在程序執(zhí)行中的特定點插入自定義代碼，而無需更改核心代碼。這使得在不破壞整個系統(tǒng)的情況下更容易添加，修改或刪除功能。鉤子本質(zhì)上是由特定動作觸發(fā)的事件，可以用來以干凈且有條理的方式擴(kuò)展應(yīng)用程序。

>如何為我的PHP API管道創(chuàng)建掛鉤？對于您的PHP API管道，涉及定義可以執(zhí)行自定義代碼的代碼中的特定點。這通常是使用事件和聽眾完成的。當(dāng)發(fā)生特定事件時，觸發(fā)相應(yīng)的偵聽器，執(zhí)行自定義代碼。這使您可以在運(yùn)行時修改應(yīng)用程序的行為，提供高度的靈活性和適應(yīng)性。

>設(shè)計靈活的API的最佳實踐是什么？幾種最佳實踐。首先，保持API簡單而直觀非常重要，從而使開發(fā)人員易于理解和使用。其次，應(yīng)將API設(shè)計為可擴(kuò)展的，從而允許添加新功能而不會破壞現(xiàn)有功能。第三，提供清晰，全面的文檔至關(guān)重要，幫助開發(fā)人員了解如何有效使用API??。最后，使用標(biāo)準(zhǔn)的HTTP方法和狀態(tài)代碼可以使API更容易預(yù)測，更易于使用。

PHP與API設(shè)計的其他語言相比如何？

PHP是API的流行選擇設(shè)計由于其簡單性和靈活性。它支持包括JSON和XML在內(nèi)的廣泛的數(shù)據(jù)格式，使創(chuàng)建可以被各種客戶消費(fèi)的API易于使用。 PHP還擁有一個龐大而活躍的社區(qū)，為開發(fā)人員提供了豐富的資源和支持。但是，像任何語言一樣，它具有其優(yōu)點和劣勢，并且語言的選擇應(yīng)基于項目的特定要求。

> API設(shè)計中有哪些共同的挑戰(zhàn)，如何解決？

API設(shè)計可以提出一些挑戰(zhàn)，包括確保一致性，管理版本控制和有效處理錯誤。一致性可以通過遵循既定的慣例和標(biāo)準(zhǔn)來維持。可以通過在API URL或請求標(biāo)頭中包含版本編號來管理版本控制。應(yīng)該優(yōu)雅地處理錯誤，提供清晰且有用的錯誤消息，以幫助開發(fā)人員診斷和解決問題。