Android开发规范性文档

最新推荐文章于 2022-04-24 12:20:41 发布
最新推荐文章于 2022-04-24 12:20:41 发布
阅读量547 收藏 1
点赞数
分类专栏： Android常用技巧 文章标签： 代码规范
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/m0_49439457/article/details/107579394
版权

一、 前言

    为了有利于项目维护、增强代码可读性、提升 Code Review 效率以及规范终端团队安卓开发，故提出以下安卓开发规范，该规范分为三部分：

    第一部分主要用于约束编码风格，参考行业内优秀的团队发布的规范和团队内部的实际情况；

    第二部分用于约束编码规则，基于2017年起ffalcon的fireline扫描规范(含阿里巴巴P3C规范)，进行约定；

    第三部分用于约束工程结构，该规范主要用于约束Gradle编程规范、组件化方案、模块内分层方案

二、 AS 规范

工欲善其事，必先利其器。

  1. 尽量使用最新的稳定版的 IDE 进行开发；

  2. 编码格式统一为 UTF-8；

  3. 统一使用编码风格设定和检查工具

  4. 删除多余的 import，减少警告出现，可利用 AS 的 Optimize Imports（Settings -> Keymap -> Optimize Imports）快捷键；

  5. Android 开发者通用工具可以参考这里：Android 开发者工具；

三、编码风格(Java)

1 命名规范

代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。正确的英文拼写和语法可以让阅读者易于理解，避免歧义。

注意：即使纯拼音命名方式也要避免采用。但 alibaba、taobao、youku、hangzhou 等国际通用的名称，可视同英文。

1.1 包名【推荐】

包名全部小写，连续的单词只是简单地连接起来，不使用下划线，采用反域名命名规则，全部使用小写字母。一级包名是顶级域名，通常为 com、edu、gov、net、org 等，二级包名为公司名如tcl，三级包名根据应用进行命名如appstore，如果是组件化开发，四级包名为该组件的名称如order,后面就是对包名内部的层级划分了，参考工程结构的[模块内应用分层]一栏。

1.2 类名【强制】

类名都以 UpperCamelCase 风格编写。

类名通常是名词或名词短语，接口名称有时可能是形容词或形容词短语。现在还没有特定的规则或行之有效的约定来命名注解类型。

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

类 描述 例如
Activity 类 Activity 为后缀标识 欢迎页面类 WelcomeActivity
Adapter 类 Adapter 为后缀标识 新闻详情适配器 NewsDetailAdapter
解析类 Parser 为后缀标识 首页解析类 HomePosterParser
工具方法类 Utils 或 Manager 为后缀标识
线程池管理类：ThreadPoolManager

日志工具类：LogUtils（Logger 也可）

打印工具类：PrinterUtils

数据库类 以 DBHelper 后缀标识 新闻数据库：NewsDBHelper
Service 类 以 Service 为后缀标识 时间服务 TimeService
BroadcastReceiver 类 以 Receiver 为后缀标识 推送接收 JPushReceiver
ContentProvider 类 以 Provider 为后缀标识 ShareProvider
自定义的共享基础类 以 Base 开头 BaseActivity, BaseFragment
测试类的命名以它要测试的类的名称开始，以 Test 结束。例如：HashTest 或 HashIntegrationTest。

接口（interface）：命名规则与类一样采用大驼峰命名法，多以 able 或 ible 结尾，如 interface Runnable、interface Accessible。

注意：如果项目采用 MVP，所有 Model、View、Presenter 的接口都以 I 为前缀，不加后缀，其他的接口采用上述命名规则。

1.3 方法名【推荐】

方法名都以 lowerCamelCase 风格编写。

方法名通常是动词或动词短语。

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

1.4 常量名【强制】

常量名命名模式为 CONSTANT_CASE，全部字母大写，用下划线分隔单词。那到底什么算是一个常量？

每个常量都是一个 static final 字段，但不是所有 static final 字段都是常量。在决定一个字段是否是一个常量时，得考虑它是否真的

感觉像是一个常量。例如，一个对象的引用不变不代表就是一个常量，比如final类型的集合对象本身的引用不变，但是集合内对象引用可变，该集合并非一个常量。

