HTTP Request Interceptor로 REST API Call에 Token 넣기

소스코드

이 게시물에는 코드작성이 포함되어 있습니다. 소스코드를 받으신 후 진행해 주세요. MEAN Stack/개발 환경 구축에서 설명된 프로그램들(git, npm, atom editor)이 있어야 아래의 명령어들을 실행할 수 있습니다.

이 게시물의 소스코드는 기본사이트 만들기 / Reactive Forms Module 로 Login Form 만들기에서 이어집니다.

angular-site.git 을 clone 한 적이 있는 경우: 터미널에서 해당 폴더로 이동 후 아래 명령어들을 붙여넣기합니다. 폴더 내 모든 코드가 이 게시물의 코드로 교체됩니다. 이를 원치 않으시면 이 방법을 선택하지 마세요.

git reset --hard
git pull
git reset --hard e3b7156
git reset --soft bc53806
npm install
atom .

angular-site.git 을 clone 한 적이 없는 경우: 터미널에서 코드를 다운 받을 폴더로 이동한 후 아래 명령어들을 붙여넣기하여 angular-site.git 을 clone 합니다.

git clone https://github.com/a-mean-blogger/angular-site.git
cd angular-site
git reset --hard e3b7156
git reset --soft bc53806
npm install
atom .

- Github에서 소스코드 보기: https://github.com/a-mean-blogger/angular-site/tree/e3b7156eb956b789e98afd815b0a11b8d47c98b1


Angular 2 기본 사이트 만들기 강의시리즈에서 사용하고 있는 JWT 로그인 REST API의 대부분은 request의 header의 x-access-token에 token이 요구됩니다. 물론 REST API call 호출 를 담당하는 service에 개별적으로 이 값을 넣어줄 수도 있겠지만, 모든 REST API call에 자동으로 token을 넣어준다면 더욱 편리하겠지요.

이번 강의에서는 HTTP Request Interceptor를 사용해서 Angular 2 사이트상의 모든 REST API call에 token을 넣는 방법을 알아보겠습니다. interceptor란 말에 눈치를 채신분이 있겠지만 실제로 REST API call을 보내기 전에 Angular가 이것을 가로채서 token을 넣은 후 보내는 방법입니다.

폴더 구조


주황색은 변경된 파일, 녹색은 새로 생성된 파일, 회색은 변화가 없는 파일입니다.

request-interceptor.service.ts 파일을 생성해 줍니다.

코드

// src/app/request-interceptor.service.ts

import { Injectable } from '@angular/core';
import { HttpEvent, HttpInterceptor, HttpHandler, HttpRequest, HttpHeaders } from '@angular/common/http';
import { Observable } from 'rxjs/Observable';

@Injectable()
export class RequestInterceptor implements HttpInterceptor {
  intercept(req: HttpRequest<any>, next: HttpHandler): Observable<HttpEvent<any>> {
    var token = localStorage.getItem('token'); //1
    var newHeader: HttpHeaders = req.headers; //2
    newHeader = newHeader.set('Content-Type', 'application/json'); //3
    if(token) newHeader = newHeader.set('x-access-token', token); //4
    const newReq = req.clone({headers: newHeader}); //5
    return next.handle(newReq); //6
  }
}

http interceptor service는 HttpInterceptor를 implements해서 만들 수 있습니다. 이 service는 req와 next를 파라메터로 하는 intercept 함수를 가집니다.

  • req: HttpRequest 타입으로 실제 요청되기 전의 request를 가지고 있습니다. 
  • next: next.handle에 request를 넣으면 실제 http call이 요청됩니다. 여기에 .subscribe를 달면 요청 후에 할일을 지정할 수도 있습니다.

1. localStorage에서 token을 가져옵니다.
2. 현재 request의 header값을 가져옵니다.
3. header에 content-type을 json 으로 설정해 줍니다.
4. token이 존재한다면 header에 x-access-token에 token을 넣어줍니다.
5. req의 값을 바로 수정할 수 없게 되어 있어서 새로운 header를 담은 clone을 만들어 줍니다.
6. 생성된 request clone으로 next.handle 함수를 호출합니다.

