Android编程规范-阿里云开发者社区

开发者社区> tangyangkai> 正文

Android编程规范

简介: 1.命名规范: 从正式开始Android开发工作第一天,主管就教我命名规范,这也从侧面反应命名规范的重要性。良好的命名习惯对今后代码的维护更新起很大作用,提高开发效率。 (1)布局文件中的id命名 规则:使用驼峰命名,前缀+逻辑名称,类变量名和布局文件id名称保持一致,不...
+关注继续查看

1.命名规范:
从正式开始Android开发工作第一天,主管就教我命名规范,这也从侧面反应命名规范的重要性。良好的命名习惯对今后代码的维护更新起很大作用,提高开发效率。

(1)布局文件中的id命名
规则:使用驼峰命名,前缀+逻辑名称,类变量名和布局文件id名称保持一致,不需要下划线分割
控件前缀规则:
TextView/EditText: tv/et
Button/RadioButton/ImageButton: btn
ImageView: img
RelativeLayout/LinearLayout/FrameLayout: layout,
ListView: listView
WebView: webView
CheckBox: chBox
如:TextView @+id/tvTitle
如:EditView @+id/etName
如:Button @+id/btnSearch
(2) 布局文件命名
规则: 使用前缀_逻辑名称命名,单词全部小写,单词间以 下划线 分割。
前缀规则:
Activity对应的布局使用activity_ 有时候类名过长 可简写为aty
Fragment对应的布局使用fragment_ 简写 fgt
如:PublishActivity: activity_publish.xml PublishAty
(3)资源文件命名
规则: 使用 前缀_用途 命名,单词全部小写,单词间以 下划线 分割。
drawable:
btn_back_selector.xml 控件前缀命名
common_circle_gray.xml 通用资源多处使用common_
chat_image_selector.xml 功能相关业务使用加用途前缀
drawable_hdpi:
btn_back_normal.9.png 控件前缀名称
btn_back_press.9.png 控件前缀名称
icon_login_lock.png icon_+用途
values/color:
pull_refresh_attrs.xml 引入的第三方资源,携带资源简拼的前缀
(4)类和接口命名
规则: 使用驼峰规则,首字母必须大写,使用名词或名词词组。要求简单易懂,富于描述,不允许出现无意义或错误单词。
如:class BookMarkAdd 正确
如:class AddBookReadPlan 错误! 应为 class BookReadPlanAdd
(5) 方法的命名
规则: 使用驼峰规则,首字母必须小写,使用动词。要求简单易懂,富于描述,不允许出现无意义或错误单词。
如:public void run();
如:public String getBookName();
(6)变量命名
规则: 使用驼峰规则,首字母必须小写,使用名词或名词词组。要求简单易懂,富于描述,不允许出现无意义或错误单词。
成员变量命名,不要在私有变量前添加m字样
常量命名,全部大写,单词间用下划线隔开

2.编程规范:

这里的编程规范总结的是Android开发中一些常用编程习惯,好的细节,好的习惯也是一个优秀程序员所必备的。

1.Java代码中不要出现中文,最多注释中可以出现中文;代码中不要出现数字,特别是一些标识不同类型的数字,所有意义数字全部抽取到Constant公共类中,避免散布在各位类中;代码任何地方不要拼错单词
2.Activity.onCreate(),Fragment.onActivityCreated(),作为程序入口,不用写入太多代码,尽量保持只调用initXXX()方法,简单明了展示调用过程。如:initData(),initView()。
3.方法使用:单个方法体不要过长,拆分臃肿方法,每个方法只作一件事;做同一个逻辑的方法,尽量靠近放到一块,方便查看;调用方法保持“临近原则”,被调用的方法,放在调用方法下方;
4.空行使用:空行将逻辑相关代码段隔开,简洁清楚,提高可读性。
空行的使用:拒绝拖沓无分割,关联代码段放一块并与后面代码分割;成员变量之间,根据业务形成分组加空行;方法之间加空行
5.控制语句:减少条件嵌套,不要超过3层
if判断使用“卫语句”,减少层级
if(obj != null) { doSomething();}
修改为:
if(obj == null) { return;}doSomething();
if语句必须用{}包括起来,即便是只有一句
6.TODO标记:记录想法,记录功能点,开发过程中可以利用TODO记录一下临时想法或为了不打扰思路留下待完善的说明;删除无用TODO,开发工具自动生成的TODO,或则已经完善的TODO,一定要删除。

