[스프링 부트(Spring Boot) & 마이바티스(Mybatis) 연동] 개발 환경 설정

2. 개발 환경 설정

스프링 부트와 마이바티스를 함께 사용하기 위한 개발 환경을 설정하는 방법에 대해 다룹니다. 이를 위해 이클립스 IDE와 마이바티스 플러그인 설치 방법, 스프링 부트 프로젝트 생성 방법 등을 다룹니다. 또한, 이번 섹션에서는 스프링 부트와 마이바티스를 연동하기 위해 필요한 의존성 추가 방법과 설정 파일 작성 방법에 대해서도 다룹니다. 이번 섹션에서 제공되는 실습을 통해 개발 환경 설정에 필요한 작업들을 간단하게 수행해 볼 수 있습니다. 이를 통해 스프링 부트와 마이바티스를 함께 사용하기 위한 필수적인 개발 환경을 구축할 수 있습니다.

 

2.1. JDK 설치 및 설정

스프링 부트와 마이바티스를 사용하여 애플리케이션을 개발하려면 먼저 Java Development Kit(JDK)를 설치해야 합니다. JDK는 Java 프로그램 개발에 필요한 도구와 라이브러리를 제공합니다. 이 섹션에서는 JDK 버전 선택, 설치 방법, 환경 변수 설정에 대해 설명합니다.

 

2.1.1. JDK 버전 선택

스프링 부트 2.5.x를 사용하려면 최소한 JDK 8을 설치해야 하며, JDK 8부터 JDK 17까지 지원합니다. 가장 최신 버전의 JDK를 설치하는 것이 좋지만, 프로젝트의 특정 요구 사항에 따라 다른 버전을 선택할 수 있습니다. JDK를 선택할 때 공식 지원 범위 내에서 선택하고, 자바 버전 간의 차이점을 고려하세요.

 

2.1.2. JDK 설치 방법

JDK를 설치하려면 아래 단계를 따르세요.

