android 开发规范 (1) - 工程 / 项目

工程命名：

这里直说 android 工程，android 的工程命名很简单，这个项目叫什么，工程名我们就怎么叫，比如微信 - weixin。可以使用拼音，但是推荐尽量不使用拼音，另外全小写

Snip20171213_50.png

如上图，就是我们新建一个android项目时，我们填入的名字对应的位置。

---

根包名：

* 包名全部小写
* 一级包名是顶级域名，通常为 com、edu、gov、net、org 等
* 二级包名为公司名
* 三级包名就是项目名

这符合上图显示的部分。

---

模块

Android 发展到现今，模块分离是一种通常，必须的做法。模块有时候很大，又会分解成2级模块，所以模块的命名一定要有传承性。

* 模块名：

上级模块名+本模块名+module，中间使用_连接，没有上级模块就不要加上了，module表示模块，可以根据喜好选择加不加上，一般还是要加上。

* 包名：

在项目包名的基础上，加上：
* 四级包名：上级模块名
* 五级包名：本模块名
* 没有上级模块的不用加

* 模块分层：

通常我们按照以下几个基本方面对模块进行划分：
* core(能力层。与具体业务无关，提供能力）
* base(基础服务层。可以独立存在，有且只有一个具有实际意义的服务，不依赖于其他的服务）
* business(业务服务层。依赖多个基础服务，一般是一个流程性的服务)

• 参考以上的代码结构，按功能分包具体可以这样做：

com
└── domain
    └── app
        ├── App.java 定义 Application 类
        ├── Config.java 定义配置数据（常量）
        ├── base 基础组件
        ├── custom_view 自定义视图
        ├── data 数据处理
        │   ├── DataManager.java 数据管理器，
        │   ├── local 来源于本地的数据，比如 SP，Database，File
        │   ├── model 定义 model（数据结构以及 getter/setter、compareTo、equals 等等，不含复杂操作）
        │   └── remote 来源于远端的数据
        ├── feature 功能
        │   ├── feature0 功能 0
        │   │   ├── feature0Activity.java
        │   │   ├── feature0Fragment.java
        │   │   ├── xxAdapter.java
        │   │   └── ... 其他 class
        │   └── ...其他功能
        ├── injection 依赖注入
        ├── util 工具类
        └── widget 小部件

---

统一依赖

module 中涉及到的依赖库版本应该和主 app 保持一致，我们应该维护一个各模块依赖基础版本库，当主项目摸个依赖版本过于低下时，我们也应该在主项目处修改依赖库版本，而不是把依赖版本下方到每个模块中，虽然 studio 工具可以较好的扫描，合并每个模块的依赖库版本然后取其中最高的，但是这是被动的，我们应该主动的发起依赖管理，通畅的做法，都是在根目录中新建 一个config.gradle 脚本，然后在里面书写依赖库版本号，然后作为全局变量提供给依赖的 module使用：

• 大家可以看这篇：Android 开发之版本统一规范
• 也可以去看这篇：关于组件化开发使用 gradle统一配置版本，依赖

---

第三方库

关于第三方开源库的问题，我们应该使用那些优秀的，广为人知的优秀的库，那么优秀的库怎么找呢，看这里：

• Android 流行框架查速表
• Android开源项目及资源查速表