安卓开发规范（一）

1.编写目的

•  为了使项目文档组织有序，方便项目组成员协调开发工作，便于后期开发人员理解和维护代码，公司的android开发项目应该有一套命名规范，小组人员在编写代码时应该遵循这些规范，使用有意义的字符书写代码中得类型、变量，形成良好的编码风格。工程文件编码格式：UTF-8 

2.简单描述

• 工程文件编码格式：UTF-8 

3.包结构

• src的目录结构

　　com.hy.prss.mobile.android.constant

• 例如：Server_Config.java 
• 描述：包下的所有类里只能装常量，常量格式public static final xxx XXX = xxx; R.id.xxx类似的资源文件不能定义在arrays里，定义在常量包里方便调用

　　com.hy.prss.mobile.android.widget 

• 例如：IconTextListView.javaPictureDialog.java 
• 描述：包下的所有类里只能是自定义控件或自定义dialog 

　　com.hy.prss.mobile.android.entity 

• 例如：User.java 

• 描述：包下的所有类里只能是属性变量+get和set方法

　　com.hy.prss.mobile.android.activity 

• 例如：MainActivity.java MyActivity是所有的Activity的父类，对Activity的统一的处理在MyActivity实现，
• 如：对顶部标题栏的显示和底部标题栏的显示Activity的作用: 加载layout, 初始化控件，设置监听，处理监听事件描述：所有活动的集合

　　com.hy.prss.mobile.android.service 

• 例如：UserManager.java 
• 描述：业务层

　　com.hy.prss.mobile.android.dao 

• 例如：SqlDBHelper.java 
• 描述：数据访问

　　com.hy.prss.mobile.android.util 

• 例如：XmlUtil.java 
• 描述：所有的零碎功能包括处理XmlUtil, JsonUtil，SharedPreferencesUtil, DBUtil，FileUtil，HttpUtil，SocketUtil，StringUtil, DeviceUtil 

　　com.hy.prss.mobile.android.app 

• 例如：MyService.java 
• 描述：存放Broadcast，service, application 所有的Service继承MyService 服务：用在不需要界面时，还需要长时间在后台运行的地方广播：用来接收系统广播用于处理后台服务与前台界面的交互

　　com.hy.prss.mobile.android.test 

• 例如：
• 描述：junit test模块测试

 

 

• values的目录结构

4.代码规范

类名、接口命名规则

• 类和接口的名称应该是一个名词，与设计文档保持一致；采用大小写混和的方式，每个单词的首字母大写；命名使用完整单词，禁止使用中文全拼，如使用缩写词必须添加注释（除非该缩写词被广泛的使用，如URL、HTML）；
• 例如：
• class UserTest;//各单词首字母大写
• interface IUserTest;//接口以大写I开头
• abstract class AbsUserTest; //抽象类以Abs开头

方法函数命名规则

•  方法名应该是动词/动名词，采用大小写混和方式，第一个单词首字母小写，其后单词的首字线大写。
• 例如
• run() runFase() 

变量命名规则

• 变量命名采用大小写混和的方式，第一个单词首字母小写，其后单词的首字母大写。变量名应简短有意义；尽量避免单个字符的变量名（临时变量除外）；所有变量要显式的赋值；
• 静态变量命名采用全大写字母，中间用下划线分隔。
• 例如int total = 0; String name = null; 
• Button bnStart = new Button(); 
• static int MAX_CODE_LINE = 200; 

资源文件代码命名规范

• 命名文件名因为该文件名不识别大写字符，所有单词间以下划线分割
• 例如：activity_main 

命名内部属性名

•  参考变量命名规则
• 例如:  bnStart 
• styleDialog 

widget缩写对应表

•  因为widget比较常用所以特用缩写代替缩写对应如下：

video_view	vv	EditText	et
WebView	wv	ImageView	iv
VideoView	vv	MediaController	mc
ListView	lv	GridView	gv
Gallery	gly	Button	btn
ImageButton	ib	CheckBox	cb
RadioButton	rb	SeekBar	sb
ProgressBar	pb	Spinner	spr
SearchView	sv	AnalogClock	ac
TimePicker	tp	DatePicker	dp

 

 

 

 

 

 

 

 

5.代码注释 

• 生成api的方法

　　　　1.选择工程，鼠标右键菜单Export ，选择Java 下面的Javadoc ，点”next” 按钮

　　　　2.Javadoc command里选javadoc.exe 的目录，如：C:\Program Files\Java\jdk1.6.0_10\bin\javadoc.exe 

