代码可以说是开发者的脸面，写出简洁规范的代码对个人，对团队都是非诚重要的。对个人而言，简洁规范的代码不仅体现自己的专业和技术水平，而且能够赢的别人的赞赏；对于团队而言，团队成员遵循统一的规范，能够更好地维护代码库的稳定和谐。
Android 是基于Java语言进行开发的，因此说到编码规范，收下件需要遵循Java的编码规范，比较有名的Java编码规范有Google的Java编码规范和Oracle的Java编码规范。一份完整的编码规范不仅仅管住编码格式是否每股前，同时也会讨论一些约定和编码标准。
A、Java 编码规范
（1）源代码文件的定义
源代码文件以文件内容中的最顶层的Java类命名，而且大小写敏感，文件扩展名为.java,文件编码格式统一为UTF-8.
（2）源码文件的结构
一个完整的源代码文件由四部分组成
a、版权信息或者许可证
例如 Android Framework （PhoneWindow类）的版权声明
/*
* Copyright (C) 2006 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
b、Java文件所在的package声明
例如：package android.net.
c、Java类需要使用到的依赖引入import 语句
注：一般不建议使用通配符“*”，而应该引入具体类，同时import 语句要按照类型进行分组，不同的组以空行分隔，第三方函数库引入类也独立成组等。一般使用IDE的格式化功能会自动帮我们分好组。
Android studio 的代码格式化快捷键win：ctrl+alt+l mac：OPTION+CMD+l
package com.explem.chaohaozhao.myviewpager.utils;
import android.app.Activity;
import android.app.AlertDialog;
import android.content.Context;
import android.content.DialogInterface;
import android.content.pm.PackageInfo;
import android.content.pm.PackageManager;
import android.net.ConnectivityManager;
import android.net.Network;
import android.net.NetworkInfo;
import android.os.Build;
import com.explem.chaohaozhao.myviewpager.R;
import java.net.InetAddress;
import java.net.NetworkInterface;
import java.net.SocketException;
import java.util.ArrayList;
import java.util.Enumeration;
import java.util.List;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
d、Java 顶级类的定义
Java 顶级类的定义有且只有一个，但可以存在内部类定义。每个类中的成员需要按照某种逻辑进行排序，维护者也需要按照相同的逻辑去添加新的成员，而不是仅仅将新的成员放到最后面，同时，多个重载方法应该按照顺序排放在一起，中间不要插入其它方法。
（3）遵循的格式
格式主要涉及代码的排版问题，需要重点关注的主要包括。
a、多使用花括号
例如 if、else、for、do、while等语句要和花括号一起使用，即使只有一条语句或者是空的，也要加上花括号：
错误的方式，而且可能会在后面的代码维护中引入bug
if (isClick)
but.setText("ddddd");
else
but.setText("ttt");
正确的写法要加上花括号
if (isClick){
but.setText("dddd");
}else{
but.setText("ttt");
}
b、列字符个数的限制
根据团队内部使用的显示器以及IDE具体问题具体分析，最终目的是保证代码良好的可阅读性，一般常见的是约定一行80个或100个字符，超过部分IDE自动换行。
c、空白的使用
不要把所有的代码都写在一起，需要按照逻辑进行分组，垂直方向的空白原则主要有：
（1）方法体内，语句的逻辑分组之间使用空行；
（2）类里面连续的成员（字段、构造方法、普通方法、嵌套内部类、静态初始化代码块等）之间加上空行。当然，也没必要加上多个空行，一个就够了。
d、switch语句（kotlin里when代替switch）
Switch语句除了要注意缩进，空白使用之外，如果连续case 之间明确不需要家break时，建议加上//fall through 注释，方便代码维护者的理解，同时一定要加上default 语句，例子如下：
switch(count){
case 1:
break;
case 3:
//fall through
default:
break;
}
e、修饰符的顺序
public(公有的) protected(受保护的) private(私有的) abstract(抽象) static(静态变量) final (修饰)transient（不参与序列化） volatile（同步机制） synchronized（） native（） strictfp（精确浮点）
QQ图片20181011153716.png
QQ图片20181011153843.png
（4）命名约定
类的命名约定遵循大驼峰命名法：JavaBean,而方法名和变量名的命名遵循小驼峰命名规则法：startPlay.常量名使用大写字母表示，单词之间以下划线分隔，例：public static final int CONNECTION_TIMEOUT = 1000;
QQ图片20181011154008.png
（5）Javadoc(文档注释)
增加 方便代码可读性
QQ图片20181011154107.png
B、Android 命名规范
（1）布局文件的命名
布局文件的命名规则使用“前缀_逻辑名”的方式，全部小写
QQ图片20181011154210.png
（2）资源文件的命名
资源文件的命名规则使用 前缀模块名逻辑名称的方式，单词全部小写
QQ图片20181011154307.png
（3）类的命名
类的命名遵循Java 的类命名规范，也就是使用大驼峰命名法，同时需要根据类的具体用途引入Android 相关的命名规则：
QQ图片20181011154402.png
C、CheckStyle（编码规范检查插件）
在Android Studio 中，我们可以引入CheckStyle 插件来进行编码规范检查，每个团队根据自身的编码格式按定制CheckStyle的规则，然后可以加入到持续构建平台中，定期扫描提交代码是否符合规范，并给出报告。
网友评论