[Spring-Framework] 22(번외). STS 4.4 - Spring Boot Starter - MyBatis(Boot용), HikariCP 3.4 사용하기
이전의 JSP/servlet의 myBatis 글과 Spring Framework를 활용하여 HikariCP를 적용한 프로젝트를 소개한 적이 있다.
이 글들에 이어서 소개하려고 한다.
IDE: Spring-Tool-Suite 4-4.7.2 Releases
- MyBatis Spring Boot Starter » 2.1.3(2020-06-05) // pom.xml에서 이거 하나만 해주면 설치 끝남.
이 글을 읽으려면, 기존의 MyBatis 사용과는 조금 차이를 두고 구현해야 한다. (Spring Boot Starter 버전이 따로 있음.)
- 고정 관념을 먼저 깨줘야 한다.
이 글을 읽고 따라해보면, 개발에 있어서 상상 초월의 퍼포먼스를 경험할 수 있을 거라고 본다.
1. 구축하는 데 원리만 제대로 알게 되면, 매우 쉽다.
할 일이 크게 없어져버렸다고 보면 된다.
책도 많이 없을 뿐더러 자료가 다소 부족해서 그렇지만, 알게 되면 무슨 DB구축이 이렇게나 쉽냐고 당황할 수 있는 수준이라고 표현하고 싶다.
이 블로그 운영자인 필자가 자랑하는 것이 아니라, 최신 버전으로 가면 갈수록 할 게 없다.
(커넥션 풀도 내장되어 있고, 영속 프레임워크도 기본 내장되어 있다. 굳이 JPA나 각종 Hibernate를 찾을 필요가 있는지 이런 생각이 들 정도이다.)
자료가 없어서 삽질을 다소 했지만, 진짜 쉬워졌다. 현재의 Spring Starter만 잘 활용하면, 많은 거 신경 쓸 필요가 전혀 없고, DB하고(SQL문법 등) 개발만 집중하면 된다. 아이디어만 잘 짜내서, 좋은 서비스 찍어내면 된다.(희망사항이긴 하지만.)
그림 1. 프로젝트 구성도 (Spring Boot Starer 프로젝트)
xml 맵핑 복잡하게 그런 것도 할 필요가 없어졌다.
2. 결과
REST Controller를 활용해서 JSON형태로 출력하였다.
잘 된다.
소스코드 양도 훨씬 줄었다. HikariCP하고, MyBatis Framework가 기본으로 Spring Boot에서는 사용된다고 보면 된다.
그림 2. 완성된 작업물
3. 데이터베이스 설계
먼저 DB설계를 하는 건 결코 아니다. 해당 작업을 조금 원할하게 따라할 수 있도록 미리 소개하는 것이다.
Spring Security에서 제시하는 기본 USER(회원)에 관한 설계를 인용하였다.
그림 3. COMP_USERS - Spring Security 사용자 계정
CREATE TABLE comp_users (
username VARCHAR(50) NOT NULL,
password VARCHAR(300) NOT NULL,
enabled INT NOT NULL,
PRIMARY KEY (username)
);
-- 계정
INSERT INTO comp_users (username, password, enabled) VALUES ('user', '$2a$10$x04djNV2e9rpcPPRyXoLk.rMm6iZe2/vYdzpqHQcLeNSYdt7kc30O', 1);
INSERT INTO comp_users (username, password, enabled) VALUES ('admin', '$2a$10$QUddY3O/6ZgkYCR6MFlv9.nqA501Fm0cc/ZxQHX5pwb1o0CYCTiIS', 1);
파일명: comp_users.sql
[첨부(Attachments)]
comp_user.zip4. 프로젝트 생성하기
프로젝트 생성은 매우 간단한 방법으로 진행된다. 인터넷이 되는 환경에서 작업을 해야 한다.
그림 3. 스프링 스타터 프로젝트(1)
프로젝트 익스플로러의 빈칸에서 오른쪽 버튼을 클릭한다.
Spring Starter Project를 클릭한다.
그림 4. 스프링 스타터 프로젝트(2)
자바 버전부터 왠만한 내용은 자동으로 입력되어 있다.
환경에 맞춰서 클래스명, 그룹, Artifact 등 입력해준다.
Next를 클릭한다.
방식이 두 가지로 확장됨: Maven, Gradle 방식
- 안드로이드 스튜디오를 경험해봤으면, Gradle 방식을 접했을 수도 있다.
Maven으로 선택한다.
(이런 부분도 있어서 Spring Boot에 대해서 또 관심을 가져야 한다. Gradle 방식도 있기 때문이다.)
그림 5. 스프링 스타터 프로젝트(3)
MyBatis가 내장되어 있는지, HikariCP가 내장되어 있는지 궁금하다면, "Type to search dep...."에 검색을 해보면 된다.
내장되어 있다고 나온다.
그래서 선택할 항목이 크게 많지는 않고, "MySQL Driver", "Oracle Driver", "Spring Security", "Spring Web"을 체크하였다.
참고로 작업을 진행할 때, Spring Security에 대해서 조금 익숙치 않은 경우라면, 체크를 해제해도 무방하다.
(보안이 워낙 강해서 URL Mapping까지도 Spring Security에서 전부 제어해버리는 일이 발생하기 때문이다.)
그림 6. 스프링 스타터 프로젝트(4)
2. pom.xml 설정하기
pom 설정을 해줘야 하는 부분은 myBatis-starter 하나만 해주면 끝난다.
http://mvnrepository.com
이 사이트가 중요하다.
Spring-Framework를 활성화 하는데 가장 큰 공헌을 한 사이트인 것 같다.
그림 6-1. MyBatis Spring Boot Starter 2.1.3 (MVNRepository.com)
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.4.0-SNAPSHOT</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.springmvc.home</groupId>
<artifactId>demo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>SpringBootMVCDemo</name>
<description>Demo project for Spring Boot</description>
<properties>
<java.version>15</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-jdbc</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-security</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web-services</artifactId>
</dependency>
<dependency>
<groupId>com.oracle.database.jdbc</groupId>
<artifactId>ojdbc8</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework.security</groupId>
<artifactId>spring-security-test</artifactId>
<scope>test</scope>
</dependency>
<!-- Spring 부트에서는 이거 쓰면 안 됨 -->
<!-- https://mvnrepository.com/artifact/org.mybatis/mybatis -->
<!--
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.5</version>
</dependency>
-->
<!-- https://mvnrepository.com/artifact/org.mybatis.spring.boot/mybatis-spring-boot-starter -->
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>2.1.3</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
<repositories>
<repository>
<id>spring-milestones</id>
<name>Spring Milestones</name>
<url>https://repo.spring.io/milestone</url>
</repository>
<repository>
<id>spring-snapshots</id>
<name>Spring Snapshots</name>
<url>https://repo.spring.io/snapshot</url>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository>
</repositories>
<pluginRepositories>
<pluginRepository>
<id>spring-milestones</id>
<name>Spring Milestones</name>
<url>https://repo.spring.io/milestone</url>
</pluginRepository>
<pluginRepository>
<id>spring-snapshots</id>
<name>Spring Snapshots</name>
<url>https://repo.spring.io/snapshot</url>
<snapshots>
<enabled>true</enabled>
</snapshots>
</pluginRepository>
</pluginRepositories>
</project>
파일명: pom.xml
[첨부(Attachments)]
3. application.properties 설정하기
application.properties 설정 파일을 설정해줘야 한다.
그림 7. application.properties 설정하기
spring.datasource.driverClassName=oracle.jdbc.driver.OracleDriver
#org.mariadb.jdbc.Driver
spring.datasource.url=jdbc:oracle:thin:@127.0.0.1:1521:orcl
#jdbc:mariadb://localhost:3306/test?characterEncoding=UTF-8&serverTimezone=UTC
spring.datasource.username=user
spring.datasource.password=password
파일명: application.properties
[첨부(Attachments)]
이 설정 하나면, 나머지 DataSource 등 설정까지 자동 인식함.
-> 글의 맨 마지막에 Spring-Legacy Project와의 차이점을 소개하겠음. (간단하게 이야기하면, 지탱해주고 있는 라이브러리가 많아졌다.)
3. RestStarterController.java - Controller
그냥 바로 컨트롤러 작업하면 된다. 설명을 해주고 싶어도 너무 간단한 구성이어서 그렇다.
공식 사이트 예제 참고해서 다소 변경한 것이다.
https://github.com/mybatis/spring-boot-starter
공식 스타터 홈페이지를 찾는데 시간이 다소 소요되었다는 것 빼고는 쉽게 되어 있다.
package com.springmvc.home.controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import com.springmvc.home.mapper.CompUserMapper;
import com.springmvc.home.model.CompUser;
@RestController
@RequestMapping("/cities")
public class RestStarterController {
private final CompUserMapper compUserMapper;
public RestStarterController(CompUserMapper compUserMapper) {
this.compUserMapper = compUserMapper;
}
@GetMapping("{state}")
CompUser getCompUser(@PathVariable String state) {
CompUser user = compUserMapper.findByUsername(state);
System.out.println("계정명:" + user.getUsername());
return compUserMapper.findByUsername(state);
}
}
파일명: RestStarterController.java
[첨부(Attachments)]
4. CompUser.java - Model
데이터베이스 설계한 내용을 그대로 해줘야 한다.
이전의 사용방법처럼 어노테이션이나 이런 거 전혀 할 필요가 전혀 없다.
자동으로 맵핑이 된다.
package com.springmvc.home.model;
public class CompUser {
private String username;
private String password;
private int enabled;
public String getUsername() {
return username;
}
public void setUsername(String username) {
this.username = username;
}
public String getPassword() {
return password;
}
public void setPassword(String password) {
this.password = password;
}
public int getEnabled() {
return enabled;
}
public void setEnabled(int enabled) {
this.enabled = enabled;
}
}
파일명: CompUser.java
[첨부(Attachments)]
5. CompUserMapper.java - DAO 또는 Service에 해당됨.(Mapper)
진정한 생산성이라는 것을 느낄 수 있다.
package com.springmvc.home.mapper;
import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Select;
import com.springmvc.home.model.CompUser;
@Mapper
public interface CompUserMapper {
@Select("select * from comp_users where username = #{username}")
public CompUser findByUsername(String username);
}
파일명: CompUserMapper.java
[첨부(Attachments)]
6. 어떤 이유 때문에 Spring Boot가 라이브러리가 많다는 건가요?
쉬워진 만큼 무언가 지탱해주고 있는 프로그램이 있다.
패키지명: com.springmvc.home
파일명: SpringBootApplication.java (자동 생성된 파일)
package com.springmvc.home;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class SpringBootMvcDemoApplication {
public static void main(String[] args) {
SpringApplication.run(SpringBootMvcDemoApplication.class, args);
}
}
파일명: SpringBootMvcDemoApplication.java
Spring Boot는 특이한 점이 프로그램 형태로 실행을 시켜버린다.
그림 8, 그림 9, 그림 10. Spring Boot를 지탱해주는 기본 library
다소 양이 많다는 것을 알 수 있다.
쉬워진 개발환경만큼 지탱해주고 있는 jar파일은 매우 많이 늘어났다는 것이다.
자세히 깨알같은 글자를 보면,
- ojdbc-18-19.7 (Oracle JDBC 19.7)
- MySQL (8.0.21)
- spring web 5.3 RC
......
최신 라인 구성을 자랑하고 있다고 보면 된다.
7. 스프링 부트와 스프링 프레임워크의 MyBatis 차이점
간단하게 요약해보았다.
그림 11. 차이점 비교
구현에 있어서 훨씬 간단해졌다는 것이다.
[첨부(Attachments)]
* 맺음글(Conclusion)
조금 당황스럽긴 하지만, 이게 글의 끝이다.
Spring Boot Starter의 DB, 커넥션 풀까지 함께 소개한 것이다. 환경 설정 몇 가지만 더 알게 되면 된다.
현재에도 Spring Legacy Project 방식으로 구현하는 이유가 있을 것으로 보인다. Spring Boot는 결과적으로는 사용하는 데 있어서 매우 간편해졌다.
* 참고자료(References)
1. Spring Boot and iBatis with H2 - A Tutorial, https://www.springboottutorial.com/spring-boot-and-iBatis-with-h2-tutorial, Accessed by 2020-09-30, Last Modified 2020-07-07.
[Spring Boot 버전의 MyBatis 핵심 사용법]
@Mapper
public interface StudentMyBatisRepository {
@Select("select * from student")
public List<Student> findAll();
@Select("SELECT * FROM student WHERE id = #{id}")
public Student findById(long id);
@Delete("DELETE FROM student WHERE id = #{id}")
public int deleteById(long id);
@Insert("INSERT INTO student(id, name, passport) VALUES (#{id}, #{name}, #{passport})")
public int insert(Student student);
@Update("Update student set name=#{name}, passport=#{passport} where id=#{id}")
public int update(Student student);
}
-> 이거 말고는 크게 없다. Hibernate 이거보다도 훨씬 편하게 개발할 수 있다고 주장한다.
2. GitHub - mybatis/spring-boot-starter: MyBatis integration with Spring Boot, https://github.com/mybatis/spring-boot-starter/, Accessed by 2020-09-30, Last Modified .
-> 공식 사이트에서 제공해주는 예제 가이드이니 참고하면 된다. 다 완벽하게 되어 있는 건 아니고, 프로그램 사용 방법이 적혀져 있다.