Android工程规范V1.0

宽仁Android工程规范

李春旺

2016-07-15

为了规范公司代码规范，使开发人员间协作顺畅，制定该规范。

前端技术主要采用Java体系，采用studio的gradle进行依赖管理并且使用其标准顶级目录结构。

主框架：MVC+retrofit2+eventbus+butterknife。

JDK版本：JDK8以上

代码字符编码格式：UTF8

日志组件：log（原生）

一、工程结构

appname

|—app/src/main/java

|————com.kuanrf.xxx

|----------------androidTest

|----------------项目编码

|------------------------业务模块名称1

|--------------------------------adapter

|----------------------------------------XxxxAdapter.java

|

|————————————————common

|—————————————————-—enums

|—————————————————————XxxxxType.java |

|————————————————-—helper

|—————————————————————XxxxxHelper.java

|

|————————————————-—modle

|—————————————————————XxxxxInfo.java

|

|————————————————-—network

|—————————————————————XxxxxCallback.java

|—————————————————————XxxxxModle.java |

|————————————————-—thread

|—————————————————————XxxxxCommonThreadPool.java |

|————————————————-—ui

|——————————————————Constants

|——————————————————IpConfig

|——————————————————Message

|———————————————————-——GSXxxx.java

|

|--------------------------------event

|----------------------------------------XxxxEvent.java

|------------------------------------------------XxxxxDaoImpl.java

|

|--------------------------------fragment

|----------------------------------------XxxxFragment.java

|

|--------------------------------main

|————————————————————ApiClient.java |————————————————————SplashUI.java

|————————————————————DatabaseListener.java |————————————————————GSXxxx.java

|————————————————————XxxxManager.java

|————————————————————XxxxReceiver.java

|

|————————————————task

|————————————————————XxxxTask.java

|

|————————————————ui

|————————————————————XxxxUI.java

|

|————————————————viewholder

|————————————————————XxxxViewHolder.java |

|————————————————wxapi

|————————————————————WXXxxActivity

|------------------------业务模块名称2

|--src/main/res

|

|----------color

|—————————common_xxx_xxx_selector.xml

|—————————xxx_segment_text_selector.xml

|—————————segment_text_dselector.xml

|—————————tab_title_selector.xml

|

|----------drawable

|—————————btn_xxx_xxx.xml

|—————————that_xxx.xml

|—————————commom_button_xxx.xml

|—————————commom_item_xxx.xml

|—————————commom_segment_xxx_xxx.xml

|—————————commom_strkoe_xxx_xxx.xml

|—————————commom_trans_rect_xxx.xml

|—————————icon_xxx_xxx.xml

|—————————intro_start_xxx.xml

|—————————issue_item_bg_xxx.xml

|—————————main_msg_xxx.xml

|—————————recore_segment_xxx.xml

|—————————reset_segment_xxx.xml

|—————————search_bar_xxx.xml

|—————————self_text_bg_xxx.xml

|—————————setting_item_top_xxx.xml

|—————layout(布局)

|

|—————drawable(样式)

|

|—————values(样式)

二、命名规则

1、java命名规范

1.1常量

一个或多个英文单词的组合，所有字母均大写，单词之间以“_”分隔，如：

public static final String UPDATE_FLAG = “T”；

final double PI = 3.14；

一般情况下常量的public等修饰符不可少。

1.2变量

一个或多个英文单词的组合，第一个单词的首字母小写，其他单词首字母均大写，其余所有字母均小写。如:

private ProjectSes projectSes;

private static String providerUrl = “http://127.0.0.1”;

一般情况下类变量（静态变量）及实例变量的public等修饰符不可少。

基础类型如int、boolean、long等数据类型，尽量采用对象类型，如：Integer、Boolean、Long。