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