[Node.js] MySQL2 모듈 장기간 연결 문제 해결

발생한 오류

도커로 MySQL 데이터베이스와 연결된 Node.js 서버 컨테이너를 밤새 실행해둔 채로 퇴근 후, 다음날 출근해서 보니 아래와 같은 오류가 발생했다.

Error: Can't add new command when connection is in closed state
Error: This socket has been ended by the other party

 

Error: Can't add new command when connection is in closed state

데이터베이스 연결이 이미 닫혔음에도 새로운 쿼리나 명령을 실행하려고 할 때 발생하는 오류이다. 연결이 예기치 않게 닫힌 경우 또는 장시간 연결로 연결이 닫혔을 때 발생할 수 있다. 네트워크 문제, 데이터베이스 서버 설정, 또는 연결 풀의 구성 문제 등이 원인일 수 있다.

 

Error: This socket has been ended by the other party

MySQL 클라이언트와 서버 간의 연결이 예기치 않게 끊어졌을 때 발생하는 오류이다. 주로 다음과 같은 상황에서 발생할 수있다.

• 네트워트 문제: 데이터베이스 서버와의 네트워크 연결이 불안정하거나 끊어진 경우.
• 서버 설정: 데이터베이스 서버 측의 설정 문제로 연결이 중단될 수 있다.
• 타임아웃: 데이터베이스 서버에서 클라이언트 연결을 타임아웃으로 강제로 끊은 경우.

 

해결 방법

다음 사항들을 적용하여 긴 활동 기간 동안 발생하는 연결 예외(connection exceptions)를 해결한다.

• mysql.createConnection 대신 mysql.createPool을 사용하여 연결 관리 개선
• enableKeepAlive: true 설정: 지속적인 연결 유지
• 연결 풀링 옵션 설정 (connectionLimit, waitForConnections',queueLimit`)

적용한 코드

// lib/db.js
const mysql = require('mysql2');
require('dotenv').config();

// createConnection이 아닌 createPool 사용
const db = mysql.createPool({
  host: process.env.DB_HOST,
  user: process.env.DB_USER,
  password: process.env.DB_PASSWORD,
  database: process.env.DB_DATABASE,
  port: process.env.DB_PORT,
  connectionLimit: 2, // 필요에 따라 조정
  waitForConnections: true,
  queueLimit: 0,
  keepAliveInitialDelay: 10000,
  enableKeepAlive: true, // maintain persistent connections
});

module.exports = db;

// index.js
const express = require('express');
const session = require('express-session');
const db = require('./lib/db'); // db.js 파일을 가져옵니다. (db => pool)
var MySQLStore = require('express-mysql-session')(session);
const sessionOption = require('./lib/sessionOption'); // sessionOption 설정 파일
const app = express();

// MySQL 세션 스토어 설정
var sessionStore = new MySQLStore(sessionOption, db); // db(pool)을 사용하여 세션 스토어 설정

// Session middleware 설정
app.use(session({
    key: 'session_cookie_name',
    secret: 'session_cookie_secret',
    store: sessionStore,
    resave: false,
    saveUninitialized: false,
}));

// Database 연결
...

 

Database를 연결하는 방법은 두가지가 있다.

 

1. db.getConnection을 사용한 방법

pool.getConnection((err, connection) => {
  if (err) {
    console.error('데이터베이스 연결 실패:', err);
    // 오류 처리
    return;
  }

  connection.query("SELECT 1", (error, results) => {
    connection.release(); // 연결 반환
    if (error) {
      console.error("쿼리 실행 오류:", error);
      // 오류 처리
    } else {
      console.log("쿼리 결과:", results);
      // 결과 처리
    }
  });
});

• getConnection: db.getConnection을 사용하여 쿼리를 실행하기 전에 데이터베이스 연결을 직접 가져온다. 이 메서드는 콜백 함수의 첫번째 인자로 오류(err)와 두번째 인자로 연결 객체(connection)을 받는다.
• 연결 관리: 쿼리를 실행한 후에는 connection.release()를 호출하여 연결을 풀에 반환해야 한다.
• 오류 처리: getConnection에서 발생한 오류와 query 메서드에서 발생한 오류를 각각 처리할 수 있다. 연결 오류나 쿼리 실행 오류에 대한 세밀한 처리가 가능하다.

 

2. db.query를 직접 사용한 방법

db.query('SELECT 1', (error, results) => {
  if (error) {
    console.error('데이터베이스 연결 실패:', error);
    // 오류 처리
    return;
  }
  console.log('데이터베이스에 성공적으로 연결됨');
});

• 간편성: db.query를 직접 사용할 경우에는 내부적으로 getConnection을 호출하고 쿼리르 ㄹ실행한 후 연결을 반환하는 과정이 자동으로 처리된다.
• 연결 관리: 내부적으로 풀에서 연결을 가져와 쿼리를 실행하고, 쿼리 실행 후 연결을 자동으로 반환한다.
• 오류 처리: db.query에서 발생한 모든 오류를 한 곳에서 처리해야 하기 때문에 연결 오류와 쿼리 실행 오류를 세밀하게 분류하거나 처리하기 어렵다.

 

그렇다면 둘 중 어떤 방법을 선택해야 할까?

• 복잡성과 유연성: db.getConnection을 사용하면 더 복잡하지만, 연결 관리를 더 세밀하게 할 수 있다. 특히 복잡한 데이터베이스 작업이나 여러 쿼리를 순차적으로 실행해야 할 때 유용하다.
• 간편성과 편의성: db.query를 직접 사용하는 경우에는 간단하게 쿼리를 실행할 수 있으며, 대부분의 경우에 충분할 수 있다. 특히, 단일 쿼리를 실행하거나 간단한 데이터베이스 작업을 수행할 때 유용하다.

따라서, 사용하는 상황에 따라 db.getConnection과 db.query를 적절히 선택하여 데이터 베이스 연결 관리와 오류 처리를 할 수 있다.

 

 

 

---

참고

• [Node.js] Mysql2 모듈 사용하여 장시간 켜놓을시 커넥션 예외가 발생하는 이슈
• ChatGPT