Android 开发规范(个人版)

2019年6月5日 245次阅读 来源: esonyf
前言

做Android开发这么多年，见过很多人写的代码(开源代码除外)，其中有的写的代码很简洁、很漂亮，让人看起来很舒服；有的写的那是一塌糊涂，根本就没有心思再往下看。最近就是在做一个项目，由于之前的代码很复杂，需要对整个软件进行重构，我是边重构边吐槽。说多了都是泪啊！所以就准备写一下这篇文章。另外说一点，本规范不是标准，只是我自己在开发中所遵循的。所以大家看看就行了。

一、命名规范

1、包的命名：

包的名字都是由小写单词组成。

1.1、 项目包名(APP的唯一ID)

一般的项目都是 ：com.公司名.项目名

1.2、功能模块包名

这个包是项目下的功能模块分包，主要有两个命名方式：

  • 按照文件的类型命名：
    例如：activity/、adapter/、fragment/ 等。
  • 按照功能模块命名：
    例如：login/、register/、setting/ 等。

2、类名

遵循两点

  • Java类名遵循大驼峰命名规范。即：以大写字母开头、由多个单词组成时，每一个单词的首字母都大写。
  • 以功能模块结尾。例如：LoginActivity、FriendListAdapter、UserModel等。

3、变量

标准的驼峰命名法。

4、静态变量、常量、枚举类型

全部大写，由多个单词组成的时候，每个单词之间以“_”连接。

5、方法名

  • 遵循驼峰命名
  • 根据方法实现功能来命名
  • 初始化一般以init开头
  • 带有返回值的以get开头
  • 设置数据的以set开头
    例如：initView()、userLogin()、private UserModel getUserInfo()、setUserFriendList(List<FriendMode> friendList)等。

6、其他

如果代码中有需要实现的功能，但是当前没有实现的代码为了标记可以打上 //TODO标记

private void initView() {
   //TODO
}

二、布局文件优化

1、多用<include />、<merge />标签

Android方法建议是一个布局文件最多嵌套三层，这个大家应该都知道吧，所以要多用<include />、<merge />标签，这样的好处有两点：

  • 减少层次的嵌套
  • 增强布局的重复利用性。

2、多用style属性

这个不用多说了吧，可以减少不少的代码量。

3、文字显示用”@string/xxx”

这个在做软件的国际化的时候，是必须的。就算是不做国际化在需要修改某一个文字时也会很方便。

4、屏幕适配

做Android的应该很关心这一点吧。关于这一点应该网上有很多的教程告诉我们要怎么去做。我这里主要说我常用的方式。
先分析页面的结构，最外层采用什么样的layout，如果是LinearLayout 多采用android:layout_weight属性，如果是RelativeLayout就会多采用android:layout_centerxxx和android:layout_alignParentxxx属性

三、代码风格

1、条件判断

1.1、能用Switch 代替的就用Switch。说一下我觉得用Switch的优点：
  • 有很多else if的时候，用switch case比较清晰。
  • 有很多else if的时候，用switch 的计算量少。
1.2、多判断不成立的条件

拿一个登录的功能做一个对比：
之前的代码

if (TextUtils.isEmpty(useName)) {
  //如果用户名为空
   showMessage("账号为空，请输入登录账号");
} else {
  //如果用户名不为空，判断密码
  if (TextUtils.isEmpty(pwd)) {
    //如果密码为空
   showMessage("密码为空，请输入密码");
  }else{
    //如果密码不为空，登录
    userLogin();
  }
}

看到这里朋友不要笑，也不要问谁会这样写啊，因为我的回答是，我真的见过有人这样写。代码的逻辑很清晰，但是if..else..的嵌套太多了。而且还加深了代码的层次。
我们再看看改过之后的代码：

if (TextUtils.isEmpty(useName)) {
   showMessage("账号为空，请输入登录账号");
   return;
}
if (TextUtils.isEmpty(useName)) {
   showMessage("密码为空，请输入密码");
   return;
}
userLogin();

相比之下，如何？是不是更简洁一些？

1.3、判断为对象为空和字符串为空字符的写法
1.3.1、判断一个对象是否为null

我见过很多都是这样写的

if(null == obj){
  return;
}

关于这种写法，我不想多说什么，但是我不习惯这种写法，所以我们先看一下Android系统是怎么判断一个字符是否为空或者是空字符的写法：

public class TextUtils {
...
  /** * Returns true if the string is null or 0-length.
   * @param str the string to be examined
   * @return true if str is null or zero length
   */
  public static boolean isEmpty(@Nullable CharSequence str) {
      if (str == null || str.length() == 0)
          return true;
      else
          return false;
  }
....
}

这个是在android.text包下面的一个工具类。借鉴官方的例子，我判断对象是否为空一般写法是：

if(obj == null){
  return;
}
1.3.2、判断字符是否为空字符

我见过最多的写法是

if(str.equals(""))
  return;
}

可以说我之前带过的工程师都是这么写的，看到这种写法我都会让他们改。原因很简单，如果当str为null的时候，这段代码是会NullPointerException的，我的写法如下，可以规避NullPointerException。

if("".equals(str)){
  return;
}

2、final 、static、static final 以及 final static 的区别

为什么要写这个呢，感觉和主题无关啊？是啊，本来我也是不想写这个的，想起之前有人问我：
什么是静态变量，什么是常量，静态变量和常量之间谁更省内存？
那这个问题就牵涉到了软件的内存优化的问题，所以还是提一下吧。

说一下个人理解：

final
  • 修饰类时，表示此类为最终类，不能被继承
  • 修饰方法(不包括构造方法)时，此方法不可以被子类覆盖。
  • 修饰变量时，就变成了常量(不可变量)，一般会伴随static一起使用
