一種軟件接口參數(shù)驗(yàn)證方法
【技術(shù)領(lǐng)域】
[0001 ]本發(fā)明涉及軟件設(shè)計(jì)技術(shù)領(lǐng)域，特別是一種軟件接口參數(shù)驗(yàn)證方法。
【背景技術(shù)】
[0002] 隨著軟件領(lǐng)域的發(fā)展，如何減少軟件的復(fù)雜性，提高軟件的質(zhì)量是軟件設(shè)計(jì)的一 個(gè)重要目標(biāo)。軟件接口設(shè)計(jì)也是軟件設(shè)計(jì)的一個(gè)內(nèi)容，不僅關(guān)系到接口外部調(diào)用的方便性， 而且關(guān)系到軟件的安全性問(wèn)題、軟件復(fù)雜性問(wèn)題。如果軟件接口的參數(shù)驗(yàn)證完全放到具體 的業(yè)務(wù)內(nèi)部去完成校驗(yàn)，必然會(huì)加重軟件接口內(nèi)部邏輯開(kāi)發(fā)的復(fù)雜性，但是如果軟件接口 不驗(yàn)證，會(huì)使得軟件安全得不到保障。因此，如果將接口參數(shù)驗(yàn)證和具體的業(yè)務(wù)邏輯分離， 必然會(huì)降低業(yè)務(wù)邏輯開(kāi)發(fā)的復(fù)雜，同時(shí)提高參數(shù)驗(yàn)證的準(zhǔn)確性和方便性，提高軟件的安全 質(zhì)量。

【發(fā)明內(nèi)容】

