Android开发代码规范

Posted 2020-06-16

目录

• 1.命名基本原则 
• 2.命名基本规范
• 2.1编程基本命名规范
• 2.2分类命名规范
• 3.分类命名规范
• 3.1基本数据类型命名规范
• 3.2控件命名规范
• 3.3变量命名规范
• 3.4整个项目的目录规范化
• 3.4 res资源文件命名规范
• 4.代码书写规范 
• 5.注释
• 6.提高代码质量
• 7.设计模式（Design Patterns）

 

1.命名基本原则
    在面向对象编程中，对于类，对象，方法，变量等方面的命名是非常有技巧的。比如，大小写的区分，使用不同字母开头等等。但究其本，追其源，在为一个资源其名称的时候，应该本着描述性以及唯一性这两大特征来命名，才能保证资源之间不冲突，并且每一个都便于记忆。

对于理解应用程序的逻辑流，命名方案是最有影响力的一种帮助。名称应该说明“什么”而不是“如何”。命名原则是：使名称足够长以便有一定的意义，并且足够短以避免冗长。唯一名称在编程上仅用于将各项区分开。以下几点是规范的命名方法。 
 

2.命名基本规范

2.1编程基本命名规范 
（1）避免难懂的名称，如属性名xxK8，这样的名称会导致多义性。   
（2） 在面向对象的语言中，在类属性的名称中包含类名是多余的，如Book.BookTitle，而是应该使用Book.Title。   
（3）在允许函数重载的语言中，所有重载都应该执行相似的函数。 

（4）使用动词-名词的方法来命名对给定对象执行特定操作的例程，如CalculateInvoiceTotal()。（例程是某个系统对外提供的功能接口或服务的集合）   

（5）只要合适，在变量名的末尾或开头加计算限定符（Avg、Sum、Min、Max、Index）。 
（6）在变量名中使用互补对，如min/max、begin/end和open/close。  

（7）布尔变量名应该包含Is，这意味着Yes/No 或 True/False 值，如 fileIsFound。   

（8）即使对于可能仅出现在几个代码行中的生存期很短的变量，仍然使用有意义的名  称。仅对于短循环索引使用单字母变量名，如 i 或 j。   

（9）为了帮助区分变量和例程，对例程名称使用Pascal大小写处理 (CalculateInvoiceTotal)，其中每个单词的第        一个字母都是大写的。对于变量名，使用 camel大小写处理 (documentFormatType)，其中除了第一个单词外每个单词的第一个字母都是大写的。   

（10）不要使用原义数字或原义字符串，而是使用命名常数，NUM_DAYS_IN_WEEK ，以便于维护和理解。  

 

 

 2.2分类命名规范

（1）包的命名 　 

　　Java包的名字都是由小写单词组成。但是由于Java面向对象编程的特性，每一名Java程序员都可以编写属于自己的Java包，为了保障每个Java包命名的唯一性，在最新的Java编程规范中，要求程序员在自己定义的包的名称之前加上唯一的前缀。由于互联网上的域名称是不会重复的，所以程序员一般采用自己在互联网上的域名称作为自己程序包的唯一前缀。 

　　例如： com.pccb.app

（2）类的命名 

　　 类的名字必须由大写字母开头而单词中的其他字母均为小写；如果类名称由多个单词组成，则每个单词的首字母均应为大写例如TestPage；如果类名称中包含单词缩写，则这个所写词的每个字母均应大写，如：XMLExample,还有一点命名技巧就是由于类是设计用来代表对象的，所以在命名类时应尽量选择名词。 　　

　　例如： Circle 

（3）方法的命名 

　　方法的名字的第一个单词应以小写字母作为开头，后面的单词则用大写字母开头。

　　例如： sendMessge 

（4）常量的命名 

　　常量的名字应该都使用大写字母，并且指出该常量完整含义。如果一个常量名称由多个单词组成，则应该用下划线来分割这些单词。

　　例如： MAX_VALUE 

（5）参数的命名 

参数的命名规范和方法的命名规范相同，而且为了避免阅读程序时造成迷惑，请在尽量保证参数名称为一个单词的情况下使参数的命名尽可能明确。 

私有属性：private int mAge;

静态变量：static String sName;

函数内部变量：int  _Age;

方法定义时的形参：int pAge;

 

（6）Javadoc注释 

