Android部分代码规范

最新推荐文章于 2024-04-10 00:18:30 发布

csdn_WZM

最新推荐文章于 2024-04-10 00:18:30 发布

阅读量267

点赞数

分类专栏：代码规范

本文链接：https://blog.csdn.net/w296365959/article/details/105240723

版权

代码规范专栏收录该内容

0 篇文章 0 订阅

订阅专栏

看看其他其他别人的博文百度android规范

//下面的记录可做参考
1.Android Studio要求
尽量使用最新的稳定版的 IDE 进行开发；
编码格式统一为 UTF-8；
编辑完 .java、.xml 等文件后一定要格式化；
删除多余的 import，减少警告出现，可利用 AS 的 Optimize Imports（Settings -> Keymap -> Optimize Imports）快捷键；
2.命名规范
代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注：国际通用名称可直接写，如 taobao、hangzhou等。

2.1 包名
包名全部小写，连续的单词只是简单地连接起来，不使用下划线，采用反域名命名规则，全部使用小写字母。

2.2 类名
类名都已UpperCamelCase驼峰式命名方法且首字母大写，尽量避免缩写。Android中特殊类命名遵守如下规则
在这里插入图片描述
测试类的命名以它要测试的类的名称开始，以 Test 结束。
接口：命名规则与类一样采用大驼峰命名法。

2.3 方法名
方法名都以 lowerCamelCase 风格编写。方法命名通常是动词或者动词短语如下图：
在这里插入图片描述
方法名风格

2.4 常量，类全局变量，局部变量，参数名

常量：常量名命名模式为 CONSTANT_CASE，全部字母大写，用下划线分隔单词。
类全局变量：驼峰式规则，已m开头，后面加上有意义的英文单词(具体干什么事的)，如果是UI控件则m后面加上控件缩写在加有意义的英文单词(指明具体干什么事的)。
局部变量：驼峰式规则，且有意义。不能随意命名。
参数名：参数名以 lowerCamelCase 风格编写，参数应该避免用单个字符命名。

2.5 字符串常量的命名和值
Android SDK 中的很多类都用到了键值对函数，比如SharedPreferences、Bundle、Intent，所以，即便是一个小应用，我们最终也不得不编写大量的字符串常量。当时用到这些类的时候，我们必须将它们的键定义为 static final 字段，并遵循以下指示作为前缀。
在这里插入图片描述
常量的命名和值

3.代码样式规范
3.1 使用标准大括号样式
左大括号不单独占一行，与其前面的代码位于同一行如：

class MyClass {
    int func() {
        if (something) {
            // ...
        } else if (somethingElse) {
            // ...
        } else {
            // ...
        }
    }
}

不论什么情况下条件语句周围添加大括号。

3.2 编写简短方法
在可行的情况下，尽量编写短小精炼的方法。我们了解，有些情况下较长的方法是恰当的，因此对方法的代码长度没有做出硬性限制。如果某个方法的代码超出 40 行，请考虑是否可以在不破坏程序结构的前提下对其拆解。

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

常量
字段
构造函数
重写函数和回调
公有函数
私有函数
内部类或接口
如：