[0003] 本發(fā)明解決的技術(shù)問(wèn)題在于提供一種軟件接口參數(shù)驗(yàn)證方法，降低軟件設(shè)計(jì)時(shí)業(yè) 務(wù)邏輯開(kāi)發(fā)的復(fù)雜，提高軟件的安全質(zhì)量。
[0004] 本發(fā)明解決上述技術(shù)問(wèn)題的技術(shù)方案是：
[0005] 所述的方法包括以下步驟：
[0006] (1)定義參數(shù)驗(yàn)證類(lèi)以及抽象接口，驗(yàn)證類(lèi)實(shí)現(xiàn)具體的參數(shù)驗(yàn)證和反饋，抽象接口 用于注解標(biāo)識(shí)用；
[0007] (2)定義軟件接口上的參數(shù)傳入形式以及參數(shù)對(duì)應(yīng)的參數(shù)類(lèi)，在參數(shù)類(lèi)對(duì)應(yīng)的屬 性獲取方法上添加參數(shù)驗(yàn)證注解標(biāo)識(shí)，指明對(duì)應(yīng)的參數(shù)屬性的參數(shù)驗(yàn)證方法；
[0008] (3)軟件接口被調(diào)用后，參數(shù)驗(yàn)證攔截器獲取軟件接口上傳遞的參數(shù)信息，根據(jù)參 數(shù)找到軟件接口對(duì)應(yīng)的參數(shù)類(lèi)以及參數(shù)屬性，獲取屬性上的參數(shù)驗(yàn)證注解標(biāo)識(shí)，加載參數(shù) 驗(yàn)證注解類(lèi)進(jìn)行參數(shù)驗(yàn)證。
[0009] 所述的參數(shù)驗(yàn)證類(lèi)主要包含驗(yàn)證類(lèi)的方法，含有輸入?yún)?shù)信息，以及自定義的驗(yàn) 證范圍信息。
[0010] 所述的參數(shù)驗(yàn)證抽象接口定義了驗(yàn)證類(lèi)的使用方式，是對(duì)驗(yàn)證類(lèi)關(guān)聯(lián)信息的一種 高度抽象，該接口用于注解標(biāo)識(shí)用，方便用戶定義參數(shù)驗(yàn)證使用；
[0011] 所述的注解標(biāo)識(shí)中分成了兩種形式:復(fù)雜參數(shù)驗(yàn)證注解和具體驗(yàn)證的參數(shù)標(biāo)識(shí)；
[0012] 所述的復(fù)雜參數(shù)驗(yàn)證注解包含參數(shù)實(shí)體類(lèi)以及對(duì)應(yīng)軟件接口上的參數(shù)形式，如參 數(shù)前綴形式，如add · pool Inf 〇 · pooIName參數(shù)的前綴為add · pool Info;所述具體驗(yàn)證的參數(shù) 標(biāo)識(shí)指明了參數(shù)驗(yàn)證具體的抽象接口，以及接口需要的輸入以及驗(yàn)證錯(cuò)誤后的反饋信息；
[0013] 所述的參數(shù)實(shí)體類(lèi)主要包含對(duì)應(yīng)的屬性以及屬性的get\set方法，其屬性支持其 他參數(shù)實(shí)體類(lèi)，其get方法上添加參數(shù)驗(yàn)證注解信息。
[0014] 所述的軟件接口的參數(shù)支持含有前綴形式，其前綴支持復(fù)雜類(lèi)型參數(shù)輸入，將前 綴和參數(shù)類(lèi)的屬性注解結(jié)合起來(lái)，便于參數(shù)驗(yàn)證。
[0015] 所述的參數(shù)驗(yàn)證攔截器會(huì)攔截接口請(qǐng)求信息，在接口請(qǐng)求到具體業(yè)務(wù)前，完成接 口上的參數(shù)驗(yàn)證信息；
[0016] 所述的攔截方法首先獲取接口上的參數(shù)，將參數(shù)轉(zhuǎn)換為key-value的形式，然后找 到參數(shù)對(duì)應(yīng)的驗(yàn)證參數(shù)實(shí)體類(lèi)，再根據(jù)key找到對(duì)應(yīng)的屬性方法以及方法上對(duì)應(yīng)的驗(yàn)證注 解標(biāo)識(shí);如果驗(yàn)證注解標(biāo)識(shí)上還包含復(fù)雜的參數(shù)類(lèi)以及前綴形式，則將對(duì)應(yīng)的key-value參 數(shù)傳遞給注解標(biāo)識(shí)中配置的參數(shù)類(lèi);如果驗(yàn)證注解標(biāo)識(shí)上是參數(shù)驗(yàn)證抽象接口，則將value 傳遞給參數(shù)接口對(duì)應(yīng)的參數(shù)驗(yàn)證類(lèi)，由參數(shù)驗(yàn)證類(lèi)具體的方法完成value的校驗(yàn)。
[0017] 本發(fā)明可以簡(jiǎn)單配置軟件接口上的參數(shù)驗(yàn)證規(guī)則，就支持軟件接口上的參數(shù)驗(yàn) 證，將參數(shù)驗(yàn)證和接口具體業(yè)務(wù)邏輯分離，降低業(yè)務(wù)的復(fù)雜度，同時(shí)參數(shù)驗(yàn)證支持參數(shù)類(lèi)中 含有嵌套參數(shù)類(lèi)，以及參數(shù)驗(yàn)證類(lèi)以及抽象接口的重復(fù)使用。
【附圖說(shuō)明】
[0018] 下面結(jié)合附圖對(duì)本發(fā)明進(jìn)一步說(shuō)明：
[0019] 圖1為本發(fā)明的流程圖。
【具體實(shí)施方式】
[0020] 流程圖如圖1所示，具體實(shí)施過(guò)程如下：
[0021] 1、定義參數(shù)驗(yàn)證抽象接口以及具體參數(shù)驗(yàn)證類(lèi)
[0022]
[0024:
[0025] 2、接口參數(shù)以及接口參數(shù)對(duì)應(yīng)的參數(shù)實(shí)體類(lèi)
[0026] (1)接口 參數(shù)形式如：add .pool info .pool Name = poo 11 &add.userName = demo-七68討妾口參數(shù)對(duì)應(yīng)的實(shí)體類(lèi)六(1(1?0〇1111：[>08?3從111?001，其中六(1(1?001111：[ >08?3從111類(lèi)中還包含 復(fù)雜的參數(shù)類(lèi)P00 1 Inf oParam屬性
[0027] (2)為了實(shí)現(xiàn)AddPoolInfosParam以及PoolInfoParam中的屬性參數(shù)驗(yàn)證，需要添 加一下注解，如下所示：
[0028]
[0029] /
[0030] AddPoo 1 Inf osParam參數(shù)類(lèi)中userName參數(shù)驗(yàn)證，在getUserName 中添加了 StringLengthLimit注解，支持內(nèi)部參數(shù)poolInfoParams屬性的驗(yàn)證，在 getPool InfoParams 方法上添加 注角軍，@MultParamsCheck(beanClass = PoolInfoParam.class，paramsPrefix = "add.poolinfo"），其中StringLengthLimit為具體 的參數(shù)驗(yàn)證實(shí)現(xiàn)類(lèi)，而MultParamsCheck主要為復(fù)雜嵌套參數(shù)標(biāo)識(shí)，beanClass為對(duì)應(yīng)的嵌 套參數(shù)類(lèi)，paramsPref ix為接口上對(duì)應(yīng)的參數(shù)前綴形式。
[0031] 3、接口調(diào)用后
[0032] 在攔截器中獲取接口參數(shù)信息Key-value形式，如：["add.poolinfo.poolName" ：" pooll"，"add.userName' ："demo_test" ]，然后驗(yàn)證方法checkMultParamsCheck，其實(shí)現(xiàn)邏 輯如下：
[0033] 獲取參數(shù)實(shí)體類(lèi)的方法，如getPoolInfoParams方法
[0034]
[0035]
[0036] 以上所揭露的僅為本發(fā)明其中一個(gè)實(shí)施例而已，當(dāng)然不能以此限定本發(fā)明之權(quán)利 范圍，因此依本發(fā)明權(quán)利要求所作的等同變化，仍屬本發(fā)明所覆蓋的范圍。
【主權(quán)項(xiàng)】
1. 一種軟件接口參數(shù)驗(yàn)證方法，其特征在于:所述的方法包括以下步驟： (1) 定義參數(shù)驗(yàn)證類(lèi)以及抽象接口，驗(yàn)證類(lèi)實(shí)現(xiàn)具體的參數(shù)驗(yàn)證和反饋，抽象接口用于 注解標(biāo)識(shí)用； (2) 定義軟件接口上的參數(shù)傳入形式以及參數(shù)對(duì)應(yīng)的參數(shù)類(lèi)，在參數(shù)類(lèi)對(duì)應(yīng)的屬性獲 取方法上添加參數(shù)驗(yàn)證注解標(biāo)識(shí)，指明對(duì)應(yīng)的參數(shù)屬性的參數(shù)驗(yàn)證方法； (3) 軟件接口被調(diào)用后，參數(shù)驗(yàn)證攔截器獲取軟件接口上傳遞的參數(shù)信息，根據(jù)參數(shù)找 到軟件接口對(duì)應(yīng)的參數(shù)類(lèi)以及參數(shù)屬性，獲取屬性上的參數(shù)驗(yàn)證注解標(biāo)識(shí)，加載參數(shù)驗(yàn)證 注解類(lèi)進(jìn)行參數(shù)驗(yàn)證。2. 根據(jù)權(quán)利要求1所述的軟件接口參數(shù)驗(yàn)證方法，其特征在于:所述的參數(shù)驗(yàn)證類(lèi)主要 包含驗(yàn)證類(lèi)的方法，含有輸入?yún)?shù)信息，以及自定義的驗(yàn)證范圍信息。3. 根據(jù)權(quán)利要求1所述的軟件接口參數(shù)驗(yàn)證方法，其特征在于:所述的參數(shù)驗(yàn)證抽象接 口定義了驗(yàn)證類(lèi)的使用方式，是對(duì)驗(yàn)證類(lèi)關(guān)聯(lián)信息的一種高度抽象，該接口用于注解標(biāo)識(shí) 用，方便用戶定義參數(shù)驗(yàn)證使用； 所述的注解標(biāo)識(shí)中分成了兩種形式:復(fù)雜參數(shù)驗(yàn)證注解和具體驗(yàn)證的參數(shù)標(biāo)識(shí)； 所述的復(fù)雜參數(shù)驗(yàn)證注解包含參數(shù)實(shí)體類(lèi)以及對(duì)應(yīng)軟件接口上的參數(shù)形式，如參數(shù)前 綴形式，如add · pool Inf 〇 · pooIName參數(shù)的前綴為add · pool Inf 〇;所述具體驗(yàn)證的參數(shù)標(biāo)識(shí) 指明了參數(shù)驗(yàn)證具體的抽象接口，以及接口需要的輸入以及驗(yàn)證錯(cuò)誤后的反饋信息； 所述的參數(shù)實(shí)體類(lèi)主要包含對(duì)應(yīng)的屬性以及屬性的get\set方法，其屬性支持其他參 數(shù)實(shí)體類(lèi)，其get方法上添加參數(shù)驗(yàn)證注解信息。4. 根據(jù)權(quán)利要求2所述的軟件接口參數(shù)驗(yàn)證方法，其特征在于:所述的參數(shù)驗(yàn)證抽象接 口定義了驗(yàn)證類(lèi)的使用方式，是對(duì)驗(yàn)證類(lèi)關(guān)聯(lián)信息的一種高度抽象，該接口用于注解標(biāo)識(shí) 用，方便用戶定義參數(shù)驗(yàn)證使用； 所述的注解標(biāo)識(shí)中分成了兩種形式:復(fù)雜參數(shù)驗(yàn)證注解和具體驗(yàn)證的參數(shù)標(biāo)識(shí)； 所述的復(fù)雜參數(shù)驗(yàn)證注解包含參數(shù)實(shí)體類(lèi)以及對(duì)應(yīng)軟件接口上的參數(shù)形式，如參數(shù)前 綴形式，如add · pool Inf 〇 · poo IName參數(shù)的前綴為add · pool Inf 〇;所述具體驗(yàn)證的參數(shù)標(biāo)識(shí) 指明了參數(shù)驗(yàn)證具體的抽象接口，以及接口需要的輸入以及驗(yàn)證錯(cuò)誤后的反饋信息； 所述的參數(shù)實(shí)體類(lèi)主要包含對(duì)應(yīng)的屬性以及屬性的get\set方法，其屬性支持其他參 數(shù)實(shí)體類(lèi)，其get方法上添加參數(shù)驗(yàn)證注解信息。5. 根據(jù)權(quán)利要求1至4任一項(xiàng)所述的軟件接口參數(shù)驗(yàn)證方法，其特征在于:所述的軟件 接口的參數(shù)支持含有前綴形式，其前綴支持復(fù)雜類(lèi)型參數(shù)輸入，將前綴和參數(shù)類(lèi)的屬性注 解結(jié)合起來(lái)，便于參數(shù)驗(yàn)證。6. 根據(jù)權(quán)利要求1至4任一項(xiàng)所述的軟件接口參數(shù)驗(yàn)證方法，其特征在于:所述的參數(shù) 驗(yàn)證攔截器會(huì)攔截接口請(qǐng)求信息，在接口請(qǐng)求到具體業(yè)務(wù)前，完成接口上的參數(shù)驗(yàn)證信息； 所述的攔截方法首先獲取接口上的參數(shù)，將參數(shù)轉(zhuǎn)換為key-value的形式，然后找到參 數(shù)對(duì)應(yīng)的驗(yàn)證參數(shù)實(shí)體類(lèi)，再根據(jù)key找到對(duì)應(yīng)的屬性方法以及方法上對(duì)應(yīng)的驗(yàn)證注解標(biāo) 識(shí);如果驗(yàn)證注解標(biāo)識(shí)上還包含復(fù)雜的參數(shù)類(lèi)以及前綴形式，則將對(duì)應(yīng)的key-value參數(shù)傳 遞給注解標(biāo)識(shí)中配置的參數(shù)類(lèi);如果驗(yàn)證注解標(biāo)識(shí)上是參數(shù)驗(yàn)證抽象接口，則將value傳遞 給參數(shù)接口對(duì)應(yīng)的參數(shù)驗(yàn)證類(lèi)，由參數(shù)驗(yàn)證類(lèi)具體的方法完成value的校驗(yàn)。7. 根據(jù)權(quán)利要求5所述的軟件接口參數(shù)驗(yàn)證方法，其特征在于:所述的參數(shù)驗(yàn)證攔截器 會(huì)攔截接口請(qǐng)求信息，在接口請(qǐng)求到具體業(yè)務(wù)前，完成接口上的參數(shù)驗(yàn)證信息； 所述的攔截方法首先獲取接口上的參數(shù)，將參數(shù)轉(zhuǎn)換為key-value的形式，然后找到參 數(shù)對(duì)應(yīng)的驗(yàn)證參數(shù)實(shí)體類(lèi)，再根據(jù)key找到對(duì)應(yīng)的屬性方法以及方法上對(duì)應(yīng)的驗(yàn)證注解標(biāo) 識(shí);如果驗(yàn)證注解標(biāo)識(shí)上還包含復(fù)雜的參數(shù)類(lèi)以及前綴形式，則將對(duì)應(yīng)的key-value參數(shù)傳 遞給注解標(biāo)識(shí)中配置的參數(shù)類(lèi);如果驗(yàn)證注解標(biāo)識(shí)上是參數(shù)驗(yàn)證抽象接口，則將value傳遞 給參數(shù)接口對(duì)應(yīng)的參數(shù)驗(yàn)證類(lèi)，由參數(shù)驗(yàn)證類(lèi)具體的方法完成value的校驗(yàn)。
【專(zhuān)利摘要】本發(fā)明涉及軟件設(shè)計(jì)技術(shù)領(lǐng)域，特別是一種軟件接口參數(shù)驗(yàn)證方法。其主要步驟：首先定義參數(shù)驗(yàn)證類(lèi)以及相關(guān)抽象接口，驗(yàn)證類(lèi)實(shí)現(xiàn)了具體的參數(shù)驗(yàn)證和反饋，抽象接口用于注解標(biāo)識(shí)用；定義軟件接口上的參數(shù)傳入形式以及參數(shù)對(duì)應(yīng)的參數(shù)類(lèi)，在參數(shù)類(lèi)對(duì)應(yīng)的屬性獲取方法上添加參數(shù)驗(yàn)證注解標(biāo)識(shí)，標(biāo)識(shí)指明對(duì)應(yīng)的參數(shù)驗(yàn)證方法；軟件接口被調(diào)用后，參數(shù)驗(yàn)證攔截器獲取軟件接口上傳遞的參數(shù)信息，根據(jù)參數(shù)找到軟件接口對(duì)應(yīng)的參數(shù)類(lèi)以及參數(shù)屬性，獲取屬性上的參數(shù)驗(yàn)證注解標(biāo)識(shí)，加載標(biāo)識(shí)上對(duì)應(yīng)的參數(shù)驗(yàn)證注解類(lèi)進(jìn)行參數(shù)驗(yàn)證。本發(fā)明可以降低軟件業(yè)務(wù)邏輯開(kāi)發(fā)的復(fù)雜；用于軟件開(kāi)發(fā)。
【IPC分類(lèi)】G06F9/44, G06F21/12
【公開(kāi)號(hào)】CN105677326
【申請(qǐng)?zhí)枴緾N201511018268
【發(fā)明人】羅義兵, 楊松, 季統(tǒng)凱
【申請(qǐng)人】國(guó)云科技股份有限公司
【公開(kāi)日】2016年6月15日
【申請(qǐng)日】2015年12月28日