[Javascript] Axios

 

 

Axios는 브라우저, Node.js를 위한 Promise API를 활용하는 HTTP 비동기 통신 라이브러리이다. 쉽게 말해서 백엔드와 프론트엔드 간 통신을 쉽게 하기 위해 Ajax와 더불어 사용하는 것. 이미 자바스크립트에서는 Fetch API가 있지만 프레임워크에서 Ajax를 구현할 땐 Axios를 쓰는 편이라고 볼 수 있다.

 

Axios의 브라우저 호환성

 

 

 

Axios 특징

• 운영 환경에 따라 브라우저의 XMLHttpRequest 객체 또는 Node.js의 HTTP API 사용.
• Promise(ES6) API 사용
• 요청과 응답 데이터의 변형
• HTTP 요청 취소
• HTTP 요청과 응답을 JSON 형태로 자동 변경

 

 

Axios vs Fetch

Axios	Fetch
써드파티 라이브러리로 설치 필요	현대 브라우저에 빌트인이라 설치 불필요
XSRF 보호해 줌	별도 보호 없음
data 속성 사용	body 속성 사용
data는 object를 포함함	body는 문자열화 되어 있음
status가 200이고 statusText가 'OK'면 성공	응답 객체가 ok 속성을 포함하면 성공
자동으로 JSON 데이터 형식으로 변환됨	.json() 함수를 사용해야 함
요청을 취소할 수 있고 타임아웃을 걸 수 있음	해당 기능 존재하지 않음
HTTP 요청을 가로챌 수 있음	기본적으로 제공하지 않음
download 진행에 대해 기본적인 지원을 함	지원하지 않음
좀 더 많은 브라우저에 지원됨	Chrome 42+, Firefox 39+, Edge 14+, and Safari 10.1+ 이상에 지원

 

위와 같이 Axios는 별도 설치가 필요하다는 단점이 있지만 그것을 커버할 만한 Fetch보다 많은 기능 지원과 문법이 조금이나마 간소화된다는 장점이 있다.

 

따라서 간단하게 사용할 때는 fetch를, 이외의 확장성을 염두했을 때에는 axios를 쓰면 좋다고 볼 수 있다.

 

[Javascript] Fetch API

 

 

 

 

Axios 설치하기

 

1) 서버에서 axios 설치

> npm install axios

 

 

2) 클라이언트(HTML)에서 axios 설치

  - jsDeliver / unpkg CDN 중 택

<script src="https://cdn.jsdelivr.net/npm/axios/dist/axios.min.js"></script>

<script src="https://unpkg.com/axios/dist/axios.min.js"></script>

 

 

 

---

 

 

Axios 문법 구성

axios({
  url: 'http://test/api/service/list/today',  // 통신할 웹 문서
  method: 'get',  // 통신할 방식
  data: {  // 인자로 보낼 데이터
    message: 'hello'
  }
});

 

 

 

axios 요청(request) 파라미터 옵션

  - 볼드는 주로 많이 쓰이는 옵션

 

• method: 요청 방식(GET이 default)
• url: 서버 주소
• baseURL: url을 상대경로로 쓸 때 url 맨 앞에 붙는 주소
  
  • 예를 들어 url이 /post고 baseURL이 https://some-domain.com/api/이면, https://some-domain.com/api/post로 요청이 감.
• headers: 요청 헤더
• data: 요청 방식이 PUT, POST, PATCH에 해당하는 경우 body에 보내는 데이터
• params: URL 파라미터(?key=value로 요청하는 url get 방식을 객체로 표현한 것)
• timeout: 요청 timeout이 발동되기 전 milliseconds의 시간을 요청. timeout보다 요청이 길어지면 요청은 취소됨.
• responseType: 서버가 응답해 주는 데이터의 타입 지정(arraybuffer, document, json, text, stream, blob)
• responseEncoding: 디코딩 응답에 사용하기 위한 인코딩(UTF-8)
• transformRequest: 서버에 전달되기 전에 요청 데이터를 바꿀 수 있음.
  • 요청 방식이 PUT, POST, PATCH, DELETE에 해당하는 경우에 이용 가능.
  • 배열의 마지막 함수는 String 또는 Buffer, 또는 ArrayBuffer를 반환.
  • header 객체를 수정 가능.
• transformResponse: 응답 데이터가 만들어지기 전에 변환 가능.
• withCredentials: cross-site access-control 요청 허용 유무. 이를 true로 하면 cross-origin으로 쿠키값을 전달할 수 있음.
• auth: HTTP의 기본 인증에 사용. auth를 통해 HTTP의 기본 인증 구성 가능.
• maxContentLength: http 응답 내용의 max 사이즈를 지정하도록 하는 옵션
• validateStatus: HTTP 응답 상태코드에 대해 Promise의 반환 값이 resolve 또는 reject할지 지정하도록 하는 옵션.
• maxRedirects: node.js에서 사용되는 리다이렉트 최대치를 지정.
• httpAgent / httpsAgent: node.js에서 http나 https를 요청을 할 때 사용자정의 agent를 정의하는 옵션
• proxy: proxy서버의 hostname과  port를 정의하는 옵션
• cancelToken: 요청을 취소하는데 사용되는 취소 토큰을 명시.

 

