Android 开发代码规范

一. AndroidStudio开发工具规范

  1. 使用最新的稳定版本.
  2. 统一文件的编码格式为utf-8.
  3. 清除每个类里面的无效的import导包.
  4. 代码样式统一,比如,tab缩进4个空格,或者 tab size等如果没有特殊情况使用默认的配置即可。
  5. 每行字数每行字符数不得超过 160 字符,设置 Editor -> Code Style.
  6. 编辑完 .java、.kt、.xml 等文件后必须格式化.

二. 命名规范

1. 包名

包名全部小写,不允许出现中文、大写字母或者下划线。

2. 类名

类名采用大驼峰命名法,用名词或名词词组命名,每个单词的首字母大写。尽量避免缩写,除非该缩写是众所周知的, 比如 HTML、URL,如果类名称中包含单词缩写,则单词缩写的每个字母均应大写。

描述例如
Activity模块名 +Activity闪屏页类SplashActivity
Fragment模块名 +Fragment主页类HomeFragment
Service模块名 +Service时间服务TimeService
BroadcastReceiver功能名 +Receiver推送接收JPushReceiver
ContentProvider功能名 +ProviderShareProvider
自定义 View功能名 + View/ViewGroup(组件名称)ShapeButton
Dialog对话框功能名+DialogImagePickerDialog
Adapter模块名 +Adapter课程详情适配器LessonDetailAdapter
解析类功能名 +Parser首页解析类HomePosterParser
工具方法类功能名 +UtilsManager线程池管理类:ThreadPoolManager
日志工具类:LogUtilsLogger也可)
打印工具类:PrinterUtils
数据库类功能名 +DBHelper新闻数据库:NewsDBHelper
自定义的共享基础类Base+ 基础BaseActivity,BaseFragment
抽象类Base/Abstract开头AbstractLogin
异常类Exception结尾LoginException

接口(interface):命名规则与类一样采用大驼峰命名法。

3. 方法名

方法名都以 lowerCamelCase 风格编写。方法名通常是动词或动词短语。

方法说明
initXX()初始化相关方法,使用 init 为前缀标识,如初始化布局initView()
isXX(),checkXX()方法返回值为 boolean 型的请使用 is/check 为前缀标识
getXX()返回某个值的方法,使用 get 为前缀标识
setXX()设置某个属性值
handleXX(),processXX()对数据进行处理的方法
displayXX(),showXX()弹出提示框和提示信息,使用 display/show 为前缀标识
updateXX()更新数据
saveXX(),insertXX()保存或插入数据
resetXX()重置数据
clearXX()清除数据
removeXX(),deleteXX()移除数据或者视图等,如removeView()
drawXX()绘制数据或效果相关的,使用 draw 前缀标识

4. 变量命名

这里的变量为广义的变量,包括了常量、局部变量、全局变量等,它们的基础规则是:

  • 类型需要是名词 / 名词短语;
  • 采用 lowerCamelCase 风格;

在具体的变量命名时,会根据该变量的类型不同而附加额外的命名规则:

类型说明例如
常量大写 & 下划线隔开,Kotlin 一定要 const valconst val TYPE_NORMAL = 1 static final TYPE_NORMAL = 1
临时变量名整型:ijkmn,字符型一般用cdefor(int i = 0;i < len; i++)
其他变量lowerCamelCase风格即可,私有变量也不要使用m开头private int tmp;
Kotlin只读变量使用val,可变变量使用var,尽可能使用valvar tmp = 0 val defaultIndex = 0

5. 资源文件

资源文件命名为全部小写,采用下划线命名法。

动画资源文件(anim/ 和 animator/)

安卓主要包含属性动画和视图动画,其视图动画包括补间动画和逐帧动画。属性动画文件需要放在 res/animator/ 目录下,视图动画文件需放在 res/anim/ 目录下。命名规则:{模块名_}逻辑名称

说明:{} 中的内容为可选,逻辑名称 可由多个单词加下划线组成。例如:refresh_progress.xmlmarket_cart_add.xmlmarket_cart_remove.xml

如果是普通的补间动画或者属性动画,可采用:动画类型_方向 的命名方式。

