App开发规范

一.项目结构

随着MVP设计模式的流行,就默认采用下面两种项目结构.

适合小项目

app——Application Activity Fragment
Presenter等的顶级父类
config——API,常量表等
model——数据层
entities——数据模型
presenter——MVP的P
view——MVP的V
utils——工具类集合
widget——各个可复用View集合
......

适合大项目

app
config
model
- entities
module——将界面层以功能模块分配包
- launch
- main
- account
- news
- music
- ..........
......

二.配置主题

先在color.xml中写好需要的颜色


#ff5722
#673AB7
#311B92
#fff
#888888
#dddddd
#999999

注意color.xml是配色表。应该是描述颜色而不是对字体颜色，背景颜色等的定义。这样能防止相近的颜色重复定义。而导致界面颜色不统一。

在style.xml中定义主题

在res目录下，创建一个values-v21目录，再创建一个style.xml:

然后在AndroidManifest.xml文件中修改application的theme属性为上面定义的AppTheme.即可实现沉浸式状态栏。

三.配置Gradle

某些SDK运行时需要检查签名是否正确。所以在debug模式时也必须用正式KEY签名。而把签名放进版本控制不是明智的做法。所以推荐下面的做法：
在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文件，里面填入你的key的相应信息

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

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

四.编码规范

为了避免合作开发写的代码风格迥异,做出下面的编码规范

所有Activity继承BaseActivity
所有Fragment继承BaseFragment
所有Presenter继承BasePresenter
...

这样利于生命周期管理,也利于全局修改.

类名的定义
所有java类都必须遵循大驼峰规则,如下所示:

AccountFragment
UserDetailActivity
UserAdater
.....

变量命名

mAdapter
mUser
mPassWord
...

以m开头,小驼峰规则.例mAdapter使用时按一个m全都出来了

方法命名

login();
showView();
loading();
...

小驼峰规则,通俗易懂,与其起好名字不如写好注释

资源的文件的命名
layout命名

activity_collection
fragment_account
item_person
include_toolbar
view_progress
...

不过对于庞大项目的开发,近百个activity开头的layout列表还是会眼瞎,所以那种情况会在前面加上模块名.
** id命名**

btn_send
tv_name
list_persons
et_password
...

然后用butterknife的插件生成变量会自动将下划线变成驼峰命
更多命名规范可以参考Android 命名规范（提高代码可以读性）这一篇文章.

五.注释规范

1.注释格式

1、单行(single-line)注释："//......"
2、块(block)注释："/*......*/"
3、文档注释："/**......*/"
4、javadoc 注释标签语法
@author   对类的说明 标明开发该类模块的作者
@version   对类的说明 标明该类模块的版本
@see     对类、属性、方法的说明 参考转向，也就是相关主题
@param    对方法的说明 对方法中某参数的说明
@return   对方法的说明 对方法返回值的说明
@exception  对方法的说明 对方法可能抛出的异常进行说明

2.参考举例
类（接口）注释

/**
* 类的描述
* @author Administrator
* @Time 2012-11-2014:49:01
*/
public classTest extends Button {
  ......
}

构造方法注释

public class Test extends Button {
  /**
   * 构造方法 的描述
   * @param name
   *       按钮的上显示的文字
   */
  public Test(String name){
     ......
  }
}

方法注释

 /**
    * 为按钮添加颜色
    * @param color 按钮的颜色
    * @return
    * @exception  (方法有异常的话加)
    * @author Administrator
    * @Time2012-11-20 15:02:29
    */
  public voidaddColor(String color){
     ......
  }

全局变量注释

public final class String
   implements Java.io.Serializable, Comparable,CharSequence
{
   /** The value is used for characterstorage. */
   private final char value[];
   /** The offset is the first index of thestorage that is used. */
   private final int offset;
   /** The count is the number of charactersin the String. */
   private final int count;
   /** Cache the hash code for the string */
private int hash; // Default to 0
......
}

字段/属性注释

public class EmailBody implements Serializable{
   private String id;
   private String senderName;//发送人姓名
   private String title;//不能超过120个中文字符
   private String content;//邮件正文
   private String attach;//附件，如果有的话
   private String totalCount;//总发送人数
   private String successCount;//成功发送的人数
   private Integer isDelete;//0不删除 1删除
   private Date createTime;//目前不支持定时 所以创建后即刻发送
   privateSet EmailList;
......

六.编程规范

源文件编码格式为 UTF-8。
java代码中不出现中文，最多注释中可以出现中文
服务端可以实现的，就不要放在客户端
引用第三方库要慎重，避免应用大容量的第三方库，导致客户端包非常大
处理应用全局异常和错误，将错误以邮件的形式发送给服务端
图片的.9处理
使用静态变量方式实现界面间共享要慎重
单元测试（逻辑测试、界面测试）
不要重用父类的handler，对应一个类的handler也不应该让其子类用到，否则会导致message.what冲突
activity中在一个View.OnClickListener中处理所有的逻辑
strings.xml中使用%1$s实现字符串的通配
数据一定要效验，例如字符型转数字型，如果转换失败一定要有缺省值；服务端响应数据是否有效判断
对于未完成的方法，使用TODO加以标记
若功能已完成，但存在效率等潜在问题时，使用XXX加以标记
若代码存在严重问题或仅用于调试，使用FIXME加以标记
values目录下文件名称较固定，不得随意更改

七.煽情

写到最后都会来一波煽情,但是我是拒绝的,但是又显得很没有逼格,最后我只好拿出我的终极必杀"一切问题都是浮云",来结束这篇文章.
终极必杀:一切问题都是浮云

必杀技.jpg

另外本人对扯蛋有独到见解,欢迎前来本人博客扯蛋,我有酒,就差你的故事了

Android App开发规范