　　Java除了可以采用我们常见的注释方式之外，Java语言规范还定义了一种特殊的注释，也就是我们所说的Javadoc注释，它是用来记录我们代码中的API的。Javadoc注释是一种多行注释，以/**开头，而以*/结束，注释可以包含一些html标记符和专门的关键词。使用Javadoc注释的好处是编写的注释可以被自动转为在线文档，省去了单独编写程序文档的麻烦。

　　例如： 

/**

* This is an example of

* Javadoc

*

* @author darchon

* @version 0.1, 10/11/2002

*/ 

　　在每个程序的最开始部分，一般都用Javadoc注释对程序的总体描述以及版权信息，之后在主程序中可以为每个类、接口、方法、字段添加Javadoc注释，每个注释的开头部分先用一句话概括该类、接口、方法、字段所完成的功能，这句话应单独占据一行以突出其概括作用，在这句话后面可以跟随更加详细的描述段落。在描述性段落之后还可以跟随一些以Javadoc注释标签开头的特殊段落，例如上面例子中的@auther和@version，这些段落将在生成文档中以特定方式显示。

虽然为一个设计低劣的程序添加注释不会使其变成好的程序，但是如果按照编程规范编写程序并且为程序添加良好的注释却可以帮助你编写出设计完美，运行效率高且易于理解的程序，尤其是在多人合作完成同一项目时编程规范就变得更加重要。俗话说“磨刀不误砍柴工”，花费一点时间去适应一下Java编程规范是有好处的。 

 

3.分类命名规范

3.1基本数据类型命名规范

Integer：int+描述          Char：chr+描述          Boolean：bln+描述 

Long：lng+描述           Short：shr +描述         Double：dbl+描述

String：str+描述           Float：flt+描述          Single：sng+描述

DataTime：dt+描述         Array：arr+描述        Object：obj+描述     

如：String  srtName;

 

3.2控件命名规范 

TextView ：txt_+描述	Button ：btn_+描述
ImageButton ：imgBtn_+描述	ImageView ：imgView_+描述
CheckBox ：chk_+描述	RadioButton ：rdoBtn_+描述
AnalogClock ：anaClk_+描述	DigitalClock ：DgtClk_+描述
DatePicker ：dtPk_+描述	TimePicker ：tmPk _+描述
ToggleButton ：tglBtn_+描述	EditText：edtTxt_+描述
ProgressBar：lcb_+描述	SeekBar：skBar _+描述
AutoCompleteTextView：autoTxt_+描述	MultiAutoCompleteTextView：mlAutoTxt_+描述
ZoomControls：zmCtrl_+描述	Include：ind_+描述
VideoView：vdoVi_+描述	WebView：webVi_+描述
RatingBar：ratBar_+描述	Tab：tab__+描述
Spinner：spn_+描述	Chronometer：Cmt_+描述
ScrollView：sclVi_+描述	TextSwitcher：txtSwt_+描述
Gallery：gal_+描述	ImageSwitcher：imgSwt_+描述
GridView：gV_+描述	ListView：lVi_+描述
ExpandableList: epdLt_+描述	MapView: mapVi_+描述

 

控件说明如下：

• TextView - 文本显示控件

• Button - 按钮控件

• ImageButton - 图片按钮控件

• ImageView - 图片显示控件

• CheckBox - 复选框控件

• RadioButton - 单选框控件

• AnalogClock - 钟表（带表盘的那种）控件

• DigitalClock - 电子表控件

• DatePicker - 日期选择控件

• TimePicker - 时间选择控件

• ToggleButton - 双状态按钮控件

• EditText - 可编辑文本控件

• ProgressBar - 进度条控件

• SeekBar - 可拖动的进度条控件

• AutoCompleteTextView - 支持自动完成功能的可编辑文本控件

• MultiAutoCompleteTextView - 支持自动完成功能的可编辑文本控件，允许输入多值（多值之间会自动地用指定的分隔符    分开）

• ZoomControls - 放大/缩小按钮控件

• Include - 整合控件

• VideoView - 视频播放控件

• WebView - 浏览器控件

• RatingBar - 评分控件

• Tab - 选项卡控件

• Spinner - 下拉框控件

• Chronometer - 计时器控件

• ScrollView - 滚动条控件

• TextSwitcher - 文字转换器控件（改变文字时增加一些动画效果）

• Gallery –画廊控件

• ImageSwitcher - 图片转换器控件（改变图片时增加一些动画效果）

• GridView - 网格控件

• ListView - 列表控件