　　　　3.选择生成到Javadoc 文档中的内容(一般选public 或protected)，选存放目录( 默认即可) ，next下一步,此页全默认即可，再next下一步。

　　　　4.如果项目采用的是UTF-8 的编码，一定要在这一页的Extra Javadoc options 中加” -encoding UTF-8 -charset UTF-8 〃。否则生成的网页中文注释都是乱码。点Finish完成

　　　　5.所有的代码注释都会被自动加入api中，所以为了让他人看懂所写代码，在编写程序代码的时候尽量加全所有可以被加入到api中的注释

• 代码注释

　　　　1.设置方法:设置注释模板的入口：Window->Preference->Java->Code Style->Code Template 然后展开Comments节点，对个个节点进行设置

　　　　2.类说明注释:该注释一般位于package/import语句之前，class描述之前。要求至少写出内容说明、创建者、创建时间和特别注意事项等内容。

　　　　　　例如/** 

　　　　　　　　* 对类的说明

　　　　　　　　* @author 张三

　　　　　　　　* @time ${date}${time} 

　　　　　　　　*@version 

　　　　　　　　*/ 

• 方法说明注释

　　　　对每个方法都应有适当的说明，位于方法声明之前，包括：说明、参数说明、异常说明、返回值说明和特别说明等

　　　　　　例如/** 

　　　　　　　　* 对方法的说明

　　　　　　　　*@param id 查询用ID 

　　　　　　　　*@return User实体类

　　　　　　　　*/ 

• 方法体内代码的注释

　　　　块的注释

 　　　　　　/***************** 说明******************/ 

　　　　对单行的注释

　　　　　　// 说明

　　　　对多行的注释

　　　　　　/* 

　　　　　　* 说明1 

　　　　　　* 说明2 */ 

　　　　例如

　　　　　　/***************** 是否是超级管理员******************/ 

　　　　　　Private Boolean isAdmin = false; 

　　　　　　/*  

　　　　　　* isAdmin == true处理

　　　　　　* false不处理

　　　　　　*/ 

　　　　　　If(isAdmin){ 

　　　　　　//设置用户id userId = “111”;} 

资源文件代码注释

• 块的注释

　　　　<!-- 说明--> 

　　　　<skip /> 

• 变量注释

　　　　<!-- 说明--> 

主题方案

1. 强烈推荐使用google官方推荐的Material Design风格
2. 颜色需要在xml中定义好
3. 样式需要在xml中定义好

依赖库与SDK

1. 图片加载：fresco
2. JSON解析：fastjson
3. View注解库：butterknife
4. 谷歌Material Design控件库：compile \'com.android.support:design:22.2.0\'
5. 日志查看：KLog
6. 下拉刷新：android-Ultra-Pull-to-Refresh
7. 图片轮播：BGABanner-Android
8. 文字生成图片：TextDrawable
9. 百度地图SDK：http://developer.baidu.com/map/
10. 友盟SDK：http://www.umeng.com/
11. ShareSDK(分享)：http://www.mob.com/
12. Bughd(bug捕捉)：http://bughd.com/
13. im(内测)：http://fir.im/
14. 模拟器：Genymotion
15. 更多开源控件及项目：android-open-project

Gradle

• 某些SDK运行是需要检测签名是否正确，所以在debug的时候也需要加入签名(腾讯的第三方登录)，且把签名放进版本控制是不明智的做法。
• 推荐如下做法
• 在app的gradle中加入如下代码

Properties props = new Properties()
props.load(new FileInputStream(file("signing.properties")))
android {
signingConfigs {
release{
keyAlias props[\'KEY_ALIAS\']
keyPassword props[\'KEY_PASSWORD\']
storeFile file(props[\'KEYSTORE_FILE\'])
storePassword props[\'KEYSTORE_PASSWORD\']
}
}
buildTypes {
release {
signingConfig signingConfigs.release
}
debug {
signingConfig signingConfigs.release
}
}
}

• 在app的gradle文件同级目录新建signing.properties文件

KEYSTORE_FILE = C:\\Users\\Mr.Jude\\Documents\\Android\\HelloWorld.jks
KEYSTORE_PASSWORD = xxxxxx
KEY_ALIAS = xxxxxx
KEY_PASSWORD = xxxxxx

• 将signing.properties添加进忽略目录。
• 其他人pull下来代码后。自己新建signing.properties填入相应信息后即可编译成功。