http interceptor를 처음 보시는 분이라면 좀 헷갈릴 수도 있는데, 크게 어려운 내용은 아닙니다. 이해가 안되는 부분이 있다면 질문해주세요

// src/app/app.module.ts

//...

import { UtilService } from './util.service';
import { AuthService } from './auth.service';
import { RequestInterceptor } from './request-interceptor.service'; //*

//...

@NgModule({
  declarations: [
//...
  ],
  imports: [
//...
  ],
  providers: [ //*
    {
      provide: HTTP_INTERCEPTORS,
      useClass: RequestInterceptor,
      multi: true,
    }, 
    UtilService,
    AuthService,
  ],
  bootstrap: [AppComponent]
})
export class AppModule { }

* {provide: HTTP_INTERCEPTORS,  useClass: RequestInterceptor,  multi: true}의 형태로 providers에 넣어주면 끝!

이제 token이 있다면 모든 REST API call에 자동으로 포함됩니다. app.component.ts를 수정해봅시다.

// src/app/app.component.ts

import { Component } from '@angular/core';
import {
  Router,
  Event as RouterEvent,
  NavigationStart,
} from '@angular/router'

import { AuthService } from './auth.service';

@Component({
  selector: 'app-root',
  templateUrl: './app.component.html',
  styleUrls: ['./app.component.css']
})
export class AppComponent {

  constructor(
    private router: Router,
    public authService: AuthService,
  ) {
    router.events.subscribe((event: RouterEvent) => { //1
      this.refreshToken(event);
    });
  }

  private refreshToken(event: RouterEvent): void {
    if (event instanceof NavigationStart && this.authService.isLoggedIn()) {
      this.authService.refresh().catch(response => null);
    }
  }

}

1. this.router.events는 경로가 변경될 때마다 Observable를 생성합니다.

2. 이때 이벤트의 타입이 NavigationStart, 즉 페이지 이동이 시작하는 시점에 로그인이 되어 있는 상태라면 token을 refresh합시다.

this.router.events가 만드는 이벤트의 종류 중 자주 쓰이는 몇 가지는 다음과 같습니다.

  • NavigationStart
  • NavigationEnd
  • NavigationCancel
  • NavigationError

이름만 보면 대충 어떤 이벤트인지 감이 옵니다. (전체 리스트와 전체  설명: https://github.com/angular/angular/blob/4.3.x/packages/router/src/events.ts)

실행 결과

Angular-CLI 명령어 사용해서 서버를 실행합시다. 

ng serve --open

로그인을 한 후 브라우저를 새로고침해 봅시다.

이전 강의때와 다르게 에러도 나지 않고 로그인도 유지가 되었습니다.

마치며..

다음 강의에서는 회원가입(Sign Up)을 다뤄보겠습니다.

댓글

S
SunWoong Lee 2017.09.21
아 프론트에서 매번 헤더세팅 할 필요 없이 이렇게 인터셉터를 쓰면 되네요 ㅠㅠ 다른 프로젝트할때 프론트에서 리퀘스트마다 계속 헤더세팅해줬었는데....ㅋㅋㅋㅋ 후 하 
I
Ian H 2017.09.22
@SunWoong Lee,
저도 처음에는 그랬어요 ㅋㅋㅋ
h
hjp 2018.08.03
강의 감사합니다. 혹시 인터셉트를 개별적으로(서비스별, 요청도메인별 등) 다른 인터셉트를 적용하는것이 가능할까요?
I
Ian H 2018.08.03
@hjp,
위 예제에서 RequestInterceptor 클라스의 intercept 함수 안에 해당 알고리듬을 작성하면 되겠습니다
댓글쓰기

이 글에 댓글을 다시려면 SNS 계정으로 로그인하세요. 자세히 알아보기

UP