3.工具规范:
开发环境,开发工具,项目框架因公司而异,这里总结下常用的工具以及第三方依赖库:
IDE
ADT(已停止更新)
Android Studio (新推出的开发环境)
Android SDK 4.4W (API 20 统一开发版本)
JDK 1.8(统一开发版本)
Libraries
Base
fastjson-android-1.2.4.jar
okhttp-2.2.0.jar
okio-1.2.0.jar
picasso-2.5.0.jar
butterknife:7.0.1
ormlite-android:4.48
volley
xutils
AChartEngine
Universal-Image-Loader
UI
PullToRefresh下拉刷新与上拉加载
QuickAdapter
PagerSlidingTabStrip
SwipeRefreshLayout
SystemBarTint 状态栏以及导航栏设置背景颜色
SwipeBackLayout 左滑返回
PullToZoomView 可以下拉缩放HeaderView
AutoLoopViewPager 轮播图
PhotoView
ViewPageIndicator
许多好看的UI效果可以去安卓巴士,github上面搜索到,这里就不列举太多了。

以上是根据自己开发以及上网查询整理的资料,持续更新中,一起学习。

版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

相关文章
使用NAT网关轻松为单台云服务器设置多个公网IP
在应用中,有时会遇到用户询问如何使单台云服务器具备多个公网IP的问题。 具体如何操作呢,有了NAT网关这个也不是难题。
26789 0
阿里云服务器怎么设置密码?怎么停机?怎么重启服务器?
如果在创建实例时没有设置密码,或者密码丢失,您可以在控制台上重新设置实例的登录密码。本文仅描述如何在 ECS 管理控制台上修改实例登录密码。
10077 0
阿里云服务器端口号设置
阿里云服务器初级使用者可能面临的问题之一. 使用tomcat或者其他服务器软件设置端口号后,比如 一些不是默认的, mysql的 3306, mssql的1433,有时候打不开网页, 原因是没有在ecs安全组去设置这个端口号. 解决: 点击ecs下网络和安全下的安全组 在弹出的安全组中,如果没有就新建安全组,然后点击配置规则 最后如上图点击添加...或快速创建.   have fun!  将编程看作是一门艺术,而不单单是个技术。
10883 0
使用SSH远程登录阿里云ECS服务器
远程连接服务器以及配置环境
2511 0
阿里云服务器如何登录?阿里云服务器的三种登录方法
购买阿里云ECS云服务器后如何登录?场景不同,阿里云优惠总结大概有三种登录方式: 登录到ECS云服务器控制台 在ECS云服务器控制台用户可以更改密码、更换系.
13884 0
阿里云服务器安全组设置内网互通的方法
虽然0.0.0.0/0使用非常方便,但是发现很多同学使用它来做内网互通,这是有安全风险的,实例有可能会在经典网络被内网IP访问到。下面介绍一下四种安全的内网互联设置方法。 购买前请先:领取阿里云幸运券,有很多优惠,可到下文中领取。
11818 0
windows server 2008阿里云ECS服务器安全设置
最近我们Sinesafe安全公司在为客户使用阿里云ecs服务器做安全的过程中,发现服务器基础安全性都没有做。为了为站长们提供更加有效的安全基础解决方案,我们Sinesafe将对阿里云服务器win2008 系统进行基础安全部署实战过程! 比较重要的几部分 1.
9159 0
腾讯云服务器 设置ngxin + fastdfs +tomcat 开机自启动
在tomcat中新建一个可以启动的 .sh 脚本文件 /usr/local/tomcat7/bin/ export JAVA_HOME=/usr/local/java/jdk7 export PATH=$JAVA_HOME/bin/:$PATH export CLASSPATH=.
4659 0
如何设置阿里云服务器安全组?阿里云安全组规则详细解说
阿里云安全组设置详细图文教程(收藏起来) 阿里云服务器安全组设置规则分享,阿里云服务器安全组如何放行端口设置教程。阿里云会要求客户设置安全组,如果不设置,阿里云会指定默认的安全组。那么,这个安全组是什么呢?顾名思义,就是为了服务器安全设置的。安全组其实就是一个虚拟的防火墙,可以让用户从端口、IP的维度来筛选对应服务器的访问者,从而形成一个云上的安全域。
7496 0
+关注
tangyangkai
多实践,多思考,多请教
40
文章
0
问答
文章排行榜
最热
最新
相关电子书
更多
《2021云上架构与运维峰会演讲合集》
立即下载
《零基础CSS入门教程》
立即下载
《零基础HTML入门教程》
立即下载