/* axios 파라미터 문법 예시 */

axios({
    method: "get", // 통신 방식
    url: "www.naver.com", // 서버
    headers: {'X-Requested-With': 'XMLHttpRequest'} // 요청 헤더 설정
    params: { api_key: "1234", language: "en" }, // ?파라미터를 전달
    responseType: 'json', // default
    
    maxContentLength: 2000, // http 응답 내용의 max 사이즈
    validateStatus: function (status) {
      return status >= 200 && status < 300; // default
    }, // HTTP응답 상태 코드에 대해 promise의 반환 값이 resolve 또는 reject 할지 지정
    proxy: {
      host: '127.0.0.1',
      port: 9000,
      auth: {
        username: 'mikeymike',
        password: 'rapunz3l'
      }
    }, // proxy서버의 hostname과 port를 정의
    maxRedirects: 5, // node.js에서 사용되는 리다이렉트 최대치를 지정
    httpsAgent: new https.Agent({ keepAlive: true }), // node.js에서 https를 요청을 할때 사용자 정의 agent를 정의
})
.then(function (response) {
    // response Action
});

 

 

---

 

 

axios 응답(response) 파라미터 옵션

 

axios를 통해 요청을 서버에 보내면 서버에서 처리를 하고 다시 데이터를 클라이언트에 응답하게 된다. 이를 .then으로 함수 인자(response)로 받아 객체에 담긴 데이터가 바로 응답 데이터다. ajax를 통해 서버로부터 받는 응답의 정보는 다음과 같다.

 

axios({
    method: "get", // 통신 방식
    url: "www.naver.com", // 서버
})
.then(function(response) {
  console.log(response.data)
  console.log(response.status)
  console.log(response.statusText)
  console.log(response.headers)
  console.log(response.config)
})

 

response.data: {}, // 서버가 제공한 응답(데이터)

response.status: 200, // `status`는 서버 응답의 HTTP 상태 코드

response.statusText: 'OK',  // `statusText`는 서버 응답으로 부터의 HTTP 상태 메시지

response.headers: {},  // `headers` 서버가 응답 한 헤더는 모든 헤더 이름이 소문자로 제공

response.config: {}, // `config`는 요청에 대해 `axios`에 설정된 구성(config)

response.request: {}
// `request`는 응답을 생성한 요청
// 브라우저: XMLHttpRequest 인스턴스
// Node.js: ClientRequest 인스턴스(리디렉션)

 

 

 

---

 

 

Axios 단축 메서드

axios를 편리하게 사용하기 위해 모든 요청 메서드는 aliases가 제공된다. 위처럼 객체 옵션을 이것저것 주면 가독성이 떨어지니 함수형으로 재구성하여 나눠놓은 것으로 이해할 수 있다. axios의 Request method에는 대표적으로 다음과 같은 것들이 있다.

• GET: axios.get(url[, config])
• POST: axios.post(url, data[, config])
• PUT: axios.put(url, data[, config])
• DELETE: axios.delete(url[, config])

axios.request(config)

axios.get(url[, config])

axios.delete(url[, config])

axios.head(url[, config])

axios.options(url[, config])

axios.post(url[, data[, config]])

axios.put(url[, data[, config]])

axios.patch(url[, data[, config]])

 

JQuery에서 $.ajax({...})를 분리해 사용하는 $.get(), $.post()처럼 매우 흡사하다고 생각될 것이다.

 

 

 

axios GET

 

get 메서드는 크게 2가지 상황이 존재한다.

1. 단순 데이터(페이지 요청, 지정된 요청) 요청을 수행하는 경우
2. 파라미터 데이터를 포함시키는 경우(사용자 번호에 따른 조회)

const axios = require('axios'); // node.js쓸때 모듈 불러오기

// user에게 할당된 id 값과 함께 요청을 합니다.
axios.get('/user?ID=12345')
  .then(function (response) {
    // 성공했을 때
    console.log(response);
  })
  .catch(function (error) {
    // 에러가 났을 때
    console.log(error);
  })
  .finally(function () {
    // 항상 실행되는 함수
  });
 

// 위와는 같지만, 옵션을 주고자 할 때는 이렇게 요청을 합니다.
axios.get('/user', {
    params: {
      ID: 12345
    }
  })
  .then(function (response) {
    console.log(response);
  })
  .catch(function (error) {
    console.log(error);
  })
  .finally(function () {
    // always executed
  });  
 
 
// async/await 를 쓰고 싶다면 async 함수/메소드를 만듭니다. 
async function getUser() {
  try {
    const response = await axios.get('/user?ID=12345');
    console.log(response);
  } catch (error) {
    console.error(error);
  }
}

 

 