// Constants
static final int NUMBER = 5;
static final ImmutableListNAMES = ImmutableList.of(“Ed”, “Ann”);
static final Joiner COMMA_JOINER = Joiner.on(’,’); // because Joiner is immutable
static final SomeMutableType[] EMPTY_ARRAY = {};
enum SomeEnum { ENUM_CONSTANT }

// Not constants
static String nonFinal = “non-final”;
final String nonStatic = “non-static”;
static final SetmutableCollection = new HashSet();
static final ImmutableSetmutableElements = ImmutableSet.of(mutable);
static final Logger logger = Logger.getLogger(MyClass.getName());
static final String[] nonEmptyArray = {“these”, “can”, “change”};

1.5 非常量字段名【强制】

非常量字段名以 lowerCamelCase 风格的基础上改造为如下风格：基本结构为 scopeVariableName{Type}、variableName{Type}。

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

注意：所有的 VO（值对象）统一采用标准的 lowerCamelCase 风格编写，所有的 DTO（数据传输对象）就按照接口文档中定义的字段名编写。

1.5.1 scope（范围）

类成员变量：

非静态字段命名以 m 开头。

静态字段命名以 s 开头。

方法内局部变量：

其他字段以小写字母开头。

例如：

public class MyClass {
public int mPublicField;
private static MyClass sSingleton;
(default) int mPackagePrivate;
private int mPrivate;
protected int mProtected;

public void test(){
	int publicField0;
}

}
使用 1 个字符前缀来表示作用范围，1 个字符的前缀必须小写，前缀后面是由表意性强的一个单词或多个单词组成的名字，而且每个单词的首写字母大写，其它字母小写，这样保证了对变量名能够进行正确的断句。

1.5.2 VariableName（变量名）

变量名中可能会出现量词，我们需要创建统一的量词，它们更容易理解，也更容易搜索。

例如：mFirstBook、mPreBook、curBook。

量词列表 量词后缀说明
First 一组变量中的第一个
Last 一组变量中的最后一个
Next 一组变量中的下一个
Pre 一组变量中的上一个
Cur 一组变量中的当前变量

1.5.3 Type（数据类型）

对于表示集合或者数组的非常量字段名，我们可以添加后缀来增强字段的可读性，比如：

集合添加如下后缀：List、Map、Set。

数组添加如下后缀：Arr。

例如：mIvAvatarList、userArr、firstNameSet。

注意：如果数据类型不确定的话，比如表示的是很多书，那么使用其复数形式来表示也可，例如 mBooks。

1.6 参数名【推荐】

参数名以 lowerCamelCase 风格编写，参数应该避免用单个字符命名。

1.7 局部变量名【强制】

局部变量名以 lowerCamelCase 风格编写，比起其它类型的名称，局部变量名可以有更为宽松的缩写。

虽然缩写更宽松，但还是要避免用单字符进行命名，除了临时变量和循环变量。

即使局部变量是 final 和不可改变的，也不应该把它示为常量，自然也不能用常量的规则去命名它。

1.8 临时变量【强制】

临时变量通常被取名为 i、j、k、m 和 n，它们一般用于整型；c、d、e，它们一般用于字符型。 如：for (int i = 0; i < len; i++)。

2 代码样式规范

2.1 使用标准大括号样式【强制】

左大括号不单独占一行，与其前面的代码位于同一行：

class MyClass {
int func() {
if (something) {
// …
} else if (somethingElse) {
// …
} else {
// …
}
}
}
我们需要在条件语句周围添加大括号：

if (condition) {
body();
}
不接受以下样式：

if (condition) body(); // bad!

if (condition)
body(); // bad!

2.2 类成员的顺序【推荐】

这并没有唯一的正确解决方案，但如果都使用一致的顺序将会提高代码的可读性，推荐使用如下排序：

  1. 常量

  2. 字段

  3. 构造函数

  4. 重写函数和回调

  5. 公有函数

  6. 私有函数

  7. 内部类或接口

例如：

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() {}

}
可以使用AS插件，使类按照生命周期排序：Lifecycle Sorter。

2.4 函数参数的排序【推荐】

在 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);

2.5 字符串常量的命名和值【推荐】

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”;

2.7 行长限制【推荐】

代码中每一行文本的长度都应该不超过 100 个字符。虽然关于此规则存在很多争论，但最终决定仍是以 100 个字符为上限，如果行长超过了 100（AS 窗口右侧的竖线就是设置的行宽末尾 ），我们通常有两种方法来缩减行长。

  • 提取一个局部变量或方法（最好）。

  • 使用换行符将一行换成多行。

