Spring集成MyBatis

時間  2020-08-13
標籤 spring 集成 mybatis 欄目 Spring 简体版
原文   原文鏈接

目錄

將 MyBatis與 Spring 進行整合，主要解決的問題就是將 SqlSessionFactory 對象交由 Spring來管理。因此，該整合，只須要將 SqlSessionFactory 的對象生成器 SqlSessionFactoryBean 註冊在 Spring 容器中，再將其注入給 Dao 的實現類便可完成整合

實現 Spring 與 MyBatis 的整合經常使用的方式：掃描的 Mapper 動態代理java

1、創建數據庫及新表

2、maven依賴pom.xml

  • spring依賴
  • mybatis依賴
  • mysql驅動
  • spring的事務依賴
  • mybatis和spring集成的依賴

完整的pom.xml文件mysql

<?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">
  <modelVersion>4.0.0</modelVersion>

  <groupId>com.md</groupId>
  <artifactId>06-spring-mybatis</artifactId>
  <version>1.0-SNAPSHOT</version>


  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <maven.compiler.source>1.8</maven.compiler.source>
    <maven.compiler.target>1.8</maven.compiler.target>
  </properties>

  <dependencies>

    <!-- 單元測試-->
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.11</version>
      <scope>test</scope>
    </dependency>

    <!--spring核心-->
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-context</artifactId>
      <version>5.2.5.RELEASE</version>
    </dependency>

    <!--spring事務用到的-->
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-tx</artifactId>
      <version>5.2.5.RELEASE</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-jdbc</artifactId>
      <version>5.2.5.RELEASE</version>
    </dependency>


    <!--mybatis的-->
    <dependency>
      <groupId>org.mybatis</groupId>
      <artifactId>mybatis</artifactId>
      <version>3.5.1</version>
    </dependency>

    <!--mybatis和spring集成的-->
    <dependency>
      <groupId>org.mybatis</groupId>
      <artifactId>mybatis-spring</artifactId>
      <version>1.3.1</version>
    </dependency>

    <!--mysql驅動-->
    <dependency>
      <groupId>mysql</groupId>
      <artifactId>mysql-connector-java</artifactId>
      <version>5.1.9</version>
    </dependency>

	<!--德魯伊，數據庫鏈接池-->
    <dependency>
      <groupId>com.alibaba</groupId>
      <artifactId>druid</artifactId>
      <version>1.1.12</version>
    </dependency>


  </dependencies>

  <build>

    <!--目的是把src/main/java目錄中的xml文件包含到輸出結果中，也就是輸出到classes目錄中-->
    <resources>
      <resource>
        <directory>src/main/java</directory><!--所在的目錄-->
        <includes><!--包括目錄下的.properties,.xml 文件都會掃描到-->
          <include>**/*.properties</include>
          <include>**/*.xml</include>
        </includes>
        <filtering>false</filtering>
      </resource>
    </resources>

  </build>

</project>

3、建立實體類

package com.md.domain;

/**
 * @author MD
 * @create 2020-08-09 20:02
 */
public class Student {
    // 屬性名和列名同樣
    private Integer id;

    private String name;

    private String email;

    private Integer age;

    public Student() {
    }


    public Student(Integer id, String name, String email, Integer age) {
        this.id = id;
        this.name = name;
        this.email = email;
        this.age = 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 String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }

    public Integer getAge() {
        return age;
    }

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

    @Override
    public String toString() {
        return "Student{" +
                "id=" + id +
                ", name='" + name + '\'' +
                ", email='" + email + '\'' +
                ", age=" + age +
                '}';
    }
}

4、建立dao接口

package com.md.dao;

import com.md.domain.Student;

import java.util.List;

/**
 * @author MD
 * @create 2020-08-09 20:04
 */
public interface StudentDao {
    int insertStudent(Student student);

    List<Student> selectStudents();
}

5、定義映射文件mapper

和dao在同一目錄下，名字和dao接口的同樣，StudentDao.xmlgit

mapper 中的 namespace 取值也爲 Dao 接口的全限定性名github