• ExpandableList - 支持展开/收缩功能的列表控件        

 

3.3变量命名规范

变量命名：前缀+类型描述+意义描述

前缀：

成员变量：m_***             局部变量：l_***          形参：a_***

常量：大写_***                  枚举值：em_***

 

3.4整个项目的目录规范化

1、系统目录规范：

　　指项目目录中不仅包括源代码，还需要包括：需求相关文档、设计文档、计划日志文档、测试文档、项目进行中学习资料文档（参考Demo）；使整个项目更加清晰，

2、源代码目录规范：

一般系统命名空间目录尽量不要超过3层，[组织名].[项目名].[模块名]：com.pccb.app

 

3.5 res资源文件命名

 1,res/layout下的xml文件统一用小写和下划线"_"组合命名，并加上前缀以便区分 

正例：

对话框的xml配置文件:dlg_name.xml

 2.layout中的id采用以下命名模式： view缩写_模块名称_view的逻辑名称

     说明：view的缩写详情如下 

ListView： lv 

RelativeView: rv 

TextView: tv 

ImageView: iv

 ImageButton: ib  / ibtn

Button:  btn 

正例： 

@＋id/lv_appstore_applist 

反例： 

@+id/ListView01

 3.activity文中的view变量采用以下命名模式： 逻辑名称_view缩写

   正例： 

ListViewapplistLv 

 4.res/drawable下的资源文件采用以下命名模式：  activity名称_逻辑名称/common_逻辑名称

   正例： 

main_default.png,main_pressed.png

 5.strings.xml中的id采用以下命名模式： activity名称_功能模块名称_逻辑名称/activity名称_逻辑名称/common_逻辑名称

   正例： 

<string name="main_downloading">正在下载„</string>

 6.字符串信息应统一在strings.xml中定义，调试信息除外

 7.使用日志时，不重要的信息定义在debug等级或者info等级，较为严重的情况把日志定义的warn等级和error等级。正常情况下尽量不使用System.out.println();作为日志的输出

4.代码书写规范 
（1）建立标准的缩进大小（如四个空格），并一致地使用此标准。用规定的缩进对齐代码节。    
（2）在括号对对齐的位置垂直对齐左括号和右括号，如：   
   for   (i=0; i<100; i++) 
   { 
         ; 
   }    
（3）沿逻辑结构行缩进代码使代码更易于阅读和理解，如：   
   if(expression) 
         { 
         if(expression ) 
          { 
            // 
            //此处填写你的代码块; 
            // 
          } 
         else 
          { 
            // 
            //此处填写你的代码块; 
            // 
          } 
         } 
（4）为注释和代码建立最大的行长度，以避免不得不滚动源代码编辑器，并且可以提供整齐的硬拷贝表示形式。     
（5）当一行内容太长而必须换行时，在后面换行代码中要使用缩进格式，如下： 
    string   inserString ="Insert   Into   TableName(username,password,email,sex,address) " 
    +"Values( ‘Soholife ‘, ‘chenyp ‘, ‘[email protected] ‘, ‘male ‘, ‘深圳福田 ‘) "; 
（6）每一行上放置的语句避免超过一条。特殊循环如for(i =0;i<100;i++)等除外。   
（7）编写SQL语句时，对于关键字使用全部大写，对于数据库元素（如表、列和视图）使用大小写混合。例如SELECT * FROM Table1；  
（8）将每个主要的SQL子句放在不同的行上，这样更容易阅读和编辑语句，例如：   

   SELECT   FirstName,   LastName 
   FROM     Customers 
   WHERE   State   =   ‘WA ‘  

（10）使用空白为源代码提供结构线索。这样做会创建代码“段”，有助于读者理解软件的逻辑分段
（11）将大的复杂代码段分为较小的、易于理解的模块。   

5.注释 
     软件文档以两种形式存在：外部的和内部的。外部文档（如规范、帮助文件和设计文档）在源代码的外部维护。内部文档由开发人员在开发时在源代码中编写的注释组成。 
     不考虑外部文档的可用性，由于硬拷贝文档可能会放错地方，源代码清单应该能够独立存在。外部文档应该由规范、设计文档、更改请求、错误历史记录和使用的编码标准组成。   以下几点是规范的注释方法：   

（1）一个工程应有一个统一的头文件注释，以说明整个工程的信息、创建日期、版本等等     

（2）对重要的程序加注释进行说明

