如何优雅的设计一个接口

最近面试有两次碰到过给你一个需求,或者一个什么样的功能,你会怎么去设计/实现。

https://github.com/DarrenDuXuan/CodeDesign

  1. 接口设计

    设计一个搜索指定目录下特定类型文件的函数,
    要求写出返回值、函数名、参数列表
    (不需要写实现)
    详细咨询了细节之后,得到的一些细节点有:
    1. 针对业务方需求,可能搜索的规则不一样。比如文件名以 abc 开始的文件,文件名以 abc 结尾的文件,文件后缀未 abc 的文件。
    2. 返回值,刚开始说的是一个文件名也就是 NSString ,但是后来我想了一下,又沟通了一下,改为了 List 也就是 NSArray <NSString >。

我当时说的两种方案。

  • 第一种方案:
    定义 ENUM

    typedef NS_ENUM(NSInteger, FileSearchRules) {
       FileSearchRulesFileNameBegin,
       FileSearchRulesFileNameEnd,
       FileSearchRulesExtension,
    };
    

    实现

    - (NSArray <NSString *> *)searchFileList:(FileSearchRules)rules key:(NSString *)key;
    

    根据不同的 rules 去调用不同的查询方法。
    一开始我想的是定义一个 Mode ,里面包含 Rules 跟 key,但是后来想了想,设计接口,最好还是不要使用多余的 Mode ,能一个参数搞定的,最好不要使用两个参数,也要尽可能的去 Mode。

  • 第二种方案
    同样是上面的 NS_ENUM ,同样的方法。需要定义一个新的方法,通过 rules 或者不同规则的一个实例,这个实例遵循一个定义好的一个 search 接口,返回对应的 List 。

    @protocol FileSearchProtocol <NSObject>
    - (NSArray <NSString *> *)searchFileList:(NSString *)key;
    @end
    
     - (id <FileSearchProtocol>)getSearchRuleMode:(FileSearchRules)rules {
     }
    

    通过 rules 获取不同规则的实现 Mode , 从而增加了方法的可扩展性以及可维护性。这也是用到了设计模式里面的策略模式加简单工厂?

  • 第三种方案

    1. 这种方案,是我在当天晚上睡不着的时候,想到的一种后续业务方可能会提出的一种需求。要问为什么睡不着,那就只能说是面试面的有点自闭,从而睡不着的。
    2. 说需求,这种接口其实最开始就该想到的,面对不同的业务方,单一策略肯定是太呆了,后续一定会有业务方提出这样的需求。对于这个规则,一种规则不够我们用了,我要同时查好几种规则。 不知道我说明白了没。也就是说,根据一个 key 甚至多个key 查找同时满足多种规则的文件,输出对应 List 。
    3. 这个时候 ENMU 就不合适了,要请出 NS_OPTIONS 这尊大神。
    typedef NS_OPTIONS(NSUInteger, FileSearchRules) {
      FileSearchRulesFileNameBegin = 1 << 0,
      FileSearchRulesFileNameEnd   = 1 << 1,
      FileSearchRulesExtension     = 1 << 2,
    };
    

    在这样的需求下,我就只能想到使用正则表达式了,首先根据规则编写正则,拿到所有文件名的 List ,再根据正则去匹配出最后的 List 输出。
    或者有什么更好的实现方式,还请评论我。

  1. 结构设计
    MP4 AVI MP3 JPG
    下载 1 1 1 1
    解压 1 0 0 0
    解码 1 1 0 1
    储存 1 1 1 1
    展示 1 1 0 1

    大概意思就是,一套框架,同时支持视频、图片、音频等多种格式的文件下载。下载完成后后续会有很多不同的操作,包括解码、储存等,但是不同格式的文件,需要的路径不一样,就像上面表里面的1和0,1表示需要做这一步操作,0表示不需要,而且后续可能会支持更多操作。你如何去设计。

  • 我当时给出的方案是,一个 Mgr ,所有的操作,在上一步操作做完之后,判断当前文件类型是否需要做下一个操作,不需要的直接跳过当前步骤。不过一些步骤需要抽象一个 Protocol 出来(如:解码),不同的文件类型解码方式不同,便于扩展。
  • 后续想了想,感觉有点 Low。是不是可以使用数据结构链表,去代替每一步操作。具体情况看代码吧,就只是这么个思路。具体细节肯定还有很多,比如 Node 怎么去实现,扩展性以及可读性等等。都需要细细的去思考。

对于框架搭建,常见的设计模式还是要了然的。至于架构那几点,单一职责什么的,也是要知道的。

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