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使用:


第三方库

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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,470评论 6 501
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,393评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,577评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,176评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,189评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,155评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,041评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,903评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,319评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,539评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,703评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,417评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,013评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,664评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,818评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,711评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,601评论 2 353