Android项目基础规范

参考
Android项目基础规范
26 Apr 2016代码管理
Git 使用 rebase 命令来合并分支,尽量不要直接 merge 导致分支代码日志混乱。
开发新功能时,自己在本地创建 feature 分支开发,功能开发完毕之后,参照上面合并流程操作功能的合并,并删除本地分支,注意不要将本地分支推送到服务器。
平时开发只在 develop 分支和自己的本地分支操作,不要操作 master 和 release 分支,这两个分支只有在功能稳定上线的时候才进行合并操作。当线上版本出现紧急 bug 时,直接基于 master 分支拉取 hotfix 分支,解决 bug 之后再合并到其它各个分支。具体流程可以参见 Git Flow 流程
git 提交日志尽量将注释缩减为一句话,不要包含详细的内容。Added ( 新加入的需求 )
Fixed ( 修复 bug 标注禅道的bug id 或者 bugtags 的 id)
Changed ( 完成的任务 )
Updated ( 完成的任务,或者由于第三方模块变化而做的变化 )

代码编写规范
编译配置相关
所有用到的第三方库文件统一在项目根目录下的 dependecies.gradle 文件中管理,并在 thirdDependencies 标签中添加引用并注释,需要填写代码库地址,方便后续查看使用及更新。
项目编译用到的 sdk 版本及 app 版本信息统一在项目根目录下的gradle.properties 中管理,其它引用的第三方库工程代码也需要同步更新。
项目中用到的第三方 app id 等信息需要在项目的 build.gradle 中定义对应字段在项目中引用,不要直接在代码中写死,容易出错也不利于维护更新。
项目中用到的颜色规范根据 ued 给出的规范统一定义于项目的 colors 中,不要直接在 xml 布局文件中写死,对于只有一两个地方用到的颜色也需要抽取出来单独定义,能够注释一下更好。
公共风格的控件需要抽取相应的 theme 放到 styles 文件中统一使用。不要直接在页面布局文件中写死控件颜色值或者字号大小,需要用统一的风格 theme,并且加上注释。
布局中需要用到固定宽高的统一在 dimens 中定义好,之后在代码中引用。

命名规范
代码中变量的命名遵照驼峰命名法。

布局文件中的控件命名尽量使用控件缩写做前缀,如 TextView 简写为tv_xx,Imageview 简写为 iv_xx。(不强求,有统一的风格即可)

图片资源命名规范如下:
背景类图片(指图片比较大,一般作为 activity 或者 view 背景的图片),用 bg_ 为前缀,一般为bg_描述。如果背景是有状态的显示的,命名规则为 bg_描述状态。
按钮类图片(可以用 shape 自己实现的就不要用图片了),用 btn
为前缀,一般为btn_描述,如果按钮有状态显示的,需要添加状态后缀,如 btn_描述normal 、btn描述focus 、btn描述enabled 。
选择框等控件使用的图片用 chx
为前缀。
Dialog 控件使用的图片用 dg_ 为前缀。
Menu 用到的图片用 menu_ 为前缀。
自己用 shape 实现的图片效果用 shape_ 为前缀。
其中有状态切换的图片组,在 drawable 文件夹中用 selector_ 为前缀。

Layout 文件命名规范如下:
如果布局文件是用于 activity ,则用 activity_ 为前缀。
如果布局文件是用于 fragment ,则用 fragment_ 为前缀。
如果布局文件是用于 ListView GridView RecycleView等 ,则用 item_ 为前缀。
如果布局文件是用于自定义 View ,则用 view_ 为前缀。
如果布局文件有多处引用使用 ,需要抽取公共引用的布局文件,则用 include_ 为前缀。

字符串资源命名规范如下:
有一个规则就是如果字符串可能有多处地方需要使用时,尽量用通用的英文单词含义就可以了(如 ok cancel back 等),对于某些字符串资源只有某些特定的范围使用时准照下面的规则。
用于 toast 弹出展示的资源用 toast_ 为前缀。
用于 dialog 展示的资源用 dialog_ 为前缀。
用于页面上标签展示的资源用 label_ 为前缀。

代码编写
页面布局中对于需要填充字符串或者图片查看控件效果的,都用 tools 命名空间进行资源的填充,对于需要隐藏的空间也需要用 tools 命名空间把控件进行显示,这样方便调整 ui ,一句话就是,要善于使用 tools 命名空间来编写布局文件。
对于布局有间距需求的,统一在 root view 级别做统一的上下左右间隔,尽量不要在子控件去做整体布局的上下左右间距处理。
代码中涉及到字符串资源的全部需要提取出来放入 strings.xml 文件中,不要在代码中直接将文本写死,很难维护。
网络请求处理尽量放到 appnetworklibrary 模块下处理,包括 model 及 Rxjava 处理数据之后返回也放到这个模块下。
项目中用到 EventBus 事件的,事件消息都放到主项目下的 event 包下,不要直接定义字符串事件处理,如果需要发送字符串事件处理的,改用发送本地广播来处理,通过 LocalBroadcastManager 来发送。
页面涉及 ViewPager 的,可以使用 FZBaseViewPagerAdapter 来设置适配器,其中的 Fragment 需要继承 FZBaseViewPagerFragment 来实现懒加载,不要一次把全部页面的数据都加载出来,切记!!!
RecycleView 的 view holder 需要继承 FZBaseViewHolder 来实现,在绑定数据的时候直接调用 bindViewData 即可。
其它相应的工具类在 appbaselibrary 模块中,有些有包含的可以直接使用,没有包含的如果是可以通用的直接在模块中添加即可,否则在主项目中添加。
数据模型中,如果没有需求需要页面级别传递数据的话,不需要实现数据的序列化(Parcelable / Serializable)。
其它欢迎补充。

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

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,387评论 25 707
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,580评论 18 139
  • 小画绘起来不吃力,小有小的精致和有趣 针管笔画画大概是除了铅笔以外最省钱的画种了 在手绘插画设计里用它来表现最贴心...
    太婆插画阅读 4,900评论 1 29
  • 荒流阅读 248评论 0 1
  • 题记:致那些同处在以太空间里的真诚人类。 人活一生总有为一些东西痴迷的时候,类似青春,类似文字,类似音乐,类似爱情...
    海欧亭亭阅读 18,757评论 9 28