不过存在以下例外情况：

  • 如果备注行包含长度超过 100 个字符的示例命令或文字网址，那么为了便于剪切和粘贴，该行可以超过 100 个字符。

  • 导入语句行可以超出此限制，因为用户很少会看到它们（这也简化了工具编写流程）。

2.7.1 换行策略

这没有一个准确的解决方案来决定如何换行，通常不同的解决方案都是有效的，但是有一些规则可以应用于常见的情况。

2.7.1.1 操作符的换行

除赋值操作符之外，我们把换行符放在操作符之前，例如：

int longName = anotherVeryLongVariable + anEvenLongerOne - thisRidiculousLongOne

  • theFinalOne;
    赋值操作符的换行我们放在其后，例如：

int longName =
anotherVeryLongVariable + anEvenLongerOne - thisRidiculousLongOne + theFinalOne;

2.7.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);

2.7.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);

2.7.1.4 RxJava 链式的换行

RxJava 的每个操作符都需要换新行，并且把换行符插入在 . 之前。

例如：

public Observable syncLocations() {
return mDatabaseHelper.getAllLocations()
.concatMap(new Func1<Location, Observable<? extends Location>>() {
@Override
public Observable<? extends Location> call(Location location) {
return mRetrofitService.getLocation(location.id);
}
})
.retry(new Func2<Integer, Throwable, Boolean>() {
@Override
public Boolean call(Integer numRetries, Throwable throwable) {
return throwable instanceof RetrofitError;
}
});
}

3 资源文件规范【强制&推荐】

【文件需添加module时，强制在文件名前添加,具体文件逻辑名的命名称为推荐】

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

如果是组件化开发，我们可以在组件和公共模块间创建一个 ui 模块来专门存放资源文件，然后让每个组件都依赖 ui 模块。这样做的好处是如果老项目要实现组件化的话，只需把资源文件都放入 ui 模块即可，还避免了多个模块间资源不能复用的问题。如果不使用公共模块，各个资源文件须使用该module作为前缀，防止引用时出现资源名重复编译报错的问题。

如果是三方库开发，其使用到的资源文件及相关的 name 都应该使用库名作为前缀，这样做可以避免三方库资源和实际应用资源重名的冲突。

3.1 动画资源文件（anim/ 和 animator/）

安卓主要包含属性动画和视图动画，其视图动画包括补间动画和逐帧动画。属性动画文件需要放在 res/animator/ 目录下，视图动画文件需放在 res/anim/ 目录下。

命名规则：模块名_{页面名_}逻辑名称。

说明：{} 中的内容为可选，逻辑名称 可由多个单词加下划线组成。

例如：portal_refresh_progress.xml、portal_market_cart_add.xml、portal_market_cart_remove.xml。

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

例如：

名称 说明
portal_fade_in 淡入
portal_fade_out 淡出
portal_push_down_in 从下方推入
portal_push_down_out 从下方推出
portal_push_left 推向左方
portal_slide_in_from_top 从头部滑动进入
portal_zoom_enter 变形进入
portal_slide_in 滑动进入
portal_shrink_to_middle 中间缩小

3.2 颜色资源文件（color/）

专门存放颜色相关的资源文件。

命名规则：模块_{页面名_}类型_逻辑名称。

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

例如：portal_sel_btn_font.xml。

颜色资源也可以放于 res/drawable/ 目录，引用时则用 @drawable 来引用，但不推荐这么做，最好还是把两者分开。

3.3 图片资源文件（drawable/ 和 mipmap/）

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

命名规则：模块名_{页面名_}类型_逻辑名称、模块名_{页面名_}类型_颜色。

说明：类型 可以是可绘制对象资源类型，也可以是控件类型（具体见附录[UI 控件缩写表]；最后可加后缀 _small 表示小图，_big 表示大图。

例如：

名称 说明
portal_main_btn_about.png portal模块下主页关于按键 模块名_页面名_类型_逻辑名称
middleware_btn_back.png middleware模块下返回按键 模块名_类型_逻辑名称
portal_ic_head_small.png portal模块下小头像图标 模块名_类型_逻辑名称
如果有多种形态，如按钮选择器：portal_sel_btn_xx.xml，采用如下命名：

