[發明專利]一種接口參數校驗方法及組件

有效

• 申請號: 201710171782.9
• 申請日: 2017-03-22
• 公開（公告）號: CN106991023B
• 公開（公告）日: 2020-10-09
• 發明（設計）人: 龔杰;王國彬;張華杰;李輝
• 申請（專利權）人: 深圳市彬訊科技有限公司
• 主分類號: G06F11/22
• 分類號: G06F11/22;H04B17/00
• 代理公司: 深圳眾鼎專利商標代理事務所(普通合伙) 44325
• 代理人: 黃章輝

本發明提供了一種接口參數校驗方法，包括以下步驟：客戶通過所述客戶端對參數進行自定義，所述注解解析模塊對參數進行解析并將解析結果數據發送給所述校驗規則生成模塊，所述校驗規則生成模塊根據所述解析結果數據生成自定義引用數據類型的比較規則，所述注解校驗模塊根據所述所述校驗規則生成模塊生成的比較規則的逐個屬性，去參數對象中尋找與之相對應的屬性,然后通過自定義的比較規則對屬性的值進行比較，如果沒有找到對應的屬性或者與之對應的屬性值不相同，則為校驗失敗，否則校驗通過,該接口參數校驗方法可基于注解、json、xml多種格式對框架進行多樣化實現，更好地支持參數的強依賴性，能夠支持復雜的參數類型。

技術領域

本發明涉及接口檢驗技術領域，尤其涉及一種接口參數校驗方法及組件。

背景技術

眾所周知，只要有接口，就會有參數，然而便有了參數的校驗。對于業務接口來說，業務代碼應該是一目了然，只有業務相關的邏輯思路，而不應該存在大量的if-if來對參數或者數據本身的校驗或者一些其他的處理，為了增強代碼得可讀性、可維護性，接口參數的校驗處理是非常重要的。

當前很多流行的開源框架都會有自身的參數校驗機制、比如struts2、spring mvc的Validator機制、hibernate-validator、commons-validator等；

對于很多情景，這些第三方組件無法滿足我們的需要，比如參數的依賴關系等。它們都只是簡單的提供校驗參數字段的格式，并且這些校驗器2020都是有狀態的，導致校驗的性能不好。對于一些大數據量的操作處理，就顯得很吃力。對于互聯網平臺的高性能的追求，低效率的接口往往是不能適用的。

因此，本領域的技術人員亟需研究出一種可基于注解、json、xml多種格式對框架進行多樣化實現，更好地支持參數的強依賴性，能夠支持復雜的參數類型，統一接口開發模式標準，規范代碼一致性，增強系統的穩定性、易維護性、健壯性，增強代碼得可讀性、可維護性，接口參數的更加準確地進行校驗處理的接口參數校驗方法及組件。

發明內容

本發明要解決的技術問題是提供一種接口參數校驗方法及組件，該接口參數校驗方法可基于注解、json、xml多種格式對框架進行多樣化實現，更好地支持參數的強依賴性，能夠支持復雜的參數類型，統一接口開發模式標準，規范代碼一致性，增強系統的穩定性、易維護性、健壯性，增強代碼得可讀性、可維護性，接口參數的更加準確地進行校驗處理。

為解決上述技術問題，本發明提供了提供了一種接口參數校驗方法，提供客戶端、校驗器及服務器，所述校驗器包括注解解析模塊、注解校驗模塊及校驗規則生成模塊，所述接口參數校驗方法包括以下步驟：所述客戶端請求服務端的一個接口，客戶通過所述客戶端對參數進行自定義，所述注解解析模塊對參數進行解析并將解析結果數據發送給所述校驗規則生成模塊，所述校驗規則生成模塊根據所述解析結果數據生成自定義引用數據類型的比較規則，所述注解校驗模塊根據所述所述校驗規則生成模塊生成的比較規則的逐個屬性，去參數對象中尋找與之相對應的屬性,然后通過自定義的比較規則對屬性的值進行比較，如果沒有找到對應的屬性或者與之對應的屬性值不相同，則為校驗失敗，否則校驗通過。

優選地，所述注解校驗模塊支持xml配置、json配置、以及基于java的自定義注解配置。

優選地，所述步驟“所述校驗規則生成模塊根據所述解析結果數據生成自定義引用數據類型的比較規則”的實現步驟包括：

所述校驗規則生成模塊根據所述解析結果數據生成實現基礎類型自定義規則；

所述校驗規則生成模塊根據所述解析結果數據生成自定義校驗規則；

其中，所述實現基礎類型自定義規則包括must、int、strin、len、date、reg、long、float及double。