Android编码规范

团队协作

前言

本文适用范围：已参加项目开发的人

写这篇文章的目的是为方便地对代码进行管理，让整个团队的代码规范化。这里的部分规定可能和你在其他地方看到的不一样，但还是请遵守这些规则。

编码规范是泯灭程序猿个性的一项制度，但对于整个团队而言，却是一件利器。

设置 AndroidStudio的 CodeStyle

• 使用Mac开发
• 使用Window开发

样式文件，请到/BitTorrent Sync/技术部/代码规范/android.xml自行查找。

项目结构规范

java/package-name/
../app 实现业务逻辑
../libs 对接第三方服务（内部、外部均可）
../tools 开发使用的小工具（如自动换算dimens）

类的命名

• activity类，命名以Activity为后缀，如：LoginActivity
• fragment类，命名以Fragment为后缀，如：ShareDialogFragment
• service类，命名以Service为后缀，如：DownloadService
• adapter类，命名以Adapter为后缀，如：CouponListAdapter
• 工具类，命名以Util为后缀，如：EncryptUtil
• 模型类（实例类），命名以Entity为后缀，如：VersionEntity
• 接口实现类，命名以Impl为后缀，如：ApiImpl
• 独立逻辑块，命名以Action为后缀，如：ToastAction
• 观察者数据类，命名以Event为后缀，如：LoginInvalidEvent
• Component类，命名以Component为后缀，如：AppComponent
• Module类，命名以Module为后缀，如：LoginModule
• Job类（处理耗时操作），命名以Job为后缀，如：LoginJob
• JobService类，命名以JobService为后缀，如：GcmJobService
• Model（数据管理类），命名以Model为后缀，如：CallModel
• ViewModel，命名以ViewModel为后缀，如：CallActivityViewModel
• Task（处理耗时操作，后续不再维护），命名以Task为后缀，如：LoginTask

方法命名

• 初始化方法，以init开头，如：initInstance()
• 创建实例方法，以make开头，如：makeInstance()
• 获取实例方法，以obtain开头，如：obtainInstance()
• 加载数据方法，以fetch开头，如：fetchInstances()
• 布尔类型判断方法，以is等“逻辑”动词开头，如：isNecessary()
• 其他之后完善

命名法则：言简意赅、无二义性。

变量命名

在Java中命名变量：

命名规则：{权限控制符}+{所属功能块}+{功能具体描述}+{类型}

// 举例如下：
protected Button mLoginCommitButton;
private Button iRegisterVerifyButton;
public User user;
public static Wallet sWallet;
public static final String BUNDLE_KEY_LOGIN_ID = "key_login_id";

权限控制符

private 变量命名为：mLoginButton，添加m前缀。
protected/package 变量命名为：mLoginButton，添加m前缀。
public 变量命名为：loginButton，无前缀。

局部变量

方法内的局部变量以_作为前缀，如：“_user”。

静态变量

static 变量命名为：sInstance，，添加s前缀。(忽略private/protected/public规则影响)
static final 变量命名为：{类型}+{功能描述}+{业务描述}，如：BUNDLE_KEY_LOGIN_ID;(忽略private/protected/public规则影响)

所属功能块及具体功能描述

按照业务逻辑划分的功能块；

• 可按页面划分：登录界面等。
  
  • 登录界面中的登陆按钮。
  • 登录界面中的发送验证码按钮。
  • ...
• 可按功能划分：登录功能等。
  
  • 登陆功能中的登陆功能。
  • 登陆功能中的验证验证码功能。
  • ...

类型

• 视图控件
  

  在Java中定义控件均为全拼，结合访问权限为protected，则命名为mButton;

• 其他类型参考类命名规则。

在XML中命名变量

在XML中定义的控件命名为: {控件类型}+{所属功能块}+{功能具体描述};
举例：textview_toolbar_title 。

布局命名

• activity，以activity_为前缀命名，如：activity_login；
• fragment，以fragment_为前缀命名，如：fragment_login；
• dialog，以dialog_为前缀命名，如：dialog_login；
• item，以item_{类型}为前缀命名
  
  • item_list
  • item_grid
  • item_recycle
  • ...
• header，以header_为前缀命名
  
  • header_list
  • header_grid
  • ...
• footer，以footer_为前缀命名
  
  • footer_list
  • footer_grid
  • ...
• content，以content_为前缀命名，可可复用的布局。
• layout，以layout_为前缀命名，用于LoaderLayout加载的布局。

资源文件命名(res)

dimens

