Spring Boot에 MySQL / Mybatis 연결하기

Spring Boot + MyBatis + MySQL

Spring Boot 프로젝트에서 MyBatis를 이용한 MySQL 연동 방법이다.

* Spring Boot 프로젝트를 생성하고 기본적인 세팅을 하는 방법은 여기에

 

1. 의존성 추가

mybatis 및 mysql을 사용하기 위해 해당 의존성을 추가한다.

maven을 사용하는 프로젝트의 설정파일인 pom.xml에서 의존성을 추가하면 글로벌 저장소에서 필요한 라이브러리를 로컬 저장소로 다운로드하고 클래스 패스를 지정하여 프로젝트에서 사용할 수 있도록 한다. 

 

아래 링크의 MVN Repository에서 원하는 의존성을 검색하여 추가할 수 있다. 보통 보편적인 버전이나 최신 버전을 사용한다.

https://mvnrepository.com/artifact/mysql/mysql-connector-java/8.0.28

 

* Duplicating managed version 8.0.28 for mysql-connector-java 경고

의존성을 추가했는데 아래와 같이 노란색 경고(Duplicating managed version 8.0.28 for mysql-connector-java)가 뜨는 경우는 사용하려는 버전이 Spring Boot 버전과 맞지 않아서 발생하는 경고이다. 꼭 그 버전을 사용해야 하는 경우가 아니라면 버전을 맞춰주면 된다.

 

Spring Boot에서는 의존성을 정의할 때 버전을 명시하지 않아도 알아서 적절한 버전을 가져와주는 의존성 관리 기능이 있다.

• mysql-connector-java: mysql과 통신할 수 있도록 하는 드라이버
• mybatis-spring-boot-starter: spring boot용 mybatis

<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
</dependency>

<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>1.3.2</version>
</dependency>

mysql은 굳이 버전을 명시하지 않아도 자동으로 버전이 매핑되지만 mybatis 같은 외부 의존성은 버전을 직접 적어주는 것이 좋다.

 

 

2. database 및 mybatis 세팅

application.properties에 아래와 같이 설정해준다.

 

데이터베이스 관련 설정은 url, 사용자 계정 정보, 드라이버 클래스를 적어준다.

마이바티스 관련 설정은 매퍼용 클래스가 위치한 경로, xml 파일이 위치한 경로를 적어 해당 경로의 파일을 읽어들이도록 하면 된다.

# database
spring.datasource.url=jdbc:mysql://localhost:3306/데이터베이스명?characterEncoding=utf8
spring.datasource.username=계정ID
spring.datasource.password=계정PW
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

# mybatis
mybatis.type-aliases-package=com.plus.tistory.dao
mybatis.mapper-locations=classpath:mybatis/mapper/*.xml

 

3. mybatis-config.xml 파일 생성

resources 내에 mybatis-config.xml 파일을 만들고 아래와 같이 적어준다.

만약 설정파일을 찾지 못해 오류가 발생하면 application.properties에 mybatis.config=mybatis-config.xml 와 같이 설정파일명을 직접 지정해주어도 된다.

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <settings>
        <setting name="mapUnderscoreToCamelCase" value="true" />
        <setting name="callSettersOnNulls" value="true"/>
    </settings>
</configuration>

여기까지가 세팅은 끝이다. 이제 mybatis를 사용하기 위해서는 mvc 패턴으로 db에 접근해보자.

 

 

4. Controller / Service / Vo / Dao 작성

- Controller

package com.plus.tistory.controller;

import java.util.List;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import com.plus.tistory.service.TestService;
import com.plus.tistory.vo.User;

@RestController
public class TestController {

	@Autowired
	private TestService testService;
	
    @RequestMapping("/")
    public String hello() {
        return "Hello Test Page!";
    }
    
    @GetMapping("/test")
    public List<User> test() {
      return testService.getUserList();
    }
}

 

- Service

package com.plus.tistory.service;

import java.util.List;

import com.plus.tistory.vo.User;

public interface TestService {
    public List<User> getUserList();
}

 

package com.plus.tistory.service;

import java.util.List;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import com.plus.tistory.dao.TestMapper;
import com.plus.tistory.vo.User;

@Service
public class TestServiceImpl implements TestService {
    
	@Autowired
	private TestMapper testMapper;

    @Override
    public List<User> getUserList() {
        return testMapper.getUserList();
    }
}

 

- Vo

package com.plus.tistory.vo;

public class User {
    private String name;
    private int age;
    
	public String getName() {
		return name;
	}
	public void setName(String name) {
		this.name = name;
	}
	public int getAge() {
		return age;
	}
	public void setAge(int age) {
		this.age = age;
	}
}

 

- Dao

@Mapper 어노테이션으로 mapper.xml 을 연결해주므로 꼭 적어주어야 한다.

package com.plus.tistory.dao;

import java.util.List;

import org.apache.ibatis.annotations.Mapper;
import org.springframework.stereotype.Repository;

import com.plus.tistory.vo.User;

@Repository
@Mapper
public interface TestMapper {
    List<User> getUserList();
}

 

<?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.plus.tistory.dao.TestMapper">

  <select id="getUserList" resultType="com.plus.tistory.vo.User">
    SELECT * FROM USER;
  </select>

</mapper>

 

- 테스트용 테이블 생성 및 데이터 삽입

create table USER (
    name varchar(20),
    age integer
);

insert into USER(name, age) values ('eric', 10);

 

이렇게 작성하면 연동은 끝난다.

 

* org.apache.ibatis.binding.BindingException: Invalid bound statement (not found) 오류

해당 오류 발생 시 Mapper 인터페이스와 Mapper xml에서 적은 id가 일치하는지 확인해봐야 한다. 일치하는데 이와 같은 오류가 발생할 경우 Mapper xml의 위치를 지정해주는 설정파일 내 mybatis.mapper-locations 설정 경로를 확인해보자.

 

서버 기동 후 /test 경로로 요청해보면 아래와 같은 결과를 확인할 수 있다. RestController로 만들어놨기 때문에 List<User>의 값을 반환한다.