🎽 인프런 워밍업 클럽 0기 백엔드 네 번째 과제

출처
https://inf.run/XKQg

데이터베이스를 사용해 만드는 API 강의에서 JdbcTemplate을 사용하여 DB에 SQL문을 실행하는 방법에 대해 학습했다.

🌈 JdbcTemplate이란?

JDBC(Java Database Connectivity)의 핵심 부분을 담당하는 중심 대리자이다.
간단히 말하면, 데이터베이스와의 상호 작용을 도와주는 도구라고 생각하면 된다.

1. SQL 쿼리를 실행하고, 그 결과를 가져오는 등의 JDBC 작업을 수행한다.
   우리가 작성하는 애플리케이션 코드는 SQL 쿼리를 제공하고 결과를 추출하는 역할을 한다.

• 이 클래스는 ResultSets을 처리하고 JDBC 예외를 다루어 주기적으로 발생하는 문제들을 처리해준다.
• PreparedStatementCreator는 Connection과 SQL, 그리고 필요한 매개변수를 받아서 준비된 문을 만들어주는 역할을 한다.
• ResultSetExtractor는 ResultSet에서 값을 추출한다.
• 이 외에도 PreparedStatementSetter나 RowMapper 같은 다양한 인터페이스를 사용할 수 있다.

2. 멀티스레드 환경에서도 안전하게 동작한다.
   서비스 내에서 직접 사용하거나 애플리케이션 컨텍스트에서 빈(Bean)으로 설정하여 사용할 수 있다.
   중요한 점은 DataSource(데이터베이스와의 연결을 나타내는 객체)는 항상 애플리케이션 컨텍스트에 빈으로 설정되어야 한다.

⛳️ Table 생성

create table fruit
(
    id              bigint auto_increment,
    name            varchar(20),
    warehousingDate date,
    price           long,
    is_sold boolean default 0,
    primary key (id)
);

먼저, fruit 테이블에 어떤 칼럼이 필요한지 확인했다.
문제 1의 HTTP 요청 본문에서 name, warehosuingDate, price가 필요하고, 문제 2, 문제 3을 해결하기 위해 해당 과일이 판매된 상태인지를 나타내는is_sold 라는 칼럼을 추가했다.

데이터의 표현 범위를 확장하기 위해 price 칼럼의 데이터 타입으로 long을 선택했다.
또한, is_sold 칼럼에는 default를 사용하여 기본값이 0이 되도록 설정했다.
(과일이 판매되지 않은 상태일 때, 별도의 값 지정 없이 0이 자동으로 할당되어 직관적이고 데이터의 일관성을 유지할 수 있다.)

⛳️ 문제1

💻 최종 코드

public record FruitInfoRequest(String name, LocalDate warehousingDate, long price) {
}

@RestController
@RequiredArgsConstructor
public class FruitController {

    private final JdbcTemplate jdbcTemplate;

    @PostMapping("/api/v1/fruit")
    public void saveFruit(@RequestBody FruitInfoRequest request) {
        String sql = "insert into fruit (name, warehousingDate, price) values (?, ?, ?)";
        jdbcTemplate.update(sql, request.name(), request.warehousingDate(), request.price());
    }
}

HTTP POST 요청을 처리하는 메소드로, /api/v1/fruit 엔드포인트에 매핑되어 있다.
클라이언트가 전송한 HTTP 요청의 본문(@RequestBody FruitInfoRequest request)에서 받은 과일 정보를 데이터베이스의 'fruit' 테이블에 저장한다.

메소드 내부에서는 SQL 쿼리를 정의하고, JdbcTemplate의 update 메서드를 사용하여 해당 쿼리를 실행한다.
이를 통해 데이터베이스에 새로운 과일 정보가 입력되며, SQL 쿼리에서는 name, warehousingDate, price 값이 FruitInfoRequest 객체에서 가져온 값으로 대체된다.

▶️ 실행 결과

⛳️ 문제2

💻 최종 코드

public record FruitIdRequest(long id) {}

@RestController
@RequiredArgsConstructor
public class FruitController {

	private final JdbcTemplate jdbcTemplate;

    @PutMapping("/api/v1/fruit")
    public void updateFruit(@RequestBody FruitIdRequest request) {
        String readSql = "select * from fruit where id = ?";
        boolean isFruitNotExist = jdbcTemplate.query(readSql, (rs, rowNum) -> 0, request.id()).isEmpty();
        if (isFruitNotExist) {
            throw new IllegalArgumentException("해당하는 과일이 존재하지 않습니다.");
        }

        String sql = "update fruit set is_sold = 1 where id = ?";
        jdbcTemplate.update(sql, request.id());
    }
}

HTTP PUT 요청을 처리하는 updateFruit 메소드로,/api/v1/fruit 엔드포인트에 매핑되어 있다.

클라이언트로부터 받은 FruitIdRequest 객체를 통해 특정 과일의 ID를 가져온다.
해당 ID로 데이터베이스의 'fruit' 테이블을 조회하는 SQL 쿼리를 실행한다.
만약 조회 결과가 없으면 (= isEmpty()가 true라면), 해당하는 ID의 과일이 존재하지 않는다는 예외를 던진다.

조회 결과가 있다면, 해당하는 ID의 과일을 'fruit' 테이블에서 찾아 is_sold 칼럼을 1로 업데이트하여 해당 과일을 판매된 상태로 변경한다.

▶️ 실행 결과

⛳️ 문제3

💻 최종 코드

public record FruitAmountResponse(long salesAmount, long notSalesAmount) {
}

@RestController
@RequiredArgsConstructor
public class FruitController {

    private final JdbcTemplate jdbcTemplate;
    
    @GetMapping("/api/v1/fruit/stat")
    public FruitAmountResponse getAmount(@RequestParam String name) {
        String readSql = "select * from fruit where name = ?";
        boolean isFruitNotExist = jdbcTemplate.query(readSql, (rs, rowNum) -> 0, name).isEmpty();
        if (isFruitNotExist) {
            throw new IllegalArgumentException("해당하는 과일이 존재하지 않습니다.");
        }

        String sql1 = "select sum(price) as salesAmount from fruit where is_sold = 1";
        String sql2 = "select sum(price) as notSalesAmount from fruit where is_sold = 0";

        Long salesAmount = jdbcTemplate.queryForObject(sql1, (rs, rowNum) -> rs.getLong("salesAmount"));
        Long notSalesAmount = jdbcTemplate.queryForObject(sql2, (rs, rowNum) -> rs.getLong("notSalesAmount"));

        return new FruitAmountResponse(salesAmount, notSalesAmount);
    }
}

HTTP GET 요청을 처리하는 getAmount 메소드로, /api/v1/fruit/stat 엔드포인트에 매핑되어 있다.

클라이언트로부터 받은 과일의 이름(@RequestParam String name)을 기반으로 데이터베이스의 'fruit' 테이블을 조회한다.
문제 2처럼 과일이 존재하지 않으면 예외를 던져 검증했다.

그리고 과일이 존재한다면, is_sold가 1(판매된 상태)인 과일의 가격 합계를 조회하는 쿼리(sql1)와 is_sold가 0(미판매 상태)인 과일의 가격 합계를 조회하는 쿼리(sql2)를 실행하여 팔린 금액과 팔리지 않은 금액을 조회하고, 이를 응답으로 반환했다.

▶️ 실행 결과

📚 참고자료
https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/jdbc/core/JdbcTemplate.html