例如:

名称说明
fade_in淡入
fade_out淡出
push_down_in从下方推入
push_down_out从下方推出
push_left推向左方
slide_in_from_top从头部滑动进入
zoom_enter变形进入
slide_in滑动进入
shrink_to_middle中间缩小

图片资源文件(drawable/ 和 mipmap/)

res/drawable/ 目录下放的是位图文件(.png、.9.png、.jpg、.gif)或编译为可绘制对象资源子类型的 XML 文件,而 res/mipmap/ 目录下放的是不同密度的启动图标,所以 res/mipmap/ 只用于存放启动图标,其余图片资源文件都应该放到 res/drawable/ 目录下。

命名规则:类型{_模块名}_逻辑名称类型{_模块名}_颜色

说明:{} 中的内容为可选;类型 可以是可绘制对象资源类型,也可以是控件类型最后可加后缀 _small 表示小图,_big 表示大图。

例如:

名称说明
btn_main_about.png主页关于按键类型_模块名_逻辑名称
btn_back.png返回按键类型_逻辑名称
divider_maket_white.png商城白色分割线类型_模块名_颜色
ic_edit.png编辑图标类型_逻辑名称
bg_main.png主页背景类型_逻辑名称
btn_red.png红色按键类型_颜色
btn_red_big.png红色大按键类型_颜色
ic_avatar_small.png小头像图标类型_逻辑名称
bg_input.png输入框背景类型_逻辑名称
divider_white.png白色分割线类型_颜色
bg_main_head.png主页头部背景类型_模块名_逻辑名称
def_search_cell.png搜索页面默认单元图片类型_模块名_逻辑名称
ic_more_help.png更多帮助图标类型_逻辑名称
divider_list_line.png列表分割线类型_逻辑名称
sel_search_ok.xml搜索界面确认选择器类型_模块名_逻辑名称
shape_music_ring.xml音乐界面环形形状类型_模块名_逻辑名称

如果有多种形态,如按钮选择器:sel_btn_xx.xml,采用如下命名:

名称说明
sel_btn_xx作用在btn_xx上的selector
btn_xx_normal默认状态效果
btn_xx_pressedstate_pressed点击效果
btn_xx_focusedstate_focused聚焦效果
btn_xx_disabledstate_enabled不可用效果
btn_xx_checkedstate_checked选中效果
btn_xx_selectedstate_selected选中效果
btn_xx_hoveredstate_hovered悬停效果
btn_xx_checkablestate_checkable可选效果
btn_xx_activatedstate_activated激活效果
btn_xx_window_focusedstate_window_focused窗口聚焦效果

注意:使用 Android Studio 的插件 SelectorChapek 可以快速生成 selector,前提是命名要规范。

布局资源文件(layout/)

命名规则:类型_模块名{模块名_}类型_逻辑名称。(也采用 PBF,方便查看,尤其在大项目中)

说明:{} 中的内容为可选。

例如:

类型名称说明
Activitymain_activity.xml主窗体模块名_类型
Fragmentmusic_fragment.xml音乐片段模块名_类型
Dialogloading_dialog.xml加载对话框逻辑名称_类型
PopupWindowinfo_ppw.xml信息弹窗(PopupWindow)逻辑名称_类型
adapter的列表项main_song_item.xml主页歌曲列表项模块名_类型_逻辑名称

布局资源 id 命名

命名规则:view 缩写{_模块名}_逻辑名,例如: btn_main_search、btn_back。
注意:使用databinding,viewbinding 直接获取布局文件控件的时候,id 命名采用驼峰样式。

菜单资源文件(menu/)

菜单相关的资源文件应放在该目录下。命名规则:{模块名_}逻辑名称

说明:{} 中的内容为可选。

字符串资源文件strings

<string>name 命名使用下划线命名法,采用以下规则:{模块名_}逻辑名称,这样方便同一个界面的所有 string 都放到一起,方便查找。

名称说明
main_menu_about主菜单按键文字
friend_title好友模块标题栏
friend_dialog_del好友删除提示
login_check_email登录验证
dialog_title弹出框标题
button_ok确认键
loading加载文字

