封裝基礎(chǔ)的angular4的request請(qǐng)求方法

為什么要封裝呢?

angular4自身提供的請(qǐng)求方法是用Observable來(lái)實(shí)現(xiàn)的焦匈。用的是觀察者模式岔帽,個(gè)人認(rèn)為這用來(lái)寫請(qǐng)求是非常方便的。

一個(gè)項(xiàng)目里會(huì)有非常多的不同的請(qǐng)求退渗,但是其實(shí)每個(gè)請(qǐng)求都會(huì)有些共性移稳。比如:每個(gè)請(qǐng)求都要傳Authorization,比如每個(gè)請(qǐng)求都要先判斷后臺(tái)返回的status字段為200時(shí)才是請(qǐng)求成功会油,后臺(tái)正真返回的數(shù)據(jù)在data字段里个粱,比如對(duì)于錯(cuò)誤信息的處理都是一樣的......等等。

所以我們需要封裝出一個(gè)請(qǐng)求翻翩,去統(tǒng)一處理這些問(wèn)題都许,從而保證組件里調(diào)用請(qǐng)求方法的時(shí)候收到的值都是可以直接拿來(lái)用的稻薇,幾乎不用再寫些重復(fù)的代碼。

希望封裝成什么樣呢胶征?

當(dāng)然是越少重復(fù)的代碼越好塞椎,我們就是想偷懶!>Φ汀案狠!!

怎么實(shí)現(xiàn)呢?

首先先新建一個(gè)請(qǐng)求的service钱雷,文件名為:request.service.ts骂铁。然后跟著我來(lái)虛擬需求,一步一步的慢慢來(lái)完善這個(gè)service罩抗。

需求A

1.請(qǐng)求方式為get拉庵。

2.默認(rèn)的請(qǐng)求超時(shí)時(shí)間為3秒,可傳入別的超時(shí)時(shí)間套蒂。

3.后臺(tái)返回的成功的json為這樣:

{

    "status": 200,

    "data"   : ...

}

錯(cuò)誤時(shí)這樣:

{

    "status": 201,

    "msg"   : "用戶名或密碼錯(cuò)誤"

}

實(shí)現(xiàn)A

request.service.ts


/**
 ********************************************************************************************
 * @App: test
 * @author: isiico
 * @type: service
 * @src: services/request.service.ts
 *
 * @descriptions:
 * 請(qǐng)求的服務(wù)
 *
 ********************************************************************************************
 */
// Angular Core
import {Injectable} from '@angular/core';
import {HttpClient} from '@angular/common/http';

// rxjs
import {Observable} from 'rxjs/Observable';
import 'rxjs/add/operator/map';
import 'rxjs/add/operator/timeout';
import 'rxjs/add/observable/throw';

@Injectable()
export class RequestService {
    private setTimeout = 3000;  // 默認(rèn)的超時(shí)時(shí)間

    constructor(private http:HttpClient) {
    }
    
    /** 獲取數(shù)據(jù)
    * param:  url    string      必填,請(qǐng)求的url
    *         time   number      可不填,請(qǐng)求的超時(shí)時(shí)間,如不填,默認(rèn)為setTimeout
    * return:        Observable  HttpClient的get請(qǐng)求钞支,請(qǐng)求完成后返回的值類型是any
    **/
    public getData(url, time = this.setTimeout):Observable<any> {
        let thiUrl = url;  // 用到的url
        let thisTime = time;  // 用到的超時(shí)時(shí)間
        return this.http.get(thiUrl)
            .timeout(thisTime)
            .map(res => this.resFun(res));
    }

    /** 返回?cái)?shù)據(jù)的處理
    *  param:    data     any     必填,需要處理的數(shù)據(jù)
    *  return:   res      any     返回處理后的值
    **/
    private resFun(data:any):any {
        let thisData:any = data;  // 需要處理的值
        let res:any;  // 最終值

        // 當(dāng)status為200時(shí)
        if (thisData['status'] == 200) {
            res = thisData['data']; // 給最終值賦值
        } else {
        // 當(dāng)status不為200時(shí)
            let err = thisData['msg'];  // 錯(cuò)誤信息
            throw new Error(err);  // 拋出錯(cuò)誤
        }
        return res;  // 返回最終值
    }
}

需求B

1.為了安全,后臺(tái)要求請(qǐng)求的頭需要加上Authorization參數(shù)泣懊。

