Android开发规范

　安卓应用 开发规范 1 、 开发 工具 设置 1、1 编码方式统一用 UTＦ－８、 Ａndroｉd Stuｄiｏ默认已就是 UＴF-8,只要不去改动它就可以了. 1、2 缩进统一为 4 个空格，将 Tab sｉze 设置为 4 则可以保证 tab 键按 4 个空格缩进。另外，不要勾选上 Usｅ taｂ character，可以保证切换到不同 tａｂ长度得环境时还能继续保持统一得４个空格得缩进样式. １、3 一行声明一个变量,不要一行声明多个变量，这样有利于写注释. ｐriｖate Ｓtring pａram1; ／/ 参数 1

　privａtｅ Strｉng param２; /／ 参数 2

　1、4、 行宽设置为 1０0，设置格式化时自动断行到行宽位置. 1、５、 使用快捷键进行代码自动格式化。

　1、6、 一个方法最多不要超过 40 行代码. 1、7 范围型得常量用枚举类定义，而不要直接用整型或字符,这样可以减少范围值得有效性检查。

　// 用枚举类定义，Good

　puｂliｃ enum CoupoｎＴype {

　/／ 现金券

　SerｉａｌizｅdName（＂１”）

　ＣASH，

　// 抵用券

　ＳerializｅdNａmｅ(＂２")

　DＥBIT，

　/／ 折扣券

　SｅｒｉalｉｚedNａme（”3”)

　DＩＳCOUNＴ

　｝ // 用整型定义，Bａd

　publiｃ ｓtatiｃ finaｌ iｎt ＴＹPＥ＿CＡSH = 1； // 现金券

　pubｌic stａtｉｃ final ｉnt TYPE_ＤEBIT = 2； // 抵扣券

　publiｃ stａtic final int TYPE_DISCＯUNＴ ＝ 3； // 折扣券

　1、8 文字大小得单位统一用 sp,元素大小得单位统一用 dp。

　1、９ 应用中得字符串统一在 strｉnｇs、xｍｌ中定义，然后在代码与布局文件中引用. 1、1０ 颜色值统一在ｃｏｌors、xmｌ中定义，然后在代码与布局文件中引用。另外，不要在代码与布局文件中引用系统得颜色,除了透明。

　1、１1 图片资源统一放在 mipmaｐ文件夹，相应得文件夹存放相应得路径。mdpi—〉4８＊48，hdpi—>72＊７２，xhdpｉ－＞96＊96，xｘｈdpi－〉１44*1４４， xxxhdpi-〉1９2＊192 16.dｒaｗaｂｌe 存放自定义 XML 文件。

　2 、

　命名规范 2、1、 包命名 me、ｋeeganlee、kandroｉｄ、moｄel

　2、2、 类与接口命名 使用大驼峰规则,用名词或名词词组命名,每个单词得首字母大写。

　以下为几种常用类得命名：

　 aｃtｉviｔy 类,命名以 Acｔiｖity 为后缀，如：LｏginＡctivity

　 fragmｅｎt 类,命名以 Fragment 为后缀，如:ShaｒeＤiaｌogFragmeｎt  service 类,命名以 Service 为后缀,如:DownｌｏadService  adａｐtｅr 类,命名以Ａdａpter 为后缀，如:ＣouｐonLｉｓtAdaptｅｒ  工具类,命名以 Util 为后缀,如:EncryptUtil  模型类,命名以 Bｅaｎ为后缀，如：ＣouponBean  接口实现类，命名以 Imｐl 为后缀，如：ApｉＩmｐl 2、3、 方法命名 使用小驼峰规则，用动词命名，第一个单词得首字母小写,其她单词得首字母大写. 以下为几种常用方法得命名：

　 初始化方法,命名以ｉnit 开头,例：ｉniｔＶｉｅw  按钮点击方法,命名以 to 开头,例:tｏLogin  设置方法，命名以 sｅt 开头，例:setＤaｔa  具有返回值得获取方法，命名以 geｔ开头,例：ｇetDatａ  通过异步加载数据得方法,命名以 loａd 开头，例:lｏadDaｔａ  布尔型得判断方法，命名以 iｓ或ｈａs，或具有逻辑意义得单词如 equals,例：ｉsEmpty 2、4、 控件缩写 控件 缩写 控件 缩写 TextＶiew txt EditＴext eｄt Buｔｔon bｔn IｍａgeBｕttoｎ ibtn ＩｍａgeView imｇ ListView liｓt ＲａdioGroup gｒouｐ RadioＢuttｏn rbｔn

　控件 缩写 控件 缩写 ＰｒogreｓsBar ｐrogress SeｅkBar sｅek CheckBox chk Sｐinｎer sｐiｎner TablｅLayout taｂle TａbｌeRoｗ roｗ LiｎｅａrLaｙout lｌayouｔ ＲelativeLａyout rlayｏut ScｒｏlｌView sｃroll SｅarcｈＶiew search ＴａｂHost hｏsｔ TabWidgｅt widｇｅt 2、5、 常量命名 全部为大写单词，单词之间用下划线分开。

　pｕbｌic fｉnａl sｔａtｉc inｔ PAGE_SIZE = ２0；

　 2、６、 变量命名 ｛范围描述+}意义描述+类型描述得组合,用驼峰式，首字母小写。

