| 名称 | 说明 |
| — | — |
| sel_btn_xx
| 作用在 btn_xx
上的 selector
|
| btn_xx_normal
| 默认状态效果 |
| btn_xx_pressed
| state_pressed
点击效果 |
| btn_xx_focused
| state_focused
聚焦效果 |
| btn_xx_disabled
| state_enabled
不可用效果 |
| btn_xx_checked
| state_checked
选中效果 |
| btn_xx_selected
| state_selected
选中效果 |
| btn_xx_hovered
| state_hovered
悬停效果 |
| btn_xx_checkable
| state_checkable
可选效果 |
| btn_xx_activated
| state_activated
激活效果 |
| btn_xx_window_focused
| state_window_focused
窗口聚焦效果 |
注意:使用 Android Studio 的插件 SelectorChapek 可以快速生成 selector,前提是命名要规范。
3.5.4 布局资源文件(layout/)
命名规则:类型_模块名
、{模块名_}类型_逻辑名称
。(也采用 PBF,方便查看,尤其在大项目中)
说明:
{}
中的内容为可选。
例如:
| 类型 | 名称 | 说明 |
| — | — | — |
| Activity
| main_activity.xml
| 主窗体 模块名_类型
|
| Fragment
| music_fragment.xml
| 音乐片段 模块名_类型
|
| Dialog
| loading_dialog.xml
| 加载对话框 逻辑名称_类型
|
| PopupWindow
| info_ppw.xml
| 信息弹窗(PopupWindow) 逻辑名称_类型
|
| adapter
的列表项 | main_song_item.xml
| 主页歌曲列表项 模块名_类型_逻辑名称
|
3.5.5 布局资源 id 命名
命名规则:{模块名_}_逻辑名_view 缩写(功能)
,例如: main_search_btn
、back_btn
。此外,采用 Kotlinx 直接获取布局文件的时候,id 命名采用驼峰样式。
说明:
{}
中的内容为可选。参考 GoogleSamples Demo:https://github.com/android/architecture-samples
例如:
| 类型 | 规范 | 命名示例 |
| — | — | — |
| TextView
| xxx_text
| user_login_text
|
| EditText
| xxx_edit
| user_login_edit
|
| ImageView
| xxx_iv
| user_login_iv
|
| Button
| xxx_btn
| user_login_btn
|
| CheckBox
| xxx_cb
| user_login_cb
|
| GridView
| xxx_gv
| user_login_gv
|
| ListView
| xxx_lv
| user_login_lv
|
| RecyclerView
| xxx_rv
| user_login_rv
|
| RadioButton
| xxx_rb
| user_login_rb
|
| LinearLayout
| xxx_ll
| user_login_ll
|
| RelativeLayout
| xxx_rl
| user_login_rl
|
| FrameLayout
| xxx_fl
| user_login_fl
|
| GridLayout
| xxx_gl
| user_login_gl
|
| ConstraintLayout
| xxx_cl
| user_login_cl
|
3.5.6 菜单资源文件(menu/)
菜单相关的资源文件应放在该目录下。命名规则:{模块名_}逻辑名称
说明:
{}
中的内容为可选。例如:main_drawer.xml
、navigation.xml
。
3.5.7 colors.xml
<color>
的 name
命名使用下划线命名法,在你的 colors.xml
文件中应该只是映射颜色的名称一个 ARGB 值,而没有其它的。不要使用它为不同的按钮来定义 ARGB 值。
例如,不要像下面这样做:
#FFFFFF
#2A91BD
#5F5F5F
#939393
#FFFFFF
#FF9D2F
…
#323232
使用这种格式,会非常容易重复定义 ARGB 值,而且如果应用要改变基色的话会非常困难。同时,这些定义是跟一些环境关联起来的,如 button
或者 comment
,应该放到一个按钮风格中,而不是在 colors.xml
文件中。
相反,应该这样做:
#FFFFFF
#DBDBDB
#939393
#5F5F5F
#323232
#27D34D
#2A91BD
#FF9D2F
#FF432F
向应用设计者那里要这个调色板,名称不需要跟 "green"
、"blue"
等等相同。"brand_primary"
、"brand_secondary"
、"brand_negative"
这样的名字也是完全可以接受的。像这样规范的颜色很容易修改或重构,会使应用一共使用了多少种不同的颜色变得非常清晰。通常一个具有审美价值的 UI 来说,减少使用颜色的种类是非常重要的。
注意:如果某些颜色和主题有关,那就单独写一个
colors_theme.xml
。
3.5.8 strings.xml
<string>
的 name
命名使用下划线命名法,采用以下规则:{模块名_}逻辑名称
,这样方便同一个界面的所有 string
都放到一起,方便查找。
| 名称 | 说明 |
| — | — |
| main_menu_about
| 主菜单按键文字 |
| friend_title
| 好友模块标题栏 |
| friend_dialog_del
| 好友删除提示 |
| login_check_email
| 登录验证 |
| dialog_title
| 弹出框标题 |
| button_ok
| 确认键 |
| loading
| 加载文字 |
3.5.9 styles.xml
<style>
的 name
命名使用大驼峰命名法,几乎每个项目都需要适当的使用 styles.xml
文件,因为对于一个视图来说,有一个重复的外观是很常见的,将所有的外观细节属性(colors
、padding
、font
)放在 styles.xml
文件中。在应用中对于大多数文本内容,最起码你应该有一个通用的 styles.xml
文件,例如:
应用到 TextView
中:
<TextView
android:layout_width=“wrap_content”
android:layout_height=“wrap_content”
android:text=“@string/price”
style=“@style/ContentText”/>
或许你需要为按钮控件做同样的事情,不要停止在那里,将一组相关的和重复 android:xxxx
的属性放到一个通用的 <style>
中。
====================================================================================
每个类完成后应该有作者姓名和联系方式的注释,对自己的代码负责。
/**
-
author : nanchen
-
e-mail : xxx@xx
-
time : 2021/01/18
-
desc : xxxx 描述
-
version: 1.0
*/
public class WelcomeActivity {
…
}
具体可以在 AS 中自己配制,进入 Settings -> Editor -> File and Code Templates -> Includes -> File Header,输入
/**
-
author : ${USER}
-
e-mail : xxx@xx
-
time : ${YEAR}/${MONTH}/${DAY}
-
desc :
-
version: 1.0
*/
这样便可在每次新建类的时候自动加上该头注释。
每一个成员方法(包括自定义成员方法、覆盖方法、属性方法)的方法头都必须做方法头注释,在方法前一行输入 /** + 回车
或者设置 Fix doc comment
(Settings -> Keymap -> Fix doc comment)快捷键,AS 便会帮你生成模板,我们只需要补全参数即可,如下所示。@param
, @return
, @throws
, @deprecated
这 4 种标记出现的时候,描述都不能为空。当描述无法在一行中容纳,连续行至少需要再缩进 4 个空格。
/**
-
Report an accessibility action to this view’s parents for delegated processing.
-
Implementations of {@link #performAccessibilityAction(int, Bundle)} may internally
-
call this method to delegate an accessibility action to a supporting parent. If the parent
-
returns true from its
-
{@link ViewParent#onNestedPrePerformAccessibilityAction(View, int, android.os.Bundle)}
-
method this method will return true to signify that the action was consumed.
-
This method is useful for implementing nested scrolling child views. If
-
{@link #isNestedScrollingEnabled()} returns true and the action is a scrolling action
-
a custom view implementation may invoke this method to allow a parent to consume the
-
scroll first. If this method returns true the custom view should skip its own scrolling
-
behavior.
-
@param action Accessibility action to delegate
-
@param arguments Optional action arguments
-
@return true if the action was consumed by a parent
*/
public boolean dispatchNestedPrePerformAccessibilityAction(int action, Bundle arguments) {
for (ViewParent p = getParent(); p != null; p = p.getParent()) {
if (p.onNestedPrePerformAccessibilityAction(this, action, arguments)) {
return true;
}
}
return false;
}
块注释与其周围的代码在同一缩进级别。它们可以是 /* ... */
风格,也可以是 // ...
风格(//
后最好带一个空格)。对于多行的 /* ... */
注释,后续行必须从 *
开始, 并且与前一行的 *
对齐。以下示例注释都是 OK 的。
/*
- This is okay.
*/
// And so
// is this.
/* Or you can
- even do this. */
注释不要封闭在由星号或其它字符绘制的框架里。
Tip:在写多行注释时,如果你希望在必要时能重新换行(即注释像段落风格一样),那么使用
/* ... */
。
比如:
全局变量的注释样式如下(注意注释之间有空格):
/**
- The next available accessibility id.
*/
private static int nextAccessibilityViewId;
/**
- The animation currently associated with this view.
*/
protected Animation currentAnimation = null;
AS 已帮你集成了一些注释模板,我们只需要直接使用即可,在代码中输入 TODO
、FIXME
等这些注释模板,回车后便会出现如下注释。
// TODO: 17/3/14 需要实现,但目前还未实现的功能的说明
// FIXME: 17/3/14 需要修正,甚至代码是错误的,不能工作,需要修复的说明
4.5.1 不言自明的方法不要加注释。
比如 Item getItem(int index)
是一段自说明的代码,我们可以直接从方法的命名就能知道它是干嘛的,所以不需要增加注释。
4.5.2 提测的代码不应该有 TODO 这样的注释
=============================================================================
左大括号不单独占一行,与其前面的代码位于同一行:
class MyClass {
int func() {
if (something) {
// …
} else if (somethingElse) {
// …
} else {
// …
}
}
}
我们需要在条件语句周围添加大括号。例外情况:如果整个条件语句(条件和主体)适合放在同一行,那么您可以(但不是必须)将其全部放在一行上。例如,我们接受以下样式:
if (condition) {
body();
}
同样也接受以下样式:
if (condition) body();
但不接受以下样式:
if (condition)
body(); // bad!
在可行的情况下,尽量编写短小精炼的方法。我们了解,有些情况下较长的方法是恰当的,因此对方法的代码长度没有做出硬性限制。如果某个方法的代码超出 40 行,请考虑是否可以在不破坏程序结构的前提下对其拆解。
这并没有唯一的正确解决方案,但如果都使用一致的顺序将会提高代码的可读性,推荐使用如下排序:
-
常量(Kotlin 伴生对象放在开头)
-
字段
-
构造函数
-
重写函数和回调
-
公有函数
-
私有函数
-
内部类或接口
例如:
public class MainActivity extends Activity {
private static final String TAG = MainActivity.class.getSimpleName();
private String mTitle;
private TextView mTextViewTitle;
@Override
public void onCreate() {
…
}
public void setTitle(String title) {
mTitle = title;
}
private void setUpView() {
…
}
static class AnInnerClass {
}
}
如果类继承于 Android 组件(例如 Activity
或 Fragment
),那么把重写函数按照他们的生命周期进行排序是一个非常好的习惯,例如,Activity
实现了 onCreate()
、onDestroy()
、onPause()
、onResume()
,它的正确排序如下所示:
public class MainActivity extends Activity {
//Order matches Activity lifecycle
@Override
public void onCreate() {}
@Override
public void onResume() {}
@Override
public void onPause() {}
@Override
public void onDestroy() {}
}
在 Android 开发过程中,Context
在函数参数中是再常见不过的了,我们最好把 Context
作为其第一个参数。
正相反,我们把回调接口应该作为其最后一个参数。
例如:
// Context always goes first
public User loadUser(Context context, int userId);
// Callbacks always go last
public void loadUserAsync(Context context, int userId, UserCallback callback);
Android SDK 中的很多类都用到了键值对函数,比如 SharedPreferences
、Bundle
、Intent
,所以,即便是一个小应用,我们最终也不得不编写大量的字符串常量。
当时用到这些类的时候,我们 必须 将它们的键定义为 static final
字段,并遵循以下指示作为前缀。
| 类 | 字段名前缀 |
| — | — |
| SharedPreferences | PREF_
|
| Bundle | BUNDLE_
|
| Fragment Arguments | ARGUMENT_
|
| Intent Extra | EXTRA_
|
| Intent Action | ACTION_
|
说明:虽然 Fragment.getArguments()
得到的也是 Bundle
,但因为这是 Bundle
的常用用法,所以特意为此定义一个不同的前缀。
例如:
// 注意:字段的值与名称相同以避免重复问题
static final String PREF_EMAIL = “PREF_EMAIL”;
static final String BUNDLE_AGE = “BUNDLE_AGE”;
static final String ARGUMENT_USER_ID = “ARGUMENT_USER_ID”;
// 与意图相关的项使用完整的包名作为值的前缀
static final String EXTRA_SURNAME = “com.myapp.extras.EXTRA_SURNAME”;
static final String ACTION_OPEN_USER = “com.myapp.action.ACTION_OPEN_USER”;
代码中每一行文本的长度都应该不超过 160 个字符。虽然关于此规则存在很多争论,但最终决定仍是以 160 个字符为上限,如果行长超过了 160(AS 窗口右侧的竖线就是设置的行宽末尾 ),我们通常有两种方法来缩减行长。
-
提取一个局部变量或方法(最好)。
-
使用换行符将一行换成多行。
不过存在以下例外情况:
-
如果备注行包含长度超过 160 个字符的示例命令或文字网址,那么为了便于剪切和粘贴,该行可以超过 160 个字符。
-
导入语句行可以超出此限制,因为用户很少会看到它们(这也简化了工具编写流程)。
5.6.1 换行策略
这没有一个准确的解决方案来决定如何换行,通常不同的解决方案都是有效的,但是有一些规则可以应用于常见的情况。
5.6.1.1 操作符的换行
除赋值操作符之外,我们把换行符放在操作符之前,例如:
int longName = anotherVeryLongVariable + anEvenLongerOne - thisRidiculousLongOne
- theFinalOne;
赋值操作符的换行我们放在其后,例如:
int longName =
anotherVeryLongVariable + anEvenLongerOne - thisRidiculousLongOne + theFinalOne;
5.6.1.2 函数链的换行
当同一行中调用多个函数时(比如使用构建器时),对每个函数的调用应该在新的一行中,我们把换行符插入在 .
之前。
例如:
Picasso.with(context).load(“https://blankj.com/images/avatar.jpg”).into(ivAvatar);
我们应该使用如下规则:
Picasso.with(context) .load(“https://blankj.com/images/avatar.jpg”) .into(ivAvatar);
5.6.1.3 多参数的换行
当一个方法有很多参数或者参数很长的时候,我们应该在每个 ,
后面进行换行。
比如:
loadPicture(context, “https://blankj.com/images/avatar.jpg”, ivAvatar, “Avatar of the user”, clickListener);
我们应该使用如下规则:
loadPicture(context,
“https://blankj.com/images/avatar.jpg”,
ivAvatar,
“Avatar of the user”,
clickListener);
5.6.1.4 RxJava 链式的换行
RxJava 的每个操作符都需要换新行,并且把换行符插入在 .
之前。
例如:
public Observable syncLocations() {
return mDatabaseHelper.getAllLocations()
.concatMap(new Func1<Location, Observable<? extends Location>>() {
@Override
自我介绍一下,小编13年上海交大毕业,曾经在小公司待过,也去过华为、OPPO等大厂,18年进入阿里一直到现在。
深知大多数初中级Android工程师,想要提升技能,往往是自己摸索成长或者是报班学习,但对于培训机构动则近万的学费,着实压力不小。自己不成体系的自学效果低效又漫长,而且极易碰到天花板技术停滞不前!
因此收集整理了一份《2024年Android移动开发全套学习资料》,初衷也很简单,就是希望能够帮助到想自学提升又不知道该从何学起的朋友,同时减轻大家的负担。
既有适合小白学习的零基础资料,也有适合3年以上经验的小伙伴深入学习提升的进阶课程,基本涵盖了95%以上Android开发知识点,真正体系化!
由于文件比较大,这里只是将部分目录截图出来,每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频,并且会持续更新!
如果你觉得这些内容对你有帮助,可以扫码获取!!(备注:Android)
![](https://i-blog.csdnimg.cn/blog_migrate/9bba08845d718ab747e626f8d6a36780.jpeg)
最后是今天给大家分享的一些独家干货:
【Android开发核心知识点笔记】
【Android思维脑图(技能树)】
【Android核心高级技术PDF文档,BAT大厂面试真题解析】
【Android高级架构视频学习资源】
《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取!
小公司待过,也去过华为、OPPO等大厂,18年进入阿里一直到现在。**
深知大多数初中级Android工程师,想要提升技能,往往是自己摸索成长或者是报班学习,但对于培训机构动则近万的学费,着实压力不小。自己不成体系的自学效果低效又漫长,而且极易碰到天花板技术停滞不前!
因此收集整理了一份《2024年Android移动开发全套学习资料》,初衷也很简单,就是希望能够帮助到想自学提升又不知道该从何学起的朋友,同时减轻大家的负担。
[外链图片转存中…(img-wnQwYAnu-1712819586551)]
[外链图片转存中…(img-NlnYmdQy-1712819586551)]
[外链图片转存中…(img-NbqgLrWg-1712819586551)]
[外链图片转存中…(img-Lpw4X9bG-1712819586552)]
[外链图片转存中…(img-k07mxgE1-1712819586552)]
既有适合小白学习的零基础资料,也有适合3年以上经验的小伙伴深入学习提升的进阶课程,基本涵盖了95%以上Android开发知识点,真正体系化!
由于文件比较大,这里只是将部分目录截图出来,每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频,并且会持续更新!
如果你觉得这些内容对你有帮助,可以扫码获取!!(备注:Android)
![](https://i-blog.csdnimg.cn/blog_migrate/9bba08845d718ab747e626f8d6a36780.jpeg)
最后是今天给大家分享的一些独家干货:
【Android开发核心知识点笔记】
[外链图片转存中…(img-xBMBumr7-1712819586552)]
【Android思维脑图(技能树)】
[外链图片转存中…(img-IMPhz6yM-1712819586552)]
【Android核心高级技术PDF文档,BAT大厂面试真题解析】
[外链图片转存中…(img-gI4OSGFs-1712819586553)]
【Android高级架构视频学习资源】
《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取!