样式资源文件tyles

<style>name 命名使用大驼峰命名法,几乎每个项目都需要适当的使用 styles.xml 文件,因为对于一个视图来说,有一个重复的外观是很常见的,将所有的外观细节属性(colorspaddingfont)放在 styles.xml 文件中。在应用中对于大多数文本内容,最起码你应该有一个通用的 styles.xml 文件,例如:

<style name="ContentText"><item name="android:textSize">@dimen/font_normal</item><item name="android:textColor">@color/basic_black</item>
</style>

应用到 TextView 中:

<TextViewandroid:layout_width="wrap_content"android:layout_height="wrap_content"android:text="@string/price"style="@style/ContentText"/>

或许你需要为按钮控件做同样的事情,将一组相关的和重复 android:xxxx 的属性放到一个通用的

颜色资源文件(color/)

color/ 是专门用于存放颜色相关资源的文件夹。命名规则:类型{_模块名}_逻辑名称

说明:{} 中的内容为可选。例如:sel_btn_font.xml

<color>name 命名使用下划线命名法,在你的 colors.xml 文件中应该只是映射颜色的名称一个 ARGB 值,而没有其它的。不要使用它为不同的按钮来定义 ARGB 值。

<?xml version="1.0" encoding="utf-8"?>
  <!-- grayscale --><color name="white"     >#FFFFFF</color><color name="gray_light">#DBDBDB</color><color name="gray"      >#939393</color><color name="gray_dark" >#5F5F5F</color><color name="black"     >#323232</color><!-- basic colors --><color name="green">#27D34D</color><color name="blue">#2A91BD</color><color name="orange">#FF9D2F</color><color name="red">#FF432F</color>

向应用设计者那里要这个调色板,名称不需要跟 "green""blue" 等等相同。"brand_primary""brand_secondary""brand_negative" 这样的名字也是完全可以接受的。像这样规范的颜色很容易修改或重构,会使应用一共使用了多少种不同的颜色变得非常清晰。通常一个具有审美价值的 UI 来说,减少使用颜色的种类是非常重要的。

注意:如果某些颜色和主题有关,那就单独写一个 colors_theme.xml

注释规范

4.1 类注释

每个类完成后应该有作者姓名和联系方式的注释,对自己的代码负责。

/*** @Author :xxx* @Date   :xxxx/xx/xx* @Email  :xxxxxx@xxx.com* @Desc   :欢迎界面*/
public class WelcomeActivity {...
}

具体可以在 AS 中自己配制,进入 Settings -> Editor -> File and Code Templates -> Includes -> File Header,输入

/*** @Author : ${USER}* @Date   : ${YEAR}/${MONTH}/${DAY}* @Email  : xxx@xx* @Desc   :*/

这样便可在每次新建类的时候自动加上该头注释。

4.2 方法注释

每一个成员方法(包括自定义成员方法、覆盖方法、属性方法)的方法头都必须做方法头注释,在方法前一行输入 /** + 回车 或者设置 Fix doc comment(Settings -> Keymap -> Fix doc comment)快捷键,AS 便会帮你生成模板,我们只需要补全参数即可。

4.3 块注释

块注释与其周围的代码在同一缩进级别。它们可以是 /* ... */ 风格,也可以是 // ... 风格( // 后最好带一个空格 )。对于多行的 /* ... */ 注释,后续行必须从 * 开始, 并且与前一行的 * 对齐。

4.4 全局变量的注释

全局变量的注释样式如下(注意注释之间有空格):

/*** The next available accessibility id.*/
private static int nextAccessibilityViewId;
/*** The animation currently associated with this view.*/
protected Animation currentAnimation = null;

4.5 其他一些注释

AS 已帮你集成了一些注释模板,我们只需要直接使用即可,在代码中输入 TODOFIXME 等这些注释模板,回车后便会出现如下注释。

// TODO: 17/3/14 需要实现,但目前还未实现的功能的说明
// FIXME: 17/3/14 需要修正,甚至代码是错误的,不能工作,需要修复的说明

4.5 注释必须遵守的规范

  • 提测的代码不应该有 TODO 这样的注释(特殊情况除外)

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.rhkb.cn/news/78279.html

