团队开发代码规范

团队合作和个人开发完全不一样,要想问题少,必须强行规定一些东西,成为一种习惯,起初会很痛苦,但是这样磨合一段时间后会发现效果非常的棒,下面的一些规范是老大经常和我们说的,我总结一下分享给大家!之后会不定时更新!!

方法命名

1、get set开头的方法只能出现在dto 、do、po等对象实体中,用于属性值的设置和获取,其他类中禁止使用,主要是为了避免读代码的人混淆

2、从数据库或者远程获取数据时,方法名称应该使用query、fetch开头

3、创建数据对象或者对象转换赋值操作,封装到一个方法里面,名字以build、generate开头,填充数据以fill开头,转换数据使用convert开头

4、方法名称必须动词在前,名词在后

5、入参不能是map,因为别人不知道传什么,出参不能是map,因为别人不知道返回的是啥。

日志处理

1、日志打印统一使用slf4j,禁止使用log4j的方法,这样主要是更换日志框架的时候更为方便

异常处理

1、所有异常不能吃掉,一直向上抛出,在最顶层捕获并打印

2、如果返回值是BaseResult或者BasicResult类型,方法则不用抛出异常,但异常信息一定要包含在返回对象之内,不能丢掉;否则必须抛出

3、为方法进行aop拦截,使用log打印入参和出参,可以为解决和定位问题节省大部分时间

参数列表

1、参数如果是必传参数,使用基本类型替代,不使用引用类型,类中的变量也是如此,数据库对象DO、POJO除外

注释

1、如果是调用其他系统接口,接口的完整返回值样例需要写在调用方法的地方。能达到的目标是让读代码的人在不用看文档的情况就能非常清晰的了解接口的返回值状态

2、普通接口、属性注释要全面,让调用者可以不去问你就知道该怎么使用该接口,而不是每个人都要问一遍,无形之中增加沟通成本

代码编写

1、dao层只负责单纯的CRUD,不掺杂处理任何业务,sql语句尽量设计成通用查询形式,非特殊情况尽量不针对某一个业务功能写针对性的sql。

2、在dap层的上面封装一层manager层,负责封装一个或一组业务而存在,让调用者不用关心具体实现就可以放心使用,所以这一层的接口要精心设计哈

3、尽量让主流程代码清晰,像参数校验、大段的数据填充、转换,这些都应该放到独立的方法和类中

4、如果一个相同意义的接口在项目中出现了两次,但是是不同的人写的,那么这两个人就要坐下来,决定干掉其中一个接口!

5、对于废弃或修改接口,将使用@Deprecated 关键字, 并通知上游修改替换, 待全部替换完毕后,后续此接口将不再维护,或是进行删除。

6、能够穷举出来的字段尽量设计成枚举,且枚举的key不能为“”

日常开发分支管理

1、每次开发新功能或者修复bug都要新拉分支进行开发,格式为开发新功能使用dev_date_xxxx,修复bug使用bugfix_date_xxxx

2、每次开发完毕,测试通过后提交合并请求,由专人负责合并到主干,必须由专人负责合并,这个很重要。

3、每次提交的日志,前缀必须是你当前在干的这件事的简称,比如(性能优化:xxxxxx),过程中所有的日志提交都要使用这个前缀

4、每天早晨都需要把release的代码向下合并到自己的分支,每天至少一次,上线合并release前再次向下合并一次,确保冲突率降到最低

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

推荐阅读更多精彩内容