名称 说明
portal_sel_btn_xx 作用在 btn_xx 上的 selector
portal_btn_xx_normal 默认状态效果
portal_btn_xx_pressed state_pressed 点击效果
portal_btn_xx_focused state_focused 聚焦效果
portal_btn_xx_disabled state_enabled 不可用效果
portal_btn_xx_checked state_checked 选中效果
portal_btn_xx_selected state_selected 选中效果
portal_btn_xx_hovered state_hovered 悬停效果
portal_btn_xx_checkable state_checkable 可选效果
portal_btn_xx_activated state_activated 激活效果
portal_btn_xx_window_focused state_window_focused 窗口聚焦效果

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

3.4 布局资源文件（layout/）

命名规则：模块名{_页面名}_类型、模块名{_页面名}_类型_逻辑名称。

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

例如：

名称 说明
portal_main_activity 主窗体 模块名_页面名_类型
portal_main_activity_head 主窗体头部 模块名_页面名_类型_逻辑名称
portal_music_fragment 音乐片段 模块名_页面名_类型
portal_music_fragment_player 音乐片段的播放器 模块名_页面名_类型_逻辑名称
portal_dialog_loading 加载对话框 模块名_类型_逻辑名称
portal_ppw_info 信息弹窗 模块名_类型_逻辑名称
portal_main_item_song 主页歌曲列表项 模块名_页面名_类型_逻辑名称

3.5 菜单资源文件（menu/）

菜单相关的资源文件应放在该目录下。

命名规则：模块名_{页面名_}逻辑名称

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

例如：portal_main_drawer.xml、portal_navigation.xml。

3.6 values 资源文件（values/）

values/ 资源文件下的文件都以 s 结尾，如 attrs.xml、colors.xml、dimens.xml，起作用的不是文件名称，而是 <resources> 标签下的各种标签，比如 <style> 决定样式，<color> 决定颜色，所以，可以把一个大的 xml 文件分割成多个小的文件，比如可以有多个 style 文件，如 styles.xml、styles_home.xml、styles_item_details.xml、styles_forms.xml。

3.6.1 colors.xml

<color> 的 name 命名使用下划线命名法，

命名规则：模块名_颜色名称

例如：portal_white。

在你的 colors.xml 文件中应该只是映射颜色的名称一个 ARGB 值，而没有其它的。不要使用它为不同的按钮来定义 ARGB 值。

例如，不要像下面这样做：

#FFFFFF #2A91BD #5F5F5F #939393 #FFFFFF #FF9D2F ... #323232 使用这种格式，会非常容易重复定义 ARGB 值，而且如果应用要改变基色的话会非常困难。同时，这些定义是跟一些环境关联起来的，如 `button` 或者 `comment`，应该放到一个按钮风格中，而不是在 `colors.xml` 文件中。

相反，应该这样做：

<!-- grayscale -->
<color name="portal_white" >#FFFFFF</color>
<color name="portal_gray_light">#DBDBDB</color>
<color name="portal_gray" >#939393</color>
<color name="portal_gray_dark" >#5F5F5F</color>
<color name="portal_black" >#323232</color>

<!-- basic colors -->
<color name="portal_green">#27D34D</color>
<color name="portal_blue">#2A91BD</color>
<color name="portal_orange">#FF9D2F</color>
<color name="portal_red">#FF432F</color>
向应用设计者那里要这个调色板，名称不需要跟 `"green"`、`"blue"` 等等相同。`"brand_primary"`、`"brand_secondary"`、`"brand_negative"` 这样的名字也是完全可以接受的。像这样规范的颜色很容易修改或重构，会使应用一共使用了多少种不同的颜色变得非常清晰。通常一个具有审美价值的 UI 来说，减少使用颜色的种类是非常重要的。

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

3.6.2 dimens.xml

像对待 colors.xml 一样对待 dimens.xml 文件，与定义颜色调色板一样，你同时也应该定义一个空隙间隔和字体大小的"调色板"。 一个好的例子，如下所示：

<!-- font sizes -->
<dimen name="portal_font_22">22sp</dimen>
<dimen name="portal_font_18">18sp</dimen>
<dimen name="portal_font_15">15sp</dimen>
<dimen name="portal_font_12">12sp</dimen>

