🎯 도서 API에 페이징 처리를 적용시킵니다.

📙 Today I Learned

SQL 날짜 및 시간 처리

날짜 계산

과거 날짜 구하기

SELECT DATE_SUB(기준_날짜, INTERVAL 숫자 단위);

미래 날짜 구하기

SELECT DATE_ADD(기준_날짜, INTERVAL 숫자 단위);

특정 기간 조회

SELECT * FROM 테이블명 WHERE 칼럼명 BETWEEN 시작일 AND 종료일;

SQL 페이징 처리

특정 페이지 데이터 가져오기

첫번째 방법

SELECT * FROM 테이블명 LIMIT 개수 OFFSET (페이지_번호 - 1) * 개수;

두번째 방법

SELECT * FROM 테이블명 LIMIT (페이지_번호 - 1) * 개수, 개수;

---

도서 API 설계

👉 수정한 부분은 주황색 글씨로 나타냅니다.

전체 도서 조회

• Method : GET

• URL : /books?limit=개수&currentPage=페이지번호

• HTTP Status Code : 200 Ok

• Request Body : x

• Response Body :

[
  {
    "id" : 도서 id,
    "title": "도서 제목",
    "img" : 이미지 id,
    "summary" : "요약 설명",
    "author" : "도서 작가",
    "price" : 가격,
    "likes" : 좋아요 수,
    "pub_date" : "출간 날짜"
  },
  {
    "id" : 도서 id,
    "title": "도서 제목",
    "img" : 이미지 id,
    "summary" : "요약 설명",
    "author" : "도서 작가",
    "price" : 가격,
    "likes" : 좋아요 수,
    "pub_date" : "출간 날짜"
  },
  ...
]

개별 도서 조회

• Method : GET

• URL : /books/:id

• HTTP Status Code : 200 Ok

• Request Body

{
  "email": "사용자가 입력한 이메일",
  "password" : "사용자가 입력한 비밀번호"
}

• Response Body :

{
  "id" : 도서 id,
  "title": "도서 제목",
  "img" : 이미지 id,
  "category" : 카테고리,
  "format" : "포맷",
  "isbn" : "isbn",  
  "summary" : "요약 설명",
  "author" : "도서 작가",
  "pages" : 쪽 수,
  "index" : "목차",
  "price" : 가격,
  "likes" : 좋아요 수,
  "liked" : boolean,
  "pub_date" : "출간 날짜"
}

카테고리별 신간 도서 조회

• Method : GET

• URL : /books?categoryId=:categoryId&news={boolean}

• HTTP Status Code : 200 Ok

• Request Body : x

• Response Body :

[
  {
    "id" : 도서 id,
    "title": "도서 제목",
    "img" : 이미지 id,
    "summary" : "요약 설명",
    "author" : "도서 작가",
    "price" : 가격,
    "likes" : 좋아요 수,
    "pub_date" : "출간 날짜"
  },
  {
    "id" : 도서 id,
    "title": "도서 제목",
    "img" : 이미지 id,
    "summary" : "요약 설명",
    "author" : "도서 작가",
    "price" : 가격,
    "likes" : 좋아요 수,
    "pub_date" : "출간 날짜"
  },
  ...
]

• 참고사항 : news가 true일 때 신간 조회 기준은 출간일로부터 1달 이내

---

BookController.js

const conn = require('../mariadb');
const { StatusCodes } = require('http-status-codes');

const allBooks = (req, res) => {
  const { news, limit, currentPage, categoryId } = req.query;

  const offset = limit * (currentPage - 1);
  let sql = 'SELECT * FROM books';
  let values = [];

  if (categoryId && news) {
    sql +=
      ' WHERE category_id = ? AND pub_date BETWEEN DATE_SUB(NOW(), INTERVAL 1 MONTH) AND NOW()';
    values.push(categoryId);
  } else if (categoryId) {
    sql += ' WHERE category_id = ?';
    values.push(categoryId);
  } else if (news) {
    sql +=
      ' WHERE pub_date BETWEEN DATE_SUB(NOW(), INTERVAL 1 MONTH) AND NOW()';
  }

  sql += ' LIMIT ? OFFSET ?';
  values.push(parseInt(limit), offset);

  conn.query(sql, values, (err, result) => {
    if (err) {
      console.log(err);
      return res.status(StatusCodes.BAD_REQUEST).end();
    }
    if (result.length) {
      return res.status(StatusCodes.OK).json(result);
    } else {
      return res.status(StatusCodes.NOT_FOUND).end();
    }
  });
};

const bookDetail = (req, res) => {
  const id = parseInt(req.params.id);

  const sql =
    'SELECT * FROM books LEFT JOIN categories ON books.category_id = categories.id  WHERE books.id = ?';
  conn.query(sql, id, (err, result) => {
    if (err) {
      console.log(err);
      return res.status(StatusCodes.BAD_REQUEST).end();
    }

    if (result[0]) {
      return res.status(StatusCodes.OK).json(result);
    } else {
      return res.status(StatusCodes.NOT_FOUND).end();
    }
  });
};

module.exports = {
  allBooks,
  bookDetail,
};
  

• allBooks : 모든 책 목록을 조회합니다.

  • categoryId, news 여부에 따라 필터링을 거칩니다.

  • limit(한 번에 가져오는 책 개수)와 currentPage(현재 페이지 번호)로 페이징을 처리합니다.

🤔 왜 offset은 limit * (currentPage - 1)일까?

offset은 조회할 데이터의 시작 위치를 의미하기 때문입니다. 0부터 시작하며, 지정한 limit만큼 데이터를 불러오게 됩니다.

currentPage	offset = limit * (currentPage - 1)	조회 범위 (LIMIT 10 OFFSET X)
1 (첫 페이지)	10 * (1 - 1) = 0	1~10번 데이터
2 (두 번째 페이지)	10 * (2 - 1) = 10	11~20번 데이터
3 (세 번째 페이지)	10 * (3 - 1) = 20	21~30번 데이터
4 (네 번째 페이지)	10 * (4 - 1) = 30	31~40번 데이터

⚠️ sql 추가 시 주의할 점

sql += 를 활용하여 SQL 뒤에 조건문을 추가할 때 앞에 공백을 추가해야 SQL 문법 오류가 발생하지 않습니다.

예시 : sql += ' LIMIT ? OFFSET ?'

• bookDetail : 책을 상세 조회합니다.

  • books 테이블과 categories 테이블을 LEFT JOIN 하여, 책이 속한 카테고리 정보를 함께 가져옵니다.

---

✏️ 한 줄 회고

이전에 페이지네이션을 직접 만들었을 때는 직접 계산까지 vanilla javascript로 작성을 했었는데, 백엔드를 활용하니 더욱 수월하다는 것을 느꼈습니다.