[BackEnd][Node.js] Express.js - 초기 구성 : DB 연결

 

 

 

🗂 목차

● [BackEnd][Node.js] Express.js - 초기 구성
● [BackEnd][Node.js] Express.js - 초기 구성 : DB 연결
● [BackEnd][Node.js] Express.js - 초기 구성 : DB 연결(Sequelize)

 

 

📚 부록

● [Node.js] Node.js 기초
● [JavaScript] 기본 문법
● [Web] URL의 이해
● [Spring] Spring이란?

 

 

🤔 내가 만난 Error

● [Node.js][Error] Cannot find module '.dotenv'

 

 

 

 

Node.js 교과서:기본기에 충실한 노드제이에스 14 입문서

"이 포스팅은 쿠팡 파트너스 활동의 일환으로, 이에 따른 일정액의 수수료를 제공받습니다."

 

 

 

 

🚀 MySql 연결

    🔽  MySql Driver 설치

최초 `Express.js`와 `MySql`을 연결하기 위해 `MySql` Driver를 설치해야 하는 것이에요.

`Spring`에서는 아래 그림과 같이 `pom.xml`이나, `build.gradle`에 `dependency`를 추가 해주면 되지만, `Node.js`에서는 설치를 해주어야 하는 것이에요.

pom.xml Maria DB Driver

 

 

명령어

npm i mysql --save

 

Project Directory에서 위의 명령어를 터미널에 입력하여 Driver를 설치해 줄 것이에요.

 

npm i mysql --save

 

 

 

 

 

 

 

    🔽  Data Base 연결

최초 `app.js` 파일에 아래 내용을 입력하여 Data Base와 연결하는 객체를 만들어 볼 것이에요. `MySql` 안에 `createConnection()`을 이용하여 Data Base 정보를 입력하면 되는 것이에요.

 

app.js - DB 연결 정보 추가

`$node app.js`를 이용해서 서버를 구동시켰다면 위의 코드를 추가한 뒤 다시 서버를 껐다가 명령어를 또 입력해서 구동시켜야 하지만, 주니하랑은 최초 `nodemon`을 이용해서 서버를 구동시킨 것이에요. 이렇게 하면 위의 코드를 추가하고, 저장만 하면 Server가 알아서 재 구동 되는 것이에요.

 

nodemon을 통해 자동 기동된 Server

위와 같이 Data Base 연결에 성공한 것을 알 수 있는 것이에요.

 

        📦  Table 생성

`Spring`에서 JPA를 이용한다면 `Entity`를 만들고, `applicaton.yml`이나, `application.properties`에 

application.yml

 

위와 같이 `ddl-auto` 설정을 `create`나, `update`를 하면 자동으로 Table이 생성되고, 또다른 방법으로 `/resouces` 밑에 `xx.sql` 파일을 만들고, `DDL` SQL문을 입력하면 Table을 생성할 수 있는데, `Spring`의 두번째 방법과 유사하게 `Node.js`에서는 `app.js`에 `DDL` SQL문을 작성하여 Table을 만들 수 있는 것이에요.

 

app.js - Table 생성 Code 추가

위의 그림 32 ~ 46번째 줄을 입력하여 저장을 하게 되면 아래와 같이 처리 결과를 볼 수 있는 것이에요.

 

 

 

DB Table 목록

위의 그림 밑에서 4번째 줄에 주니하랑이 만든 `test_board` Table이 잘 만들어진 것을 확인할 수 있는 것이에요.

 

 

 

 

 

 

 

    🔽  MySQL 연결 객체 모듈화

이제 우리는 Data Base 연결 방법과 Query 전송 방법을 알게 된 것이에요.

이제 `MySQL 연결 객체를 모듈화` 해보도록 할 것이에요.

만약 모듈화해서 사용하지 않으면 `Express.js Route`에서 Data Base와 어떤 Data를 주고 받을 때 마다 `MySQL` 접속 Code를 계속 적어줘야 하는 불편함이 생길 것이에요.

이를 막기 위해 `config`라는 Directory를 만들고, 해당 Directory안에 `mysql.js`를 만들어 줄 것이에요. 

 

config/mysql.js

 

`app.js`에서는 Data Base 연결에 대해 작업하지 않게 할 것이기 때문에 위에서 작성한 내용을 모두 지우고, 아래 Code를 `mysql.js`에 작성할 것이에요.

 

mysql.js

 

`mysql.js`의 1번째 줄은 `mysql Driver`를 불러오는 것이에요.

그런 뒤 4 ~ 17번째 줄까지 `Data Base`와 연결하는 객체를 생성할 수 있도록 작성한 것이에요.

위에서 생성한 객체를 통해 19 ~ 28번째 줄까지 Data Base와 실패 연결을 시도하는 것이에요.
연결에 실패하면 23번째 if문으로 들어가서 Error 내용을 출력할 것이고, 아니라면 26번째 줄 내용을 출력해 줄 것이에요.

