Android开发有哪些规范?

  • 编码方式
  • 统一用UTF-8. Android Studio默认已是UTF-8,只要不去改动它就可以了。

    1. 缩进
      统一为4个空格,将Tab size设置为4则可以保证tab键按4个空格缩进。另外,不要勾选上Use tab character,可以保证切换到不同tab长度的环境时还能继续保持统一的4个空格的缩进样式。
    2. 花括号

    public void method()
    {
    // Bad
    }
    public void method() {
    // Good
    }

    1. 空格的使用

    if、else、for、switch、while等逻辑关键字与后面的语句留一个空格隔开。

    // Good
    if (booleanVariable) {
    // TODO while booleanVariable is true
    } else {
    // TODO else
    }
    // Bad
    if(booleanVariable) {
    // TODO while booleanVariable is true
    }else {
    // TODO else

    运算符两边各用一个空格隔开。

    int result = a + b; //Good, = 和 + 两边各用一个空格隔开
    int result=a+b; //Bad,=和+两边没用空格隔开

    方法的每个参数之间用一个空格隔开。

    public void method(String param1, String param2); // Good,param1后面的逗号与String之间隔了一个空格
    method(param1, param2); // Good,方法调用时,param1后面的逗号与param2之间隔了一个空格
    method(param1,param2); // Bad,没有用一个空格隔开

    1. 空行的使用

    将逻辑相关的代码段用空行隔开,以提高可读性。空行也只空一行,不要空多行。在以下情况需用一个空行:

    • 两个方法之间
    • 方法内的两个逻辑段之间
    • 方法内的局部变量和方法的第一条逻辑语句之间
    • 常量和变量之间
    1. 长行

    当一个表达式无法容纳在一行内时,可换行显示,另起的新行用8个空格缩进。

    someMethod(longExpression1, longExpression2, longExpression3,
    longExpression4, longExpression5);

    1. 一行声明一个变量
      一行声明一个变量,不要一行声明多个变量,这样有利于写注释。

    private String param1; // 参数1
    private String param2; // 参数2

    1. 行宽设置为100,设置格式化时自动断行到行宽位置。
    2. 使用快捷键进行代码自动格式化。

    Windows:CTRL+ALT+L
    Mac:OPTION+COMMAND+L

    1. 一个方法最多不要超过40行代码。
    2. 引用第三方库要慎重

    避免应用大容量的第三方库,导致客户端包非常大。

    1. 文字大小的单位

    统一用sp,元素大小的单位统一用dp。

    1. 应用中的字符串

    统一在strings.xml中定义,然后在代码和布局文件中引用。

    1. 颜色值

    统一在colors.xml中定义,然后在代码和布局文件中引用。另外,不要在代码和布局文件中引用系统的颜色,除了透明。

    1. JSON解析

    Android中调用服务器端的接口一般返回的是JSON数据,在解析JSON的时候,无论是使用原始的手工解析方式,还是使用javabean的解析方式,解析出来的结果在使用的时候必须都进行判空处理。不允许因为服务端的json出问题,导致app在解析json的时候出现崩溃。

    1. Int类型常量

    函数返回的时候,如果返回的int类型的数据并不是真实的实用的数据值(例如表示宽度、高度、大小等值),仅仅代表函数执行成功、失败、异常的状态值,并且这些值是有限的几个值,必须要将这些值使用静态常量描述,或者使用枚举类型,例如:

    int GetJsonString()

    该函数返回-1表示获取解析JSON数据异常,返回0表示成功,返回1表示网络连接异常,返回2表示JSON内容中的数据部分为空。那么在函数内部的代码里不要直接使用这些字面值,这些字面值对于程序员来说是毫无意义的,代码可阅读性很差,建议做成下面的模式:

    public static final int RESULT_PARSE_JSON_EXCEPTION = -1;
    public static final int RESULT_SUCCESS = 0;
    public static final int RESULT_NETWORK_EXCEPTION = 1;
    public static final int RESULT_NO_DATA = 2;

    使用这些符号常量值代替字面值的好处是,符号常量值是由大写的英文单词组成,是有意义的,可以帮助程序员更好的理解函数返回值的意义,而且符号常量值对应的具体的赋值在后期也是很方便修改的

    1. 封装 Log 功能

    Log功能应该封装成为自动将当前所在类的类名变成log输出的TAG参数,发布的app最好是能循环写日志文件到系统存储中,并且日志文件应该使用反复覆盖的方式重复利用。下面仅仅是一个不完善的例子:

    public class MyLog {
    public static final String TAG = "myapp ";
    public static void v(Object o, String message) {
    Log.v(TAG + o.getClass().getSimpleName(), message);
    }
    }

    使用方法:

    Log.v(TAG + o.getClass().getSimpleName(), message);

    打印结果

    V/myapp MainActivity: Hello

    1. Activity点击事件
      activity中在一个View.OnClickListener中处理所有的逻辑。
    2. 数据一定要效验
      例如字符型转数字型,如果转换失败一定要有缺省值;
      服务端响应数据是否有效判断;

    原文地址:http://blog.51cto.com/13807306/2132085

    时间: 2024-10-11 22:00:31

    Android开发有哪些规范?的相关文章

    Android开发代码格式规范

    书写规范 1. 编码方式统一用UTF-8. Android Studio默认已是UTF-8,只要不去改动它就可以了. 2. 缩进统一为4个空格,将Tab size设置为4则可以保证tab键按4个空格缩进.另外,不要勾选上Use tab character,可以保证切换到不同tab长度的环境时还能继续保持统一的4个空格的缩进样式. 3. 花括号不要单独一行,和它前面的代码同一行.而且,花括号与前面的代码之间用一个空格隔开. public void method() { // Good } publ

    Android开发之——编码规范

    1. 前言 这份文档参考了 Google Java 编程风格规范和 Google 官方 Android 编码风格规范.该文档仅供参考,只要形成一个统一的风格,见量知其意就可. 2. 源文件基础 2.1 文件名 源文件以其最顶层的类名来命名,大小写敏感,文件扩展名为.java. 2.2 文件编码:UTF-8 源文件编码格式为 UTF-8. 2.3 特殊字符 2.3.1 空白字符 除了行结束符序列,ASCII水平空格字符(0x20,即空格)是源文件中唯一允许出现的空白字符,这意味着: 所有其它字符串

    Android开发编码规范(自用)

    转载请注明本文出自Cym的博客(http://blog.csdn.net/cym492224103),谢谢支持!   Android开发编码规范 目的及指导原则 目的 统一规范 Eclipse编辑环境下Java的编码风格和标准 指导原则 1)首先是为人编写程序,其次才是计算机.这是软件开发的基本要点,软件的生命周期贯穿产品的开发.测试.生产.用户使用.版本升级和后期维护等长期过程,只有易读.易维护的软件代码才具有生命力. 2)保持代码的简单清晰,避免过分的编程技巧.保持代码的简单化是软件工程化的

    值得你学习的 Android 开发规范(下)

    4 资源文件规范 4.1 资源布局文件(XML文件(layout布局文件)) 全部小写,采用下划线命名法 4.1.1 contentView命名 必须以全部单词小写,单词间以下划线分割,使用名词或名词词组. 所有Activity或Fragment的contentView必须与其类名对应,对应规则为:将所有字母都转为小写,将类型和功能调换(也就是后缀变前缀). 例如:activity_main.xml 4.1.2 Dialog命名 规则:dialog_描述.xml 例如:dialog_hint.x

    Android开发代码规范(转)

    Android开发代码规范 1.命名基本原则    在面向对象编程中,对于类,对象,方法,变量等方面的命名是非常有技巧的.比如,大小写的区分,使用不同字母开头等等.但究其本,追其源,在为一个资源其名称的时候,应该本着描述性以及唯一性这两大特征来命名,才能保证资源之间不冲突,并且每一个都便于记忆. 对于理解应用程序的逻辑流,命名方案是最有影响力的一种帮助.名称应该说明“什么”而不是“如何”.命名原则是:使名称足够长以便有一定的意义,并且足够短以避免冗长.唯一名称在编程上仅用于将各项区分开.以下几点

    Android开发命名规范

    刚开始进行android开发时候,命名都是按照拼音来,所以有的时候想看懂命名的那个控件什么是什么用的,就要读一遍甚至好几遍才知道,这样的话,在代码的审查和修改过程中就会浪费不少不必要的时间.如果就是我一个人开发,一个人维护的话还好,可是如果一个项目是团队分工合作,这样让你的同事去看你的代码就更加吃力了,因为大家之间的编程方式不一样,所以,在开发过程中,命名规范统一尤为重要,最好是团队中统一好大家命名方法,这样对于日后的工作会轻松很多. 在面试的时候,审核一个程序员的编程水平的时候,命名规范也是一

    ym——Android开发编码规范(自用)

    Android开发编码规范 目的及指导原则 目的 统一规范 Eclipse编辑环境下Java的编码风格和标准 指导原则 1)首先是为人编写程序,其次才是计算机.这是软件开发的基本要点,软件的生命周期贯穿产品的开发.测试.生产.用户使用.版本升级和后期维护等长期过程,只有易读.易维护的软件代码才具有生命力. 2)保持代码的简单清晰,避免过分的编程技巧.保持代码的简单化是软件工程化的基本要求.不要过分追求技巧,否则会降低程序的可读性. 3)编程时首先保证正确性,其次考虑效率.编程首先考虑的是满足正确

    Android开发规范——命名

    在讲解命名规范前,先初略介绍下当前主要的标识符命名法和英文缩写规则.标识符命名法标识符命名法最要有四种: 1 驼峰(Camel)命名法:又称小驼峰命名法,除首单词外,其余所有单词的第一个字母大写. 2 帕斯卡(pascal)命名法:又称大驼峰命名法,所有单词的第一个字母大写 3 下划线命名法:单词与单词间用下划线做间隔. 4 匈牙利命名法:广泛应用于微软编程环境中,在以Pascal命名法的变量前附加小写序列说明该变量的类型. 量的取名方式为:<scope_> + <prefix_>

    Android开发规范(编码+性能+UI)

    现在为你带来Android开发规范,包括Android编码规范,Android性能优化以及Android UI优化. 一.Android编码规范 1.java代码中不出现中文,最多注释中可以出现中文 2.局部变量命名.静态成员变量命名 只能包含字母,单词首字母出第一个外,都为大写,其他字母都为小写 3.常量命名 只能包含字母和_,字母全部大写,单词之间用_隔开 4.layout中的id命名 命名模式为:view缩写_模块名称_view的逻辑名称 view的缩写详情如下 LayoutView:lv