<!-- typical spacing between two views -->
<dimen name="portal_spacing_40">40dp</dimen>
<dimen name="portal_spacing_24">24dp</dimen>
<dimen name="portal_spacing_14">14dp</dimen>
<dimen name="portal_spacing_10">10dp</dimen>
<dimen name="portal_spacing_4">4dp</dimen>

<!-- typical sizes of views -->
<dimen name="portal_button_height_60">60dp</dimen>
<dimen name="portal_button_height_40">40dp</dimen>
<dimen name="portal_button_height_32">32dp</dimen>
布局时在写 `margins` 和 `paddings` 时，你应该使用 `portal_spacing_xx` 尺寸格式来布局，而不是像对待 `string` 字符串一样直接写值，像这样规范的尺寸很容易修改或重构，会使应用所有用到的尺寸一目了然。 这样写会非常有感觉，会使组织和改变风格或布局非常容易。
3.6.3 strings.xml

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

名称 说明
portal_main_menu_about 主菜单按键文字
portal_friend_title 好友模块标题栏
portal_friend_dialog_del 好友删除提示
portal_login_check_email 登录验证
portal_dialog_title 弹出框标题
portal_button_ok 确认键
portal_loading 加载文字

3.6.4 styles.xml

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

应用到 TextView 中：


或许你需要为按钮控件做同样的事情，不要停止在那里，将一组相关的和重复 android:xxxx 的属性放到一个通用的 <style> 中。

3.7 id 命名

命名规则：view 缩写 模块名_{_页面名}_逻辑名，例如： portal_btn_main_search、portal_btn_back。

4注释规范

为了减少他人阅读你代码的痛苦值，请在关键地方做好注释。

4.1 类注释【强制】

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

/**

  • author : Blankj
  • time : 2017/03/07
  •  
 

*/
 public class WelcomeActivity {
 …
 }
 具体可以在 AS 中自己配制，进入 Settings -> Editor -> File and Code Templates -> Includes -> File Header，输入
 

/**
 

  •  
  • author : ${USER}
  • time :  
      
       
        
         
         
           Y 
          
         
           E 
          
         
           A 
          
         
           R 
          
         
        
          / 
         
        
       
         {YEAR}/ 
        
       
     YEAR/{MONTH}/${DAY}
  •  
 

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

4.2 方法注释【推荐】
 

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

/**
 

  • bitmap 转 byteArr
  • @param bitmap bitmap 对象
  • @param format 格式
  • @return 字节数组
     */
     public static byte[] bitmap2Bytes(Bitmap bitmap, CompressFormat format) {
     if (bitmap == null) return null;
     ByteArrayOutputStream baos = new ByteArrayOutputStream();
     bitmap.compress(format, 100, baos);
     return baos.toByteArray();
     }
 

4.3 块注释【推荐】
 

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

/*
 

  • This is
  • okay.
     */
 

// And so
 // is this.
 

/* Or you can
 

  • even do this. */
     注释不要封闭在由星号或其它字符绘制的框架里。
 

 
 
Tip：在写多行注释时，如果你希望在必要时能重新换行（即注释像段落风格一样），那么使用 /* ... */。
 

 

4.4 其他一些注释【推荐】
 

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

4.5.编码风格设定和检查工具
 

编码风格设定规范来源于Square的Android规范，编码风格检查规范来自于Google风格检查规范.
 

五、编码规范(P3C-Java)
 

包含集合处理、并发处理、控制语句、注释规约等，详情参考P3C官方文档。
 

