封装的意义:为什么项目中不需要“api”这个目录

api目录

我们项目中有一个api目录,放着所有的请求的代码,


async function getIsOpen (params) {

  return await fetchSmart('api/foreign/getIsOpen_v3', {

    method: 'post',

    params,

  })

}

async function testStarted (params) {

  return await fetchSmart('api/foreign/testStarted', {

    method: 'post',

    params,

  })

}

不只我们公司的项目,别的公司的项目也分了这个目录,但是拆分出api这个目录的意义何在?

无意义的封装

我们都知道拆分是为了复用,而http接口是和服务端交互数据的一种方式,在项目中大量存在。所以,封装是必要的,但应该把请求之前的参数处理,和响应之后的数据处理都封装起来。这样的封装才是可复用有意义的,不然两个地方用到了同一个api中的接口,却需要对响应数据做两次处理,而且连参数也需要自己处理,这样有什么意义呢。就像之前聊过的同步多次赋值,异步多层promise,或者多次无任何操作的调用一样,都是无用功。


let a = 1;

a = a;// 无意义

a = a; // 无意义

new Promise((resolve, reject) => {

    return new Promise((resolve, reject) => {// 无意义

        return new Promise((resolve, reject) => { // 无意义

        })

   })

})

const a = (num1,num2) => {

        return num1 + num2;

}

const b = (num1,num2) => {// 无意义

         return a(num1, num2);

}

const c = (num1, num2) => {// 无意义

        return b(num1, num2);

}

你可能觉得你不会写上面的代码,但再看一遍api下的代码,不觉得是一样的么


async function getStuList (params) {

  const response = await fetchSmart('api/getStuList', {

    method: 'post',

    params,

  }).catch(error => {

    return error;

  });

  return response;

}

对参数没做任何处理,对响应没做任何处理,本来是promise返回的也是promise,代码里用


const studentList = await getStudentList(params);


const studentList = await fetchSmart('api/getStuList', {

    method: 'post',

    params,

  })

没有很大的区别。

正确的封装

异步请求的代码应该放在service中,在组件里面只要调用传入参数就好了,请求前的参数处理,还有响应后的数据处理都是封装好了的,组件拿到的是处理好的数据,这才是api应该的形式。


/* GET heroes whose name contains [search](https://www.angular.cn/api/common/PlatformLocation#search) term */

  searchHeroes(term: string): Observable<Hero[]> {

    if (!term.trim()) {

      // if not [search](https://www.angular.cn/api/common/PlatformLocation#search) term, return empty hero array.

      return of([]);

    }

    return this.http.get<Hero[]>(`${this.heroesUrl}/?name=${term}`).pipe(

      tap(_ => this.log(`found heroes matching "${term}"`)),

      catchError(this.handleError<Hero[]>('searchHeroes', []))

    );

  }

在vuex里面service就是action handler,api层应该合并到action handler里,单独出来的意义不大。

总结

封装的意义是为了复用一段处理逻辑,像api这样只是传递了一层,没做任何处理的封装是没意义的,封装一千层也不解决问题,api应该包括请求之前的参数处理,和响应之后的数据处理,也就是service层的工作。在vuex中对应的是action handler。当然名字叫什么或者放在什么地方不重要,更重要的是,减少无意义的封装,让每一个目录都有意义。

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

推荐阅读更多精彩内容