代码规范,泛泛而谈

自从开始工作到现在也有一年半了,也算个小菜鸡,刚开始工作受前辈影响,加上自己稍微的强迫症,对代码规范十分看重,如果代码是砖头的话,代码规范就是图纸,是图纸,是砌砖的方式,谁都不想自己家建的乱七八糟吧。

简单写写平时注意的规范吧,基本都是对照阿里规范来进行的,本文是通过阿里规范认证之后写的,算是对之前一直遵循的规范和阿里规范学习的一个总结吧

1,千万不要在代码中成段的注释代码,不要的代码删了就是了,留着过年啊,一页的代码,大部分注释掉,然后中间穿插可执行代码,简直没法看。当然阿里规范有一条是自己之后会用到的,加///注释掉,这个是基于没提交过仓库的代码,如果是以前仓库提交过的,不用的,也直接删掉,想找回直接在仓库中找回。

2,参数封装POJO类,方便参数扩展和可维护。
举例:

 public String get(Integer a, Long b, Integer c, String d, String e, Integer f, String g,
                      String h, String i, Integer g, String k) throws IOException {

这种代码完全不知道,入参是什么,估计只有开发人员知道了,可维护性太差。

3,try-catch,只封装可能出现RuntimeException的地方,不要图省事成片catch,成片catch也无所谓,最怕那种不try-catch,还有catch中,加错误日志,打入参和异常栈,不要直接打e.getMessage(),更有甚者,直接e.printStackTrace();,要不报错都没法查,也可以用ExceptionHandler注解来catch RuntimeException。还有接口错误信息不要把异常栈直接传给调用方,传给调用方是想着让调用方给你查bug还是怎么,还有的接口是直接给前端用的,把异常栈信息传出去就要被笑话了。

4,使用卫语句,经常看到别人写的代码,if else五六层,简直了,卫语句很好的解决了这个问题。

5,多用ctrl+alt+m,提方法,别一个方法写那么长,让别人看不懂,一个方法长了,完全可以提子逻辑方法,主方法放子逻辑方法的调用,一眼就能知道子逻辑方法是干嘛的,很清晰。

6,提常量,不要代码中成篇魔数,让别人没法看,如果常量是一个范围,提枚举类,成篇的魔数直接让接锅的人崩溃。

7,多用Lombok,简化代码,看着爽

8,应用结构,一个好的应用结构,好比楼房,每层是干嘛的,更加合理,使得可读性和可维护性更高,可以参考阿里应用结构规范,个人喜欢api放参数校验,结果封装等,把逻辑交给service,dao放数据库相关操作。

9,注意防止NPE的产生,任何可能产生NPE的地方都要加判断

10,列表接口必须分页, 同时增加page size 过大校验。

代码规范最重要最重要的是code review,谁都会写垃圾代码,code review是垃圾代码的一道防线

阿里规范还有就是数据库的一些规范,建库建表,索引知识等,还有单元测试的,就先不写了,可以去看。

本文太多的细节没写,就先写自己第一时间想到的,以后有机会补充

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

推荐阅读更多精彩内容

  • 陈墨者沉默着阅读 147评论 0 0
  • 清晨入溪园,朝露待日晞。 银杏叶渐黄,果儿满枝丫。 无名荆棘丛,串串结玛瑙。 霜染五彩叶,绚烂更胜花。 2017-...
    秋天的丘阅读 796评论 2 49