android自用规范二:编码风格篇

原则上,编码风格我们遵循google java编码风格;为了方便他人维护代码,我们约定了一些常见的规范

我们约定了:
服务端请求结果:用RE_开头
数据解析对象:用DTO后缀
前缀、后缀一律大写,举例

public class RE_SubmitAnswer extends RE_Result {
    public C2ServerCheckDetailDTO wrapper;

    public static class C2ServerCheckDetailDTO implements Serializable {
        public int score;
    }
}

RE、DTO放在model文件夹内

放model文件夹内

本地数据保存类,使用Entity结尾

对于一个类来说,我们约定的顺序如下

  1. 常量
  2. 控件变量
  3. 引用、数值变量
  4. 静态实例化方法,比如Activity调用的start方法public static void start(){}
  5. 系统、重写方法
  6. public方法
  7. 私有方法
下面是一些比较常见的编码习惯

  • 减少重复代码 ,同样的代码重复多次的时候就可以考虑重构了
  • 避免魔鬼数字,尽量使用常量来代替数字
  • 职责单一,比如实现下载文件功能就不应该出现在 Activity里。而是应该抽成一个通用的下载工具类,供Activity调用
  • 减小代码的影响范围,能用private的不用public,能用临时变量的不用全局变量。
  • 缓存耗费资源的计算结果,避免重复计算
  • 条件语句遇到流程复杂的,使用switch代替大量的if else语法
下面是一些编码方面性能优化的习惯

  1. 集合、数组如果事先知道数量,则用该数量初始化比如 List<String> temp = new ArrayList(3);
  2. 善用android sdk提供的Util类,比如TextUtils,比如用ArrayMap替代HashMap,在hashMap的key是int类型的情况下,使用SparseArray代替HashMap
下面是android Studio提供的功能,使用好,可以减少我们工作量

  • 设置变量前缀、后缀等
    类里的全局变量使用m前缀,比如mViewPager,这样会减少和方法内变量、参数的冲突

    编码风格,设置前缀

  • 重构之提取代码
    复杂的语句用变量表达意图,比如我们经常遇到if()判断语句里面有一大堆条件,稍不留神就容易产生Bug
    AS可以帮我们把选中的代码块提取成变量、常量、属性、参数、方法等等形态


    重构,提取代码
  • 用好TODO
    尽量避免使用TODO,因为TODO经常就不了了之,能当下解决的,加个班搞定吧
    有时候资源限制,我们不得不用todo的时候,请使用android Studio 提供的语法
    //TODO:todo描述

    系统自动高亮

    这样有什么好处呢?我们可以清晰的跟踪到项目中残留的todo数量,方便我们管理,记得删除系统自动创建的//todo语句
    todo列表

  • 用好书签
    有时候我们在修改代码的时候,会遇到在多个资源文件,类之间的跳转,这个时候我们就可以用书签标注好要定位的行

    书签快捷方式

    使用f11在当前行加上书签,使用shift+f11弹出全部书签列表

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

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,520评论 25 707
  • 2017.12.24 更新 来回听了两遍永澄老师的年目标课程,自己的期待也更新到了V3版本,看起来对自己2018年...
    RickyUp阅读 458评论 0 4
  • 有枣,才能找回青春无限; 有枣,才可以绽放人生光彩; 有枣,才可以活的骄傲豪迈! 今天推荐: 凌枣 一、知识普及 ...
    读书人一枚阅读 468评论 2 3
  • 命运这个词真的很神奇,自创造之始,既煞有其事,又无法证实,天生的缥缈,无法捉摸,却又似冥冥之中有只大手在左...
    渊叔阅读 225评论 0 0
  • 自己给自己打点鸡血吧 嗯,要坚强,要努力,要迎难而上,可关键的问题是我为什么坚强,为什么要迎难而上,最近有什么困难...
    百事可爱哟阅读 214评论 0 0