<?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.dao.StudentDao">


    <insert id="insertStudent">
        insert into student values(#{id},#{name},#{email},#{age})
    </insert>


    <select id="selectStudents" resultType="com.md.domain.Student">

        select id,name,email,age from student

    </select>

</mapper>

6、建立mybatis主配置文件

在 src /main/resources下定義 MyBatis 的主配置文件，命名爲 mybatis.xmlspring

注意：sql

  1. 主配置文件中再也不須要數據源的配置了。由於數據源要交給 Spring 容器來管理了
  2. 這裏對 mapper 映射文件的註冊，使用<package/>標籤，即只需給出 mapper 映射文件所在的包便可。由於 mapper 的名稱與 Dao 接口名相同，能夠使用這種簡單註冊方式。這種方式的好處是，如有多個映射文件，這裏的配置也是不用改變的。固然，也可以使用原來的<resource/>標籤方式
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">

<configuration>


    <!--settings：控制mybatis全局行爲-->
    <settings>

        <!--設置mybatis輸出日誌-->
        <setting name="logImpl" value="STDOUT_LOGGING"/>
    </settings>


    <!--設置別名-->
    <typeAliases>
        <!--
			package:把包下面的全部類名做爲別名
			name：實體類所在的包名-->
        <package name="com.md.domain"/>

    </typeAliases>



    <!-- sql映射文件的位置 -->
    <mappers>

        <!--name是包名，這個包中全部mapper.xml一次加載-->
        <package name="com.md.dao"/>
    </mappers>

</configuration>

7、建立Service接口和實現類，屬性是dao

package com.md.service;

import com.md.domain.Student;

import java.util.List;

/**
 * @author MD
 * @create 2020-08-09 20:25
 */
public interface StudentService {

    int addStudent(Student student);

    List<Student> queryStudent();

}

//-------------------------------------
package com.md.service.impl;

import com.md.dao.StudentDao;
import com.md.domain.Student;
import com.md.service.StudentService;

import java.util.List;

/**
 * @author MD
 * @create 2020-08-09 20:27
 */
public class StudentServiceImpl implements StudentService {

    // 引用類型
    private StudentDao studentDao;

    // 爲了使用set注入來賦值
    public void setStudentDao(StudentDao studentDao) {
        this.studentDao = studentDao;
    }

    @Override
    public int addStudent(Student student) {
        int i = studentDao.insertStudent(student);
        return i;
    }



    @Override
    public List<Student> queryStudent() {
        List<Student> studentList = studentDao.selectStudents();

        return studentList;
    }
}

8、建立spring的配置文件

在 src /main/resources下定義 Spring的主配置文件，命名爲 applicationContext.xml數據庫

聲明mybatis的對象交給spring建立apache

1. 數據源DateSourcemybatis

使用 JDBC 模板，首先須要配置好數據源，數據源直接以 Bean 的形式配置在 Spring 配置文件中。根據數據源的不一樣，其配置方式不一樣：app

這裏使用的Druid，Druid 是阿里的開源數據庫鏈接池。是 Java 語言中最好的數據庫鏈接池。Druid 能
夠提供強大的監控和擴展功能

https://github.com/alibaba/druid

首先在pom.xml中加入依賴，上面添加過了

而後是在spring的配置文件中

<!--聲明數據源DataSource，做用是鏈接數據庫-->
    <bean id="myDataSource" class="com.alibaba.druid.pool.DruidDataSource" init-method="init" destroy-method="close">

        <!--set注入提供鏈接數據庫信息-->
        <property name="url" value="${jdbc.url}" />
        <property name="username" value="${jdbc.username}" />
        <property name="password" value="${jdbc.password}" />
        <property name="maxActive" value="${jdbc.maxActive}" />

    </bean>

爲了維護方法方便，還能夠使用屬性文件

在在 src /main/resources下定義jdbc.properties

jdbc.url=jdbc:mysql://localhost:3306/ssm
jdbc.username=root
jdbc.password=123456
jdbc.maxActive=20

而後再spring的配置文件中

<!--
        把數據庫的配置信息寫在一個獨立的文件中，編譯修改數據庫的配置內容
        讓spring知道jdbc.properties文件的位置
    -->
    <context:property-placeholder location="classpath:jdbc.properties"/>


    <!--聲明數據源DataSource，做用是鏈接數據庫-->
    <bean id="myDataSource" class="com.alibaba.druid.pool.DruidDataSource" init-method="init" destroy-method="close">
 <!--    使用屬性配置文件中的數據，語法 ${key} -->
        <property name="url" value="${jdbc.url}" /><!--setUrl()-->
        <property name="username" value="${jdbc.username}"/>
        <property name="password" value="${jdbc.password}" />
        <property name="maxActive" value="${jdbc.maxActive}" />


    </bean>

這樣就能夠了

2. 註冊SqlSessionFactoryBean

<!--SqlSessionFactory-->
    <!--聲明的是mybatis中提供的SqlSessionFactoryBean類，這個類內部建立SqlSessionFactory-->
    <bean id="SqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">

        <!--set注入，把數據庫鏈接池付給dataSource屬性-->
        <property name="dataSource" ref="myDataSource"/>
        <!--mybatis主配置文件的位置
            configLocation屬性是Resource類型，讀取配置文件
            它的賦值使用的是value ， 指定文件的路徑，使用的是classpath：表示文件的位置
        -->
        <property name="configLocation" value="classpath:mybatis.xml"/>
    </bean>

3. 定義 Mapper 掃描配置器 MapperScannerConfigurer

也就是建立dao對象

<!--建立 dao對象
        使用SqlSession的getMapper(StudentDao.class)
        MapperScannerConfigurer在內部調用getMapper()生成每一個dao接口的代理對象
    -->
    <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
        <!--指定的是SqlSessionFactory對象的id-->
        <property name="sqlSessionFactoryBeanName" value="SqlSessionFactory"/>

        <!--指定包名，包名是dao接口所在的包名
            MapperScannerConfigurer會掃描這個包中的全部接口，把每一個接口都執行
            一次getMapper()方法，獲得每一個接口的dao對象
            建立好的dao對象放入到spring的容器中

            dao默認對象的名稱：是接口名字的首字母小寫
        -->


        <property name="basePackage" value="com.md.dao"/>

        <!--多個包-->
        <!--<property name="basePackage" value="com.md.dao,com.md.dao2"/>-->

    </bean>

4. 向 Service 注入接口名

<!--聲明service-->
    <bean id="studentService" class="com.md.service.impl.StudentServiceImpl">

        <!--就是上面經過建立的dao對象-->
        <property name="studentDao" ref="studentDao"/>
    </bean>

總：

Spring的配置文件

用的時候直接複製

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd">

    <!--
        把數據庫的配置信息寫在一個獨立的文件中，編譯修改數據庫的配置內容
        讓spring知道jdbc.properties文件的位置
    -->
    <context:property-placeholder location="classpath:jdbc.properties"/>


    <!--聲明數據源DataSource，做用是鏈接數據庫-->
    <bean id="myDataSource" class="com.alibaba.druid.pool.DruidDataSource" init-method="init" destroy-method="close">

        <!--set注入提供鏈接數據庫信息-->
        <!--<property name="url" value="jdbc:mysql://localhost:3306/ssm" />-->
        <!--<property name="username" value="root" />-->
        <!--<property name="password" value="123456" />-->
        <!--<property name="maxActive" value="20" />-->

        <property name="url" value="${jdbc.url}" />
        <property name="username" value="${jdbc.username}" />
        <property name="password" value="${jdbc.password}" />
        <property name="maxActive" value="${jdbc.maxActive}" />

    </bean>



    <!--SqlSessionFactory-->
    <!--聲明的是mybatis中提供的SqlSessionFactoryBean類，這個類內部建立SqlSessionFactory-->
    <bean id="SqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">

        <!--set注入，把數據庫鏈接池付給dataSource屬性-->
        <property name="dataSource" ref="myDataSource"/>
        <!--mybatis主配置文件的位置
            configLocation屬性是Resource類型，讀取配置文件
            它的賦值使用的是value ， 指定文件的路徑，使用的是classpath：表示文件的位置
        -->
        <property name="configLocation" value="classpath:mybatis.xml"/>
    </bean>



    <!--建立 dao對象
        使用SqlSession的getMapper(StudentDao.class)
        MapperScannerConfigurer在內部調用getMapper()生成每一個dao接口的代理對象
    -->
    <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
        <!--指定的是SqlSessionFactory對象的id-->
        <property name="sqlSessionFactoryBeanName" value="SqlSessionFactory"/>

        <!--指定包名，包名是dao接口所在的包名
            MapperScannerConfigurer會掃描這個包中的全部接口，把每一個接口都執行
            一次getMapper()方法，獲得每一個接口的dao對象
            建立好的dao對象放入到spring的容器中

            dao默認對象的名稱：是接口名字的首字母小寫
        -->


        <property name="basePackage" value="com.md.dao"/>

        <!--多個包-->
        <!--<property name="basePackage" value="com.md.dao,com.md.dao2"/>-->


    </bean>


    <!--上面的這個是一個模板，只有最後dao對象的這個包名的value的值是根據本身建立寫的-->




    <!--下面的就是本身定義的service-->



    <!--聲明service-->
    <bean id="studentService" class="com.md.service.impl.StudentServiceImpl">

        <!--就是上面經過建立的dao對象-->
        <property name="studentDao" ref="studentDao"/>
    </bean>

</beans>

9、建立測試類

@Test
    public void test03(){
        ApplicationContext c = new ClassPathXmlApplicationContext("applicationContext.xml");
        // 獲取到了spring容器中的對象
        StudentService studentService = (StudentService) c.getBean("studentService");
        studentService.addStudent(new Student(1008,"馮寶寶","fb@qq.com",20));

        // spring和mybatis整合在一塊兒使用，事務是自動提交的

        List<Student> studentList = studentService.queryStudent();
        studentList.forEach(stu-> System.out.println(stu));

    }

總體目錄結構

10、總結

  1. 新建maven項目
  2. 加入maven依賴
    • spring依賴
    • mybatis依賴
    • mysql驅動
    • spring的事務依賴
    • mybatis和spring集成的依賴
    • 德魯伊，數據庫鏈接池的依賴
  3. 建立實體類
  4. 建立dao接口和mapper文件
  5. 建立mybatis主配置文件
  6. 建立Service接口和實現類，屬性是dao
  7. 建立spring的配置文件：聲明mybatis的對象交給spring建立
    • 數據源DateSource
    • SqlSessionFactory
    • Dao對象
    • 聲明自定義的service
  8. 建立測試類，獲取Service對象，經過service調用dao完成數據庫的訪問
相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程