2. 程式人生 > >Spring Boot入門系列（六）如何整合Mybatis實現增刪改查

Spring Boot入門系列（六）如何整合Mybatis實現增刪改查

阿新 • • 發佈：2020-03-16

前面介紹了Spring Boot 中的整合Thymeleaf前端html框架，同時也介紹了Thymeleaf 的用法。不清楚的朋友可以看看之前的文章：https://www.cnblogs.com/zhangweizhong/category/1657780.html。

今天主要講解Springboot整合Mybatis，並實現最基本的增刪改查功能。Spring Boot整合Mybatis的方式有兩種：一種是註解形式的，也就是沒有Mapper.xml檔案，還有一種是XML形式的，我推薦的是使用註解形式，為什麼呢？因為更加的簡介，減少不必要的錯誤。

 

一、整合Mybatis

第一步：資料庫新建Person表

這個表結構很簡單，就是普通的使用者表。

CREATE TABLE `sys_user` (
  `id` varchar(32) NOT NULL DEFAULT '',
  `username` varchar(32) DEFAULT NULL,
  `password` varchar(64) DEFAULT NULL,
  `nickname` varchar(64) DEFAULT NULL,
  `age` int(11) DEFAULT NULL,
  `sex` int(11) DEFAULT NULL,
  `job` int(11) DEFAULT NULL,
  `face_image` varchar(6000) DEFAULT NULL,
  `province` varchar(64) DEFAULT NULL,
  `city` varchar(64) DEFAULT NULL,
  `district` varchar(64) DEFAULT NULL,
  `address` varchar(255) DEFAULT NULL,
  `auth_salt` varchar(64) DEFAULT NULL,
  `last_login_ip` varchar(64) DEFAULT NULL,
  `last_login_time` datetime DEFAULT NULL,
  `is_delete` int(11) DEFAULT NULL,
  `regist_time` datetime DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=latin1;

 

第二步：增加mybatis相關依賴

我們只需要加上pom.xml檔案這些依賴即可。

       <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.41</version>
        </dependency>
        <!--mybatis-->
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>1.3.1</version>
        </dependency>
        <!--mapper-->
        <dependency>
            <groupId>tk.mybatis</groupId>
            <artifactId>mapper-spring-boot-starter</artifactId>
            <version>1.2.4</version>
        </dependency>
        <!-- pagehelper -->
        <dependency>
            <groupId>com.github.pagehelper</groupId>
            <artifactId>pagehelper-spring-boot-starter</artifactId>
            <version>1.2.3</version>
        </dependency>
        <!-- druid 資料庫連線框架-->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid-spring-boot-starter</artifactId>
            <version>1.1.9</version>
        </dependency>
        <dependency>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-core</artifactId>
            <version>1.3.2</version>
            <scope>compile</scope>
            <optional>true</optional>
        </dependency>

 

第三步：增加統一的mapper介面

在utils包中建立一個統一的mapper介面，
後面所有的mapper類都會繼承這個介面
package com.weiz.utils;

import tk.mybatis.mapper.common.Mapper;
import tk.mybatis.mapper.common.MySqlMapper;

/**
 * 繼承自己的MyMapper
 *
 * @author weiz
 * @since 2019-09-06 21:53
 */
public interface MyMapper<T> extends Mapper<T>, MySqlMapper<T> {
    //TODO
    //FIXME 特別注意，該介面不能被掃描到，否則會出錯
}
特別注意：該介面不能被掃描到，否則會出錯。所以我把這個介面放在了utils包中。

 

第四步：更改application.properties配置檔案

主要是mybatis相關的資料庫配置。

############################################################
# 資料來源相關配置，這裡用的是阿里的druid 資料來源
############################################################
spring.datasource.url=jdbc:mysql://localhost:3306/zwz_test
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.druid.initial-size=1
spring.datasource.druid.min-idle=1
spring.datasource.druid.max-active=20
spring.datasource.druid.test-on-borrow=true
spring.datasource.druid.stat-view-servlet.allow=true

############################################################
# mybatis 相關配置
############################################################
mybatis.type-aliases-package=com.weiz.pojo
mybatis.mapper-locations=classpath:mapper/*.xml
mapper.mappers=com.weiz.utils.MyMapper    #這個MyMapper 就是我之前建立的mapper統一介面。後面所有的mapper類都會繼承這個介面
mapper.not-empty=false
mapper.identity=MYSQL
# 分頁框架
pagehelper.helperDialect=mysql
pagehelper.reasonable=true
pagehelper.supportMethodsArguments=true
pagehelper.params=count=countSql

這裡的配置有點多，不過最基本的配置都在這。

 

二、程式碼自動生成工具

Spring Boot有mybatis  generator自動生成程式碼外掛，能自動生成pojo實體類、介面、mapper.xml 檔案，提高開發效率。這裡就不介紹怎麼安裝使用mybatis  generator外掛。介紹一個簡單的GeneratorDisplay自動生成類。

第五步：建立GeneratorDisplay類

package com.weiz.utils;

import java.io.File;
import java.util.ArrayList;
import java.util.List;

import org.mybatis.generator.api.MyBatisGenerator;
import org.mybatis.generator.config.Configuration;
import org.mybatis.generator.config.xml.ConfigurationParser;
import org.mybatis.generator.internal.DefaultShellCallback;

public class GeneratorDisplay {

    public void generator() throws Exception{

        List<String> warnings = new ArrayList<String>();
        boolean overwrite = true;
        //指定 逆向工程配置檔案
        File configFile = new File("generatorConfig.xml"); 
        ConfigurationParser cp = new ConfigurationParser(warnings);
        Configuration config = cp.parseConfiguration(configFile);
        DefaultShellCallback callback = new DefaultShellCallback(overwrite);
        MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config,
                callback, warnings);
        myBatisGenerator.generate(null);

    } 
    
    public static void main(String[] args) throws Exception {
        try {
            GeneratorDisplay generatorSqlmap = new GeneratorDisplay();
            generatorSqlmap.generator();
        } catch (Exception e) {
            e.printStackTrace();
        }
        
    }
}

這個其實也是呼叫mybatis generator實現的。跟mybatis generator安裝外掛是一樣的。

 

第六步：增加generatorConfig.xml配置檔案

在resources檔案下建立generatorConfig.xml檔案，配置如下：

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration
        PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
        "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">

<generatorConfiguration>
    <context id="MysqlContext" targetRuntime="MyBatis3Simple" defaultModelType="flat">
        <property name="beginningDelimiter" value="`"/>
        <property name="endingDelimiter" value="`"/>

        <plugin type="tk.mybatis.mapper.generator.MapperPlugin">
            <property name="mappers" value="com.weiz.utils.MyMapper"/>
        </plugin>
　　　　 <!-- 資料庫連線配置-->　
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/zwz_test"
                        userId="root"
                        password="root">
        </jdbcConnection>

        <!-- 對於生成的pojo所在包 -->
        <javaModelGenerator targetPackage="com.weiz.pojo" targetProject="src/main/java"/>

        <!-- 對於生成的mapper所在目錄 -->
        <sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources"/>

        <!-- 配置mapper對應的java對映 -->
        <javaClientGenerator targetPackage="com.weiz.mapper" targetProject="src/main/java"
                             type="XMLMAPPER"/>


        <table tableName="sys_user"></table>
         
    </context>
</generatorConfiguration>

注意：利用Mybatis Generator自動生成程式碼，對於已經存在的檔案會存在覆蓋和在原有檔案上追加的可能性，不宜多次生成。如需重新生成，需要刪除已生成的原始檔。

 

第七步：Mybatis Generator自動生成程式碼

執行GeneratorDisplay 如下圖所示，即可自動生成相關的程式碼。

 

第八步：在service包下建立UserService及UserServiceImpl介面實現類

1. 建立com.weiz.service包，新增UserService介面類

package com.weiz.service;

import com.weiz.pojo.SysUser;

import java.util.List;

public interface UserService {

    public void saveUser(SysUser user) throws Exception;

    public void updateUser(SysUser user);

    public void deleteUser(String userId);

    public SysUser queryUserById(String userId);

    public List<SysUser> queryUserList(SysUser user);

    public List<SysUser> queryUserListPaged(SysUser user, Integer page, Integer pageSize);public void saveUserTransactional(SysUser user);
}
2. 建立com.weiz.service.impl包，並增加UserServiceImpl實現類
package com.weiz.service.impl;

import com.github.pagehelper.PageHelper;
import com.weiz.mapper.SysUserMapper;
import com.weiz.mapper.SysUserMapperCustom;
import com.weiz.pojo.SysUser;
import com.weiz.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.thymeleaf.util.StringUtils;
import tk.mybatis.mapper.entity.Example;

import java.util.List;

@Service
public class UserServiceImpl implements UserService {

    @Autowired
    private SysUserMapper userMapper;

    @Override
    public void saveUser(SysUser user) throws Exception {
        userMapper.insert(user);
    }

    @Override
    public void updateUser(SysUser user) {
        userMapper.updateByPrimaryKeySelective(user);
    }

    @Override
    public void deleteUser(String userId) {
        userMapper.deleteByPrimaryKey(userId);
    }

    @Override
    public SysUser queryUserById(String userId) {
        return userMapper.selectByPrimaryKey(userId);
    }

    @Override
    public List<SysUser> queryUserList(SysUser user) {
        return null;
    }

    @Override
    public List<SysUser> queryUserListPaged(SysUser user, Integer page, Integer pageSize) {
　　　　 // 分頁功能實現
        PageHelper.startPage(page,pageSize);
        Example example = new Example(SysUser.class);
        Example.Criteria criteria = example.createCriteria();

        if (!StringUtils.isEmptyOrWhitespace(user.getUsername())) {
            criteria.andLike("username", "%" + user.getUsername() + "%");
        }

        if (!StringUtils.isEmptyOrWhitespace(user.getNickname())) {
            criteria.andLike("nickname", "%" + user.getNickname() + "%");
        }

        List<SysUser> userList = userMapper.selectByExample(example);

        return userList;
    }

    @Override
    public void saveUserTransactional(SysUser user) {

    }
}

 

第九步：編寫controller層，增加MybatisController控制器

package com.weiz.controller;

import com.weiz.utils.JSONResult;
import com.weiz.pojo.SysUser;
import com.weiz.service.UserService;
import org.n3r.idworker.Sid;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.Date;
import java.util.List;

@RestController
@RequestMapping("mybatis")
public class MyBatisCRUDController {

    @Autowired
    private UserService userService;

    @Autowired
    private Sid sid;

    @RequestMapping("/saveUser")
    public JSONResult saveUser() throws Exception {
　　　　 // 自動生成ID，也可以直接用uuid
        String userId = sid.nextShort();

        SysUser user = new SysUser();
        user.setId(userId);
        user.setUsername("spring boot" + new Date());
        user.setNickname("spring boot" + new Date());
        user.setPassword("abc123");
        user.setIsDelete(0);
        user.setRegistTime(new Date());

        userService.saveUser(user);

        return JSONResult.ok("儲存成功");
    }

    @RequestMapping("/updateUser")
    public JSONResult updateUser() {

        SysUser user = new SysUser();
        user.setId("10011001");
        user.setUsername("10011001-updated" + new Date());
        user.setNickname("10011001-updated" + new Date());
        user.setPassword("10011001-updated");
        user.setIsDelete(0);
        user.setRegistTime(new Date());

        userService.updateUser(user);

        return JSONResult.ok("儲存成功");
    }


    @RequestMapping("/deleteUser")
    public JSONResult deleteUser(String userId) {

        userService.deleteUser(userId);

        return JSONResult.ok("刪除成功");
    }

    @RequestMapping("/queryUserById")
    public JSONResult queryUserById(String userId) {

        return JSONResult.ok(userService.queryUserById(userId));
    }

    @RequestMapping("/queryUserList")
    public JSONResult queryUserList() {

        SysUser user = new SysUser();
        user.setUsername("spring boot");
        user.setNickname("lee");

        List<SysUser> userList = userService.queryUserList(user);

        return JSONResult.ok(userList);
    }

    @RequestMapping("/queryUserListPaged")
    public JSONResult queryUserListPaged(Integer page) {
        if (page == null) {
            page = 1;
        }

        int pageSize = 10;

        SysUser user = new SysUser();

        List<SysUser> userList = userService.queryUserListPaged(user, page, pageSize);

        return JSONResult.ok(userList);
    }

    @RequestMapping("/queryUserByIdCustom")
    public JSONResult queryUserByIdCustom(String userId) {

        return JSONResult.ok(userService.queryUserByIdCustom(userId));
    }

    @RequestMapping("/saveUserTransactional")
    public JSONResult saveUserTransactional() {

        String userId = sid.nextShort();

        SysUser user = new SysUser();
        user.setId(userId);
        user.setUsername("lee" + new Date());
        user.setNickname("lee" + new Date());
        user.setPassword("abc123");
        user.setIsDelete(0);
        user.setRegistTime(new Date());

        userService.saveUserTransactional(user);

        return JSONResult.ok("儲存成功");
    }


}

 

第十步：在啟動主類新增掃描器

在SpringBootStarterApplication 啟動類中增加包掃描器。

@SpringBootApplication
//掃描 mybatis mapper 包路徑
@MapperScan(basePackages = "com.weiz.mapper")     // 這一步別忘了。
//掃描 所有需要的包, 包含一些自用的工具類包 所在的路徑
@ComponentScan(basePackages = {"com.weiz","org.n3r.idworker"})
public class SpringBootStarterApplication {

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

}

 

第十一步：測試

在瀏覽器輸入controller裡面定義的路徑即可。只要你按照上面的步驟一步一步來，基本上就沒問題，是不是特別簡單。

 

 

最後

以上，就把Spring Boot整合Mybatis及實現增刪改查介紹完了，Spring Boot 整合Mybatis 是整個Spring Boot 非常重要的功能，也是非常核心的基礎功能，希望大家能夠熟練掌握。後面會深入介紹Spring Boot的各個功能和用法。

這個系列課程的完整原始碼，也會提供給大家。大家關注我的微信公眾號（架構師精進），回覆：springboot原始碼。獲取這個系列課程的完整原始碼。

&n

相關推薦

ABP入門系列（5）——展現層實現增刪改查

這一章節將通過完善Controller、View、ViewModel，來實現展現層的增刪改查。最終實現效果如下圖： 一、定義Controller ABP對ASP.NET MVC Controllers進行了整合，通過引入Abp.Web.Mvc名稱空間，建立Controller繼承自AbpControlle

Spring Boot入門系列（六）如何整合Mybatis實現增刪改查

前面介紹了Spring Boot 中的整合Thymeleaf前端html框架，同時也介紹了Thymeleaf 的用法。不清楚的朋友可以看看之前的文章：https://www.cnblogs.com/zhangweizhong/category/1657780.html。 今天主要講解Springboot整合M

Spring Boot入門系列（八）整合定時任務Task，一秒搞定定時任務

前面介紹了Spring Boot 中的整合Redis快取已經如何實現資料快取功能。不清楚的朋友可以看看之前的文章：https://www.cnblogs.com/zhangweizhong/category/1657780.html。 今天主要講解Springboot整合定時任務。在SpringMvc中也會用

Spring Boot學習筆記（六）整合Junit

第一步，在pom.xml檔案中增加依賴 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spr

Spring Boot入門系列（九）如何實現非同步執行任務

前面介紹了Spring Boot 如何整合定時任務，不清楚的朋友可以看看之前的文章：https://www.cnblogs.com/zhangweizhong/category/1657780.html。 今天主要講解Spring Boot中的另外一個任務：非同步任務。所謂非同步任務，其實就是非同步執行程式，

Spring Boot入門系列（十）如何使用攔截器，一學就會！

前面介紹了Spring Boot 如何整合定時任務已經Spring Boot 如何建立非同步任務，不清楚的朋友可以看看之前的文章：https://www.cnblogs.com/zhangweizhong/category/1657780.html。 接下來開始講 Spring Boot的重要功能：整合攔截器

Spring Boot入門系列（十三）如何實現事務

前面介紹了Spring Boot 中的整合Mybatis並實現增刪改查。不清楚的朋友可以看看之前的文章：https://www.cnblogs.com/zhangweizhong/category/1657780.html。 Spring Boot 整合完Mybatis，有個特別重要的功能之前忘記講了：那就是

MongoDB（六）java操作mongodb增刪改查

    java操作mysql資料庫的程式碼我們已經瞭如指掌了，增刪改查，java對mongodb資料庫也是類似的操作，先是資料庫連線，再是進行操作。     首先我們進入進入admin資料庫，然後建立自己的資料庫testMongoDb，進入admin資料庫後，就可以直

Springboot2（29）整合zookeeper的增刪改查、節點監聽、分散式讀寫鎖、分散式計數器

原始碼地址 springboot2教程系列 實現zookeeper節點的增刪改查、節點監聽、分散式讀寫鎖、分散式計數器 新增依賴 <properties> <project.build.sourceEncoding

Springboot學習筆記（六）關於jdbc的增刪改查

資料庫配置為： 以資料庫demo1，表：zh_user作為演示。含有以下幾個元素： 實體類為：User 1、查        （1）查詢全部，sql語句：”select* from zh_user（表名）”;在Dao層。 Service層Controller層：

04_web基礎（八）之車票實現增刪改查初級版本

lose src uri sed RR 實現 手動添加 jsp頁面 ebs 43.web頁面顯示車票列表簡略完成 　　代碼: 　　控制層代碼 1 package com.day03.station.controller; 2 3 import com.day03

SpringBoot整合Mybatis實現增刪改查的功能

ger 開始 pan ble img 映射 講師 -name date SpringBoot框架作為現在主流框架之一，好多框架都漸漸的移植到SpringBoot中來。前面我給大家介紹過redis，jpa等等的的整合,今天在這裏給大家介紹一下Mybatis的整合過程。 S

springboot整合mybatis實現增刪改查流程以及易錯點

Springboot+mybatis+mysql實現增刪改查操作。 在昨天學習的springboot的入門程式上進行擴充套件開發。首先建立好專案目錄結構,如圖： 整個流程類似ssm整合，controller—》service—》dao ，介面訪問xml。這個寫完的結構

Spring Boot入門系列（十八）整合mybatis，使用註解的方式實現增刪改查

之前介紹了Spring Boot 整合mybatis 使用xml配置的方式實現增刪改查，還介紹了自定義mapper 實現複雜多表關聯查詢。雖然目前 mybatis 使用xml 配置的方式 已經極大減輕了配置的複雜度，支援 generator 外掛 根據表結構自動生成實體類、配置檔案和dao層程式碼，減輕很大一

Spring Boot入門系列（十七）整合Mybatis，建立自定義mapper 實現多表關聯查詢！

之前講了Springboot整合Mybatis，介紹瞭如何自動生成pojo實體類、mapper類和對應的mapper.xml 檔案，並實現最基本的增刪改查功能。mybatis 外掛自動生成的mapper 實現了大部分基本、通用的方法，如：insert、update、delete、select 等大概20個左右

Spring Boot入門系列（十九）整合mybatis，使用註解實現動態Sql、引數傳遞等常用操作！

前面介紹了Spring Boot 整合mybatis 使用註解的方式實現資料庫操作，介紹瞭如何自動生成註解版的mapper 和pojo類。 接下來介紹使用mybatis 常用註解以及如何傳引數等資料庫操作中的常用操作。 其實，mybatis 註解方式 和 XML配置方式兩者的使用基本上相同，只有在構建 SQL

Spring Boot（六）整合 MyBatis 操作 MySQL 8

一、簡介 1.1 MyBatis介紹 MyBatis 是一款優秀的持久層框架，它支援定製化 SQL、儲存過程以及高階對映。MyBatis 避免了幾乎所有的 JDBC程式碼和手動設定引數以及獲取結果集。 1.2 MyBatis發展史 MyBatis 原本是apache

Spring Boot入門系列（十四）使用JdbcTemplate操作資料庫，配置多資料來源！

前面介紹了Spring Boot 中的整合Mybatis並實現增刪改查、如何實現事物控制。不清楚的朋友可以看看之前的文章：https://www.cnblogs.com/zhangweizhong/category/1657780.html。 Spring Boot 除了Mybatis資料庫框架，還有Jdbc

Spring Boot入門系列（十五）Spring Boot 開發環境熱部署

在實際的專案開發過中，當我們修改了某個java類檔案時，需要手動重新編譯、然後重新啟動程式的，整個過程比較麻煩，特別是專案啟動慢的時候，更是影響開發效率。其實Spring Boot的專案碰到這種情況，同樣也同樣需要經歷重新編譯、重新啟動程式的過程。 只不過 Spring Boot 提供了一個spring-bo

Spring Boot入門系列（二十）快速打造Restful API 介面

spring boot入門系列文章已經寫到第二十篇，前面我們講了spring boot的基礎入門的內容，也介紹了spring boot 整合mybatis，整合redis、整合Thymeleaf 模板引擎 等各種框架，同時也介紹了使用jdbcTemplate 操作資料庫，配置多資料來源 等系列內容。應該說sp