SpringBoot集成Mybatis

通過 SpringBoot +MyBatis 實現對數據庫學生表的查詢操作

一、實現步驟

新建一個09-springboot-web-mybatis項目，方式和之前一樣，基於springboot的

1. 准備數據庫

新建一個數據庫springboot，指定字符編碼集utf-8，並創建數據表

表名為：t_student，並插入幾條數據

2. 在pom.xml 中添加相關 jar 依賴

<!--Mybatis整合springboot的起步依賴-->
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>2.0.0</version>
        </dependency>

        <!--MySQL 的驅動依賴，點擊就可以查看，此時默認的是8.0的，
            也可以根據自己使用的mysql版本號，來指定版本號
            我使用的5.7
        -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.9</version>
        </dependency>

3. 在Springboot的核心配置文件 application.properties 中配置數據源

注意mysql的版本差別

#配置內嵌 Tomcat 端口號
server.port=9090
#配置項目上下文根
server.servlet.context-path=/09-springboot-web-mybatis


#配置數據庫的連接信息
#注意這里的驅動類有變化，這是mysql8.0
#spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
#spring.datasource.url=jdbc:mysql://localhost:3306/springboot?useUnicode=true&characterEncoding=UTF-8&useJDBCCompliantTimezoneShift=true&useLegacyDatetimeCode=false&serverTimezone=GMT%2B8

#我用的mysql5.7
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/springboot

spring.datasource.username=root
spring.datasource.password=123456

4. 開發代碼

1. 使用 Mybatis 反向工程生成接口、映射文件以及實體 bean，具體看下面的介紹

2. 在 service 包下創建 service 接口並編寫代碼

package com.md.springboot.service;

import com.md.springboot.model.Student;

/**
 * @author MD
 * @create 2020-08-21 9:42
 */
public interface StudentService {

    /**
     * 根據學生id查詢學生信息
     * @param id
     * @return
     */
    Student queryStudentById(Integer id);
}

3. 在 service.impl 包下創建 service 接口並編寫代碼

package com.md.springboot.service.impl;

import com.md.springboot.mapper.StudentMapper;
import com.md.springboot.model.Student;
import com.md.springboot.service.StudentService;


/**
 * @author MD
 * @create 2020-08-21 9:43
 */
@Service
public class StudentServiceImpl implements StudentService {

    @Autowired
    private StudentMapper studentMapper;

    @Override
    public Student queryStudentById(Integer id) {
        return studentMapper.selectByPrimaryKey(id);
    }

}

4. 在 web 包下創建 StudentController 並編寫代碼

package com.md.springboot.web;

import com.md.springboot.model.Student;

import com.md.springboot.service.StudentService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

/**
 * @author MD
 * @create 2020-08-21 9:40
 */
@Controller
public class StudentController {


    @Autowired
    private StudentService studentService;


    @RequestMapping(value = "/student")
    @ResponseBody
    public Object student(){
        Student student = studentService.queryStudentById(3);

        return student;
    }

}

5. 在 Mybatis 反向工程生成的 StudentMapper 接口上加一個 Mapper 注解
@Mapper 作用：mybatis 自動掃描數據持久層的映射文件及 DAO 接口的關系

// 掃描dao接口到spring容器
@Mapper
public interface StudentMapper {
    int deleteByPrimaryKey(Integer id);

    int insert(Student record);

    int insertSelective(Student record);

    Student selectByPrimaryKey(Integer id);

    int updateByPrimaryKeySelective(Student record);

    int updateByPrimaryKey(Student record);
}

6. 注意：默認情況下，Mybatis 的 xml 映射文件不會編譯到 target 的 class 目錄下，所
以我們需要在 pom.xml 文件中配置 resource

 <!--Mybatis 的 xml 映射文件編譯到 target 的 class 目錄下-->
        <resources>
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>**/*.xml</include>
                </includes>
            </resource>
        </resources>

5. 啟動

二、DAO 其它開發方式

1. 在運行的主類上添加注解包掃描

@MapperScan("com.md.springboot.mapper")

此時就可以注釋掉 StudentMapper 接口上的@Mapper 注解

//@Mapper
public interface StudentMapper {

在運行主類 Application 上加@MapperScan("com.md.springboot.mapper")

@SpringBootApplication
//Mybatis 提供的注解：掃描數據持久層的 mapper 映謝配置文件,DAO 接口上就不用加@Mapper
@MapperScan("com.md.springboot.mapper")
public class Application {

2. 將接口和映射文件分開

因為 SpringBoot 不能自動編譯接口映射的 xml 文件，還需要手動在 pom 文件中指定，

還可以直接將映射文件直接放到 resources 目錄下，這樣就不用手動在pom文件中指定了

在 resources 目錄下新建目錄 mapper 存放映射文件，將 StudentMapper.xml 文件移到 resources/mapper 目錄下

在 application.properties 配置文件中指定映射文件的位置，這個配置只有接口和映射文件不在同一個包的情況下，才需要指定

# 指定 Mybatis 映射文件的路徑
mybatis.mapper-locations=classpath:mapper/*.xml

三、Spring Boot 事務支持

Spring Boot 使用事務非常簡單，底層依然采用的是 Spring 本身提供的事務管理

• 在入口類中使用注解 @EnableTransactionManagement 開啟事務支持
• 在訪問數據庫的 Service 方法上添加注解 @Transactional 即可

1. 在 StudentService 接口中添加更新學生方法

    /**
     * 根據學生的id更新學生信息
     * @param student
     * @return
     */
    int modifyStudentById(Student student);

