Android的API设计

  1. 简单明确
    单个单词简单明确
    //例:
     size();
     remove();
     removeAll()
    
    //反例:
     countObservers();
     deleteObserver(Observer);
     deleteObservers();
    
    约束规则:在创建方法时,需要遵守一定的规则,方便调用者理解,相互关联的方法可以考虑保留一致的前缀或后缀
    //例:
     execute(String);
     executeBatch();
     executeQuery(String);
     executeUpdate(String);
    
  2. 限制长度
    不要超过4个单词,这样会大大降低可读性,虽然作用显得更明确,但是太过啰嗦
    反例:AbstractBeanFactoryBasedTargetSourceCreator
  3. 参数限制
    方法里有过多参数往往让人不能明确区分其作用,特别在重载方法时,多个方法参数五花八门,会让人不知所措,可以考虑重新优化代码结构或者重新定义一个model
    反例:regionMatches(boolean, int, String, int, int)
    在遇到多个参数的情况下,需要遵守一定原则:数组在前(如:copyOf(T[], int))
  4. 返回参数
    单个对象没有找到返回null或者抛出异常由调用者来处理;
    列表不能返回null,如何没有需要返回的数据就返回一个空集合,防止调用处未能进行空处理而导致异常的发生。
  5. 命名格式
    (1)回调(onSomethingDone) :由其他类来调用本类中的方法,在Listener和Callback中是比较常见的
    ​ 例:onTitleChanged
    (2)主动调用(doSomething):一般是比较常见的方法,多数由本类中其他方法来调用,但是许多开发者利用或创建时却很随意,可用在优化代码显示,比价常见的命名有:reset,refresh,init
    ​ 例:invalidateOptionsMenu

总结

API的设计过程很多时候不能一撮而就,需要慢慢积累和进化,一个功能性的API一旦设计出来,意味着在一定时间内是相对稳定的,使用者能够放心的去调用,所以也需要一定的前瞻性,特别是对于Android开发着来说,其系统版本的高速迭代,可能会或多或少的影响到自己设计的程序;每个API接口应该只专注一件事,并做好(如果它很难命名,那么这或许是个不好的征兆,好的名称可以驱动开发、并且只需拆分与合并模块即可);遵守最小惊讶原则,用户API只需根据需求来设计即可,不需要刻意去设计一下复杂无用的API。

Thanks

http://www.csdn.net/article/2013-04-10/2814835-how-design-good-regular-api
http://blog.csdn.net/hdy007/article/details/1508834
http://www.codeceo.com/article/google-java-good-api.html

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

推荐阅读更多精彩内容

  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 31,296评论 18 399
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,102评论 18 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 170,571评论 25 707
  • 你说 你们的恋情还未稳固 不想弄得人尽皆知 可是来之不易的爱情 让你掩不住脸上的欣喜 别人见到便问起 ...
    清新寡欲阅读 195评论 0 0
  • 有一种相遇,止在遇过就好,我没想过要上前打招呼。 我一直很不喜欢搬家,大约是小时候跟着爸妈到处跑,住过很多地方,搬...
    一颗牙疼阅读 196评论 0 1