module import convention

여리·2023년 2월 13일
0

모듈 import 순서

import 순서 컨벤션에 맞게 작성하는것이 어디에도 나와있지는 않지만 개발자들끼리 통상적으로 약속되어 있는 순서들이 있다. 사소한 부분이라 놓치기 쉽지만 처음 코드를 작성할 때부터 신경쓰고 작성하게 되면 추후에 관리하기도 용이하며 가독성도 좋아진다.
이런 리뷰를 받은 적이 있다.

다음과 같은 순서로 import 해준다.

  1. Bulit-in 패키지
  2. 3rd-party 패키지
  3. custom 패키지

bulit-in 패키지

Node.js 자체에서 사용할 수 있는 패키지( ex- http)를 의미한다.
자세한 bulit in Package 종류는 링크에서 확인!

https://www.w3schools.com/nodejs/ref_modules.asp

3rd-party 패키지

서드파티는 웹 서비스 제공 단체와 독립적인 단체이고, 이 단체에서 제공하는 스크립트(=JavaScript)라 서드파티 스크립트할 수 있다. 쉽게 생각하면 npm을 init 하면서 package.json이 생성되는데 그에따라 모듈을 설치하고 import할 수 있는 것들을 생각하면 좀 더 쉽게 이해할 수 있는 것 같다.(ex. bycrpt, express 등등)

custom 패키지

개발자가 소스코드를 작성하면서 각 기능별로 layered pattern 형식으로 진행함에따라 각 기능별로 improt를 해와야 하는 경우에 custom package를 사용한다.
backend 기준에서는 layered pattern 상황에서 controller, service, Dao 의 역할에서 역할별 module.export를 import를 해오는 상황을 custom package로 볼 수 있을 것 같다.

⬇️ import 패키지 효율적 작성 예시(각 성격별 패키지 별로 개행을 통해 구분을 인지할 수 있도록 하는것이 좋다.)

const http = require("http"); //bulit-in package

const bycrpt = require("bcrypt"); //3rd-party package

const userDao = require("../models/userDao"); //custom package 
const constraints = require("../utills/constraints"); //custom package
const constants = require("../utills/constants"); //custom package
profile
beckend developer

0개의 댓글