2. 在 StudentServiceImpl 接口實現類

對更新學生方法進行實現，並構建一個異常，同時在該方法上加@Transactional 注解

 @Override
    @Transactional // 添加這個注解說明該方法添加了事務管理
    public int modifyStudentById(Student student) {


        int updateCount = studentMapper.updateByPrimaryKeySelective(student);

        System.out.println("更新結果："+updateCount);



//        用於測試事務是否有效
        int a = 10 / 0;

        return updateCount;
    }

3. 在StudentController 中添加更新學生的方法

@RequestMapping(value = "/modify")
    @ResponseBody
    public Object modifyStudent(){
        int count = 0;

        try {
            Student student = new Student();
            student.setId(1);
            student.setName("tim");
            student.setAge(30);

            count = studentService.modifyStudentById(student);
        } catch (Exception e) {
            e.printStackTrace();
            return "fail";
        }


        return count;
    }

4. 在Application 類

@EnableTransactionManagement 可選，但是 業務方法上 必須添加@Transactional 事務才生效

@SpringBootApplication
@MapperScan("com.md.springboot.mapper")
@EnableTransactionManagement //開啟事務支持(可選項，但@Transactional 必須添加)
public class Application {

5. 啟動

此時就生效了，數據庫沒有任何改變

6. 去掉注解

注釋掉 StudentServiceImpl 上的@Transactional 測試

數據庫的數據被更新

四、SpringBoot 工程下使用 Mybatis 反向工程

1. 拷貝 Mybatis 反向工程配置文件到項目的根目錄下

2. 根據項目及表的情況，修改 GeneratorMapper.xml 配置

• 如果使用 高版本 ， 驅動類變為：com.mysql.cj.jdbc.Driver
• url 后面應該加屬性 nullCatalogMeansCurrent=true ，否則生成有問題

當前版本 MySQL 數據庫為 5.7

主要根據注釋來修改自己的內容

<?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>
    <!-- 指定連接數據庫的 JDBC 驅動包所在位置，指定到你本機的完整路徑 -->
    <classPathEntry location="E:\Java\tool\maven_repository\mysql\mysql-connector-java\5.1.9\mysql-connector-java-5.1.9.jar"/>



    <!-- 配置 table 表信息內容體，targetRuntime 指定采用 MyBatis3 的版本 -->
    <context id="tables" targetRuntime="MyBatis3">
        <!-- 抑制生成注釋，由於生成的注釋都是英文的，可以不讓它生成 -->
        <commentGenerator>
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>
        <!-- 配置數據庫連接信息 -->
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/springboot"
                        userId="root"
                        password="123456">
        </jdbcConnection>




        <!-- 生成 model 類，targetPackage 指定 model 類的包名， targetProject 指定
        生成的 model 放在 IDEA 的哪個工程下面-->
        <javaModelGenerator targetPackage="com.md.springboot.model"
                            targetProject="src/main/java">
            <property name="enableSubPackages" value="false"/>
            <property name="trimStrings" value="false"/>
        </javaModelGenerator>




        <!-- 生成 MyBatis 的 Mapper.xml 文件，targetPackage 指定 mapper.xml 文件的
        包名， targetProject 指定生成的 mapper.xml 放在 IDEA 的哪個工程下面 -->
        <sqlMapGenerator targetPackage="com.md.springboot.mapper"
                         targetProject="src/main/java">
            <property name="enableSubPackages" value="false"/>
        </sqlMapGenerator>





        <!-- 生成 MyBatis 的 Mapper 接口類文件,targetPackage 指定 Mapper 接口類的包
        名， targetProject 指定生成的 Mapper 接口放在 IDEA 的哪個工程下面 -->
        <javaClientGenerator type="XMLMAPPER"
                             targetPackage="com.md.springboot.mapper" targetProject="src/main/java">
            <property name="enableSubPackages" value="false"/>
        </javaClientGenerator>





        <!-- 數據庫表名及對應的 Java 模型類名，有幾個表寫幾個table -->
        <table tableName="t_student" domainObjectName="Student"
               enableCountByExample="false"
               enableUpdateByExample="false"
               enableDeleteByExample="false"
               enableSelectByExample="false"
               selectByExampleQueryId="false"/>