2.當(dāng)請(qǐng)求失敗(如404麻惶,500這種)時(shí)馍刮,處理好錯(cuò)誤信息,最后的錯(cuò)誤信息要像 實(shí)現(xiàn)A 里一樣窃蹋,是可以直接用的字符串類型的錯(cuò)誤信息卡啰。

實(shí)現(xiàn)B

request.service.ts (只展示新增的代碼,完整代碼后面有)


import 'rxjs/add/operator/catch';

@Injectable()
export class RequestService {

    /** 添加Authorization的屬性 */
    private addAuthorization(options:any):void { 
        options['headers'] = { 
            'Authorization': '1drf5dg4d7s4w7z', 
        }; 
    } 
    
    /** 獲取數(shù)據(jù)
    * param:  url    string      必填,請(qǐng)求的url
    *         time   number      可不填,請(qǐng)求的超時(shí)時(shí)間,如不填,默認(rèn)為setTimeout
    * return:        Observable  HttpClient的get請(qǐng)求警没,請(qǐng)求完成后返回的值類型是any
    **/
    public getData(url, time = this.setTimeout):Observable<any> {
        let thiUrl = url;  // 用到的url
        let options = {};  // 請(qǐng)求的設(shè)置
        let thisTime = time;  // 用到的超時(shí)時(shí)間
        this.addAuthorization(options);  // 請(qǐng)求頭里添加Authorization參數(shù)
        return this.http.get(thiUrl, options)
            .timeout(thisTime)
            .catch(this.httpErrorFun)  // 處理錯(cuò)誤信息(必須放在timeout和map之間)
            .map(res => this.resFun(res));
    }

    /** 對(duì)請(qǐng)求錯(cuò)誤信息的處理
   *  param:    err                 any                 必填,需要處理的錯(cuò)誤信息
   *  return:   Observable.throw    Observable<string>  string:處理后顯示的錯(cuò)誤文字
   **/
    public httpErrorFun(err:any):Observable<string> {  
        let res:string = '';  // 處理后的結(jié)果
        let data:any = err;  // 需要處理的值

        /** 后臺(tái)有返回錯(cuò)誤信息時(shí) */
        if (data.hasOwnProperty('error') && data.hasOwnProperty('message')) {
            res = data.message;

        /** 后臺(tái)沒(méi)有返回錯(cuò)誤信息只有錯(cuò)誤名時(shí) */
        } else if (data.hasOwnProperty('name')) {
            let errName = data.name;

        /** 請(qǐng)求超時(shí) */
        if (errName == 'TimeoutError') {
            res = '對(duì)不起匈辱,請(qǐng)求超時(shí)了';
        }

        /** 后臺(tái)返回未授權(quán)時(shí) */
        } else if (data == "Unauthorization") {
            res = '您沒(méi)有權(quán)限,請(qǐng)重新登錄';
        } else {
            res = "哎呀杀迹,不知道是啥錯(cuò)誤~~";
        }

        return Observable.throw(res);
    }
}

完整的request service 代碼

request.service.ts


/**
 ********************************************************************************************
 * @App: test
 * @author: isiico
 * @type: service
 * @src: services/request.service.ts
 *
 * @descriptions:
 * 請(qǐng)求的服務(wù)
 *
 ********************************************************************************************
 */
// Angular Core
import {Injectable} from '@angular/core';
import {HttpClient} from '@angular/common/http';

// rxjs
import {Observable} from 'rxjs/Observable';
import 'rxjs/add/operator/map';
import 'rxjs/add/operator/timeout';
import 'rxjs/add/observable/throw';
import 'rxjs/add/operator/catch';

@Injectable()
export class RequestService {
    private setTimeout:number = 3000;  // 默認(rèn)的超時(shí)時(shí)間

    constructor(private http:HttpClient) {
    }

    /** 添加Authorization的屬性 */
    private addAuthorization(options:any):void {
        options['headers'] = {
            'Authorization': '1drf5dg4d7s4w7z',
        };
    }
    
    /** 獲取數(shù)據(jù)
    * param:  url    string      必填,請(qǐng)求的url
    *         time   number      可不填,請(qǐng)求的超時(shí)時(shí)間,如不填,默認(rèn)為setTimeout
    * return:        Observable  HttpClient的get請(qǐng)求亡脸,請(qǐng)求完成后返回的值類型是any
    **/
    public getData(url, time = this.setTimeout):Observable<any> {
        let thiUrl = url;  // 用到的url
        let options = {};  // 請(qǐng)求的設(shè)置
        let thisTime = time;  // 用到的超時(shí)時(shí)間
        this.addAuthorization(options);  // 請(qǐng)求頭里添加Authorization參數(shù)
        return this.http.get(thiUrl, options)
            .timeout(thisTime)
            .catch(this.httpErrorFun)  // 處理錯(cuò)誤信息(必須放在timeout和map之間)
            .map(res => this.resFun(res));
    }