static
  • 修饰变量，即为静态变量，静态变量在内存中只有一个拷贝(省内存)，JVM只为静态分配一次内存，在加载类的过程中完成静态变量的内存分配，可用类名直接访问，当然也可以通过对象来访问(不推荐)。（ps:这就是为什么final的常量会伴随static一起使用的原因)
  • static代码块是类加载时，初始化自动执行的。如果static代码块有多个，JVM将按照它们在类中出现的先后顺序依次执行它们，每个代码块只会被执行一次。
static{
.....
}
  • static方法可以直接通过类名调用,static方法只能访问static的变量和方法

上面首先解答了什么是常量、什么是静态变量的问题，那么再看一下谁更省内存：

一个完整的Java程序运行过程会涉及以下内存区域：
寄存器： JVM内部虚拟寄存器，存取速度非常快，程序不可控制。
栈： 保存局部变量的值，包括：a.用来保存基本数据类型的值；b.保存类的 实例 ，即堆区 对象 的引用(指针)。也可以用来保存加载方法时的帧。
堆： 用来存放动态产生的数据，比如new出来的 对象 。注意创建出来的对象只包含属于各自的成员变量，并不包括成员方法。因为同一个类的对象拥有各自的成员变量，存储在各自的堆中，但是他们共享该类的方法，并不是每创建一个对象就把成员方法复制一次。
常量池： JVM为每个已加载的类型维护一个常量池，常量池就是这个类型用到的常量的一个有序集合。包括直接常量(基本类型，String)和对其他类型、方法、字段的 符号引用(1) 。池中的数据和数组一样通过索引访问。由于常量池包含了一个类型所有的对其他类型、方法、字段的符号引用，所以常量池在Java的动态链接中起了核心作用。 常量池存在于堆中 。
代码段： 用来存放从硬盘上读取的源程序代码。
全局数据段： 用来存放static定义的静态成员或全局变量。分配该区时内存全部清0，结果变量的初始化为0。

下图表示内存分配图：

《Android 开发规范(个人版)》

具体参考：Java中的内存处理机制和final、static、final static总结

static属性在类加载，也就是第一次用到这个类的时候初始化，对于后来的实例的创建，不再次进行初始化。

常量在代码执行之前绑定到内存单元,并且在整个程序执行过程中都指向相同的内存单元.
所以，在程序的启动时，常量要相对与静态变量占内存，而在软件运行过程中，他们是一样的。但是对于小运行内存的手机来说，大量的static 和final 是要尽量要避免的。

3、视图与逻辑处理分开

这一点很重要。这也是我写这篇文章的最主要目的，我说过，最近是在对一个项目进行重构。其中，有一个自定义的 View,里面充斥着大量的逻辑代码还有网络请求等等。看到这种代码，我是彻底无语了。

以下为个人理解：

View本身只是一个控件，可以提供接口或者方法让外部改变其内容或者形状，并且需要把自己的触摸事件返回给调用者。需要做什么完全交由调用者自己去实现。

所以，一个视图，仅仅是做显示的，怎么能进行逻辑代码的处理？不管从任何角度来说，都不应该这样做。

4、分模块，各司其职

在进行代码重构的时候，抽时间学习了下MVP(Model View Presenter)模式。这里先说一下Android中的MVC。在说之前先问大家一个问题:
在你们做过的项目中，哪些是M,哪些是V,哪些又是C?

先不要往下看，先仔细想一想。

相信会有很多人包括之前的我在内，都会认为M就是写的一些实体类，V就是写的布局文件，C就是写在Activity里面的逻辑代码。而且有的时候V和C还是混合的。
但是后来发现不是这样的。

MVC for Android
在Android开发中，比较流行的开发框架模式采用的是MVC框架模式，采用MVC模式的好处是便于UI界面部分的显示和业务逻辑，数据处理分开。那么Android项目中哪些代码来充当M,V,C角色呢？
M层：适合做一些业务逻辑处理，比如数据库存取操作，网络操作，复杂的算法，耗时的任务等都在model层处理。
V层：应用层中处理数据显示的部分，XML布局可以视为V层，显示Model层的数据结果。
C层：在Android中，Activity处理用户交互问题，因此可以认为Activity是控制器，Activity读取V视图层的数据（eg.读取当前EditText控件的数据），控制用户输入（eg.EditText控件数据的输入），并向Model发送数据请求（eg.发起网络请求等）。

具体可参考链接：框架模式 MVC 在Android中的使用
同样的问题，如果采用MVP模式，在你们做过的项目中，哪些是M,哪些是V,哪些又是P?

View层负责处理用户事件和视图部分的展示。在Android中，它可能是Activity或者Fragment类。
Model层负责访问数据。数据可以是远端的Server API，本地数据库或者SharedPreference等。
Presenter层是连接（或适配）View和Model的桥梁。

具体参考链接：Android开发中的MVP架构详解

本文的重点不是研究什么是MVP和什么是MVC,只是想说，不管是在代码重构的时候还是说开发新项目的时候，都应该采取一种开发模式，一个是方便代码的维护，另一个就是方便别人阅读。
就拿之前重构的那个自定义View类来说，不出bug还好一点，一旦出现什么问题，那是牵一发而动全身啊！代价很大的。

先写这么多吧，如果想到什么以后再补充。
以上都是个人观点，不当之处，敬请谅解。

    原文作者：esonyf
    原文地址: https://www.jianshu.com/p/45ffeff3d6b5
    本文转自网络文章，转载此文章仅为分享知识，如有侵权，请联系博主进行删除。
点赞