    </context>
</generatorConfiguration>

此時會報錯，如下

這個時候可以不用理會，項目也是會正常運行的，當然也可以這樣

添加之后就不會報紅了

3. 在pom.xml 文件中添加 mysql 反向工程依賴

<build>
        <plugins>
            <!--mybatis 代碼自動生成插件-->
            <plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>1.3.6</version>
                <configuration>
                    <!--配置文件的位置-->
                    <configurationFile>GeneratorMapper.xml</configurationFile>
                    <verbose>true</verbose>
                    <overwrite>true</overwrite>
                </configuration>
            </plugin>
        </plugins>

    </build>

4. 雙擊生成相關文件

5. 生成的文件

自動生成model/Student、實體類

以及StudentMapper，接口

StudentMapper.xml 具體對數據庫的操作

這樣方便我們使用，具體的下面詳細介紹，注意看注釋

Student

package com.md.springboot.model;

public class Student {
    private Integer id;

    private String name;

    private Integer age;

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }
}

StudentMapper

package com.md.springboot.mapper;

import com.md.springboot.model.Student;

public interface StudentMapper {
    int deleteByPrimaryKey(Integer id);

    int insert(Student record);

    int insertSelective(Student record);

    Student selectByPrimaryKey(Integer id);

    int updateByPrimaryKeySelective(Student record);

    int updateByPrimaryKey(Student record);
}

StudentMapper.xml

<?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.md.springboot.mapper.StudentMapper">


  <!--
    數據庫字段名稱     實體對象屬性名稱
    user_name           userName
    user_age            userAge

  -->
  <!--
    如果數據表中的字段是多個單詞構成的，通過Mybatis逆向工程生成的對象屬性名稱
    會按照駝峰命名法的規則生成屬性名稱
    自己設計數據表的時候，多個單詞之前使用下划線分隔

  -->

  <!--
    resultMap的作用
    1. 當數據庫中的字段名稱和實體類對象的屬性名不一致，可以進行轉換
    2. 當前查詢的結果對象沒有對應一個表時，可以自定義一個結果集
  -->
  <resultMap id="BaseResultMap" type="com.md.springboot.model.Student">
    <!--
      id標簽只能修飾主鍵字段，result標簽修飾其他字段
      column 數據庫中的字段名稱
      property 映射對象的屬性名稱
      jdbcType 對應的類型
    -->
    <id column="id" jdbcType="INTEGER" property="id" />
    <result column="name" jdbcType="VARCHAR" property="name" />
    <result column="age" jdbcType="INTEGER" property="age" />
  </resultMap>


  <!--sql語句片段，將公共部分抽出-->
  <sql id="Base_Column_List">
    id, name, age
  </sql>




  <select id="selectByPrimaryKey" parameterType="java.lang.Integer" resultMap="BaseResultMap">
    select 
    <include refid="Base_Column_List" />
    from t_student
    where id = #{id,jdbcType=INTEGER}
  </select>

  <delete id="deleteByPrimaryKey" parameterType="java.lang.Integer">
    delete from t_student
    where id = #{id,jdbcType=INTEGER}
  </delete>

  <insert id="insert" parameterType="com.md.springboot.model.Student">
    insert into t_student (id, name, age
      )
    values (#{id,jdbcType=INTEGER}, #{name,jdbcType=VARCHAR}, #{age,jdbcType=INTEGER}
      )
  </insert>


  <!--動態sql-->
  <insert id="insertSelective" parameterType="com.md.springboot.model.Student">
    insert into t_student
    <trim prefix="(" suffix=")" suffixOverrides=",">
      <if test="id != null">
        id,
      </if>
      <if test="name != null">
        name,
      </if>
      <if test="age != null">
        age,
      </if>
    </trim>
    <trim prefix="values (" suffix=")" suffixOverrides=",">
      <if test="id != null">
        #{id,jdbcType=INTEGER},
      </if>
      <if test="name != null">
        #{name,jdbcType=VARCHAR},
      </if>
      <if test="age != null">
        #{age,jdbcType=INTEGER},
      </if>
    </trim>
  </insert>


  <update id="updateByPrimaryKeySelective" parameterType="com.md.springboot.model.Student">
    update t_student
    <set>
      <if test="name != null">
        name = #{name,jdbcType=VARCHAR},
      </if>
      <if test="age != null">
        age = #{age,jdbcType=INTEGER},
      </if>
    </set>
    where id = #{id,jdbcType=INTEGER}
  </update>

  <update id="updateByPrimaryKey" parameterType="com.md.springboot.model.Student">
    update t_student
    set name = #{name,jdbcType=VARCHAR},
      age = #{age,jdbcType=INTEGER}
    where id = #{id,jdbcType=INTEGER}
  </update>
</mapper>