如若内容造成侵权/违法违规/事实不符,请联系长河编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

SpringMVC -- REST风格开发,RESTful快速开发、RESTful注解开发

&#x1f40c;个人主页&#xff1a; &#x1f40c; 叶落闲庭 &#x1f4a8;我的专栏&#xff1a;&#x1f4a8; c语言 数据结构 javaweb 石可破也&#xff0c;而不可夺坚&#xff1b;丹可磨也&#xff0c;而不可夺赤。 REST 一、REST简介1.1REST风格简介 二、RESTful入门案例2.…

MySQL日期常见的函数

-- 获取当天日期 -- 2023-06-20 select curdate();-- 获取当天年月日时分秒 select now();-- 日期运算 -- 2024-06-20 17:04:17 select date_add(now(),interval 1 year);-- 日期比较 -- 0 select datediff(now(),now());-- 日期MySQL对于日期类型数据如何查询 -- 获取指定日期…

IDEA SpringBoot Maven profiles 配置

IDEA SpringBoot Maven profiles 配置 IDEA版本&#xff1a; IntelliJ IDEA 2022.2.3 注意&#xff1a;切换环境之后务必点击一下刷新&#xff0c;推荐点击耗时更短。 application.yaml spring:profiles:active: env多环境文件名&#xff1a; application-dev.yaml、 applicat…

2023年 Java 面试八股文(20w字)

目录 第一章-Java基础篇 1、你是怎样理解OOP面向对象 难度系数&#xff1a;⭐ 2、重载与重写区别 难度系数&#xff1a;⭐ 3、接口与抽象类的区别 难度系数&#xff1a;⭐ 4、深拷贝与浅拷贝的理解 难度系数&#xff1a;⭐ 5、sleep和wait区别 难度系数&a…

CI/CD—Docker初入门学习

1 docker 了解 1 Docker 简介 Docker 是基于 Go 语言的开源应用容器虚拟化技术。Docker的主要目标是build、ship and run any app&#xff0c;anywhere&#xff0c;即通过对应用组件的封装、分发、部署、运行等生命周期的管理&#xff0c;达到应用组件级别的一次封装、到处运…

MySQL索引3——Explain关键字和索引使用规则(SQL提示、索引失效、最左前缀法则)

目录 Explain关键字 索引性能分析 Id ——select的查询序列号 Select_type——select查询的类型 Table——表名称 Type——select的连接类型 Possible_key ——显示可能应用在这张表的索引 Key——实际用到的索引 Key_len——实际索引使用到的字节数 Ref ——索引命…

vs导出和导入动态库和静态库

1. 动态库和导出和导入 1.1 动态库的导出 1. 创建新项目 新建新项目&#xff0c;选择动态链接库&#xff08;DLL&#xff09;。 填写项目名称&#xff0c;并选择项目保存的路径&#xff0c;然后点击创建。 创建完成后&#xff0c;会自动生成如下所示文件&#xff0c;可以根据…

PostgreSQL-数据库命令

PostgreSQL-数据库命令 介绍 一个数据库是一个或多个模式的集合&#xff0c;而模式包含表、函数等。因此&#xff0c;完整的逻辑组织结构层次是服务器实例&#xff08;PostgreSQL Server&#xff09;、数据库&#xff08;Database&#xff09;、模式&#xff08;Schema&#…

jmeter 5.1彻底解决中文上传乱码

1.修改源码,然后重新打jar包,就是所有上传文件名重新获取文件名 参考链接:多种Jmeter中文乱码问题处理方法 - 51Testing软件测试网 2.修改Advanced,必须选java

API接口统一管理

API接口统一管理 在开发项目的时候,接口可能很多需要统一管理。在src目录下去创建api文件夹去统一管理项目的接口&#xff1b;这样便于后期维护和团队开发。 axios二次封装 对于axios不熟悉的话&#xff0c;建议先学习这篇文章:Axios的基本使用 在开发项目的时候避免不了与后…

App Cleaner Uninstaller for Mac 苹果电脑软件卸载工具