• /values/dimens.xml 用于定义需要适配多个分辨率的引用。

    <dimen name="_font_title_large">@dimen/text_size_24</dimen>
    <dimen name="_font_title">@dimen/text_size_20</dimen>
    <dimen name="_font_midtitle">@dimen/text_size_18</dimen>
    <dimen name="_font_subtitle">@dimen/text_size_17</dimen>
    <dimen name="_font_head">@dimen/text_size_15</dimen>
    <dimen name="_font_text">@dimen/text_size_14</dimen>
    <dimen name="_font_annotation">@dimen/text_size_12</dimen>

• /values-{分辨率}/dimens.xml 用于定义各个分辨率下的模板。

    <dimen name="text_size_8">8sp</dimen>
    <dimen name="text_size_10">10sp</dimen>
    <dimen name="text_size_11">11sp</dimen>
    <dimen name="text_size_12">12sp</dimen>
    <dimen name="text_size_13">13sp</dimen>
    <dimen name="text_size_14">14sp</dimen>
    <dimen name="text_size_15">15sp</dimen>
    <dimen name="text_size_16">16sp</dimen>
    <dimen name="text_size_17">17sp</dimen>
    <dimen name="text_size_18">18sp</dimen>
    <dimen name="text_size_20">20sp</dimen>
    <dimen name="text_size_22">22sp</dimen>
    <dimen name="text_size_24">24sp</dimen>

numerics.xml

用于定义与单位(sp/px/dp等)无关的数值类型。

    <item name="card_scale_rate" format="float" type="dimen">0.7</item>
    <item name="card_scale_rate_origin" format="float" type="dimen">1.0</item>

styles.xml

<!--  FONT  -->
<style name="Font"/>
<style name="Font.Accent" parent="Font"/>
<style name="Font.Accent.High">
<item name="android:textColor">@color/text_accent_high</item>
</style>
<!-- 文章标题 字体更大 -->
<style name="Font.Accent.High.TitleLarge.Bold" parent="@style/Font.Accent.High">
<item name="android:textSize">@dimen/_font_title_large</item>
<item name="android:textStyle">bold</item>
</style>
<!-- 文章标题 -->
<style name="Font.Accent.High.Title.Bold" parent="@style/Font.Accent.High">
<item name="android:textSize">@dimen/_font_title</item>
<item name="android:textStyle">bold</item>
</style>
<!-- 一级标题 -->
<style name="Font.Accent.High.Subtitle.Bold" parent="@style/Font.Accent.High">
<item name="android:textSize">@dimen/_font_subtitle</item>
<item name="android:textStyle">bold</item>
</style>
<!-- 正文 -->
<style name="Font.Accent.High.Subtitle.Normal" parent="@style/Font.Accent.High">
<item name="android:textSize">@dimen/_font_subtitle</item>
<item name="android:textStyle">normal</item>
</style>
<!-- 二级标题 -->
<style name="Font.Accent.High.Head.Normal" parent="@style/Font.Accent.High">
<item name="android:textSize">@dimen/_font_head</item>
<item name="android:textStyle">normal</item>
</style>
<!-- 三级标题 -->
<style name="Font.Accent.High.Text.Normal" parent="@style/Font.Accent.High">
<item name="android:textSize">@dimen/_font_text</item>
<item name="android:textStyle">normal</item>
</style>
<!-- 注释 强调（会员首页检测指标） -->
<style name="Font.Accent.High.Annotation.Normal" parent="@style/Font.Accent.High">
<item name="android:textSize">@dimen/_font_annotation</item>
<item name="android:textStyle">normal</item>
</style>
<!-- 重要性中等的文本颜色，如简介、地址和联系方式等 -->
<style name="Font.Accent.Mid" parent="Font.Accent">
<item name="android:textColor">@color/text_accent_mid</item>
</style>

colors.xml && colors_basic.xml

colors_basic.xml

    <!-- 灰度色阶模板-->
    <color name="_grey_0">#FFFFFF</color>
    <color name="_grey_50">#FAFAFA</color>
    <color name="_grey_100">#F5F5F5</color>
    <color name="_grey_200">#EEEEEE</color>
    <color name="_grey_300">#E0E0E0</color>
    <color name="_grey_400">#BDBDBD</color>
    <color name="_grey_500">#9E9E9E</color>
    <color name="_grey_600">#757575</color>
    <color name="_grey_700">#616161</color>
    <color name="_grey_800">#424242</color>
    <color name="_grey_900">#212121</color>
    <color name="_grey_1000">#000000</color>

colors.xml

    <!--文本-->
    <color name="text_white">@color/_white</color>
    <color name="text_hint">@color/_grey_300</color>
    <color name="text_band">@color/_band</color>
    <color name="text_accent_high">@color/_accent_high</color>
    <color name="text_accent_mid">@color/_accent_mid</color>
    <color name="text_accent_low">@color/_accent_low</color>
    <color name="text_accent_warn">@color/_accent_warn</color>

Git-Flow 开发规范