　pｒivatｅ TextVｉeｗ headｅrTitleＴｘt; // 标题栏得标题

　privatｅ Ｂｕttｏn loginBtn； // 登录按钮

　prｉｖatｅ CouponBO ｃｏuｐonBO; /／ 券实例

　２、7、 控件 iｄ命名 控件缩写＿{范围_}意义,范围可选，只在有明确定义得范围内才需要加上. <!-— 这就是标题栏得标题 －-＞

　ＴｅxtViｅｗ ａｎｄroid:id＝＂+iｄ／txt_headｅr_title＂

　<!——这就是登录按－— >

　Ｂutton aｎdｒoid:id=”+iｄ/btn_login”

　2、8、 layout 命名 组件类型＿{范围_}功能，范围可选，只在有明确定义得范围内才需要加上。

　以下为几种常用得组件类型命名：

　 activｉｔy_{范围_｝功能,为 Acｔivｉtｙ得命名格式  fragment_{范围＿}功能，为Ｆｒagmｅnｔ得命名格式  dialｏg_｛范围_}功能，为Ｄialｏg 得命名格式  ｉtem_list＿｛范围＿｝功能，为 LｉstVｉew 得 iｔem 命名格式  item_gｒid_{范围＿｝功能，为ＧriｄＶｉew 得ｉtem 命名格式  headｅr＿lisｔ_｛范围＿}功能，为ＬistViｅｗ得 HeadeｒＶiew 命名格式  ｆooter＿list_｛范围_}功能,为 LｉstＶｉeｗ得ＦｏｏterVieｗ命名格式 2、9、 strinｇs 得命名 类型_{范围_｝功能,范围可选。

　以下为几种常用得命名：

　 页面标题，命名格式为：tｉｔle＿页面  按钮文字，命名格式为:bｔn＿按钮事件  标签文字，命名格式为:labeｌ_标签文字  选项卡文字，命名格式为：ｔab_选项卡文字  消息框文字，命名格式为:toasｔ_消息  编辑框得提示文字，命名格式为:ｈｉnt_提示信息  图片得描述文字，命名格式为:dｅｓｃ_图片文字  对话框得文字,命名格式为：dｉalog＿文字

　 ｍｅｎu 得 iｔｅm 文字，命名格式为:ａction_文字 2、10、 ｃoloｒs 得命名 前缀{_控件｝{_范围｝｛_后缀}，控件、范围、后缀可选,但控件与范围至少要有一个。

　 背景颜色,添加 bg 前缀  文本颜色,添加ｔext 前缀  分割线颜色,添加 div 前缀  区分状态时，默认状态得颜色，添加 normal 后缀  区分状态时，按下时得颜色,添加 pｒｅssed 后缀  区分状态时，选中时得颜色，添加 seleｃteｄ后缀  区分状态时，不可用时得颜色,添加 disａｂle 后缀 11、 drawａble 得命名 前缀{＿控件}{_范围}{_后缀｝，控件、范围、后缀可选,但控件与范围至少要有一个。

　 图标类，添加 iｃ前缀  背景类,添加 bg 前缀  分隔类，添加 div 前缀  默认类,添加ｄef 前缀  区分状态时,默认状态,添加 norｍaｌ后缀  区分状态时，按下时得状态，添加ｐrｅsｓeｄ后缀  区分状态时，选中时得状态，添加 selｅｃｔed 后缀  区分状态时,不可用时得状态，添加 disａble 后缀  多种状态得，添加ｓeｌecｔoｒ后缀（一般为 LｉstView 得 selｅctor 或按钮得 seｌecｔoｒ) 12、 动画文件命名

　动画类型＿动画方向。

　 fade＿in,淡入  fａde_out,淡出  pusｈ＿down_in，从下方推入  ｐuｓh_doｗn_ｏｕt,从下方推出  sliｄｅ＿iｎ_from_ｔop，从头部滑动进入  ｚoom_enter，变形进入  sｈｒinｋ_ｔo_midｄｌe，中间缩小 3 、 注释规范 3、１、 文件头注释 文件顶部统一添加版权声明，声明得格式如下：

　/＊＊

　＊ Ｃopyrｉgｈt （c) 201５、 Keeｇan 小钢 Inc、 All rｉghｔs reｓeｒvｅd、

　＊／

　３、2、 类与接口注释 类与接口统一添加ｊavadoc 注释，格式如下: /*＊

　* 类或接口得描述信息

　＊

　＊ author ＄｛ＵSER｝

　* datｅ $｛DATＥ｝

　＊／

　3、３、 方法注释

　下面几种方法，都必须添加 javaｄoｃ注释，说明该方法得用途与参数说明,以及返回值得说明。

　 接口中定义得所有方法  抽象类中自定义得抽象方法  抽象父类得自定义公用方法  工具类得公用方法 /＊*

　* 登录

　＊

　* param lｏginName 登录名

　＊ param ｐａssword 密码

　＊ param ｌistener 回调监听器

　＊/

　pubｌｉc void logiｎ(Ｓｔriｎｇ lｏginNamｅ, String ｐasswｏrｄ， ActioｎCallbackＬisｔeｎｅr＆ｌt；Vｏｉｄ＆gt; lisｔener）；

　３、4、 变量与常量注释 下面几种情况下得常量与变量，都要添加注释说明,优先采用右侧//来注释,若注释说明太长则在上方添加注释.  接口中定义得所有常量  公有类得公有常量  枚举类定义得所有枚举常量  实体类得所有属性变量 ｐublic static finａl int TYPE_CＡＳＨ = 1； // 现金券

　pｕblic stａtiｃ finaｌ ｉnｔ TYPＥ_DEBIT = ２； // 抵扣券

　puｂlic statiｃ ｆｉnａｌ int TYＰE_DIＳCOUNT = 3； ／/ 折扣券

　ｐrｉvaｔe ｉnt ｉd； /／ 券 id

　ｐriｖate Stｒｉｎg naｍｅ； /／ 券名称

　prｉvatｅ Strinｇ ｉnｔｒｏdｕce; /／ 券简介

　４、 开发环境 开发工具：andｒｏidstudio 版本管理:git 开发版本：5、0 最低版本：4、0 5 、 第三方开源框架选择  网络请求:Voｌley  JSOＮ解析:fastjsｏn，ＧSON  图片缓存：Vｏlｌｅy  内存检测：lｅａkcａnary  数据库：sｑｌite  融云:即时通讯  友盟—数据统计，推送，意见反馈  设计模式：MVC 设计模式

　 配置主题：主题遵循配置化原则.  多渠道打包—gradlｅ ｆｌavor  持续集成-jenｋins  ＡPK 瘦身—编程开发得时候应该考虑,迭代优化。保证 AＰK 大小５Ｍ以内。

　 支付服务-微信支付、支付宝

　 分享-sｈａde sdk

　Activiｔｙ：担任 MVC 中得 C

　 页面逻辑写在这里，按模块划分 Adaｐtｅr:适配器 Ａｐi:自定义工具,如Ｖｏlｌey 自定义请求 Basｅ：基类 Bｅａn：MVC 中得 M

　 jaｖaｂｅａｎ类 ,按模块划分 mon：常量定义空间

　Ｄiａloｇ：自定义Ｄｉalｏg Fraｇmeｎｔ:碎片 Seｒviｃe:服务，按模块划分 Ｕtils：工具类 Ｗiｄgeｔ：自定义控件 Ａppcｏntext：自定义 AｐpConｔext Appmanagｅr：同上 Ａppstarｔ：开始页面 6 、 测试工具 建议可以尝试采用三方自动测试平台，验证 APＰ非功能特性. 7 、

　移动设备尺寸规范汇总 参考

相关热词搜索： 规范 开发 android