App Cleaner & Uninstaller 是一款非常有用的 Mac 应用程序清理和卸载工具。它可以彻底地清理系统中的应用程序、扩展和残留文件&#xff0c;以释放磁盘空间并优化系统性能。 此外&#xff0c;它还提供了磁盘空间监控和智能清理建议等功能&#xff0c;使用户可以轻松地管理…

STM32基础入门学习笔记:面包板 配件包扩展模块与编程

文章目录&#xff1a; 一&#xff1a;阵列键盘 1.阵列键盘测试程序 KEYPAD4x4.h KEYPAD4x4.c main.c 2.键盘中断测试程序 NVIC.h NVIC.c main.c 二&#xff1a;舵机控制 1.延时函数驱动舵机程序 SG90.h SG90.c main.c 2.PWM(脉冲宽度调制 脉宽调制/占空比)驱动…

Leetcode周赛 | 2023-8-6

2023-8-6 题1体会我的代码 题2我的超时代码题目体会我的代码 题3体会我的代码 题1 体会 这道题完全就是唬人&#xff0c;只要想明白了&#xff0c;只要有两个连续的数的和&#xff0c;大于target&#xff0c;那么一定可以&#xff0c;两边一次切一个就好了。 我的代码 题2 我…

应急响应-勒索病毒的处理思路

0x00 关于勒索病毒的描述 勒索病毒入侵方式&#xff1a;服务弱口令&#xff0c;未授权&#xff0c;邮件钓鱼&#xff0c;程序木马植入&#xff0c;系统漏洞等 勒索病毒的危害&#xff1a;主机文件被加密&#xff0c;且几乎难以解密&#xff0c;对主机上的文件信息以及重要资产…

NAT协议(网络地址转换协议)详解

NAT协议&#xff08;网络地址转换协议&#xff09;详解 为什么需要NATNAT的实现方式静态NAT动态NATNAPT NAT技术的优缺点优点缺点 NAT协议是将IP数据报头中的IP地址转换为另外一个IP地址的过程&#xff0c;主要用于实现私有网络访问公有网络的功能。这种通过使用少量的IP地址代…

【源码分析】Nacos自动注册源码分析

文章目录 服务注册&#xff08;AP协议&#xff09;服务发现&#xff08;CP协议&#xff09;Nacos是如何整合到SpringCloudAlibaba的&#xff1f; 服务注册&#xff08;AP协议&#xff09; Nacos提供了NamingService的registerInstance方法来提供服务注册的功能。 因此只要我们…

vue v-slot指令

目录 定义语法使用场景场景一场景二场景三tips只有一个默认插槽时 定义 在Vue中&#xff0c; v-slot 指令用于定义插槽的模板内容。它用于在父组件中传递内容到子组件中的插槽。 v-slot 指令可以用于 标签或组件标签上&#xff0c;以便在子组件中使用插槽。 语法 使用 v-slo…

16-1_Qt 5.9 C++开发指南_多语言界面

文章目录 1. 多语言界面设计概述2. tr()函数的使用3. 生成语言翻译文件4. 使用Qt Linguist 翻译 ts 文件5. 调用翻译文件改变界面语言5.1 生成qm文件5.2 项目启动时设置界面语言5.3 动态切换语言 1. 多语言界面设计概述 有些软件需要开发多语言界面版本&#xff0c;如中文版和…

自动化测试框架?数据驱动vs关键字驱动,该怎么做?

目录&#xff1a;导读 前言一、Python编程入门到精通二、接口自动化项目实战三、Web自动化项目实战四、App自动化项目实战五、一线大厂简历六、测试开发DevOps体系七、常用自动化测试工具八、JMeter性能测试九、总结&#xff08;尾部小惊喜&#xff09; 前言 对于自动化测试框…

BI报表工具有哪些作用?奥威BI全面剖析数据

BI报表工具有哪些作用&#xff1f;主要的作用是通过整合多业务来源数据&#xff0c;全面分析挖掘数据&#xff0c;来帮助企业实现数据化运营、支持智能决策、实现数据资产沉淀和增值、进行数据挖掘和预测分析、提高数据可读性和数据可视化程度等&#xff0c;从而提高企业的竞争…