BAEL-7395 - Return Auto Generated Id from Insert with MyBatis (#16745)

* BAEL-7395 - Return Auto Generated Id from Insert with MyBatis

* Minor fix

* Add MapperScan on Application class

* Update Application.java

Author: apeterlic

mybatis/src/main/java/com/baeldung/mybatis_sqlscript/Main.java

@@ -1,4 +1,4 @@
-package org.baeldung.mybatis_sqlscript;
+package com.baeldung.mybatis_sqlscript;
 
 import org.apache.ibatis.jdbc.ScriptRunner;
 

persistence-modules/spring-mybatis/src/main/java/com/baeldung/mybatis/generatedid/Application.java

@@ -0,0 +1,15 @@
+package com.baeldung.mybatis.generatedid;
+
+import org.mybatis.spring.annotation.MapperScan;
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+@MapperScan("com.baeldung.mybatis.generatedid")
+@SpringBootApplication
+public class Application {
+
+    public static void main(String[] args) {
+        SpringApplication.run(Application.class, args);
+    }
+
+}

persistence-modules/spring-mybatis/src/main/java/com/baeldung/mybatis/generatedid/Car.java

@@ -0,0 +1,26 @@
+package com.baeldung.mybatis.generatedid;
+
+public class Car {
+
+    private Long id;
+
+    private String model;
+
+    // getters and setters
+
+    public Long getId() {
+        return id;
+    }
+
+    public void setId(final Long id) {
+        this.id = id;
+    }
+
+    public String getModel() {
+        return model;
+    }
+
+    public void setModel(final String model) {
+        this.model = model;
+    }
+}

persistence-modules/spring-mybatis/src/main/java/com/baeldung/mybatis/generatedid/CarMapper.java

@@ -0,0 +1,18 @@
+package com.baeldung.mybatis.generatedid;
+
+import org.apache.ibatis.annotations.Insert;
+import org.apache.ibatis.annotations.Mapper;
+import org.apache.ibatis.annotations.Options;
+import org.apache.ibatis.annotations.SelectKey;
+
+@Mapper
+public interface CarMapper {
+
+    @Insert("INSERT INTO CAR(MODEL) values (#{model})")
+    @Options(useGeneratedKeys = true, keyColumn = "ID", keyProperty = "id")
+    void saveUsingOptions(Car car);
+
+    @Insert("INSERT INTO CAR(MODEL) values (#{model})")
+    @SelectKey(statement = "CALL IDENTITY()", before = false, keyColumn = "ID", keyProperty = "id", resultType = Long.class)
+    void saveUsingSelectKey(Car car);
+}

persistence-modules/spring-mybatis/src/main/java/com/baeldung/mybatis/generatedid/CarXmlMapper.java

@@ -0,0 +1,12 @@
+package com.baeldung.mybatis.generatedid;
+
+import org.apache.ibatis.annotations.Mapper;
+
+@Mapper
+public interface CarXmlMapper {
+
+    void saveUsingOptions(Car car);
+
+    void saveUsingSelectKey(Car car);
+
+}

persistence-modules/spring-mybatis/src/main/java/com/baeldung/mybatis/spring/PersistenceAutoConfig.java

@@ -7,7 +7,7 @@
 
 @SpringBootConfiguration
 @EnableAutoConfiguration
-@ComponentScan(basePackages = { "com.baeldung.mybatis" }, excludeFilters = {
+@ComponentScan(basePackages = { "com.baeldung.mybatis.spring" }, excludeFilters = {
   @ComponentScan.Filter(type = FilterType.ASSIGNABLE_TYPE, value = { PersistenceConfig.class })
 })
 public class PersistenceAutoConfig {

persistence-modules/spring-mybatis/src/main/java/com/baeldung/mybatis/spring/PersistenceConfig.java

@@ -14,7 +14,7 @@
 import javax.sql.DataSource;
 
 @Configuration
-@MapperScan("com.baeldung.mybatis")
+@MapperScan("com.baeldung.mybatis.spring")
 @EnableAutoConfiguration(exclude = { DataSourceAutoConfiguration.class, MybatisAutoConfiguration.class })
 public class PersistenceConfig {
 

persistence-modules/spring-mybatis/src/main/resources/car-schema.sql

@@ -0,0 +1,5 @@
+CREATE TABLE IF NOT EXISTS CAR
+(
+    ID    INTEGER PRIMARY KEY AUTO_INCREMENT,
+    MODEL VARCHAR(100) NOT NULL
+);

persistence-modules/spring-mybatis/src/main/resources/com/baeldung/mybatis/generatedid/CarXmlMapper.xml

@@ -0,0 +1,22 @@
+<?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.baeldung.mybatis.generatedid.CarXmlMapper">
+
+    <insert id="saveUsingOptions" parameterType="com.baeldung.mybatis.generatedid.Car"
+            useGeneratedKeys="true" keyColumn="ID" keyProperty="id">
+        INSERT INTO CAR(MODEL)
+        VALUES (#{model});
+    </insert>
+
+    <insert id="saveUsingSelectKey" parameterType="com.baeldung.mybatis.generatedid.Car">
+        INSERT INTO CAR(MODEL)
+        VALUES (#{model});
+
+        <selectKey resultType="Long" order="AFTER" keyColumn="ID" keyProperty="id">
+            CALL IDENTITY()
+        </selectKey>
+    </insert>
+
+</mapper>

persistence-modules/spring-mybatis/src/test/java/com/baeldung/mybatis/generatedid/CarMapperUnitTest.java

@@ -0,0 +1,37 @@
+package com.baeldung.mybatis.generatedid;
+
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.test.context.ContextConfiguration;
+
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+
+@SpringBootTest(classes = Application.class)
+@ContextConfiguration(classes = TestConfig.class)
+class CarMapperUnitTest {
+
+    @Autowired
+    private CarMapper carMapper;
+
+    @Test
+    void givenCar_whenSaveUsingOptions_thenReturnId() {
+        Car car = new Car();
+        car.setModel("BMW");
+
+        carMapper.saveUsingOptions(car);
+
+        assertNotNull(car.getId());
+    }
+
+    @Test
+    void givenCar_whenSaveUsingSelectKey_thenReturnId() {
+        Car car = new Car();
+        car.setModel("BMW");
+
+        carMapper.saveUsingSelectKey(car);
+
+        assertNotNull(car.getId());
+    }
+
+}