[發明專利]一種API網關緩存響應數據的實現方法及系統

在審

• 申請號: 202210251543.5
• 申請日: 2022-03-15
• 公開（公告）號: CN114785637A
• 公開（公告）日: 2022-07-22
• 發明（設計）人: 張積磊;栗凱;朱璐;玄德
• 申請（專利權）人: 浪潮云信息技術股份公司
• 主分類號: H04L12/66
• 分類號: H04L12/66;H04L67/568
• 代理公司: 濟南信達專利事務所有限公司 37100
• 代理人: 姜鵬

1.一種API網關緩存響應數據的實現方法及系統，其特征在于，包括以下步驟：

選擇使用模板進行緩存插件的配置，格式選擇yaml或者json等可以說明字段意義的方式即可，用戶通過設置模板中的各項參數來進行插件配置；

當用戶選擇某個API去綁定某個緩存插件時，需要生成該綁定關系的唯一性Id，使用該Id和后端數據庫存儲的插件配置信息以及待綁定的API的各項參數信息去生成Kong插件的標準配置并保存，以此來讓Kong讀取，識別緩存插件的內容；

API調用模塊，當用戶調用API時，Kong讀取該API的Kong配置文件，根據文件中是否存在緩存插件的配置來確定是否綁定緩存插件；

緩存插件執行模塊判斷API是否是第一次發起請求，如果是第一次請求，請求后成功HttpStatusCode400的響應數據按設計好的格式存儲到Redis中，然后將響應數據返回給客戶端；調用綁定了緩存插件的API時，響應數據中需要在Header中額外添加一個字段，通過該字段來告知客戶端本次的響應數據是否使用了API緩存；由于綁定了緩存插件不代表一定進行了緩存數據的使用，當未使用允許緩存的后端Header，或是因為緩存超時而沒有在Redis查詢到緩存數據時，同樣需要請求實際的后端；通過在響應信息中添加緩存是否使用的說明字段的方式，來保證用戶在調用API時能夠明確的知道是否使用到了API緩存；對于Redis緩存，需要設置其存儲格式，保證API調用時，能夠取出與所調用API相對應的正確的緩存信息，使用hash存儲；

如果API不是第一次發起請求，則判斷API是否攜帶配置文件中設置的Header信息，如果沒有攜帶設置的信息，則進行正常的路由請求；若API不是第一次發起請求，也攜帶了設置好的Header信息，將根據API信息去Redis緩存中取出對應的緩存的響應數據，返回給客戶端。

2.根據權利要求1所述的一種API網關緩存響應數據的實現方法，其特征在于：緩存插件創建的參數分為參數唯一性定義byParameters與緩存插件特有Header定義cacheableHeaders兩部分，當一個綁定緩存插件的API被調用時，通過前者區分網關應當從緩存數據庫中取出的數據；后者定義緩存插件需要識別的Header，此時API即使綁定了緩存插件，但沒有攜帶模板中配置的允許緩存的后端Header時，也不會啟用針對該API的數據緩存功能；通過這種方式，使API不需要頻繁的解綁插件，就可以靈活的開啟或者關閉數據緩存功能。

3.根據權利要求2所述的一種API網關緩存響應數據的實現方法，其特征在于：用戶創建插件時，需要對創建出來的插件模板進行合法性校驗，主要包括插件名稱校驗，類型長度合法性校驗以及模板配置解析校驗等；當緩存插件創建后，后端將該配置保存到后端持久化存儲的數據庫中，以便后續綁定API時生成相應的Kong插件配置。

4.根據權利要求1所述的一種API網關緩存響應數據的實現方法，其特征在于：每進行一次API的緩存插件綁定操作都將生成一個Kong的插件配置，將該配置更新到該API的Kong配置文件中，用以在調用API時Kong對配置的識別與處理。

5.一種API網關緩存響應數據的實現系統，其特征在于：包括緩存插件創建模塊、插件綁定模塊、API調用模塊、緩存插件執行模塊以及緩存數據返回模塊；

插件綁定模塊將API綁定在插件創建模塊的插件上，API調用模塊讀取API的Kong配置文件，緩存插件執行模塊對首次發起的API數據處理，緩存數據返回模塊對非首次提出的API數據處理。