今天給同事封裝了一個(gè)接口,說起接口封裝的事情,其實(shí)其實(shí)很有的聊。很多時(shí)候,說一個(gè)服務(wù)好,一個(gè)服務(wù)爛,實(shí)際上都是在吐槽服務(wù)隊(duì)外暴露的接口好壞。不管什么語言,封裝接口,抽象起來,就是由一個(gè)函數(shù)名,若干個(gè)參數(shù),若干個(gè)返回值組成的。封裝的好壞,就在這幾個(gè)上面。
函數(shù)名
首先是函數(shù)名。函數(shù)名的好壞很明顯,我的觀點(diǎn),是否簡單,不重復(fù)。比如在一個(gè)User類中你封裝一個(gè)方法,叫做findUser。我就覺得很啰嗦了。你使用的時(shí)候會(huì)這樣使用
User::findUser($id);
那又是何必呢?為什不直接叫做find呢?
User::find($id);
我記得前段時(shí)間在網(wǎng)上還看到一篇文章,你見過哪些奇葩的代碼。其中就有一些有趣的函數(shù)名。在我的視角看來,下面的函數(shù)名都很奇葩:
function weizhi() // 中文拼音function getuserinfo() // 單詞和單詞沒用大小寫分割function getUserIsEnable() // 明明是bool判斷卻用get開頭
基本上,我們選擇使用 動(dòng)詞 或者 動(dòng)詞+名詞 或者 動(dòng)詞+名詞 + 副詞
比如
function find()function getUser()function getUserByName()
我覺得這些都是很符合人性的函數(shù)名。
參數(shù)
一句話, 參數(shù)盡量不要封裝。。。盡量不要太多。。。
盡量不要封裝就是,能隊(duì)外暴露的細(xì)節(jié)越多,用戶使用成本越低,比如,根據(jù)地理位置獲取地址的函數(shù)
// 里面的$coord是一個(gè)數(shù)組['lat','lng']function getCityByCoord($coord)
就不如
function getCityByCoord($lat, $lng)
還有不要太多就是如果你參數(shù)個(gè)數(shù)超過5個(gè),就該考慮封裝了。封裝的時(shí)候,我習(xí)慣會(huì)把一些“不重要的”,“不常用的”封裝成一個(gè)參數(shù),并且設(shè)置這個(gè)參數(shù)默認(rèn)值。
// 這里的conditions 可以設(shè)置表列名,只能用等號 ['class' => 1]function getUsers($offset, $limit, $sort, $conditions = [])
返回值