（3）修改代码或删除时，将原代码用注释的方法屏蔽，同时要加开发者自身对修改操作的注释。格式为：

//原代码

//Added/（Modified/ Deleted） by 开发者姓名 年-月-日;

//因为业务原因修改的，要注明修改或删除原因）

新代码
（4）使用XML文档格式，如下面方法的注释： 
  <!-- 注释内容 -->

（5）避免杂乱的注释，而是应该使用空白将注释同代码分开。   
（6）移除所有临时或无关的注释，以避免在日后的维护工作中产生混乱。   
（7）注释应对代码进行准确的说明，不应存在歧义。   
（8）在整个应用程序中，使用具有一致的标点和结构的统一样式来构造注释。   

（9）方法注释的内容（1，5，6，7项正常情况下都要写上去）  

1.类该方法是做什么的。 2.该方法如何工作。 3.代码修改历史纪录。 4.方法调用代码示范。 

5.必须传入什么样的参数给这个方法。@param 6.异常处理。@throws 

7.这个方法返回什么。@return

 

6.提高代码质量

（1）删除无用的变量

（2）删除无用的引入 

（3）对于可以复用的部分，一定提取成共用的方法，减少代码量

（4）变量/方法命名一定要符合清晰易懂，不用太在乎长度

（5）代码完成后，进行code review，减少出错几率 

 (6)  用适合的方式尽量去思考设计模式方式来进行开发

 

 

7.设计模式（Design Patterns）——可复用面向对象软件的基础

   设计模式（Design pattern）是一套被反复使用、多数人知晓的、经过分类编目的、代码设计经验的总结。使用设计模式是为了可重用代码、让代码更容易被他人理解、保证代码可靠性。 毫无疑问，设计模式于己于他人于系统都是多赢的，设计模式使代码编制真正工程化，设计模式是软件工程的基石，如同大厦的一块块砖石一样。项目中合理的运用设计模式可以完美的解决很多问题，每种模式在现在中都有相应的原理来与之对应，每一个模式描述了一个在我们周围不断重复发生的问题，以及该问题的核心解决方案，这也是它能被广泛应用的原因。

   一个程序员对设计模式的理解:
      “不懂”为什么要把很简单的东西搞得那么复杂。后来随着软件开发经验的增加才开始明白我所看到的“复杂”恰恰就是设计模式的精髓所在，我所理解的“简单”就是一把钥匙开一把锁的模式，目的仅仅是着眼于解决现在的问题，而设计模式的“复杂”就在于它是要构造一个“万能钥匙”，目的是提出一种对所有锁的开锁方案。在真正理解设计模式之前我一直在编写“简单”的代码.
    这个“简单”不是功能的简单，而是设计的简单。简单的设计意味着缺少灵活性，代码很钢硬，只在这个项目里有用，拿到其它的项目中就是垃圾，我将其称之为“一次性代码”。

    -->要使代码可被反复使用,请用‘设计模式‘对你的代码进行设计.

很多我所认识的程序员在接触到设计模式之后，都有一种相见恨晚的感觉，有人形容学习了设计模式之后感觉自己好像已经脱胎换骨，达到了新的境界，还有人甚至把是否了解设计模式作为程序员划分水平的标准。

我们也不能陷入模式的陷阱，为了使用模式而去套模式，那样会陷入形式主义。我们在使用模式的时候，一定要注意模式的意图（intent），而不 要过多的去关注模式的实现细节，因为这些实现细节在特定情况下，可能会发生一些改变。不要顽固地认为设计模式一书中的类图或实现代码就代表了模式本身。

设计原则：(重要)
    1.逻辑代码独立到单独的方法中，注重封装性--易读，易复用。
不要在一个方法中，写下上百行的逻辑代码。把各小逻辑代码独立出来，写于其它方法中，易读其可重复调用。
    2.写类，写方法，写功能时，应考虑其移植性，复用性：防止一次性代码！
是否可以拿到其它同类事物中应该？是否可以拿到其它系统中应该？
    3.熟练运用继承的思想：
找出应用中相同之处，且不容易发生变化的东西，把它们抽取到抽象类中，让子类去继承它们；
继承的思想，也方便将自己的逻辑建立于别人的成果之上。如ImageField extends JTextField；
熟练运用接口的思想：
找出应用中可能需要变化之处，把它们独立出来，不要和那些不需要变化的代码混在一起。

 

设计模式：

    1.java的23中设计模式 

    2.MVC模式 

    3.MVP 模式