CHA1-Structure——3.如何组织工程的源文件

原文:Organizing your Source Files

概述


Android应用程序代码应该使用清晰的文件夹结构整齐地组织,这样可以使代码更清晰地阅读。另外,代码和类的恰当的命名约定,是保证代码清晰可维护的重要方式。

命名约定

一定要阅读Ribot的代码和风格指南,以获得在代码风格和命名指南上的详细解释说明。

对于Java代码

以下命名和大小写约定在Java代码中非常重要:

Type Example Description Link
Variable incomeTaxRate All variables should be camel case Read More
Constant DAYS_IN_WEEK All constants should be all uppercase Read More
Method convertToEuroDollars All methods should be camel case Read More
Parameter depositAmount All parameter names should be camel case Read More

参看命名指南来了解更多的细节。

对于Android类

Android类应该以特殊的约定方式命名,使得类的作用能够通过名字清晰的表述出来。例如所有的Activity应该以Activity结尾,比如MoviesActivity。以下是Android类中重要的命名约定:

Name Convention Inherits
Activity CreateTodoItemActivity AppCompatActivity, Activity
List Adapter TodoItemsAdapter BaseAdapter, ArrayAdapter
Database Helper TodoItemsDbHelper SQLiteOpenHelper
Network Client TodoItemsClient N/A
Fragment TodoItemDetailFragment Fragment
Service FetchTodoItemService Service, IntentService

在对其他类型的文件命名前请认真思考,目标是对任意特定的Android类能够通过后缀进行标识。

Android项目的文件夹结构组织

在组织应用的包结构时,有几个最佳实践可供参考。

按类别组织包的结构

实现这一点的方法是按类别将事物进行分组,每个组件都聚集在相关的包中。

  • com.example.myapp.activities - 包含所有的Activity
  • com.example.myapp.adapters - 包含所有的自定义Adapter
  • com.example.myapp.models - 包含所有的数据模型
  • com.example.myapp.network - 包含所有网络操作相关的代码
  • com.example.myapp.fragments - 包含所有的Fragment
  • com.example.myapp.utils - 包含所有的帮助类支持代码
  • com.example.myapp.interfaces - 包含所有的接口

在应用中以上述方式组织文件夹结构逻辑较为清晰,阅读代码时会相对舒适。你可以通过Futurice的最佳实践中看到它们在这种结构基础上所做的轻微修改。

按应用特性组织包的结构

或者,我们可以按特性而不是按层进行组织。这种方式将包映射成特性集合。考虑下述的包结构:

  • com.example.myapp.service.* - 它是所有与后台相关的服务包/类的子包
  • com.example.myapp.ui.* - 它是所有UI相关包/类的子包
  • com.example.myapp.ui.mainscreen - 包含一些应用主屏幕相关的类
  • com.example.myapp.ui.detailsscreen - 包含一些应用的详情页Item相关的类

这个特性允许你将DetailsActivity, DetailsFragment, DetailsListAdapter, DetailsItemModel 放在一个包里,当处理“Item详情”功能时,它可以提高方便的导航。

DetailsListAdapter and DetailsItemModel类或它们的属性可被定义为包私有级别,因此不会暴露在包外。在包内你可以直接访问它的属性而避免了生成大量的“setter”方法。

这可以使对象的创建简单直观,并且对象在包外保持不变。

资源的组织


资源应该被拆分成以下主要的文件和文件夹:

Name Path Description
XML Layouts res/layout/ This is where we put our XML layout files.
XML Menus res/menu/ This is where we put our AppBar menu actions.
Drawables res/drawable This is where we put images and XML drawables.
Colors res/values/colors.xml This is where we put color definitions.
Dimensions res/values/dimens.xml This is where we put dimension values.
Strings res/values/strings.xml This is where we put strings.
Styles res/values/styles.xml This is where we put style values.

查看完整的资源列表并注意以下事项:

  • 不要在布局中使用十六进制硬编码的方式设置颜色值. 不要使用硬编码值,而是要将所有的颜色值放入res/values/colors.xml,并在布局中以@color/royal_blue的方式引用颜色。

  • 不要在布局中使用硬编码的方式设置margin/padding的尺寸值. 不要使用硬编码值,而是要将[所有尺寸值](http://developer.and放入res/values/dimens.xml,并在布局中以@dimen/item_padding_left的方式引用它们。

  • 为了支持多设备,我们可以使用可选的资源系统,基于不同的设备类型,屏幕尺寸以及API版本提供不同的颜色、字符串、尺寸和样式值等。

确保在开发应用时尽早地使用正确的方式组织资源。一定要参考Ribot代码和风格指南以获得在样式和命名约定上的深度建议。

将资源组织到子目录中

有些问题不仅如何组织源文件,而且还会涉及如何更好地组织应用程序资源。在当前的应用程序中,动辄会有成百上千的不同layouts,drawables,styles等,并且在默认情况下,它们都分在同一个类别列表下,在单个的子目录中(如res/layout)。

为进一步整理或对各种资源进行分组,最好的方式是安装Android Studio的第三方folding-plugin来创建虚拟文件夹。

<a href="https://github.com/dmytrodanylyk/folding-plugin">

</a>

有关其他选项的讨论,请参考StackOverflow上的文章

结论


上述方式中哪一个最适合你的项目,最终还是由你来决定。
 然而,通常在Java 程序中,按特性对应用结构进行分包被认为更好一些,并且更有意义。

参考引用


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

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,050评论 25 707
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,497评论 18 139
  • 太长了,还是转载吧...今天在看博客的时候,无意中发现了@Trinea在GitHub上的一个项目Android开源...
    庞哈哈哈12138阅读 20,100评论 3 283
  • afinalAfinal是一个android的ioc,orm框架 https://github.com/yangf...
    passiontim阅读 15,360评论 2 44
  • 梦到我三姑跳楼了,哭醒,站着哭坐着哭趴着哭哭到胳膊发麻发抖,给我爸打电话他以为信号不好挂了,为什么会做这种梦,我日他妈
    琢磨啥呢阅读 187评论 0 0