Android开发规范
版本历史
版本/状态 | 作者 | 参与者 | 日期 | 备注 |
---|---|---|---|---|
1.0 | Panda | Panda | 2015-12-09 | 无 |
2.0 | Panda | Panda | 2016-07-12 | 无 |
开发原则
- 基于Fragment而不是Activity开发应用。
- 采用Butterknife系列(AndroidStudio、Butterknife、ButterKnife Zelezny、butterfork)来提高界面开发效率。
- 采用EventBus解耦事件触发模块和事件处理模块。
- 采用liteORM实现数据库的对象化读取。
- 采用liteHttp实现一行代码访问网络数据。
- 采用liteAsyn实现高效并发的多线程处理。
- 采用PandaAndroidLib作为主体框架,不断持续积累于其中。
命名规范
标识符命名法主要有四种:
- 驼峰(Camel)命名法:又称小驼峰命名法。除首单词外,其余所有单词的第一个字母大写,如launchIcon。
- 帕斯卡(pascal)命名法:又称大驼峰命名法。所有单词的第一个字母大写,如LaunchIcon。
- 下划线命名法:单词与单词间用下划线做间隔,如launch_icon。
- 匈牙利命名法:广泛应用于微软编程环境中,在以Pascal命名法的变量前附加小写序列说明该变量的类型。 量的取名方式为:范围前缀+类型前缀+限定词,如g_hLaunchIcon。
命名总体原则:
- 用最少的字符完整表达标识符的含义。
- 不要用缩写,除非是约定俗成的,比如用tmp、len、lib等。
执行规则:
- java文件:
- 包名:大层次采用PandaAndroidLib的MVC结构,如果不是要抽取为独立包,尽量不要新建小层次,如果确定有需要,请和开发Leader讨论。
- 类名:采用帕斯卡(pascal)命名法,使用Name+Style的结构,比如LaunchActivity。
- 参数名:采用匈牙利命名法,非界面控件类型前缀可以忽略,如mTextViewPassword,mPassword。
- 方法名:采用驼峰(Camel)命名法。如getPassword。
- 其它命名:采用Java常规标准即可。不熟悉的参考安卓.开发规范(高级)
- xml文件:
- 文件名:采用下划线命名法,否则Android编译不通过。
- layout中的id:采用下划线命名法,使用控件类型+Name的结构,如textview_password。常用控件类型可以采用缩写:
- TextView→tv
- EditText→et
- Surface→srf
- LinearLayout→ll
- FrameLayout→fl
- RelativeLayout→rl
代码规范
开发遵守SOLID原则:
- S:单一责任原则
- O:开放/关闭原则
- L:Liskov 替换原则
- I:接口分离原则
- D:依赖注入原则
Review执行规则:
- 每个方法不得超过『一巴掌』。
- 每个普通类不得超过100行。
- 每个Fragment不得超过300行。