SpringBoot整合MyBatis教程Provider進階(Insert)

本教程主要詳細講解SpringBoot整合MyBatis項目高級操作模式,主要使用到@Provider高級模式進行MyBatis整合開發,本文主要講解Insert輸入數據操作.

基礎環境

技術	版本
Java	1.8+
SpringBoot	2.x.x
MyBatis	3.5.x

創建項目

初始化項目

mvn archetype:generate -DgroupId=com.edurt.sli.slismpi -DartifactId=spring-learn-integration-springboot-mybatis-provider-insert -DarchetypeArtifactId=maven-archetype-quickstart -Dversion=1.0.0 -DinteractiveMode=false

修改pom.xml增加MyBatis

<?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 http://maven.apache.org/xsd/maven-4.0.0.xsd">

    <parent>
        <artifactId>spring-learn-integration-springboot-mybatis-provider</artifactId>
        <groupId>com.edurt.sli</groupId>
        <version>1.0.0</version>
    </parent>

    <modelVersion>4.0.0</modelVersion>

    <artifactId>spring-learn-integration-springboot-mybatis-provider-insert</artifactId>

    <name>SpringBoot整合MyBatis教程Provider進階(Insert)</name>

    <properties>
        <system.java.version>1.8</system.java.version>
        <plugin.maven.compiler.version>3.3</plugin.maven.compiler.version>
        <springboot.common.version>2.1.3.RELEASE</springboot.common.version>
        <springboot.mybatis.common.version>2.1.1</springboot.mybatis.common.version>
        <mysql.version>5.1.47</mysql.version>
        <lombox.version>1.18.8</lombox.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <version>${springboot.common.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <version>${springboot.common.version}</version>
        </dependency>
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>${springboot.mybatis.common.version}</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>${mysql.version}</version>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>${lombox.version}</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <version>${springboot.common.version}</version>
                <configuration>
                    <fork>true</fork>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>${plugin.maven.compiler.version}</version>
                <configuration>
                    <source>${system.java.version}</source>
                    <target>${system.java.version}</target>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

mybatis-spring-boot-starter:該starter是我們使用SpringBoot整合MyBatis的依賴整合包

在src/main/java目錄下新建com.edurt.sli.slismpi目錄並在該目錄下新建SpringBootMyBatisProviderInsertIntegration類文件,在文件輸入以下內容

package com.edurt.sli.slismpi;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.stereotype.Component;

@SpringBootApplication
@Component(value = "com.edurt.sli.slismpi")
public class SpringBootMyBatisProviderInsertIntegration {

    public static void main(String[] args) {
        SpringApplication.run(SpringBootMyBatisProviderInsertIntegration.class, args);
    }

}

構建SQL文件

在src/main目錄下新建example.sql文件,鍵入以下內容

create database spring;

use spring;

drop table if exists user;
create table user
(
    id       int(20) auto_increment,
    userName varchar(20),
    title    varchar(20),
    primary key (id)
)
    default charset 'utf8';

我們運行該sql文件進行創建數據庫/數據表操作.

配置MyBatis

在/src/main/java/com/edurt/sli/slismpi目錄下創建config目錄,並在該目錄下新建MyBatisProviderConfig配置類,鍵入以下代碼

package com.edurt.sli.slismpi.config;

import org.apache.ibatis.session.SqlSessionFactory;
import org.mybatis.spring.SqlSessionFactoryBean;
import org.mybatis.spring.annotation.MapperScan;
import org.mybatis.spring.boot.autoconfigure.ConfigurationCustomizer;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.jdbc.datasource.DataSourceTransactionManager;

import javax.sql.DataSource;

@Configuration
@MapperScan(value = {"com.edurt.sli.slismpi.mapper"})
public class MyBatisProviderConfig {

    @Bean(name = "transactionManager")
    public DataSourceTransactionManager transactionManager(
            @Qualifier("dataSource") DataSource dataSource) {
        return new DataSourceTransactionManager(dataSource);
    }

    @Bean(name = "sqlSessionFactory")
    @ConditionalOnMissingBean(name = "sqlSessionFactory")
    public SqlSessionFactory sqlSessionFactory(@Qualifier("dataSource") DataSource dataSource) throws Exception {
        final SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean();
        sessionFactory.setDataSource(dataSource);
        return sessionFactory.getObject();
    }

    @Bean
    ConfigurationCustomizer mybatisConfigurationCustomizer() {
        return configuration -> {
            configuration.setMapUnderscoreToCamelCase(Boolean.TRUE);
            configuration.setLogPrefix("com.edurt.sli.slismpi");
        };
    }

}

@MapperScan註解用於指定我們Mapper文件所在的位置

在/src/main/resources資源目錄下創建一個application.properties的配置文件,用於數據庫連接配置,鍵入以下內容

server.port=8989
spring.datasource.url=jdbc:mysql://localhost:3306/spring?useSSL=false
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.username=root
spring.datasource.password=123456

配置數據模型

在/src/main/java/com/edurt/sli/slismpi目錄下創建model目錄,並在該目錄下新建UserModel實體類,鍵入以下代碼

package com.edurt.sli.slismpi.model;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.ToString;

@Data
@ToString
@AllArgsConstructor
@NoArgsConstructor
public class UserModel {

    private Integer id;
    private String userName;
    private String title;

}

支持數據Insert功能

在/src/main/java/com/edurt/sli/slismpi目錄下創建provider目錄,並在該目錄下新建UserInsertProvider類,用於轉換實體與SQL腳本,鍵入以下代碼

package com.edurt.sli.slismpi.provider;

import com.edurt.sli.slismpi.model.UserModel;
import org.apache.ibatis.jdbc.SQL;
import org.springframework.util.ObjectUtils;

public class UserInsertProvider {

    private String tableName = "user";

    public String insertModelByValues(UserModel model) {
        return new SQL() {{
            INSERT_INTO(tableName);
            if (!ObjectUtils.isEmpty(model.getTitle())) {
                VALUES("title", model.getTitle());
            }
            if (!ObjectUtils.isEmpty(model.getUserName())) {
                VALUES("userName", model.getUserName());
            }
        }}.toString();
    }

}

我們是使用MyBatis提供的動態構建SQL功能進行構建SQL語句,需要注意的是在VALUES中對應的column是數據表中的字段,而不是實體類的字段.

在/src/main/java/com/edurt/sli/slismpi目錄下創建mapper目錄,並在該目錄下新建UserInsertMapper數據表操作映射類,鍵入以下內容

package com.edurt.sli.slismpi.mapper;

import com.edurt.sli.slismpi.model.UserModel;
import com.edurt.sli.slismpi.provider.UserInsertProvider;
import org.apache.ibatis.annotations.InsertProvider;
import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Options;

@Mapper
public interface UserInsertMapper {

    @InsertProvider(type = UserInsertProvider.class, method = "insertModelByValues")
    @Options(useGeneratedKeys = true, keyColumn = "id", keyProperty = "id")
    Integer insertModel(UserModel model);

}

@InsertProvider標記我們使用高級功能type指定Provider類名,method指定的是該類中要使用的哪一個方法

接下來我們在/src/test/java目錄下新建com.edurt.sli.slismpi目錄,並在該目錄下新建UserInsertMapperTest測試文件,鍵入以下內容

package com.edurt.sli.slismpi;

import com.edurt.sli.slismpi.mapper.UserInsertMapper;
import com.edurt.sli.slismpi.model.UserModel;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.jdbc.AutoConfigureTestDatabase;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;

@RunWith(SpringJUnit4ClassRunner.class)
@AutoConfigureTestDatabase(replace = AutoConfigureTestDatabase.Replace.NONE)
@SpringBootTest(
        classes = SpringBootMyBatisProviderInsertIntegration.class,
        webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT
)
public class UserInsertMapperTest {

    @Autowired
    private UserInsertMapper userInsertMapper;

    private UserModel user;

    @Before
    public void before() {
        user = new UserModel();
    }

    @Test
    public void testInsertModelByValues() {
        // userName is null
        user.setTitle("Test");
        this.userInsertMapper.insertModelByValues(user);
        // title is null
        user = new UserModel();
        user.setUserName("Test");
        this.userInsertMapper.insertModelByValues(user);
    }


}

注意: 此時運行會出現Error updating database. Cause: com.mysql.jdbc.exceptions.jdbc4.MySQLSyntaxErrorException: Unknown column 'Test' in 'field list'字段未找到錯誤,這時我們需要將Provider中的model.getTitle()修改爲#{title}

INTO_COLUMNS … INTO_VALUES方式

修改UserInsertProvider類在該類中鍵入以下代碼

public String insertModelByIntoColumnsAndValues(UserModel model) {
    return new SQL() {{
        INSERT_INTO(tableName);
        INTO_COLUMNS("title", "userName");
        INTO_VALUES("#{title}", "#{userName}");
    }}.toString();
}

INTO_COLUMNS添加的是數據庫中的字段名稱
INTO_VALUES對應添加字段的數據值

需要注意的是INTO_COLUMNS和INTO_VALUES必須要一一對應

修改UserInsertMapper類,添加以下代碼:

@InsertProvider(type = UserInsertProvider.class, method = "insertModelByIntoColumnsAndValues")
    @Options(useGeneratedKeys = true, keyColumn = "id", keyProperty = "id")
    Integer insertModelByIntoColumnsAndValues(UserModel model);

修改UserInsertMapperTest類,添加以下測試代碼:

@Test
public void testInsertModelByIntoColumnsAndValues() {
    user = new UserModel();
    user.setUserName("Test");
    this.userInsertMapper.insertModelByIntoColumnsAndValues(user);
}

批量添加數據

修改UserInsertProvider類在該類中鍵入以下代碼支持批量添加數據操作

public String insertModelByBatch(List<UserModel> list) {
    SQL sql = new SQL()
            .INSERT_INTO(tableName).
                    INTO_COLUMNS("title", "userName");
    StringBuilder sb = new StringBuilder();
    for (int i = 0, len = list.size(); i < len; i++) {
        if (i > 0) {
            sb.append(") , (");
        }
        sb.append("#{list[");
        sb.append(i);
        sb.append("].title}, ");
        sb.append("#{list[");
        sb.append(i);
        sb.append("].userName}");
    }
    sql.INTO_VALUES(sb.toString());
    return sql.toString();
}

注意: 批量插入數據的values格式：values (?, ?, ?) , (?, ?, ?) , (?, ?, ?)
MyBatis只能讀取到list參數，所以使用list[i].Filed訪問變量，如 #{list[0].title}

修改UserInsertMapper類,添加以下代碼:

@InsertProvider(type = UserInsertProvider.class, method = "insertModelByBatch")
@Options(useGeneratedKeys = true, keyColumn = "id", keyProperty = "id")
Integer insertModelByBatch(List<UserModel> list);

修改UserInsertMapperTest類,添加以下測試代碼:

@Test
public void testInsertModelByBatch() {
    List<UserModel> list = new ArrayList<>();
    for (int i = 0; i < 10; i++) {
        UserModel user = new UserModel();
        user.setUserName(String.valueOf(i));
        user.setTitle(String.valueOf(i));
        list.add(user);
    }
    this.userInsertMapper.insertModelByBatch(list);
}

我們運行後返回如下錯誤

Caused by: org.apache.ibatis.builder.BuilderException: Error invoking SqlProvider method 'public java.lang.String com.edurt.sli.slismpi.provider.UserInsertProvider.insertModelByBatch(java.util.List)' with specify parameter 'class org.apache.ibatis.session.defaults.DefaultSqlSession$StrictMap'.  Cause: org.apache.ibatis.binding.BindingException: Parameter 'arg0' not found. Available parameters are [collection, list]
	at org.apache.ibatis.builder.annotation.ProviderSqlSource.createSqlSource(ProviderSqlSource.java:169)
	at org.apache.ibatis.builder.annotation.ProviderSqlSource.getBoundSql(ProviderSqlSource.java:131)
	at org.apache.ibatis.mapping.MappedStatement.getBoundSql(MappedStatement.java:297)
	at org.apache.ibatis.executor.statement.BaseStatementHandler.<init>(BaseStatementHandler.java:64)
	at org.apache.ibatis.executor.statement.PreparedStatementHandler.<init>(PreparedStatementHandler.java:41)
	at org.apache.ibatis.executor.statement.RoutingStatementHandler.<init>(RoutingStatementHandler.java:46)
	at org.apache.ibatis.session.Configuration.newStatementHandler(Configuration.java:592)
	at org.apache.ibatis.executor.SimpleExecutor.doUpdate(SimpleExecutor.java:48)
	at org.apache.ibatis.executor.BaseExecutor.update(BaseExecutor.java:117)
	at org.apache.ibatis.executor.CachingExecutor.update(CachingExecutor.java:76)
	at org.apache.ibatis.session.defaults.DefaultSqlSession.update(DefaultSqlSession.java:197)
	at org.apache.ibatis.session.defaults.DefaultSqlSession.insert(DefaultSqlSession.java:184)
	at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
	at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at java.lang.reflect.Method.invoke(Method.java:498)
	at org.mybatis.spring.SqlSessionTemplate$SqlSessionInterceptor.invoke(SqlSessionTemplate.java:426)
	... 37 more
Caused by: org.apache.ibatis.binding.BindingException: Parameter 'arg0' not found. Available parameters are [collection, list]
	at org.apache.ibatis.session.defaults.DefaultSqlSession$StrictMap.get(DefaultSqlSession.java:342)
	at org.apache.ibatis.builder.annotation.ProviderSqlSource.extractProviderMethodArguments(ProviderSqlSource.java:198)
	at org.apache.ibatis.builder.annotation.ProviderSqlSource.createSqlSource(ProviderSqlSource.java:146)
	... 53 more

通過錯誤我們可以看到,MyBatis在解析list的時候出現了錯誤導致的,無法找到list參數,那麼這個時候我們需要修改傳遞參數爲:

@InsertProvider(type = UserInsertProvider.class, method = "insertModelByBatch")
@Options(useGeneratedKeys = true, keyColumn = "id", keyProperty = "id")
Integer insertModelByBatch(@Param("list") Collection<UserModel> list);

把我們原來的List list替換爲**@Param(“list”) Collection list**

修改UserInsertProvider的方法insertModelByBatch爲

public String insertModelByBatch(Map map) {
    List<UserModel> models = (List<UserModel>) map.get("list");
    SQL sql = new SQL()
            .INSERT_INTO(tableName).
                    INTO_COLUMNS("title", "userName");
    StringBuilder sb = new StringBuilder();
    for (int i = 0, len = models.size(); i < len; i++) {
        if (i > 0) {
            sb.append(") , (");
        }
        sb.append("#{list[");
        sb.append(i);
        sb.append("].title}, ");
        sb.append("#{list[");
        sb.append(i);
        sb.append("].userName}");
    }
    sql.INTO_VALUES(sb.toString());
    return sql.toString();
}

將原來的參數List list修改爲Map map然後在獲取通過**map.get(“list”);**獲取數據集合.

打包文件部署

打包數據

mvn clean package -Dmaven.test.skip=true -X

運行打包後的文件即可

java -jar target/spring-learn-integration-springboot-mybatis-provider-insert-1.0.0.jar

源碼地址

GitHub
Gitee

qianmoQ 博客專家

發佈了92 篇原創文章 · 獲贊 10 · 訪問量 178萬+

私信關注

SpringBoot整合MyBatis教程Provider進階(Insert)

基礎環境

創建項目

構建SQL文件

配置MyBatis

配置數據模型

支持數據Insert功能

INTO_COLUMNS … INTO_VALUES方式

批量添加數據

打包文件部署

源碼地址

Kafka存儲機制

aws語音呼叫調用，告警電話

【轉】[C#] WebAPI 防止併發調用二（冥等性）

HTTP URL 詳解

2021年新年將至，提前祝大家新年快樂

SpringBoot Security整合JWT授權RestAPI

Presto環境部署-Coordinator|Works配置

SpringBoot整合MyBatis教程(註解版)

SpringBoot整合MyBatis教程Provider進階(Update, Delete)

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結