代码规范

#代码规范(从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()

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

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