支付中心接口設(shè)計(jì)之參數(shù)命名

目前,java版支付中心處在研發(fā)階段秕衙。下午蠢甲,特有鉆研精神的云龍同學(xué)饒有興趣的問(wèn)我“戰(zhàn)哥,你覺(jué)得表字段用哪種命名方式比較好呢据忘?”

所用的db是mysql鹦牛,他是想征求一下我的看法,是用駝峰式命名還是小寫(xiě)加下劃線方式勇吊。

我直截了當(dāng)?shù)卣f(shuō)用駝峰式曼追。為什么? 我認(rèn)為汉规,像java語(yǔ)言或.net語(yǔ)言礼殊,實(shí)體類(lèi)的屬性一般是遵從駝峰式命名的(稍有不同的是java一般首字母小寫(xiě),而.net是首字母大寫(xiě))针史。我們的程序里的數(shù)據(jù)訪問(wèn)層一般均采用ORM框架晶伦。如果表字段是小寫(xiě)字母+下劃線,那么啄枕,相應(yīng)的POJO/POCO實(shí)體類(lèi)的屬性也會(huì)是小寫(xiě)字母+下劃線婚陪,這樣,違背了駝峰式命名規(guī)范泌参,有違代碼的整潔度脆淹。

接著,如我所期沽一,云龍問(wèn)“那你支付中心對(duì)外的api接口參數(shù)為什么用小寫(xiě)+下劃線的方式呢未辆?”

我答道,對(duì)外提供的接口锯玛,

  • 如果用駝峰式。 首先兼蜈,我們用word編寫(xiě)接口說(shuō)明文檔時(shí)攘残,在參數(shù)表格列里輸入?yún)?shù)名后,如果按tab鍵为狸,則word默認(rèn)首字母是大寫(xiě)的歼郭。而如果恰好我們的首字母是小寫(xiě)時(shí),如果我們?cè)诰帉?xiě)時(shí)忽略了這個(gè)細(xì)節(jié)辐棒,這就會(huì)給對(duì)接者帶來(lái)疑惑(產(chǎn)品設(shè)計(jì)上有一條重要的原則:Don't Make Me Think病曾,同樣適用于軟件設(shè)計(jì)); 更甚之漾根,如果簽名規(guī)則要求的簽名原串包括參數(shù)名時(shí)泰涂,那么,因字母大小寫(xiě)所致的驗(yàn)簽失敗往往不那么容易排查出來(lái)辐怕,進(jìn)而造成雙方的“不必要”溝通逼蒙。
  • 如果用小寫(xiě)+下劃線。 首先寄疏,這種方式規(guī)避了上面駝峰式命名的不足是牢。 其次,考慮到商戶對(duì)接存在不同的編程語(yǔ)言如php/java/.net陕截,跨語(yǔ)言程序員之間也都會(huì)認(rèn)可驳棱。

云龍和偉業(yè)聽(tīng)后表示贊同。
我解釋农曲,我們?cè)诮涌陂_(kāi)發(fā)和商戶對(duì)接支持這些事情上踩過(guò)的坑太多了社搅,逐漸的就要考慮這些細(xì)節(jié)。


api接口文檔
letter-case

【另面觀】
其實(shí)乳规,也許是從事IT項(xiàng)目管理的職業(yè)病罚渐,我喜歡考慮項(xiàng)目成本,系統(tǒng)設(shè)計(jì)方面驯妄,始終堅(jiān)持通過(guò)合理設(shè)計(jì)規(guī)避不必要的溝通和互撕荷并。

像上面支付接口的參數(shù),如果不考慮命名形式青扔,用駝峰式源织,勢(shì)必會(huì)增加后續(xù)甲乙雙方聯(lián)調(diào)過(guò)程中的溝通成本翩伪。那么,倘若我們改為小寫(xiě)加下劃線的形式谈息,就會(huì)規(guī)避這些真的是不必要的溝通缘屹。 ——這就是軟件意識(shí)。
有些程序員一天的工作就是商戶接口對(duì)接聯(lián)調(diào)支持侠仇。有些領(lǐng)導(dǎo)看到下屬員工一天忙碌的對(duì)接轻姿,認(rèn)為其工作很飽滿。

【延伸】
我也饒有興趣逻炊,忽然在想互亮,我們支付中心對(duì)外提供的這種接口在技術(shù)層面叫作什么呢? api是應(yīng)用程序接口余素,即程序包里的公開(kāi)的方法及對(duì)這些方法的說(shuō)明豹休。而這種通過(guò)http發(fā)布的接口,是什么呢桨吊? rpc接口威根?rmi接口?webapi视乐? 我也去找云龍和偉業(yè)探討洛搀,他們說(shuō)就是接口嘛,笑我太愛(ài)琢磨了佑淀。
我常常就這樣較真兒姥卢,當(dāng)然,我也不認(rèn)為這種較真兒是什么缺點(diǎn)渣聚。于是独榴,為了一個(gè)細(xì)節(jié),我會(huì)去查看好些技術(shù)帖子和blog奕枝。于是棺榔,我也再了解了一下rpc、web Service隘道、web api症歇。