1. Oracle 공식 웹사이트(https://www.oracle.com/java/technologies/javase-jdk11-downloads.html)에서 원하는 버전의 JDK를 다운로드합니다. OpenJDK(https://adoptium.net/)를 사용하는 것도 좋은 대안입니다.
2. 다운로드한 파일을 실행하여 JDK를 설치합니다. 기본 설치 경로를 사용하거나 원하는 경로를 선택할 수 있습니다.
3. 설치가 완료되면, 설치된 JDK의 경로를 확인합니다. 예를 들어, 기본 경로는 "C:\Program Files\Java\jdk-버전"일 수 있습니다.

 

2.1.3. 환경 변수 설정

JDK를 설치한 후, 환경 변수를 설정해야 합니다. 이렇게 하면 시스템에서 Java 컴파일러와 런타임을 찾을 수 있습니다. 환경 변수를 설정하는 방법은 다음과 같습니다.

 

1. 제어판 > 시스템 및 보안 > 시스템 > 고급 시스템 설정으로 이동합니다.
2. 시스템 속성 창의 고급 탭에서 환경 변수 버튼을 클릭합니다.
3. 시스템 변수 섹션에서 '새로 만들기'를 클릭하고 변수 이름에 'JAVA_HOME'을 입력하고 변수 값에 JDK 설치 경로를 입력합니다. 예를 들어, "C:\Program Files\Java\jdk-버전"을 입력합니다.
4. 'Path' 변수를 찾아 편집 버튼을 클릭합니다. 새로운 항목을 추가하고 "%JAVA_HOME%\bin"을 입력합니다. 이렇게 하면 Java 실행 파일에 대한 경로가 설정됩니다.
5. 설정이 완료되면, 모든 창을 닫고 명령 프롬프트를 엽니다.
6. 명령 프롬프트에서 'java -version'과 'javac -version' 명령어를 실행하여 설치된 JDK 버전을 확인합니다. 출력된 버전이 일치하면 환경 변수 설정이 정상적으로 완료된 것입니다.

이제 JDK가 성공적으로 설치되고 환경 변수가 설정되었습니다. 다음 단계는 스프링 부트 프로젝트를 생성하는 것입니다.

 

2.2. 스프링 부트 프로젝트 생성

스프링 부트 프로젝트를 생성하는 가장 쉬운 방법은 Spring Initializr라는 온라인 툴을 사용하는 것입니다. 이 툴은 웹 기반 인터페이스를 제공하여 프로젝트 구성 요소를 선택하고 프로젝트 구조를 자동으로 생성해 줍니다. 

 

2.2.1. Spring Initializr 사용

1. 웹 브라우저를 열고 https://start.spring.io/ 사이트에 접속합니다.
2. 프로젝트 유형(Project type)을 선택합니다. 일반적으로 'Maven Project' 또는 'Gradle Project' 중 하나를 선택할 수 있습니다. 이 교육자료에서는 Maven 기반 프로젝트를 사용하겠습니다.
3. 프로젝트 메타데이터(Project metadata)를 입력합니다. 이에는 'Group'(프로젝트 그룹 ID), 'Artifact'(프로젝트 아티팩트 ID), 'Name'(프로젝트 이름), 'Description'(프로젝트 설명), 'Package name'(패키지 이름) 등이 포함됩니다.
4. 패키징(Packaging) 옵션을 선택합니다. 일반적으로 'Jar' 또는 'War' 중 하나를 선택할 수 있습니다. 스프링 부트에서는 'Jar' 패키징이 권장됩니다.
5. Java 버전을 선택합니다. 프로젝트에서 사용할 Java 버전을 선택하세요. 이 교육자료에서는 Java 11을 사용하겠습니다.
6. 의존성(Dependencies) 섹션에서 필요한 라이브러리를 검색하여 선택합니다. 예를 들어, 웹 애플리케이션 개발을 위해 'Web' 카테고리에서 'Spring Web' 의존성을 선택합니다.
7. 'Generate' 버튼을 클릭하여 생성된 프로젝트 파일을 다운로드합니다. 다운로드한 압축 파일을 원하는 위치에 압축 해제합니다.

 

2.2.2. 프로젝트 구성 요소 선택

스프링 부트 프로젝트 생성 시 선택할 수 있는 주요 구성 요소는 다음과 같습니다.

 

• 프로젝트 유형: Maven 또는 Gradle 기반 프로젝트를 선택할 수 있습니다. Maven은 전통적인 빌드 도구로 널리 사용되며, Gradle은 성능과 유연성을 강조한 최신 빌드 도구입니다.
• 패키징: JAR 또는 WAR 패키징을 선택할 수 있습니다. JAR 패키징은 스프링 부트 실행 가능한 JAR 파일을 생성하며, WAR 패키징은 웹 애플리케이션 서버에 배포할 수 있는 WAR 파일을 생성합니다. 스프링 부트에서는 JAR 패키징이 권장됩니다.
• Java 버전: 프로젝트에서 사용할 Java 버전을 선택할 수 있습니다. 현재 가장 널리 사용되는 버전은 Java 8, Java 11, 그리고 Java 17입니다. 여기서는 Java 11을 사용하겠습니다.
• 의존성: 프로젝트에 필요한 라이브러리를 선택할 수 있습니다. 예를 들어, 스프링 웹 애플리케이션 개발을 위해서는 'Spring Web' 의존성이 필요하며, 마이바티스를 사용하기 위해서는 'MyBatis' 의존성이 필요합니다. 추가로, 데이터베이스 연결을 위한 'JDBC API'와 특정 데이터베이스 드라이버를 선택해야 합니다.

프로젝트 구조는 다음과 같습니다.

• src/main/java: Java 소스 코드가 저장되는 디렉토리입니다.
• src/main/resources: 프로젝트에서 사용하는 리소스 파일(예: 설정 파일, SQL 파일 등)이 저장되는 디렉토리입니다.
• src/test/java: 테스트 코드가 저장되는 디렉토리입니다.
• pom.xml: Maven 기반 프로젝트의 빌드 설정 파일입니다. 의존성, 플러그인, 프로파일 등 프로젝트 빌드와 관련된 설정을 포함합니다. (Gradle 기반 프로젝트의 경우 build.gradle 파일에 해당합니다.)

생성된 프로젝트를 개발 환경에 임포트한 후, 프로젝트를 실행해 보겠습니다.

1. 사용하는 IDE에서 "File" > "Open" 메뉴를 선택하고, 압축 해제한 프로젝트 디렉토리를 선택하여 프로젝트를 엽니다.
2. IDE에서 메인 클래스(@SpringBootApplication이 선언된 클래스)를 찾아 'Run' 버튼을 클릭하거나, 터미널에서 프로젝트 디렉토리로 이동한 후 ./mvnw spring-boot:run 명령을 실행합니다. (Gradle 기반 프로젝트의 경우 ./gradlew bootRun 명령을 사용합니다.) 
3. 웹 브라우저에서 http://localhost:8080 주소로 접속하여 스프링 부트 애플리케이션이 정상적으로 실행되는지 확인합니다.

 

2.3. 마이바티스 의존성 추가

스프링 부트 프로젝트에 마이바티스를 연동하기 위해서는 먼저 마이바티스 관련 의존성을 추가해야 합니다. Maven 기반 프로젝트와 Gradle 기반 프로젝트에서 의존성을 추가하는 방법을 설명하겠습니다.

 

2.3.1. Maven 기반 프로젝트

Maven 기반 프로젝트의 경우, pom.xml 파일에 아래와 같이 마이바티스 스프링 부트 스타터(mybatis-spring-boot-starter) 의존성을 추가합니다. 

<dependencies>
    <!-- 기존 의존성 생략 -->

    <!-- 마이바티스 스프링 부트 스타터 의존성 추가 -->
    <dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-starter</artifactId>
        <version>2.2.0</version>
    </dependency>
</dependencies>

 

2.3.2. Gradle 기반 프로젝트

Gradle 기반 프로젝트의 경우, build.gradle 파일에 아래와 같이 마이바티스 스프링 부트 스타터(mybatis-spring-boot-starter) 의존성을 추가합니다.

dependencies {
    // 기존 의존성 생략

    // 마이바티스 스프링 부트 스타터 의존성 추가
    implementation 'org.mybatis.spring.boot:mybatis-spring-boot-starter:2.2.0'
}

 

의존성을 추가한 후 프로젝트를 빌드하면, 마이바티스 관련 라이브러리가 프로젝트에 포함됩니다.

 

이제 스프링 부트 프로젝트와 마이바티스를 연동할 준비가 되었습니다. 마이바티스 연동을 위해 추가적으로 설정 파일(application.properties 또는 application.yml)에 데이터베이스 연결 정보와 마이바티스 설정을 추가해야 합니다.

 

예를 들어, application.properties 파일에 다음과 같이 데이터베이스 연결 정보를 추가할 수 있습니다.

spring.datasource.url=jdbc:mysql://localhost:3306/mydatabase?serverTimezone=UTC&characterEncoding=UTF-8
spring.datasource.username=myuser
spring.datasource.password=mypassword
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

마이바티스 설정도 application.properties 파일에 다음과 같이 추가할 수 있습니다.

mybatis.type-aliases-package=com.example.mybatisdemo.domain
mybatis.mapper-locations=classpath:mapper/*.xml

이제 마이바티스 의존성을 추가하고, 필요한 설정을 완료한 스프링 부트 프로젝트에서 마이바티스를 사용하여 데이터베이스 작업을 수행할 수 있습니다. 마이바티스는 데이터베이스와의 상호 작용을 단순화하고, SQL 쿼리를 XML 파일이나 애너테이션을 통해 관리할 수 있게 도와줍니다.

 

다음 단계는 마이바티스 매퍼와 도메인 객체를 작성하는 것입니다.

• 1. 도메인 객체(Domain Object): 도메인 객체는 데이터베이스 테이블의 행을 나타내는 자바 객체입니다. 이 객체는 데이터베이스 테이블과 일대일로 매핑되며, 테이블의 각 열은 객체의 속성으로 표현됩니다. 예를 들어, 'User' 도메인 객체를 생성하려면 다음과 같이 작성할 수 있습니다.

package com.example.mybatisdemo.domain;

public class User {
    private Long id;
    private String username;
    private String email;
    // getters and setters 생략
}

 

• 2. 매퍼 인터페이스(Mapper Interface): 매퍼 인터페이스는 도메인 객체와 SQL 쿼리를 매핑하는 역할을 합니다. 인터페이스에 정의된 메서드는 XML 파일이나 애너테이션을 사용하여 SQL 쿼리와 매핑됩니다. 예를 들어, 'UserMapper' 인터페이스를 생성하려면 다음과 같이 작성할 수 있습니다.

package com.example.mybatisdemo.mapper;

import com.example.mybatisdemo.domain.User;
import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Select;

import java.util.List;

@Mapper
public interface UserMapper {
    @Select("SELECT * FROM user")
    List<User> findAll();
}

 

• 3. 매퍼 XML 파일(Mapper XML file): 매퍼 인터페이스에서 사용할 SQL 쿼리를 XML 파일로 작성할 수 있습니다. 이 방법을 사용하면 SQL 쿼리를 한 곳에서 관리하고, 변경이 쉽게 할 수 있습니다. 예를 들어, 'UserMapper.xml' 파일을 작성하려면 다음과 같이 작성할 수 있습니다.

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.example.mybatisdemo.mapper.UserMapper">
    <select id="findAll" resultType="com.example.mybatisdemo.domain.User">
        SELECT * FROM user
    </select>
</mapper>

 

마이바티스 매퍼와 도메인 객체를 작성한 후, 스프링 빈(Bean)으로 주입하여 서비스 또는 컨트롤러에서 사용할 수 있습니다. 이렇게 하면 데이터베이스 작업을 손쉽게 처리할 수 있으며, 애플리케이션 로직과 데이터베이스 작업을 분리하여 코드의 가독성과 유지 보수성을 향상시킬 수 있습니다.

 

예를 들어, 사용자 정보를 조회하는 서비스를 구현하려면 다음과 같이 작성할 수 있습니다.

package com.example.mybatisdemo.service;

import com.example.mybatisdemo.domain.User;
import com.example.mybatisdemo.mapper.UserMapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;

@Service
public class UserService {
    private final UserMapper userMapper;

    @Autowired
    public UserService(UserMapper userMapper) {
        this.userMapper = userMapper;
    }

    public List<User> findAll() {
        return userMapper.findAll();
    }
}

 

컨트롤러에서는 서비스를 주입받아 사용자 정보를 조회하고, 클라이언트에 응답을 반환할 수 있습니다.

package com.example.mybatisdemo.controller;

import com.example.mybatisdemo.domain.User;
import com.example.mybatisdemo.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.List;

@RestController
public class UserController {
    private final UserService userService;

    @Autowired
    public UserController(UserService userService) {
        this.userService = userService;
    }

    @GetMapping("/users")
    public List<User> findAll() {
        return userService.findAll();
    }
}

 

이제 스프링 부트 프로젝트에서 마이바티스를 사용하여 데이터베이스 작업을 수행하는 방법에 대해 알아보았습니다. 이를 통해 데이터베이스 작업을 더 간결하게 처리할 수 있으며, 애플리케이션 로직과 데이터베이스 작업을 명확하게 분리하여 코드의 가독성과 유지 보수성을 높일 수 있습니다. 이러한 기술을 활용하여 다양한 스프링 부트 프로젝트를 구축하고, 데이터베이스와의 상호 작용을 보다 쉽게 처리할 수 있습니다. 

 

 

 

2023.05.06 - [프로그래밍/스프링 부트(Spring Boot) & 마이바티스(Mybatis) 연동] - [스프링 부트(Spring Boot) & 마이바티스(Mybatis) 연동] 서론

[스프링 부트(Spring Boot) & 마이바티스(Mybatis) 연동] 서론