Android 开发代码规范

news2024/11/16 15:56:58

一. 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
工具方法类功能名 +Utils或Manager线程池管理类：ThreadPoolManager
日志工具类：LogUtils（Logger也可）
打印工具类：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
临时变量名整型：i、j、k、m、n，字符型一般用c、d、efor(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.xml、market_cart_add.xml、market_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 文件，因为对于一个视图来说，有一个重复的外观是很常见的，将所有的外观细节属性（colors、padding、font）放在 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 中：

<TextView
    android: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 已帮你集成了一些注释模板，我们只需要直接使用即可，在代码中输入 TODO、FIXME 等这些注释模板，回车后便会出现如下注释。

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

4.5 注释必须遵守的规范

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

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

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

C++笔记之++i和i++是原子操作吗？

C++笔记之++i和i++是原子操作吗？

C笔记之i和i是原子操作吗&#xff1f; code review! 文章目录 C笔记之i和i是原子操作吗&#xff1f;1.i是原子操作吗&#xff1f;2.i是原子操作吗&#xff1f;3.前置递增和后置递增 1.i是原子操作吗&#xff1f; 2.i是原子操作吗&#xff1f; 3.前置递增和后置递增
阅读更多...
绝美！轮到AI写真爆火了！18种AI视频制作教程；Llama 2微调的极速指南；Nijijourney官方AI绘画课 | ShowMeAI日报

绝美！轮到AI写真爆火了！18种AI视频制作教程；Llama 2微调的极速指南；Nijijourney官方AI绘画课 | ShowMeAI日报

&#x1f440;日报&周刊合集 | &#x1f3a1;生产力工具与行业应用大全 | &#x1f9e1; 点赞关注评论拜托啦&#xff01; &#x1f916; 摄影写真面临AI技术洗牌&#xff0c;一键生成杂志大片的时代来了 软件&#xff1a;midjourney & Stable Diffusion 模型&#xff…
阅读更多...
Appium+python自动化（三十四）- 有图有真相，很美很精彩 - 屏幕截图和Android APP类型简介

Appium+python自动化（三十四）- 有图有真相，很美很精彩 - 屏幕截图和Android APP类型简介

简介 在实际自动化项目运行过程中&#xff0c;很多时候App可以会出现各种异常&#xff0c;为了更好的定位问题&#xff0c;除了捕捉日志我们还需要对运行时的设备状态来进行截屏。从而达到一种“有图有真相”的效果。 截图方法 方法1 save_screenshot() 该方法直接保存当前…
阅读更多...
传统计算机视觉

传统计算机视觉

传统计算机视觉 计算机视觉难点图像分割基于主动轮廓的图像分割基于水平集的图像分割交互式图像分割基于模型的运动分割 目标跟踪基于光流的点目标跟踪基于均值漂移的块目标跟踪基于粒子滤波的目标跟踪基于核相关滤波的目标跟踪 目标检测一般目标检测识别之特征一般目标检测识别…
阅读更多...
【深度学习】生成对抗网络Generative Adversarial Nets

【深度学习】生成对抗网络Generative Adversarial Nets

序言 本文是GAN网络的原始论文&#xff0c;发表于2014年&#xff0c;我们知道&#xff0c;对抗网络是深度学习中&#xff0c;CNN基础上的一大进步&#xff1b; 它最大的好处是&#xff0c;让网络摆脱训练成“死模型”到固定场所处去应用&#xff0c;而是对于变化的场景&#xf…
阅读更多...
【小梦C嘎嘎——启航篇】类和对象（上篇）

【小梦C嘎嘎——启航篇】类和对象（上篇）

【小梦C嘎嘎——启航篇】类和对象&#xff08;上篇&#xff09;&#x1f60e; 前言&#x1f64c;什么是面向过程&#xff1f;什么是面向对象&#xff1f;什么是类和对象类中的访问权限属性类的大小计算this 指针构造函数析构函数 总结撒花&#x1f49e; &#x1f60e;博客昵称&…
阅读更多...
自动化测试——APP测试

自动化测试——APP测试

一、环境配置 1、安装jdk 配置环境变量 2、Android SDK 环境安装 3、Appium Server安装 4、模拟器安装 5、安装appium-python-client Python第三方库 二、APP自动化测试原理 三、Desired Capabilites——APPium自动化配置项 1、设置参数 2、操作系统 3、选择版本 4、设备名称…
阅读更多...
LeetCode 1857. Largest Color Value in a Directed Graph【拓扑排序,动态规划】困难

LeetCode 1857. Largest Color Value in a Directed Graph【拓扑排序,动态规划】困难

本文属于「征服LeetCode」系列文章之一&#xff0c;这一系列正式开始于2021/08/12。由于LeetCode上部分题目有锁&#xff0c;本系列将至少持续到刷完所有无锁题之日为止&#xff1b;由于LeetCode还在不断地创建新题&#xff0c;本系列的终止日期可能是永远。在这一系列刷题文章…
阅读更多...
【LeetCode】148.排序链表

【LeetCode】148.排序链表

题目 给你链表的头结点 head &#xff0c;请将其按 升序 排列并返回 排序后的链表 。 示例 1&#xff1a; 输入&#xff1a;head [4,2,1,3] 输出&#xff1a;[1,2,3,4]示例 2&#xff1a; 输入&#xff1a;head [-1,5,3,4,0] 输出&#xff1a;[-1,0,3,4,5]示例 3&#xff1…
阅读更多...
Go 下载安装教程

Go 下载安装教程

1. 下载地址&#xff1a;The Go Programming Language (google.cn) 2. 下载安装包 3. 安装 &#xff08;1&#xff09;下一步 &#xff08;2&#xff09;同意 &#xff08;3&#xff09;修改安装路径&#xff0c;如果不修改&#xff0c;直接下一步 更改后&#xff0c;点击下一…
阅读更多...
软件测试/测试开发丨Selenium环境安装与使用

软件测试/测试开发丨Selenium环境安装与使用

Selenium 官方网站&#xff1a; www.selenium.dev/ 简介&#xff1a; 用于web浏览器测试的工具&#xff1b;支持的浏览器包括IE&#xff0c;Firefox&#xff0c;Safari&#xff0c;Chrome&#xff0c;Edge等&#xff1b;使用简单&#xff0c;可使用Java&#xff0c;Python等…
阅读更多...
InnoDB引擎底层逻辑讲解——逻辑存储结构

InnoDB引擎底层逻辑讲解——逻辑存储结构

逻辑存储结构架构事务原理MVCC 1.逻辑存储结构 InnoDB逻辑存储结构图 mysql数据文件存储位置(linux系统) cd /var/lib/mysql一个mysql实例中有多个表空间&#xff0c;我们切换到某一个特定的数据库如itcast数据库&#xff0c;每个ibd文件都是一个表空间&#xff0c; cd it…
阅读更多...
使用pikachu管理工具下的XSS后台进行实战

使用pikachu管理工具下的XSS后台进行实战

写在前面的重要提示&#xff1a; Attention&#xff1a;技术没有好坏之分&#xff0c;关键在于使用技术的人或组织。网络安全技术是一把双刃剑 – 作为网络安全人&#xff0c;虽然无法控制头上的帽子是否会变绿&#xff0c;但能控制不让它变黑&#xff1b;无论我们在物质上面对…
阅读更多...
Cilium 系列-7-Cilium 的 NodePort 实现从 SNAT 改为 DSR

Cilium 系列-7-Cilium 的 NodePort 实现从 SNAT 改为 DSR

系列文章 Cilium 系列文章 前言 将 Kubernetes 的 CNI 从其他组件切换为 Cilium, 已经可以有效地提升网络的性能。但是通过对 Cilium 不同模式的切换/功能的启用&#xff0c;可以进一步提升 Cilium 的网络性能。具体调优项包括不限于&#xff1a; 启用本地路由 (Native Rou…
阅读更多...
精读《自由布局吸附线的实现》

精读《自由布局吸附线的实现》

目录 判断 box 离哪条边最近 产生吸附效果 resize 时中间对齐线需要放大双倍吸附力 总结 自由布局吸附线的效果如下图所示&#xff1a; 那么如何实现吸附线呢&#xff1f;我们先归纳一下吸附线的特征&#xff1a; 正在拖动的 box 与其他 box 在水平或垂直位置距离接近时&am…
阅读更多...
Spring之BeanDefinition（二）

Spring之BeanDefinition（二）

Spring之BeanDefinition 文章目录 Spring之BeanDefinition1、对象和bean的区别2、BeanDefinition作用AutowireCandidate说明Primary说明ConstructorArgumentValues说明第一种使用方式第二种使用方式 MutablePropertyValuesabstract小结 3、BeanDefinition的发展历程3、BeanDefi…
阅读更多...
RedHat7.9安装mysql8.0.32 ↝ 二进制方式

RedHat7.9安装mysql8.0.32 ↝ 二进制方式

RedHat7.9安装mysql8.0.32 ↝ 二进制方式 一、rpm方式安装1、检查是否安装了mariadb2、下载mysqlmysql8.0.323、上传解压4、创建安装目录&#xff0c;拷贝解压后的文件至安装目录/usr/local/mysql8.0/5、创建相关目录&#xff0c;开始安装6、创建mysql组和用户7、更改安装目录归…
阅读更多...
SpringAOP的相关概念

SpringAOP的相关概念

文章目录 一.什么是AOP二.AOP的组成部分三.SpringAOP的实现3.1 增加SpringAOP依赖3.2 创建切面3.2 创建切点3.3 创建通知3.4 创建连接点 四.SpringAOP的实现原理4.1 JDK动态代理4.2 CGLIB 动态代理总结 一.什么是AOP AOP&#xff0c;全称为Aspect-Oriented Programming&#x…
阅读更多...
创建jupyterlab的快捷启动的一种方式

创建jupyterlab的快捷启动的一种方式

1、找Jupyter Notebook的快捷图标 首先&#xff0c;找到Jupyter Notebook的快捷图标&#xff0c;打开其文件位置。 2、复制Jupyter Notebook快捷方式 复制Jupyter Notebook的快捷方式 将复制Jupyter Notebook的快捷方式的这两处的Noetbook修改为lab。 如下图 3、找Jupy…
阅读更多...
RocketMQ概论

RocketMQ概论

目录 前言&#xff1a; 1.概述 2.下载安装、集群搭建 3.消息模型 4.如何保证吞吐量 4.1.消息存储 4.1.1顺序读写 4.1.2.异步刷盘 4.1.3.零拷贝 4.2.网络传输 前言&#xff1a; RocketMQ的代码示例在安装目录下有全套详细demo&#xff0c;所以本文不侧重于讲API这种死…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023