來(lái)源:嵌入式資訊精選
最近在做一個(gè)網(wǎng)關(guān)項(xiàng)目,分享一下在設(shè)計(jì)模塊的接口時(shí)的一個(gè)小心得。
網(wǎng)絡(luò)通信少不了對(duì)數(shù)據(jù)的處理,舉個(gè)例子,下行的網(wǎng)關(guān)發(fā)給設(shè)備的某類(lèi)消息中的數(shù)據(jù)格式如下:
這是json格式的數(shù)據(jù),還有很多發(fā)下來(lái)的消息也是json格式的,因此需要一個(gè)json模塊來(lái)專(zhuān)門(mén)進(jìn)行數(shù)據(jù)解析以及組json格式的包??梢詮木W(wǎng)上下載針對(duì)嵌入式的小型json模塊直接移植過(guò)來(lái),但這里考慮到數(shù)據(jù)協(xié)議并不復(fù)雜,嵌套層數(shù)不多,最多也就兩層,所以自己寫(xiě)算了。
首先需要設(shè)計(jì)解析json數(shù)據(jù)的接口,該設(shè)計(jì)成什么樣?請(qǐng)看下面兩種方法。
方法一
定義一個(gè)結(jié)構(gòu)體:
定義數(shù)據(jù)處理函數(shù)如下:
輸入:要處理的數(shù)據(jù)data,數(shù)據(jù)長(zhǎng)度len
處理:把數(shù)據(jù)中的一項(xiàng)一項(xiàng)的值解析出來(lái)存到結(jié)構(gòu)體outdata中對(duì)應(yīng)的元素中去
輸出:outdata;
返回:0(正常)/-1(異常);
比如上述數(shù)據(jù),輸出:
方法二
定義數(shù)據(jù)處理函數(shù)如下:
輸入:要處理的數(shù)據(jù)data及其長(zhǎng)度len,要從json數(shù)據(jù)中獲取內(nèi)容的屬性名稱(chēng) attribute;
輸出:屬性的值value;
處理:從數(shù)據(jù)data中獲取attibute的值,賦給value;
返回:0/-1.
比如,輸入上面數(shù)據(jù)賦給data,attribute='msg',輸出value='DEVICE_CONTROL'
總結(jié)
上面兩種方法哪種方法更好?乍一看,方法一好像很好,很省心對(duì)吧?你只需要輸入數(shù)據(jù),在里面處理一番,輸出的東西都給你弄好了。但是,仔細(xì)想想,這個(gè)函數(shù)里面會(huì)怎么實(shí)現(xiàn)呢?第一步是從data中去獲取'msg'屬性的值,賦值給結(jié)構(gòu)體中的type,第二步是從data中獲取”id”屬性的值賦給結(jié)構(gòu)體中id,這不就是方法二函數(shù)在做的事情嗎?所以方法一里面還是要調(diào)用方法二中函數(shù)的,方法一并沒(méi)有把最小單位的重復(fù)動(dòng)作設(shè)計(jì)成一個(gè)函數(shù)。
另一方面,方法一中直接把數(shù)據(jù)中的各屬性輸出到結(jié)構(gòu)體,實(shí)際上是雜糅了業(yè)務(wù)相關(guān)的東西在里面,也就是說(shuō),如果換一個(gè)項(xiàng)目,仍然有json數(shù)據(jù)要處理,但是屬性名字不是這些,而是其他命名的,那么方法一中的函數(shù)就不能直接復(fù)用移植,方法一并不是純處理json格式數(shù)據(jù)的函數(shù),雜糅了具體項(xiàng)目業(yè)務(wù)的協(xié)議在里面了,不夠純粹。方法一中函數(shù)適合放在具體業(yè)務(wù)處理的模塊里面,方法二中函數(shù)才是json模塊函數(shù),可移植性比較好。
另外在進(jìn)行模塊設(shè)計(jì)時(shí),有一個(gè)原則是“高內(nèi)聚,低耦合”,顯然如果方法一中的函數(shù)放到j(luò)son模塊中去,那就不夠內(nèi)聚了,與業(yè)務(wù)模塊有一些耦合了。
點(diǎn)贊▼
聯(lián)系客服