javascript 쿠키(document.cookie) 헬퍼 라이브러리 (ri-cookie.js)
javascript 쿠키(document.cookie) 헬퍼 라이브러리 (ri-cookie.js)
REDINFO
약 1년전 2022-11-21 01:08:40

 

$.cookie 

 

JAVASCRIPT 만을 이용하여 쿠키를 조작할때는 정말 많은 어려움이 있습니다. 이를 해결하기위해 조금이나마 시간을 투자하여 별도 커스텀 함수를 만들어서 사용하게 됩니다.  하지만 그 시간마저도 바쁜 개발자에게는 허락되지 않을 수 있습니다. 이때 빠르게 사용할 수 있는 라이브러리를 간단하게 모듈화 하여 만들어 보았습니다. 

 

| 라이브러리 다운로드

 

 

 

| 사용예제 

가장 먼저 해당 라이브러리를 다운로드 후 웹 서버에 업로드 한 후 아래와 같이 적당한 위치에 로드 후 사용이 가능합니다.

<!-- ri-cookie.js -->
<script src="./ri-cookie.js"></script>

 

준비가 완료되었다면 $.cookie.set() 메서드를 이용하여 쿠키를 하나 생성해 볼 수 있습니다. 

$.cookie.set('name','강민'); 

 

생성된 쿠키를 하나 삭제하고 싶을땐 $.cookie.unset() 메서드를 이용하여 삭제할 수 있습니다. 

$.cookie.unset('name'); 

 

만약 생성된 쿠키 전체를 삭제하고 싶을땐 $.cookie.destory() 메서드를 이용하여 비우기가 가능합니다. 

$.cookie.destory();

 

$.cookie.get(); 를 이용하면 원하는 쿠키를 볼 수 있습니다. 

$.cookie.get('name');

 

혹시나 원하는 쿠키가 아닌 전체 쿠키에 대한 정보를 얻고 싶을땐 $.cookie.$ 를 통해 객체로 정보를 얻을 수 있습니다.  

$.cookie.$

 

 

 

| 설정 & 옵션 상세

객체 or 메서드 설명
$

현재 저장된 쿠키의 값을 실시간으로 가지고 있습니다. 별도 $.cookie.get(name) 을 하지 않고도 볼 수 있습니다.

  • ex) console.log($.cookie.$[name]);
defaultOption

쿠키 생성시 값이 없을 경우 기본으로 지정될 옵션 정보입니다. 

  • expires 
    • Type: int 
    • 만료일을 현재 시간으로 부터 기준으로 입력 하면 됩니다.  만약 이값이 0일 경우에는 기본 브라우저 닫기까지 유효합니다. (session)
    • ex) 60*60*24 (1일기준) 
  • path
    • Type: string
    • 저장경로 입니다. 
  • domain
    • Type: string
    • 저장될 도메인을 지정합니다.
  • secure
    • Type: boolean
    • 현재 웹 서버가 보안서버일 경우 양단간 https 프로토콜로 통신하는 경우 설정 가능합니다. 주로 크롬80 쿠키 보안시 SameSite=None 설정과 함께 사용됩니다. 
    • 이설정을 사용할려면 true , 그렇지 않으면 false 로 설정하면됩니다.
  • option
    • Type: docment.cookie setting string 
    • 별도로 설정할 옵션이 있을 경우 지정할 수 있습니다. 대부분의 경우 사용할 필요가 없습니다.
optionCheck

set 메소드 파라미터중 option 값을 체킹합니다. 별도로 사용할 필요는 없습니다. 

set

쿠키를 지정하는 옵션입니다. 

  • name
    • Type: string
    • 쿠키명을 입력합니다. (양쪽 공백값은 삭제됩니다.)
  • value
    • Type: string
    • 쿠키 값을 입력합니다.
  • expires
    • Type:number
    • 쿠키 유효시간초를 입력합니다. 
    • ex) 60*60*24 (1일기준) 
  • path
    • Type: string
    • 저장경로 입니다. 기본 값은 '/' 입니다. 
  • domain
    • Type: string
    • 저장될 도메인을 지정합니다. 기본값은 현재 접속한 URL의 도메인 입니다. 
  • secure
    • Type: boolean
    • 현재 웹 서버가 보안서버일 경우 양단간 https 프로토콜로 통신하는 경우 설정 가능합니다. 주로 크롬80 쿠키 보안시 SameSite=None 설정과 함께 사용됩니다. 
    • 이설정을 사용할려면 true , 그렇지 않으면 false 로 설정하면됩니다.
  • option
    • Type: docment.cookie setting string 
    • 별도로 설정할 옵션이 있을 경우 지정할 수 있습니다. 대부분의 경우 사용할 필요가 없습니다.
get

쿠키명을 통해 원하는 쿠키의 값을 가져올 수 있습니다.

  • name
    • Type: string
    • 쿠키명을 입력합니다. (양쪽 공백값은 삭제됩니다.)
unset

쿠키명을 통해 원하는 쿠키의 값을 삭제할 수 있습니다.

  • name
    • Type: string
    • 쿠키명을 입력합니다. (양쪽 공백값은 삭제됩니다.)
destory

생성된 전체 쿠키를 삭제 할 수 있습니다.

update

쿠키 생성/삭제  등의 업데이트 시 내부에서 실행됩니다. 별도로 사용할 필요가 없습니다.

 

 

 

버전 & 이력

본 $.cookie 라이브러리의 현재 버전은 1.0 입니다. 

 

  • 2022-11-20 라이브러리 개발
  • 2022-11-21 라이브러리 최초 버전(1.0) 배포 시작

 

 

 

서포트 & 기타

본 라이브러리 사용중 오류나 알 수 없는 버그가 있을 경우  lcy@redinfo.co.kr 로 문의 주시면 최대한 빠른 시일 내 답변 드릴 수 있도록 하겠습니다.

 

 

 

이 포스트글이 도움이 되었나요?
4
카테고리 연관글

Comment

댓글작성

0(500) | 1(30)