代码规范

#代码规范(从code review总结)

1. 没有使用filterStartLimit过滤limit字段值.filterStartLimit作用是防止sql注入.  orderby, page(分页), groupby等参数都有类似风险。


2. 代码里不应出现magic number, 应该定义常量增加可读性

3. 路由URL中的"/"应该用来体现层级而不是用来划分单词。

/offline/course/{id}/picture    #应该使用  /offline_course/{id}/picture

4. 异常需要分类 不能都简单抛出serviceException

Topxia\Common\Exception 中已经有部分Exception类型,根据业务选择

5. 检查代码的无用逻辑

如在controller层调用search时,如果searchUserCount为0,可以避免searchUsers

6. dao层sql 查询 orderby 需要限制可排序字段(防注入)。

7. search方法使用的场景是当查询条件不确定

conditions  = array( 'parentId' => 0 ); 应该使用 findXXXbyparentId(findParentXXX)

8. 变量命名冗余,enrollmentPlan => plan,增加可读性

就像在CourseController下 不是courseManageAciton 应是manageAciton,在这个语境下manage自然被理解为是管理Course。

9. ‘if-else’循环内容复杂,应当简洁,考虑使用‘key => value’。

多重循环嵌套时,可以考虑是否可以用键值对形式来实现,或者用拼接的方法实现。

$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中,不可暴露数据库信息如”depth=> 2

11. 字段”created_time”和”updated_time”,不应写在service(新框架不用赋值,原先框架应写在dao)

12. 数据库字段命名驼峰和下划线皆可  userId user_id

13. 方法的命名不能太笼统,要尽量有具体的含义。

validateAuthority()  修改为=> tryManageClassroomThread()

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,029评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,395评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,570评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,535评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,650评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,850评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,006评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,747评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,207评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,536评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,683评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,342评论 4 330
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,964评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,772评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,004评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,401评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,566评论 2 349

推荐阅读更多精彩内容

  • 代码格式 使用空格而不是制表符 Tab 不要在工程里使用 Tab 键,使用空格来进行缩进。在 Xcode > Pr...
    small_Sun阅读 1,355评论 1 3
  • (1): 包名全部小写,根包名公司域名的反写(不要www)如augmentum的域名为www.augmentum....
    stutterr阅读 635评论 0 0
  • iOS编程规范0规范 0.1前言 为􏰀高产品代码质量,指导广大软件开发人员编写出简洁、可维护、可靠、可 测试、高效...
    iOS行者阅读 4,446评论 21 35
  • 演讲是一门学问,前几天刚讲了如果能做一个成功的演讲者,那么你将来一定是一个成功的人。 那如何把演讲讲好...
    城市格调刘姣阅读 322评论 0 0
  • 2016七月上 他和他十指相扣还漫步于校园的林荫小路 2016七月下 他和她却天各一方于世界的不同角落 七月 “他...
    留白里的句号阅读 217评论 0 0