---

 

 

axios POST

 

post 메서드는 일반적으로 데이터를 message body에 포함시켜 보낸다. 위에서 봤던 get 메서드에서 params를 사용한 경우와 비슷하게 수행된다.

axios.post("url", {
		firstName: 'Fred',
		lastName: 'Flintstone'
    })
    .then(function (response) {
        // response  
    }).catch(function (error) {
        // 오류발생시 실행
    })

 

 

---

 

axios DELETE

 

delete 메서드에는 일반적으로 body가 비어 있다. REST 기반 API 프로그램에서 데이터베이스에 저장되어 있는 내용을 삭제하는 목적으로 사용한다.

axios.delete('/user?ID=12345')
  .then(function (response) {
    // handle success
    console.log(response);
  })
  .catch(function (error) {
    // handle error
    console.log(error);
  })

 

하지만 query나 params가 많아져서 헤더에 많은 정보를 담을 수 없을 때는 다음과 같이 두 번째 인자에 data를 추가해 줄 수 있다.

axios.delete('/user?ID=12345',{
    data: {
      post_id: 1,
      comment_id: 13,
      username: "foo"
    }
  })
  .then(function (response) {
    // handle success
    console.log(response);
  })
  .catch(function (error) {
    // handle error
    console.log(error);
  })

 

 

---

 

axios PUT

 

REST 기반 API 프로그램에서 데이터베이스에 저장되어 있는 내용을 갱신(수정)하는 목적으로 사용된다. PUT 메서드는 서버에 있는 데이터베이스의 내용을 변경하는 것을 주 목적으로 하고 있다. put 메서드는 서버 내부적으로 get -> post 과정을 거치기 때문에 post 메서드와 비슷한 형태이다.

 

axios.put("url", {
        username: "",
        password: ""
    })
    .then(function (response) {
         // response  
    }).catch(function (error) {
        // 오류발생시 실행
    })

 

 

---

 

 

다양한 Axios 응용 메서드

 

1) axios 동시 요청

function getUserAccount() {
  return axios.get('/user/12345');
}
 
function getUserPermissions() {
  return axios.get('/user/12345/permissions');
}
 
axios.all([getUserAccount(), getUserPermissions()])
  .then(axios.spread(function (acct, perms) {
    // 두개의 요청이 성공했을 때
  }));

 

 

 

2) axios Instance 만들기

custom 속성을 지닌 axios만의 instance를 만들 수 있다.

//axios.create([config])

const instance = axios.create({
  baseURL: 'https://some-domain.com/api/',
  timeout: 1000,
  headers: {'X-Custom-Header': 'foobar'}
});

 

 

 

3) axios로 formdata 보내기

const addCustomer = () => {
  const url = `/api/customers`;
  
  const formData = new FormData();
  formData.append("image", file);
  formData.append("name", userName);
  formData.append("birthday", birthday);
  formData.append("gender", gender);
  formData.append("job", job);
  
  const config = {
    headers: {
      "content-type": "multipart/form-data",
    },
  };
  
  return axios.post(url, formData, config);
};

 

 

 

4) 원격 이미지 다운 받기(blob)

const imgurl = 'https://play-lh.googleusercontent.com/hYdIazwJBlPhmN74Yz3m_jU9nA6t02U7ZARfKunt6dauUAB6O3nLHp0v5ypisNt9OJk';

axios({
   url: imgurl,
   method: 'GET',
   responseType: 'blob' // blob 데이터로 이미지 리소스를 받아오게 지정
})
.then((response) => {
   const url = URL.createObjectURL(new Blob([response.data])); // blob 데이터를 객체 url로 변환
   
   // 이미지 자동 다운 로직
   const link = document.createElement('a');
   link.href = url
   link.setAttribute('download', `sample.png`)
   document.body.appendChild(link)
   link.click()
 })

 

 

 

5) axios 에러 핸들링하기

axios
.get('/user/12345', {
  validateStatus: function (status) {
 	 return status < 500; // 만일 응답코드가 500일경우 reject()를 반환한다.
  }
})
.catch(function (error) {
    console.log(error.toJSON());
})

 

 

---

 

 

Axios 전역 설정(Config Defaults)

 

모든 요청에 적용되는 설정의 default 값을 전역으로 명시할 수 있다. 주로 서버에서 서버로 axios를 사용할 때 요청 헤더를 명시하는 데 자주 쓰인다.

 

axios.defaults.baseURL = 'https://api.example.com';
axios.defaults.headers.common['Authorization'] = AUTH_TOKEN;
axios.defaults.headers.post['Content-Type'] = 'application/x-www-form-urlencoded';

// Instance를 만들 때 설정의 default 값을 설정할 수 있다.
const instance = axios.create({
  baseURL: 'https://api.example.com'
});
 
// Instance를 만든 후  defalut 값을 수정할 수 있다. 
instance.defaults.headers.common['Authorization'] = AUTH_TOKEN;
instance.defaults.timeout = 2500;