public class MainActivity extends Activity {
    private static final String TAG = MainActivity.class.getSimpleName();
    private String mTitle;
    private TextView mTvTitle;

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

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

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

4.1.动画资源文件（anim/ 和animator/）
安卓主要包含属性动画和视图动画，其视图动画包括补间动画和逐帧动画。属性动画文件需要放在 res/animator/ 目录下，视图动画文件需放在 res/anim/ 目录下。
命名规则：{模块名}逻辑名称。
说明：{} 中的内容为可选，逻辑名称可由多个单词加下划线组成。
例如：refresh_progress.xml、market_cart_add.xml、market_cart_remove.xml。
如果是普通的补间动画或者属性动画，可采用：动画类型方向的命名方式。
例如：
在这里插入图片描述

4.2.颜色资源文件（color/）
专门存放颜色相关的资源文件。
命名规则：类型_逻辑名称。
例如：sel_btn_font.xml。

4.3.图片资源文件（drawable/ 和 mipmap/）
图片资源统一放在 xhdpi 目录下。有其他特殊的可单独考虑
命名规则：类型{模块名}逻辑名称、类型{模块名}颜色。

4.4.布局资源文件（layout/）
命名规则：类型模块名、类型{模块名}_逻辑名称。
说明：{} 中的内容为可选。
例如：
在这里插入图片描述

4.5.菜单资源文件（menu/）
菜单相关的资源文件应放在该目录下。
命名规则：{模块名_}逻辑名称
说明：{} 中的内容为可选。
例如：main_drawer.xml、navigation.xml。

4.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。
Colors的 name 命名使用下划线命名法，在你的 colors.xml 文件中应该只是映射颜色的名称一个 ARGB 值，而没有其它的。不要使用它为不同的按钮来定义 ARGB 值。
例如，不要像下面这样做：

 <resources>
      <color name="button_foreground">#FFFFFF</color>
      <color name="button_background">#2A91BD</color>
      <color name="comment_background_inactive">#5F5F5F</color>
      <color name="comment_background_active">#939393</color>

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

<resources>
      <color name="white"     >#FFFFFF</color>
      <color name="gray_light">#DBDBDB</color>
      <color name="gray"      >#939393</color>
      <color name="color_F2F2F2"> #F2F2F2</color>
       <color name="color_666666"> #666666</color>

Dimens
dimens.xml 文件中应该只是映射一个具体的大小值.如:

<resources>
    <!-- font sizes -->
    <dimen name="sp_22">22sp</dimen>
    <dimen name="sp_18">18sp</dimen>
    <dimen name="sp_15">15sp</dimen>
    <dimen name="sp_12">12sp</dimen>
    <!-- typical spacing between two views -->
    <dimen name="dp_40">40dp</dimen>
    <dimen name="dp_24">24dp</dimen>
    <dimen name="dp_14">14dp</dimen>

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

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

4.7.id命名
命名规则：view缩写{模块名}逻辑名，例如： btn_main_search、btn_back。

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

5.1.注释类
每个类完成后应该有作者姓名和简单描述.

/**
 * @author xxx
 * @time 2020/01/01
 * @describe xxx
 * @package 
 */
public class TestActivity {
   ...
}

具体可以在 AS 中自己配制，进入 Settings -> Editor -> File and Code Templates -> Includes -> File Header，输入指定注释模板

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

6.其他的一些规范
1、合理布局，有效运用 < merge>、< ViewStub>、< include> 标签
2、Activity 和 Fragment 里面有许多重复的操作以及操作步骤，所以我们都需要提供一个 BaseActivity 和 BaseFragment，让所有的 Activity 和 Fragment 都继承这个基类。
3、方法基本上都按照调用的先后顺序在各自区块中排列；
4、相关功能作为小区块放在一起（或者封装掉）；
5、当一个类有多个构造函数，或是多个同名函数，这些函数应该按顺序出现在一起，中间不要放进其它函数；
6、提取方法，去除重复代码。对于必要的工具类抽取也很重要，这在以后的项目中是可以重用的。
7、尽可能使用局部变量；
8、及时关闭流；
9、使用 AS 自带的 Lint 来优化代码结构
10、最后不要忘了内存泄漏的检测；

csdn_WZM

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
Android部分代码规范

1.Android Studio要求尽量使用最新的稳定版的 IDE 进行开发；编码格式统一为 UTF-8；编辑完 .java、.xml 等文件后一定要格式化；删除多余的 import，减少警告出现，可利用 AS 的 Optimize Imports（Settings -> Keymap -> Optimize Imports）快捷键；2.命名规范代码中的命名严禁使用拼音与...
复制链接

扫一扫