Java代码规范1.0.1

      前言:最近项目组内部在做CodeReview,将我们在日常工作中编写的代码进行一个评审,发现潜在问题,然后收集、整理、讨论、形成规范,指导后续软件开发,提升软件质量。以下是个人的一期总结,后续将不定期陆续更新完善此规范。

1.命名、注释和提示:

(1).命名方法时,首字母不能为大写,哪怕是单词的缩写也不能为大写。如HgSetToHgInfo,必须改成hgSetToHgInfo。

(2).命名要规范,易理解,与方法执行的目的或作用保持一致。例如,获取数据列表,命名应为getHolidayGuardsByWatchId,而不是getWatchIdHolidayGuards。

(3).关于注释,可利用方法和变量的命名来理解业务逻辑,或者用注释来说明方法的用途和注意要点,两者酌情而定。

(4).定义了未使用的对象或变量,编译器会提示此多余代码,在AndroidStudio编译器中,代码提示中有黄色提示的,即多余的变量,一定要进行处理。

2.网络请求:

(1).网络请求,不能直接return掉,return掉之后,请求会一直在哪儿,没有返回,调用者无法做相应处理。

(2).在网络请求之前,不需要返回数据,listener可为空。

3.Log日志:

(1).在调试程序时,统一使用LogUtil,便于发布版本时控制Log的开关,可针对个人需要在特定模块Log中增加Tag。

(2).Log Level需要根据实际情况和规范来写,不能到处写error级别的Log。

4.判断方法:

(1).判断变量x是否为null时,统一为 x == null,不能写成null == x;

(2).方法体内,有过长的判断时,尽可能抽调出来,新建临时变量来判断,使代码结构清晰,便于阅读。

(3).网络请求返回object时,有些地方有判断是否为空,有些地方未判断是否为空,前后不一,需保持一致。

5.数据处理:

(1).方法命名了getData,但是在内部又进行了本地缓存数据的删除等操作,需要考虑重命名,减少歧义,或是将本地数据删除操作等封装出来。

(2).执行数据库删除操作时未对成功或失败的情况做处理,当因为不可知因素删除失败时,需要对失败情况进行处理,如重执行,输出日志等。

(3).List返回值时,面对返回null和返回空集合的选择,对于集合和数组作为返回值,使用长度为零的数组或者集合,而不是null,好处是可简化代码,增强程序健壮性,缺陷是会增加微不足道的系统开销。

可简单的概括为:任何在逻辑上表示查找(search或者get)的意思时,应该返回null;当空对象与其他返回对象有一样的行为和意义时,使用空对象。

6.其他:

(1).Dao在构造函数初始化中new比较好,避免在每个方法体中使用时new临时对象,增加代码行数。但临时对象在使用后可以被及时回收,两种方案需针对具体情况处理。

(2).单例模式在多个线程密集调用getInstance时,存在创建多个实例的可能。可使用synchronized修饰getInstance方法,但使用此方法后必然会导致性能下降,可使用双重检查加锁,首先进入

该方法时进行null == sInstance检查,如果第一次检查通过,即没有实例创建,则进入synchronized控制的同步块,并再次检查实例是否创建,如果仍未创建,则创建该实例。

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

推荐阅读更多精彩内容