    /** 返回?cái)?shù)據(jù)的處理
    *  param:    data     any     必填,需要處理的數(shù)據(jù)
    *  return:   res      any     返回處理后的值
    **/
    private resFun(data:any):any {
        let thisData:any = data;  // 需要處理的值
        let res:any;  // 最終值

        // 當(dāng)status為200時(shí)
        if (thisData['status'] == 200) {
            res = thisData['data']; // 給最終值賦值
        } else {
        // 當(dāng)status不為200時(shí)
            let err = thisData['msg'];  // 錯(cuò)誤信息
            throw new Error(err);  // 拋出錯(cuò)誤
        }
        return res;  // 返回最終值
    }

    /** 對(duì)請(qǐng)求錯(cuò)誤信息的處理
   *  param:    err                 any                 必填,需要處理的錯(cuò)誤信息
   *  return:   Observable.throw    Observable<string>  string:處理后顯示的錯(cuò)誤文字
   **/
    public httpErrorFun(err:any):Observable<string> {
        let res:string = '';  // 處理后的結(jié)果
        let data:any = err;  // 需要處理的值

        /** 后臺(tái)有返回錯(cuò)誤信息時(shí) */
        if (data.hasOwnProperty('error') && data.hasOwnProperty('message')) {
            res = data.message;

        /** 后臺(tái)沒(méi)有返回錯(cuò)誤信息只有錯(cuò)誤名時(shí) */
        } else if (data.hasOwnProperty('name')) {
            let errName = data.name;

        /** 請(qǐng)求超時(shí) */
        if (errName == 'TimeoutError') {
            res = '對(duì)不起,請(qǐng)求超時(shí)了';
        }

        /** 后臺(tái)返回未授權(quán)時(shí) */
        } else if (data == "Unauthorization") {
            res = '您沒(méi)有權(quán)限树酪,請(qǐng)重新登錄';
        } else {
            res = "哎呀浅碾,不知道是啥錯(cuò)誤~~";
        }

        return Observable.throw(res);
    }
}

小結(jié)

至此,我們已經(jīng)完成了一個(gè)滿足基本需求的续语,可以公共使用的請(qǐng)求服務(wù)垂谢,接下來(lái)我們來(lái)看怎么在組件內(nèi)調(diào)用。

調(diào)用

我們有個(gè)叫l(wèi)ist的組件疮茄,要調(diào)用get請(qǐng)求滥朱,請(qǐng)求成功顯示數(shù)據(jù)根暑,請(qǐng)求失敗,顯示錯(cuò)誤信息徙邻。

list.component.ts


/**
 ********************************************************************************************
 * @App: test
 * @author: isiico
 * @type: component
 * @src: components/list.component.ts
 *
 * @descriptions:
 * list組件
 *
 ********************************************************************************************
 */
// Angular Core
import { Component, OnInit } from '@angular/core';

// Services
import { RequestService } from "../services/request.service";

@Component({
  moduleId: module.id,
  templateUrl: 'list.component.html'
})

export class ListComponent implements OnInit {
    listApi = '/assets/mock-data/list.json';  // 列表的api地址
    list:Array<any>;  // 列表數(shù)據(jù)(類型為數(shù)組)
    listErrMsg: string = '';  // 列表請(qǐng)求的錯(cuò)誤信息
    
    constructor(private req: RequestService) {
    }
    
    /** 獲取list */
    getList(){
        this.listErrMsg = '';  // 清空錯(cuò)誤信息

        // 發(fā)送請(qǐng)求
        this.req.getData(this.cabinetListApi)
            .subscribe(
            res=>{
            // 請(qǐng)求成功
                this.cabinets = [];
                this.cabinets = res;
            },err=>{
            // 請(qǐng)求失敗
                this.cabinets = [];
                this.listErrMsg = err;
        })

    }
    
    ngOnInit() {
        this.getList();
    }
}

頁(yè)面的顯示自己去完成吧排嫌!