今天周六,加班的同事早已回家谭梗。我從洗手間回到工位忘晤,辦公區(qū)周?chē)幕韬冢巴馊h(huán)上疾馳的車(chē)輛激捏,CBD夜景燈火闌珊设塔,不覺(jué)中渲染出我的孤寂。大周末的远舅,是時(shí)候回家陪陪孩子做點(diǎn)家務(wù)了闰蛔。


最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末痕钢,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子序六,更是在濱河造成了極大的恐慌任连,老刑警劉巖,帶你破解...
    沈念sama閱讀 211,194評(píng)論 6 490
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件例诀,死亡現(xiàn)場(chǎng)離奇詭異随抠,居然都是意外死亡,警方通過(guò)查閱死者的電腦和手機(jī)繁涂,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,058評(píng)論 2 385
  • 文/潘曉璐 我一進(jìn)店門(mén)拱她,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人爆土,你說(shuō)我怎么就攤上這事≈畈希” “怎么了步势?”我有些...
    開(kāi)封第一講書(shū)人閱讀 156,780評(píng)論 0 346
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)背犯。 經(jīng)常有香客問(wèn)我坏瘩,道長(zhǎng),這世上最難降的妖魔是什么漠魏? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 56,388評(píng)論 1 283
  • 正文 為了忘掉前任倔矾,我火速辦了婚禮,結(jié)果婚禮上柱锹,老公的妹妹穿的比我還像新娘哪自。我一直安慰自己,他們只是感情好禁熏,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,430評(píng)論 5 384
  • 文/花漫 我一把揭開(kāi)白布壤巷。 她就那樣靜靜地躺著,像睡著了一般瞧毙。 火紅的嫁衣襯著肌膚如雪胧华。 梳的紋絲不亂的頭發(fā)上,一...
    開(kāi)封第一講書(shū)人閱讀 49,764評(píng)論 1 290
  • 那天宙彪,我揣著相機(jī)與錄音矩动,去河邊找鬼。 笑死释漆,一個(gè)胖子當(dāng)著我的面吹牛悲没,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播男图,決...
    沈念sama閱讀 38,907評(píng)論 3 406
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼檀训,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼柑潦!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起峻凫,我...
    開(kāi)封第一講書(shū)人閱讀 37,679評(píng)論 0 266
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤渗鬼,失蹤者是張志新(化名)和其女友劉穎,沒(méi)想到半個(gè)月后荧琼,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體譬胎,經(jīng)...
    沈念sama閱讀 44,122評(píng)論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,459評(píng)論 2 325
  • 正文 我和宋清朗相戀三年命锄,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了堰乔。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 38,605評(píng)論 1 340
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡脐恩,死狀恐怖镐侯,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情驶冒,我是刑警寧澤苟翻,帶...
    沈念sama閱讀 34,270評(píng)論 4 329
  • 正文 年R本政府宣布,位于F島的核電站骗污,受9級(jí)特大地震影響崇猫,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜需忿,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,867評(píng)論 3 312
  • 文/蒙蒙 一诅炉、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧屋厘,春花似錦涕烧、人聲如沸。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 30,734評(píng)論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至仲翎,卻和暖如春痹扇,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背溯香。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 31,961評(píng)論 1 265
  • 我被黑心中介騙來(lái)泰國(guó)打工鲫构, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人玫坛。 一個(gè)月前我還...
    沈念sama閱讀 46,297評(píng)論 2 360
  • 正文 我出身青樓结笨,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子炕吸,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,472評(píng)論 2 348

推薦閱讀更多精彩內(nèi)容

  • 1伐憾、引言 數(shù)據(jù)庫(kù)設(shè)計(jì)過(guò)程中表、字段等的命名規(guī)范也算是設(shè)計(jì)規(guī)范的一部分赫模,不過(guò)設(shè)計(jì)規(guī)范更多的是為了確保數(shù)據(jù)庫(kù)設(shè)計(jì)的合理...
    SnowflakeCloud閱讀 40,961評(píng)論 0 48
  • Spring Cloud為開(kāi)發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見(jiàn)模式的工具(例如配置管理树肃,服務(wù)發(fā)現(xiàn),斷路器瀑罗,智...
    卡卡羅2017閱讀 134,629評(píng)論 18 139
  • 1. 簡(jiǎn)介 1.1 什么是 MyBatis 胸嘴? MyBatis 是支持定制化 SQL、存儲(chǔ)過(guò)程以及高級(jí)映射的優(yōu)秀的...
    笨鳥(niǎo)慢飛閱讀 5,454評(píng)論 0 4
  • 周杰倫是一個(gè)時(shí)代的象征,作為90年這一代人摧玫,我們真的是聽(tīng)著杰倫的歌長(zhǎng)大的呢~ 現(xiàn)在耳奕,立刻,這一秒诬像,請(qǐng)你唱出周杰倫的...
    王婉妮閱讀 748評(píng)論 0 0
  • 你是否經(jīng)常陷入這樣一個(gè)怪圈颅停,你在一天的時(shí)間內(nèi)谓晌,不管有空沒(méi)空掠拳,都會(huì)不斷的刷微博刷朋友圈癞揉,不停的點(diǎn)開(kāi)工作群里時(shí)不時(shí)跳出...
    桐花與貓閱讀 4,422評(píng)論 37 200