简单整理的Android开发规范

一、包命名

1、包名全部采用小写,不用下划线区分单词,多个单词用驼峰命名法。例:com.packer.tablet、com.packer.tablet.otherView
2、包名按功能模块划分,该模块相关类都放置同一个包下面。例:网络请求相关类放在net或http包下面,数据库相关类放在db包下面,数据pojo类放在bean包下面,activity和相关的adapter都放在同一个包下面等。

二、代码

1、变量、方法命名主要采用大/小驼峰命名法,首字母小写,后面的每个单词首字母大写。例:getPackerInfo()
2、静态常量使用public final static修饰(Java)、const val(Kotlin),并且命名为大写,例:INTENT_RESULT_DATA = "data"
3、类名、接口名、枚举名等首字母大写,若由多个单词组成,则其后每个单词首字母大写,例:class ConfigManager{}
4、继承自安卓组件的类,采用父类名作为后缀,例:class LoginActivity extends Activity{}
5、变量、方法的命名以有意义的英文单词命名,例:getLoginInfo()、loginUrl
6、成员变量尽量以m开头命名,推荐,例:mContext
7、控件命名尽量以控件名简写作为开头或结尾,驼峰式命名法。例:TextView控件:tvAdd、addTv Button控件:btnLogin、loginBtn
8、id命名尽量以控件名简写作为开头或结尾,全部小写,单词之间用下划线隔开。例:TextView控件:tv_add、add_tv Button控件:btn_login、login_btn
9、编码格式统一为 UTF-8

三、资源

1、资源命名全部采用小写,各单词间以下划线区分。例:icon_booking_order.png
2、selector文件以selector_开头、shape文件以shape开头。例:selector_clear_btn_bg.xml、shape_et_gray_bg.xml
3、布局文件命名以类型+模块名命名。例:activity_login.xml、dialog_change_price.xml、fragment_order_layout.xml、list_order_item.xml、recycle_food_item.xml、include_login_title_bar_layout.xml

四、常用开发库

1、网络请求库:Retrofit、OKHttp
2、数据解析库:Gson、fastjson
3、软件更新、异常上报:bugly
4、图片加载库:Glide
5、数据库存储:Room
6、数据通讯:EventBus
7、扫码功能:zxing相关库
8、日志打印:LogCook、LogToFile
9、内存泄漏检测工具:LeakCanary
10、轻量级数据存储:DataStore、MMKV

五、开发

1、新项目优先使用Kotlin语言与Java混合开发、原有Java旧项目仍用Java开发。
2、大型复杂优先使用MVVM架构开发,简单的小项目可不用。
3、使用Log打印日志而不是System.out.println()。
4、定义基本数据类型变量非必要情况不用装箱类。
5、一个方法不能超过80行,多了就分开。
6、版本号为3位数,例:versionName "1.0.0",小修小改bug修复最后一位加1,小新功能添加修改中间位加1,大功能添加修改第一位加1,每更新一次版本,versionCode加1
7、使用视图绑定viewBinding或者DataBinding替代findViewById

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

推荐阅读更多精彩内容

  • 作为一个很重度的强迫症患者,写代码的时候经常会为文件命名纠结一会儿,为了解决这个问题同时也使得项目看起来更加有条例...
    程起蒙阅读 823评论 0 1
  • 摘要 1 前言 2 AS 规范 3 命名规范 4 代码样式规范 5 资源文件规范 6 版本统一规范 7 第三方库规...
    Blankj阅读 41,615评论 21 314
  • 转自(https://github.com/Blankj/AndroidStandardDevelop) 摘要 1...
    cvmars阅读 315评论 0 3
  • android开发者这么久,你是否真的了解android开发规范呢?本文转自https://www.jianshu...
    毹毹阅读 2,332评论 0 2
  • 一个好的开发规范,就是团队合作的基石 阿里巴巴Java开发手册(正式版) Java 文件 采用驼峰命名法 文件头 ...
    Gmf_阅读 645评论 0 0