六、其他规范【推荐】
 

  1.  
    合理布局，有效运用 <merge>、<ViewStub>、<include> 标签；
     
  2.  
    Activity 和 Fragment 里面有许多重复的操作以及操作步骤，所以我们都需要提供一个 BaseActivity 和 BaseFragment，让所有的 Activity 和 Fragment 都继承这个基类。
     
  3.  
    方法基本上都按照调用的先后顺序在各自区块中排列；
     
  4.  
    相关功能作为小区块放在一起（或者封装掉）；
     
  5.  
    当一个类有多个构造函数，或是多个同名函数，这些函数应该按顺序出现在一起，中间不要放进其它函数；
     
  6.  
    数据提供统一的入口。无论是在 MVP、MVC 还是 MVVM 中，提供一个统一的数据入口，都可以让代码变得更加易于维护。比如可使用一个 DataManager，把 http、preference、eventpost、database 都放在 DataManager 里面进行操作，我们只需要与 DataManager 打交道；
     
  7.  
    多用组合，少用继承；
     
  8.  
    提取方法，去除重复代码。对于必要的工具类抽取也很重要，这在以后的项目中是可以重用的。
     
  9.  
    可引入 Dagger2 减少模块之间的耦合性。Dagger2 是一个依赖注入框架，使用代码自动生成创建依赖关系需要的代码。减少很多模板化的代码，更易于测试，降低耦合，创建可复用可互换的模块；
     
  10.  
    项目引入 RxAndroid 响应式编程，可以极大的减少逻辑代码；
     
  11.  
    通过引入事件总线，如：EventBus、AndroidEventBus、RxBus，它允许我们在 DataLayer 中发送事件，以便 ViewLayer 中的多个组件都能够订阅到这些事件，减少回调；
     
  12.  
    尽可能使用局部变量；
     
  13.  
    尽量减少对变量的重复计算；如下面的操作：for (int i = 0; i < list.size(); i++) { …}建议替换为：for (int i = 0, len = list.size(); i < len; i++) { …}
     
  14.  
    尽量采用懒加载的策略，即在需要的时候才创建；例如：String str = “aaa”;if (i == 1) { list.add(str);}建议替换为：if (i == 1) { String str = “aaa”; list.add(str);}
     
  15.  
    不要在循环中使用 try...catch...，应该把其放在最外层；
     
  16.  
    使用带缓冲的输入输出流进行 IO 操作；
     
  17.  
    尽量使用 HashMap、ArrayList、StringBuilder，除非线程安全需要，否则不推荐使用 HashTable、Vector、StringBuffer，后三者由于使用同步机制而导致了性能开销；
     
  18.  
    尽量在合适的场合使用单例；使用单例可以减轻加载的负担、缩短加载的时间、提高加载的效率，但并不是所有地方都适用于单例，简单来说，单例主要适用于以下三个方面：
     
  19.  
    控制资源的使用，通过线程同步来控制资源的并发访问。
     
  20.  
    控制实例的产生，以达到节约资源的目的。
     
  21.  
    控制数据的共享，在不建立直接关联的条件下，让多个不相关的进程或线程之间实现通信。
     
  22.  
    把一个基本数据类型转为字符串，基本数据类型.toString() 是最快的方式，String.valueOf(数据) 次之，数据 + "" 最慢；
     
  23.  
    使用 AS 自带的 Lint 来优化代码结构（什么，你不会？右键 module、目录或者文件，选择 Analyze -> Inspect Code）；
     

                

                
                
        

        

    

  


    

      

        

            

              
                
                  Kint_Wq
                
              
            

            

                关注
              
            

        

        

          
      

      

            

                专栏目录
          









                



	

		

			

				
					
Android开发规范文档完整版

				
			

			

				

					09-22
				

			

		

		

			
				
Android开发规范文档，上传的为docx版本方便修改。

			
		

	



                

              
                



	

		

			

				
					
android之开发命名规范阿里文档

				
			

			

				

					lizhong
				

				

					08-22
					
					741
					
				

			

		

		

			
				
前言

一份合格的代码不应只满足于实现功能, 更应该遵循良好的规范. 遵循良好的代码规范有利于:


	提升程序稳定性, 减少代码隐患, 降低故障率;
	
	
	增强可扩展性, 大幅提高维护效率;
	
	
	统一标准, 提升多人协作效率;
	
	
	方便新人快速上手, 在项目组人员发生变动时保证项目进度;
	
这里梳理一下Android开发过程中需要注意的一些地方, 包括多个部分, 另外根据约束力...

			
		

	



                


  
              

                


	

		

			

				
					
周末福利：Android 开发规范（完结版）

				
			

			

				

					Android技术之家
				

				

					12-08
					
					1666
					
				

			

		

		

			
				
摘要1 前言2 AS 规范3 命名规范4 代码样式规范5 资源文件规范6 版本统一规范7 第三方库规范8 注释规范9 测试规范10 其他的一些规范1 前言为了有利于项目维护、增强代码可读性、提升 Code Review 效率以及规范团队安卓开发，故提出以下安卓开发规范，该规范结合本人多年的开发经验并吸取多家之精华，可谓是本人的呕心沥血之作，称其为当前最完善的安卓开发规范一点也不为过，如有更好建议，

			
		

	





	

		

			

				
					
