From 8ff8628008b26e7955e871c4163abbc80a4c64ee Mon Sep 17 00:00:00 2001
From: FrancoCorleone <jedfra6@gmail.com>
Date: Thu, 8 Aug 2019 14:40:43 +0200
Subject: [PATCH] feat(BAEL-3044) Implement MyBatis with Spring/SpringBoot
 module (#7507)

---
 persistence-modules/spring-mybatis/pom.xml    | 113 ++++++++++++++++++
 .../com/baeldung/mybatis/spring/Article.java  |  19 +++
 .../mybatis/spring/ArticleMapper.java         |  11 ++
 .../mybatis/spring/PersistenceAutoConfig.java |  14 +++
 .../mybatis/spring/PersistenceConfig.java     |  37 ++++++
 .../src/main/resources/beans.xml              |  21 ++++
 .../src/main/resources/data.sql               |   3 +
 .../src/main/resources/schema.sql             |   6 +
 .../ArticleMapperBootIntegrationTest.java     |  13 ++
 .../spring/ArticleMapperCommonTest.java       |  22 ++++
 .../spring/ArticleMapperIntegrationTest.java  |  11 ++
 .../ArticleMapperXMLIntegrationTest.java      |  11 ++
 pom.xml                                       |   1 +
 13 files changed, 282 insertions(+)
 create mode 100644 persistence-modules/spring-mybatis/pom.xml
 create mode 100644 persistence-modules/spring-mybatis/src/main/java/com/baeldung/mybatis/spring/Article.java
 create mode 100644 persistence-modules/spring-mybatis/src/main/java/com/baeldung/mybatis/spring/ArticleMapper.java
 create mode 100644 persistence-modules/spring-mybatis/src/main/java/com/baeldung/mybatis/spring/PersistenceAutoConfig.java
 create mode 100644 persistence-modules/spring-mybatis/src/main/java/com/baeldung/mybatis/spring/PersistenceConfig.java
 create mode 100644 persistence-modules/spring-mybatis/src/main/resources/beans.xml
 create mode 100644 persistence-modules/spring-mybatis/src/main/resources/data.sql
 create mode 100644 persistence-modules/spring-mybatis/src/main/resources/schema.sql
 create mode 100644 persistence-modules/spring-mybatis/src/test/java/com/baeldung/mybatis/spring/ArticleMapperBootIntegrationTest.java
 create mode 100644 persistence-modules/spring-mybatis/src/test/java/com/baeldung/mybatis/spring/ArticleMapperCommonTest.java
 create mode 100644 persistence-modules/spring-mybatis/src/test/java/com/baeldung/mybatis/spring/ArticleMapperIntegrationTest.java
 create mode 100644 persistence-modules/spring-mybatis/src/test/java/com/baeldung/mybatis/spring/ArticleMapperXMLIntegrationTest.java

diff --git a/persistence-modules/spring-mybatis/pom.xml b/persistence-modules/spring-mybatis/pom.xml
new file mode 100644
index 0000000000..ecdcd1d923
--- /dev/null
+++ b/persistence-modules/spring-mybatis/pom.xml
@@ -0,0 +1,113 @@
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <groupId>com.baeldung</groupId>
+    <artifactId>spring-mybatis</artifactId>
+    <version>0.1-SNAPSHOT</version>
+    <name>spring-mybatis</name>
+
+    <parent>
+        <groupId>com.baeldung</groupId>
+        <artifactId>parent-boot-2</artifactId>
+        <version>1.0.0-SNAPSHOT</version>
+        <relativePath>../../parent-boot-2</relativePath>
+    </parent>
+
+    <dependencies>
+
+        <!-- Spring -->
+
+        <dependency>
+            <groupId>org.springframework</groupId>
+            <artifactId>spring-context</artifactId>
+            <version>${org.springframework.version}</version>
+        </dependency>
+
+        <dependency>
+            <groupId>org.springframework</groupId>
+            <artifactId>spring-beans</artifactId>
+            <version>${org.springframework.version}</version>
+        </dependency>
+
+        <!-- SpringBoot -->
+
+        <dependency>
+            <groupId>org.mybatis.spring.boot</groupId>
+            <artifactId>mybatis-spring-boot-starter</artifactId>
+        </dependency>
+
+        <!-- Persistence -->
+
+        <dependency>
+            <groupId>com.h2database</groupId>
+            <artifactId>h2</artifactId>
+            <version>${h2.version}</version>
+        </dependency>
+
+        <dependency>
+            <groupId>org.springframework</groupId>
+            <artifactId>spring-jdbc</artifactId>
+            <version>${org.springframework.version}</version>
+        </dependency>
+
+        <dependency>
+            <groupId>org.mybatis</groupId>
+            <artifactId>mybatis</artifactId>
+            <version>${mybatis.version}</version>
+        </dependency>
+
+        <dependency>
+            <groupId>org.mybatis</groupId>
+            <artifactId>mybatis-spring</artifactId>
+            <version>${spring-mybatis.version}</version>
+        </dependency>
+
+        <!-- test scoped -->
+
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-test</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.springframework</groupId>
+            <artifactId>spring-test</artifactId>
+            <version>${org.springframework.version}</version>
+            <scope>test</scope>
+        </dependency>
+
+        <dependency>
+            <groupId>org.assertj</groupId>
+            <artifactId>assertj-core</artifactId>
+            <version>${assertj-core.version}</version>
+            <scope>test</scope>
+        </dependency>
+
+    </dependencies>
+
+    <build>
+        <finalName>spring-mybatis</finalName>
+        <resources>
+            <resource>
+                <directory>src/main/resources</directory>
+                <filtering>true</filtering>
+            </resource>
+        </resources>
+    </build>
+
+    <properties>
+        <!-- Spring -->
+        <org.springframework.version>5.1.8.RELEASE</org.springframework.version>
+
+        <!-- persistence -->
+        <spring-mybatis.version>2.0.2</spring-mybatis.version>
+        <mybatis.version>3.5.2</mybatis.version>
+        <mybatis-spring-boot-starter.version>2.1.0</mybatis-spring-boot-starter.version>
+        <h2.version>1.4.197</h2.version>
+
+        <!-- testing -->
+        <assertj-core.version>3.8.0</assertj-core.version>
+
+    </properties>
+
+</project>
diff --git a/persistence-modules/spring-mybatis/src/main/java/com/baeldung/mybatis/spring/Article.java b/persistence-modules/spring-mybatis/src/main/java/com/baeldung/mybatis/spring/Article.java
new file mode 100644
index 0000000000..90e4ce6170
--- /dev/null
+++ b/persistence-modules/spring-mybatis/src/main/java/com/baeldung/mybatis/spring/Article.java
@@ -0,0 +1,19 @@
+package com.baeldung.mybatis.spring;
+
+public class Article {
+    private Long id;
+    private String title;
+    private String author;
+
+    public Long getId() {
+        return id;
+    }
+
+    public String getTitle() {
+        return title;
+    }
+
+    public String getAuthor() {
+        return author;
+    }
+}
diff --git a/persistence-modules/spring-mybatis/src/main/java/com/baeldung/mybatis/spring/ArticleMapper.java b/persistence-modules/spring-mybatis/src/main/java/com/baeldung/mybatis/spring/ArticleMapper.java
new file mode 100644
index 0000000000..db5b3675f4
--- /dev/null
+++ b/persistence-modules/spring-mybatis/src/main/java/com/baeldung/mybatis/spring/ArticleMapper.java
@@ -0,0 +1,11 @@
+package com.baeldung.mybatis.spring;
+
+import org.apache.ibatis.annotations.Mapper;
+import org.apache.ibatis.annotations.Param;
+import org.apache.ibatis.annotations.Select;
+
+@Mapper
+public interface ArticleMapper {
+    @Select("SELECT * FROM ARTICLES WHERE id = #{id}")
+    Article getArticle(@Param("id") Long id);
+}
diff --git a/persistence-modules/spring-mybatis/src/main/java/com/baeldung/mybatis/spring/PersistenceAutoConfig.java b/persistence-modules/spring-mybatis/src/main/java/com/baeldung/mybatis/spring/PersistenceAutoConfig.java
new file mode 100644
index 0000000000..72f754c01d
--- /dev/null
+++ b/persistence-modules/spring-mybatis/src/main/java/com/baeldung/mybatis/spring/PersistenceAutoConfig.java
@@ -0,0 +1,14 @@
+package com.baeldung.mybatis.spring;
+
+import org.springframework.boot.SpringBootConfiguration;
+import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
+import org.springframework.context.annotation.ComponentScan;
+import org.springframework.context.annotation.FilterType;
+
+@SpringBootConfiguration
+@EnableAutoConfiguration
+@ComponentScan(basePackages = { "com.baeldung.mybatis" }, excludeFilters = {
+  @ComponentScan.Filter(type = FilterType.ASSIGNABLE_TYPE, value = { PersistenceConfig.class })
+})
+public class PersistenceAutoConfig {
+}
diff --git a/persistence-modules/spring-mybatis/src/main/java/com/baeldung/mybatis/spring/PersistenceConfig.java b/persistence-modules/spring-mybatis/src/main/java/com/baeldung/mybatis/spring/PersistenceConfig.java
new file mode 100644
index 0000000000..f02e04e5a1
--- /dev/null
+++ b/persistence-modules/spring-mybatis/src/main/java/com/baeldung/mybatis/spring/PersistenceConfig.java
@@ -0,0 +1,37 @@
+package com.baeldung.mybatis.spring;
+
+import org.apache.ibatis.session.SqlSessionFactory;
+import org.mybatis.spring.SqlSessionFactoryBean;
+import org.mybatis.spring.annotation.MapperScan;
+import org.mybatis.spring.boot.autoconfigure.MybatisAutoConfiguration;
+import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
+import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseBuilder;
+import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseType;
+
+import javax.sql.DataSource;
+
+@Configuration
+@MapperScan("com.baeldung.mybatis")
+@EnableAutoConfiguration(exclude = { DataSourceAutoConfiguration.class, MybatisAutoConfiguration.class })
+public class PersistenceConfig {
+
+    @Bean
+    public DataSource dataSource() {
+        return new EmbeddedDatabaseBuilder()
+          .setType(EmbeddedDatabaseType.H2)
+          .addScript("schema.sql")
+          .addScript("data.sql")
+          .build();
+    }
+
+    @Bean
+    public SqlSessionFactory sqlSessionFactory() throws Exception {
+        SqlSessionFactoryBean factoryBean = new SqlSessionFactoryBean();
+        factoryBean.setDataSource(dataSource());
+        return factoryBean.getObject();
+    }
+
+}
\ No newline at end of file
diff --git a/persistence-modules/spring-mybatis/src/main/resources/beans.xml b/persistence-modules/spring-mybatis/src/main/resources/beans.xml
new file mode 100644
index 0000000000..6ed82b7934
--- /dev/null
+++ b/persistence-modules/spring-mybatis/src/main/resources/beans.xml
@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<beans xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+       xmlns:jdbc="http://www.springframework.org/schema/jdbc" xmlns="http://www.springframework.org/schema/beans"
+       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/jdbc http://www.springframework.org/schema/jdbc/spring-jdbc.xsd">
+
+
+    <jdbc:embedded-database id="dataSource" type="H2">
+        <jdbc:script location="schema.sql"/>
+        <jdbc:script location="data.sql"/>
+    </jdbc:embedded-database>
+
+    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
+        <property name="dataSource" ref="dataSource"/>
+    </bean>
+
+    <bean id="articleMapper" class="org.mybatis.spring.mapper.MapperFactoryBean">
+        <property name="mapperInterface" value="com.baeldung.mybatis.spring.ArticleMapper"/>
+        <property name="sqlSessionFactory" ref="sqlSessionFactory"/>
+    </bean>
+
+</beans>
\ No newline at end of file
diff --git a/persistence-modules/spring-mybatis/src/main/resources/data.sql b/persistence-modules/spring-mybatis/src/main/resources/data.sql
new file mode 100644
index 0000000000..86203bf561
--- /dev/null
+++ b/persistence-modules/spring-mybatis/src/main/resources/data.sql
@@ -0,0 +1,3 @@
+TRUNCATE TABLE ARTICLES;
+INSERT INTO ARTICLES
+VALUES (1, 'Working with MyBatis in Spring', 'Baeldung');
\ No newline at end of file
diff --git a/persistence-modules/spring-mybatis/src/main/resources/schema.sql b/persistence-modules/spring-mybatis/src/main/resources/schema.sql
new file mode 100644
index 0000000000..807e1ec624
--- /dev/null
+++ b/persistence-modules/spring-mybatis/src/main/resources/schema.sql
@@ -0,0 +1,6 @@
+CREATE TABLE IF NOT EXISTS `ARTICLES`
+(
+    `id`     INTEGER PRIMARY KEY,
+    `title`  VARCHAR(100) NOT NULL,
+    `author` VARCHAR(100) NOT NULL
+);
diff --git a/persistence-modules/spring-mybatis/src/test/java/com/baeldung/mybatis/spring/ArticleMapperBootIntegrationTest.java b/persistence-modules/spring-mybatis/src/test/java/com/baeldung/mybatis/spring/ArticleMapperBootIntegrationTest.java
new file mode 100644
index 0000000000..531356ffa2
--- /dev/null
+++ b/persistence-modules/spring-mybatis/src/test/java/com/baeldung/mybatis/spring/ArticleMapperBootIntegrationTest.java
@@ -0,0 +1,13 @@
+package com.baeldung.mybatis.spring;
+
+import org.junit.runner.RunWith;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.test.context.ContextConfiguration;
+import org.springframework.test.context.junit4.SpringRunner;
+
+@RunWith(SpringRunner.class)
+@SpringBootTest
+@ContextConfiguration(classes = PersistenceAutoConfig.class)
+public class ArticleMapperBootIntegrationTest extends ArticleMapperCommonTest {
+
+}
diff --git a/persistence-modules/spring-mybatis/src/test/java/com/baeldung/mybatis/spring/ArticleMapperCommonTest.java b/persistence-modules/spring-mybatis/src/test/java/com/baeldung/mybatis/spring/ArticleMapperCommonTest.java
new file mode 100644
index 0000000000..33071dc0c1
--- /dev/null
+++ b/persistence-modules/spring-mybatis/src/test/java/com/baeldung/mybatis/spring/ArticleMapperCommonTest.java
@@ -0,0 +1,22 @@
+package com.baeldung.mybatis.spring;
+
+import org.junit.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+class ArticleMapperCommonTest {
+
+    @Autowired
+    ArticleMapper articleMapper;
+
+    @Test
+    public void whenRecordsInDatabase_shouldReturnArticleWithGivenId() {
+        Article article = articleMapper.getArticle(1L);
+
+        assertThat(article).isNotNull();
+        assertThat(article.getId()).isEqualTo(1L);
+        assertThat(article.getAuthor()).isEqualTo("Baeldung");
+        assertThat(article.getTitle()).isEqualTo("Working with MyBatis in Spring");
+    }
+}
diff --git a/persistence-modules/spring-mybatis/src/test/java/com/baeldung/mybatis/spring/ArticleMapperIntegrationTest.java b/persistence-modules/spring-mybatis/src/test/java/com/baeldung/mybatis/spring/ArticleMapperIntegrationTest.java
new file mode 100644
index 0000000000..9298714cb2
--- /dev/null
+++ b/persistence-modules/spring-mybatis/src/test/java/com/baeldung/mybatis/spring/ArticleMapperIntegrationTest.java
@@ -0,0 +1,11 @@
+package com.baeldung.mybatis.spring;
+
+import org.junit.runner.RunWith;
+import org.springframework.test.context.ContextConfiguration;
+import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
+
+@RunWith(SpringJUnit4ClassRunner.class)
+@ContextConfiguration(classes = PersistenceConfig.class)
+public class ArticleMapperIntegrationTest extends ArticleMapperCommonTest {
+
+}
diff --git a/persistence-modules/spring-mybatis/src/test/java/com/baeldung/mybatis/spring/ArticleMapperXMLIntegrationTest.java b/persistence-modules/spring-mybatis/src/test/java/com/baeldung/mybatis/spring/ArticleMapperXMLIntegrationTest.java
new file mode 100644
index 0000000000..de8974d4ad
--- /dev/null
+++ b/persistence-modules/spring-mybatis/src/test/java/com/baeldung/mybatis/spring/ArticleMapperXMLIntegrationTest.java
@@ -0,0 +1,11 @@
+package com.baeldung.mybatis.spring;
+
+import org.junit.runner.RunWith;
+import org.springframework.test.context.ContextConfiguration;
+import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
+
+@RunWith(SpringJUnit4ClassRunner.class)
+@ContextConfiguration(locations = "classpath:/beans.xml")
+public class ArticleMapperXMLIntegrationTest extends ArticleMapperCommonTest {
+
+}
diff --git a/pom.xml b/pom.xml
index aabede4f3a..d095e8a7bc 100644
--- a/pom.xml
+++ b/pom.xml
@@ -879,6 +879,7 @@
 				<module>spring-freemarker</module>
 				<module>persistence-modules/spring-hibernate-3</module>
 				<module>persistence-modules/spring-hibernate4</module>
+				<module>persistence-modules/spring-mybatis</module>
 				<module>spring-integration</module>
 				<module>spring-jenkins-pipeline</module>
 				<module>spring-jersey</module>