Data Base와 작업이 끝나면 연결을 해제해주는 것이 좋은 것이에요. `Spring Boot`에서 `JPA`나, `MyBatis`는 자동으로 해제를 해 주기 때문에 따로 해제 구문을 작성하지 않지만, JAVA에서 `JDBC`를 이용하여 Data Base를 이용할 땐 반드시 종료 구문을 작성해 줘야 하는 것이에요. 이를 위해 30 ~ 39번째 줄로 연결을 끊어주는 것이에요.

마지막으로 41번째 줄은 생성한 Data Base 연결을 위한 객체를 모듈화하여 외부 파일에서 불러서 사용할 수 있도록 export(내보내기) 해 준 것이에요.

 

 

 

 

 

 

    🔽  Data Base 연결 정보 숨기기

`Spring Boot`을 이용해서 Coding을 할 때, Data Base 접속 정보를 `application.yml`이나, `application.properties`에 작성하고, 이를 Git Hub에 올라가지 않도록 `.gitignore`에 등록을 하거나, `jasypt` 등을 이용해서 정보를 숨길 수 있는 것이에요.

그렇다면 `Node.js`에서는 어떤 방법을 이용할 수 있을까요?

`Node.js`에서는 `dotenv`를 이용하여 환경 변수용 파일을 따로 만들어 관리할 수 있는 것이에요. 그럼 이 파일을 `.gitignore`에 등록하면? Data Base 연결 정보를 지킬 수 있는 것이에요.

 

설치 명령어

npm i dotenv --save

 

 

$npm i dotenv--save

반응형

 

 

 

        📦  환경 변수 설정

`dotenv`는 Project 최상위 경로에 `.env`에서 변수를 가져와 사용할 수 있도록 도와주는 친구인 것이에요.
그렇다면 주니하랑은 `.env`를 만들어야 겠어요! 🧑🏻‍💻

 

.env - Data Base 연결 정보

 

 

참고로 `.env` 파일에서는 각 변수의 값이 자동으로 문자열 형태로 저장되기 때문에 작은 따옴표(')나, 큰 따옴표(")로 묶으면 안되는 것이에요. 

 

 

 

        📦  환경 변수 사용

이제 Data Base를 다시 연결될 수 있도록 환경 변수를 이용해야 되는 것이에요.

`.env`에 등록된 환경 변수는 `process.env.{변수명}`으로 접근할 수 있는 것이에요.

`mysql.js`에 `mysql.createConnection`부분 연결 정보를 고쳐볼 것이에요.

 

위의 그림 10 ~ 14번째 줄을 보면 변화가 있는 것을 알 수 있는 것이에요.

 

 

 

 

 

 

 

    🔽  Data Base 연결

다시 Data Base와 정상적으로 연결을 위해 `app.js`에서 정상적으로 불러와 Data Base 접속이 잘 되는지 확인 해 볼 것이에요.

 

app.js

위의 그림과 같이 최초 3번째 줄에 `dotenv`를 불러오고, `config()`를 호출해줘야 하는 것이에요. `MySQL` 연결 정보 등을 가지고 있는 `mysql.js`를 import 시키고, 그것은 객체화 하여 `mysql.js`의 `init()`을 호출 하여 Data Base를 연결 한 뒤 9번째 줄에 `open()`을 이용해서 Data Base 연결을 시도하도록 해 준 것이에요.

 

문제 발생!!

위 문제는 '이 곳'에서 해결 방법을 확인 하실 수 있도록 준비 해 둘 것이에요.

 

 

 

위의 문제를 해결하고, 정상적으로 Server가 구동 되었습니다.

 

 

 

 

 

🚀 .gitignore 작성

위에서 이야기 했듯 Data Base 연결 정보는 Git Hub에 올라가지 않도록 작업을 해주어야 하는 것이에요.

주니하랑은 https://www.toptal.com/developers/gitignore 이 곳에서 Git Hub에 올라가면 안되는 것들을 손쉽게 받아볼 것이에요.

 

gitignore.io

이렇게 이용하는 OS와 기타 올라가지 않았으면 하는 것들을 적은 뒤 '생성'을 눌러 확인 해 볼 것이에요.

 

gitignore.io

위 내용을 모두 긁어 Project 최상위에 `.gitignore`을 만들고, 내용을 붙혀넣기 해주면 되는 것이에요.

 

.gitignore - 1 ~ 11

 

.gitignore - 77 ~ 79

주니하랑은 Data Base 접속 정보가 들어있는 `.env`와 엄청나게 많은 `node_modules` 그리고, MacOS를 이용하면 쓸데없이 따라 올라가는 `.DS_Sotre`를 제외하고 싶었고, 위와 같이 입력된 것을 확인할 수 있는 것이에요.

 

이제 push를 해 볼것이에요.

 

주니하랑 Git Hub

원하는대로 잘 올라간 것이에요. 😃 👍

 

 

 

참고 자료 : [Node.js] Express + MySQL로 REST API 만들기 (2)

 

 

 

Node.js 교과서:기본기에 충실한 노드제이에스 14 입문서

"이 포스팅은 쿠팡 파트너스 활동의 일환으로, 이에 따른 일정액의 수수료를 제공받습니다."