據(jù)量子力學(xué)得到,點(diǎn)贊這篇文章的人都會(huì)成為歐皇鹃栽,從此過(guò)著開(kāi)心幸福的生活??躏率。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市民鼓,隨后出現(xiàn)的幾起案子薇芝,更是在濱河造成了極大的恐慌,老刑警劉巖丰嘉,帶你破解...
    沈念sama閱讀 219,110評(píng)論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件夯到,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡饮亏,警方通過(guò)查閱死者的電腦和手機(jī)耍贾,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,443評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)路幸,“玉大人荐开,你說(shuō)我怎么就攤上這事〖螂龋” “怎么了晃听?”我有些...
    開(kāi)封第一講書(shū)人閱讀 165,474評(píng)論 0 356
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)砰识。 經(jīng)常有香客問(wèn)我能扒,道長(zhǎng),這世上最難降的妖魔是什么辫狼? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 58,881評(píng)論 1 295
  • 正文 為了忘掉前任初斑,我火速辦了婚禮,結(jié)果婚禮上膨处,老公的妹妹穿的比我還像新娘见秤。我一直安慰自己,他們只是感情好真椿,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,902評(píng)論 6 392
  • 文/花漫 我一把揭開(kāi)白布秦叛。 她就那樣靜靜地躺著,像睡著了一般瀑粥。 火紅的嫁衣襯著肌膚如雪挣跋。 梳的紋絲不亂的頭發(fā)上,一...
    開(kāi)封第一講書(shū)人閱讀 51,698評(píng)論 1 305
  • 那天狞换,我揣著相機(jī)與錄音避咆,去河邊找鬼舟肉。 笑死,一個(gè)胖子當(dāng)著我的面吹牛查库,可吹牛的內(nèi)容都是我干的路媚。 我是一名探鬼主播,決...
    沈念sama閱讀 40,418評(píng)論 3 419
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼樊销,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼整慎!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起围苫,我...
    開(kāi)封第一講書(shū)人閱讀 39,332評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤裤园,失蹤者是張志新(化名)和其女友劉穎,沒(méi)想到半個(gè)月后剂府,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體拧揽,經(jīng)...
    沈念sama閱讀 45,796評(píng)論 1 316
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,968評(píng)論 3 337
  • 正文 我和宋清朗相戀三年腺占,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了淤袜。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 40,110評(píng)論 1 351
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡衰伯,死狀恐怖铡羡,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情意鲸,我是刑警寧澤烦周,帶...
    沈念sama閱讀 35,792評(píng)論 5 346
  • 正文 年R本政府宣布,位于F島的核電站临扮,受9級(jí)特大地震影響论矾,放射性物質(zhì)發(fā)生泄漏教翩。R本人自食惡果不足惜杆勇,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,455評(píng)論 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望饱亿。 院中可真熱鬧蚜退,春花似錦、人聲如沸彪笼。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 32,003評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)配猫。三九已至幅恋,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間泵肄,已是汗流浹背捆交。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 33,130評(píng)論 1 272
  • 我被黑心中介騙來(lái)泰國(guó)打工淑翼, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人品追。 一個(gè)月前我還...
    沈念sama閱讀 48,348評(píng)論 3 373
  • 正文 我出身青樓玄括,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親肉瓦。 傳聞我的和親對(duì)象是個(gè)殘疾皇子遭京,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,047評(píng)論 2 355

推薦閱讀更多精彩內(nèi)容

  • Spring Cloud為開(kāi)發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見(jiàn)模式的工具(例如配置管理,服務(wù)發(fā)現(xiàn)泞莉,斷路器哪雕,智...
    卡卡羅2017閱讀 134,662評(píng)論 18 139
  • Android 自定義View的各種姿勢(shì)1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 172,171評(píng)論 25 707
  • 推開(kāi)浮游在記憶中金色教室的門,陽(yáng)光灑在卷尺和鉛筆的桌上戒财,周圍空無(wú)一人热监。揉捏散落在桌上的碎紙片,一本本整齊排列的書(shū)本...
    梅林愛(ài)橙子閱讀 147評(píng)論 0 0
  • 昨天是兒童節(jié)饮寞,刷刷朋友圈孝扛,真是厲害,大家居然把每個(gè)大大小小的節(jié)日都過(guò)成了情人節(jié)幽崩,撒了一堆狗糧苦始。 兒童節(jié),最近這幾年...
    洪木木閱讀 287評(píng)論 0 0
  • 毫無(wú)征兆的離開(kāi) 沒(méi)了晚安 今晚該如何想念
    佛笑來(lái)人閱讀 423評(píng)論 8 12