Android的开发文档规范

				
			

			

				

					小范屯
				

				

					03-08
					
					919
					
				

			

		

		

			
				
Android的开发文档规范
我们项目的代码时间时间很长，经过太多人手，代码的规范性堪忧，目前存在较多的比较自由的「代码规范」，这非常不利于项目的维护，代码可读性也不够高。
分析现有项目的代码的情况，输出的『定制化规范』文档，用于提高代码的可读性和可维护性。
目的

对于个人：帮助团队写「正确」的代码，提升编程能力。
团队内部：统一项目的编码风格，降低维护『非自己模块』的成本
对外部门：交付更加稳定的产品，并降低后期的维护难度

准备及通用
开发工具配置规范
工欲善其事，必先利其器。

推荐使用最新的稳定版

			
		

	



		

			
		



	

		

			

				
					
Android开发规范文档

				
			

			

				

					Android_machong的博客
				

				

					09-17
					
					462
					
				

			

		

		

			
				
剑走偏锋终归会落下一些东西,以后会慢慢整理

1.   基本命名规则

 

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

对于理解应用程序的逻辑流，命名方案是最有影响力的一种帮助。名称应该说明“什...

			
		

	





	

		

			

				
					
自己总结的Android 开发规范文档

				
			

			

				

					11-02
				

			

		

		

			
				
本文档旨在为开发者提供一套全面且实用的Android开发规范指南，帮助开发者养成良好的编码习惯。  #### 二、标识符命名法  1. **驼峰命名法**（Camel Case）：  - **小驼峰命名法**：用于变量和方法，首单词首字母...

			
		

	





	

		

			

				
					
Android开发规范参考文档.docx编程资料

				
			

			

				

					04-09
				

			

		

		

			
				
本文档旨在全面解析《Android开发规范参考文档》中的关键知识点，包括编码规范、命名规则、资源管理等多个方面，以帮助开发者提高代码质量、增强应用性能。  #### 一、Java编码规范  1. **代码中的字符限制**   - ...

			
		

	





	

		

			

				
					
Android开发规范参考文档.pdf

					
最新发布

				
			

			

				

					04-02
				

			

		

		

			
				
《Android开发规范参考》文档详述了Android应用开发过程中的编码和设计规范，旨在提高代码质量和维护性。以下是一些核心要点的详细说明：  1. **编码规范**：  - **Java代码规范**：禁止在代码中使用中文，除非在...

			
		

	





	

		

			

				
					
Android开发规范参考文档(北京试行).doc

				
			

			

				

					06-28
				

			

		

		

			
				
以下是一些从《Android开发规范参考文档(北京试行)》中提取的关键点：  1. **编码语言限制**：Java代码中禁止出现中文，除非是在注释中。XML代码中的注释应使用`<!-- -->`包裹。  2. **变量命名规范**：  - 成员变量...

			
		

	





	

		

			

				
					
Android开发之Android开发规范(初)

				
			

			

				

					weixin_34033624的博客
				

				

					02-02
					
					156
					
				

			

		

		

			
				
首先，说一下Android开发规范之编码规范1，java代码中不出现中文，最多注释中可以出现中文，中文统一写在strings.xml中；2，局部变量命名、静态成员变量命名 只能包含字母，单词首字母大写，其他字母都为小写3，常量命名只能包含字母和_，字母全部大写，单词之间用_隔开4，布局文件中的id命名命名模式为：view缩写_模块名称_view的逻辑名称常用控件的缩写如下LayoutView：lv...

			
		

	





	

		

			

				
					
Android开发规范.pdf

				
			

			

				

					09-27
				

			

		

		

			
				
Android开发规范.pdf

			
		

	





	

		

			

				
					
Android开发文档

				
			

			

				

					01-07
				

			

		

		

			
				
浅显易懂的介绍Android开发的基础知识，适合刚入门的移动开发工程师，大佬请忽略

			
		

	





	

		

			

				
					
Android开发技术文档

				
			

			

				

					04-16
				

			

		

		

			
				
Android开发技术文档 Android开发技术文档 Android开发技术文档 Android开发技术文档

			
		

	





	

		

			

				
					
Android开发初学者必看文档：Android开发规范

				
			

			

				

					lxjhoney的博客
				

				

					12-30
					
					322
					
				

			

		

		

			
				
