代碼規(guī)范

#代碼規(guī)范(從code review總結(jié))

1. 沒有使用filterStartLimit過濾limit字段值.filterStartLimit作用是防止sql注入.? orderby, page(分頁), groupby等參數(shù)都有類似風(fēng)險(xiǎn)拓萌。


2. 代碼里不應(yīng)出現(xiàn)magic number, 應(yīng)該定義常量增加可讀性

3. 路由URL中的"/"應(yīng)該用來體現(xiàn)層級而不是用來劃分單詞掩浙。

/offline/course/{id}/picture? ? #應(yīng)該使用? /offline_course/{id}/picture

4. 異常需要分類 不能都簡單拋出serviceException

Topxia\Common\Exception 中已經(jīng)有部分Exception類型矾兜,根據(jù)業(yè)務(wù)選擇

5. 檢查代碼的無用邏輯

如在controller層調(diào)用search時(shí),如果searchUserCount為0顽素,可以避免searchUsers

6. dao層sql 查詢 orderby 需要限制可排序字段(防注入)谷市。

7. search方法使用的場景是當(dāng)查詢條件不確定

conditions ?= array( 'parentId' => 0 ); 應(yīng)該使用 findXXXbyparentId(findParentXXX)

8. 變量命名冗余蛋哭,enrollmentPlan => plan运沦,增加可讀性

就像在CourseController下 不是courseManageAciton 應(yīng)是manageAciton,在這個(gè)語境下manage自然被理解為是管理Course泵额。

9. ‘if-else’循環(huán)內(nèi)容復(fù)雜,應(yīng)當(dāng)簡潔携添,考慮使用‘key => value’嫁盲。

多重循環(huán)嵌套時(shí),可以考慮是否可以用鍵值對形式來實(shí)現(xiàn)烈掠,或者用拼接的方法實(shí)現(xiàn)羞秤。

$status = array(

'new' => 'admin_enrollment_declare',

'declareing' => 'admin_enrollment_audit',

'assigned' => 'admin_enrollment_update_classroom',

);

if (!empty($plan) && $plan['status'] != 'published') {

return $this->redirect($this->generateUrl($status[$plan['status']] ,array('id' => $plan['id'])));

}

10. 在Controller中,不可暴露數(shù)據(jù)庫信息如”depth=> 2

11. 字段”created_time”和”updated_time”左敌,不應(yīng)寫在service(新框架不用賦值瘾蛋,原先框架應(yīng)寫在dao)

12. 數(shù)據(jù)庫字段命名駝峰和下劃線皆可 ?userId user_id

13. 方法的命名不能太籠統(tǒng),要盡量有具體的含義矫限。

validateAuthority()? 修改為=> tryManageClassroomThread()

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末哺哼,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子叼风,更是在濱河造成了極大的恐慌取董,老刑警劉巖,帶你破解...
    沈念sama閱讀 219,490評論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件无宿,死亡現(xiàn)場離奇詭異茵汰,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)懈贺,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,581評論 3 395
  • 文/潘曉璐 我一進(jìn)店門经窖,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人梭灿,你說我怎么就攤上這事画侣。” “怎么了堡妒?”我有些...
    開封第一講書人閱讀 165,830評論 0 356
  • 文/不壞的土叔 我叫張陵配乱,是天一觀的道長。 經(jīng)常有香客問我皮迟,道長搬泥,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,957評論 1 295
  • 正文 為了忘掉前任伏尼,我火速辦了婚禮忿檩,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘爆阶。我一直安慰自己燥透,他們只是感情好沙咏,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,974評論 6 393
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著班套,像睡著了一般肢藐。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上吱韭,一...
    開封第一講書人閱讀 51,754評論 1 307
  • 那天吆豹,我揣著相機(jī)與錄音,去河邊找鬼理盆。 笑死痘煤,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的熏挎。 我是一名探鬼主播速勇,決...
    沈念sama閱讀 40,464評論 3 420
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼坎拐!你這毒婦竟也來了烦磁?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,357評論 0 276
  • 序言:老撾萬榮一對情侶失蹤哼勇,失蹤者是張志新(化名)和其女友劉穎都伪,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體积担,經(jīng)...
    沈念sama閱讀 45,847評論 1 317
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡陨晶,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,995評論 3 338
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了帝璧。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片先誉。...
    茶點(diǎn)故事閱讀 40,137評論 1 351
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖的烁,靈堂內(nèi)的尸體忽然破棺而出褐耳,到底是詐尸還是另有隱情,我是刑警寧澤渴庆,帶...
    沈念sama閱讀 35,819評論 5 346
  • 正文 年R本政府宣布铃芦,位于F島的核電站,受9級特大地震影響襟雷,放射性物質(zhì)發(fā)生泄漏刃滓。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,482評論 3 331
  • 文/蒙蒙 一耸弄、第九天 我趴在偏房一處隱蔽的房頂上張望咧虎。 院中可真熱鬧,春花似錦计呈、人聲如沸老客。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,023評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽胧砰。三九已至,卻和暖如春苇瓣,著一層夾襖步出監(jiān)牢的瞬間尉间,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,149評論 1 272
  • 我被黑心中介騙來泰國打工击罪, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留哲嘲,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 48,409評論 3 373
  • 正文 我出身青樓媳禁,卻偏偏與公主長得像眠副,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個(gè)殘疾皇子竣稽,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,086評論 2 355

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

  • 代碼格式 使用空格而不是制表符 Tab 不要在工程里使用 Tab 鍵囱怕,使用空格來進(jìn)行縮進(jìn)。在 Xcode > Pr...
    small_Sun閱讀 1,362評論 1 3
  • (1): 包名全部小寫,根包名公司域名的反寫(不要www)如augmentum的域名為www.augmentum....
    stutterr閱讀 642評論 0 0
  • iOS編程規(guī)范0規(guī)范 0.1前言 為??高產(chǎn)品代碼質(zhì)量,指導(dǎo)廣大軟件開發(fā)人員編寫出簡潔毫别、可維護(hù)娃弓、可靠、可 測試岛宦、高效...
    iOS行者閱讀 4,459評論 21 35
  • 演講是一門學(xué)問台丛,前幾天剛講了如果能做一個(gè)成功的演講者,那么你將來一定是一個(gè)成功的人砾肺。 那如何把演講講好...
    城市格調(diào)劉姣閱讀 325評論 0 0
  • 2016七月上 他和他十指相扣還漫步于校園的林蔭小路 2016七月下 他和她卻天各一方于世界的不同角落 七月 “他...
    留白里的句號閱讀 218評論 0 0