Android开发初学者必看文档：Android开发规范

			
		

	





	

		

			

				
					
Android开发规范

				
			

			

				

					从0到1，突破自己
				

				

					06-11
					
					8896
					
				

			

		

		

			
				
1 介绍

1.1 目的



减少维护花费。

提高可读性。

加快工作交接。

减少名字增生。

降低缺陷引入的机会。


1.2 术语和定义

强制：编程时必须遵守的规定，含有强制字样或字体用加粗式样标注。
推荐：编程时推荐遵守的规定，字体用普通式样标注。

2 文件组织

避免超过 2000 行的源文件。

2.1 Java 包和源文件


			
		

	





	

		

			

				
					
Android官方开发文档下载

				
			

			

				

					DaleyZou的博客
				

				

					04-19
					
					5216
					
				

			

		

		

			
				
Android官方开发文档 docs-24_r02.rar（链接：https://pan.baidu.com/s/12xC998JeUHj3ndfDXPM2ww 密码：bxyk）



ADT下载、Android Studio下载：https://www.cnblogs.com/bjzhanghao/archive/2012/11/14/android-platform-sdk-download...

			
		

	





	

		

			

				
					
移动Android开发-规范文档

				
			

			

				

					wzgiceman
				

				

					09-10
					
					6812
					
				

			

		

		

			
				
Android规范文档

本手册以开发者为中心视角分为 Java 语言规范， Android 资源文件命名与使用，Android 基本组件，UI 与布局，进程、线程与消息通信， 文件与数据库，Bitmap、Drawable 与动画，安全，其他等九大部分，根据约束力强弱， 规约依次分为强制、推荐、参考三大类:


【强制】必须遵守，违反本约定或将会引起严重的后果;
【推荐】尽量遵守，长期遵守有助于系...

			
		

	





	

		

			

				
					
Android 开发规范（完结版）

				
			

			

				

					m0_69789996的博客
				

				

					04-24
					
					512
					
				

			

		

		

			
				
单个的大写字母，后面可以跟一个数字（如：E, T, X, T2）。
以类命名方式（参考3.2 类名），后面加个大写的 T（如：RequestT, FooBarT）。

更多还可参考：[阿里巴巴 Java 开发手册](()
4 代码样式规范
4.1 使用标准大括号样式
左大括号不单独占一行，与其前面的代码位于同一行：
class MyClass {
int func() {
if (something) {
// …
} else if (somethingElse) {
// …
} else {
// .

			
		

	





	

		

			

				
					
Android 开发规范（一）

				
			

			

				

					代码君
				

				

					04-03
					
					840
					
				

			

		

		

			
				
书写规范



1. 编码方式

统一用UTF-8. Android Studio默认已是UTF-8，只要不去改动它就可以了。 




2. 缩进

统一为4个空格，将Tab size设置为4则可以保证tab键按4个空格缩进。另外，不要勾选上Use tab character，可以保证切换到不同tab长度的环境时还能继续保持统一的4个空格的缩进样式。 
 



3. 花括号



public...

			
		

	





	

		

			

				
					

				
			

			

				

					
				

			

		

		

			
				

			
		

	



              




          




        



    





    



      

      

        
      

      





	

		评论	
	

	
	




  

    

      添加红包
      
    

    

      

        
        

          
          
        

        
请填写红包祝福语或标题

      

      

        
        

          
          个
        

        
红包个数最小为10个

      

      

        
        

          
          元
        

        
红包金额最低5元

      

      

        
        

          当前余额3.43元
          前往充值 >
        

      

      

        

          需支付：10.00元
        

        
        
      

    

  





  

    
    
  

  

    
    
  








  

    

      

        

          

            
            
成就一亿技术人!

          

          

        

        

          

          

            领取后你会自动成为博主和红包主的粉丝
            规则
          

        

      

      

        

          

            
              
            
            

              
hope_wisdom
 发出的红包
            

          

        

        

          

          

          

        

      

    

    

  



      
      

      
实付元

      
使用余额支付

      

        

          

            
            点击重新获取
          

        

        
扫码支付

      

      

        
          
            
          
          
        
      

      

        
        钱包余额
          0
          

            
            

              

                
抵扣说明：

                
 1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
 2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

              

            

          

      

      余额充值