Spring集成MyBatis

提示：文章写完后，目录可以自动生成，如何生成可参考右边的帮助文档

---

配置步骤

步骤：
1.新建maven项目
2.加入maven的依赖
    1）spring的依赖
    2）mybatis的依赖
    3）MySQL的驱动
    4）spring的事务的依赖
    5）mybatis和spring集成的依赖：mybatis官方提供的，用来在spring项目中创建mybatis
        SqlSessionFactory，dao对象的

3.创建实体类
4.创建dao接口和mapper文件
5.创建mybatis配置文件
6.创建service接口和实现类，实现类的属性是dao
7.创建spring的配置文件：声明mybatis的对象交给spring创建
    1）数据源 DruidDataSource
    2）SqlSessionFactory
    3）dao对象
    4）声明自定义的service
8.创建测试类，获取service对象，通过service调用dao完成数据库的访问

实例

话不多说直接上实战配置

1.新建Maven项目

选择Maven项目，我这里是用的JDK1.8（你们装的什么就用什么），勾选Create from archetype（创建模板），选择quickstart模板，下一步

写上项目名

选择自己的Maven配置文件和本地仓库，完成。

下面是我的项目结构：

2.加入maven的依赖

<?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.wenhua</groupId>
  <artifactId>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核心-IoC-->
    <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>

      <!--lombok-->
      <!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
      <dependency>
          <groupId>org.projectlombok</groupId>
          <artifactId>lombok</artifactId>
          <version>1.18.12</version>
          <scope>provided</scope>
      </dependency>
  </dependencies>

  <build>

<!--    目的是把src/main/java目录中的xml文件包含到输出结果中。输出到class目录中-->
    <resources>
      <resource>
        <directory>src/main/java</directory><!--所在的目录-->
        <includes><!--包括目录下的.properties,.xml文件都会扫描到-->
          <include>**/*.properties</include>
          <include>**/*.xml</include>
        </includes>
        <filtering>false</filtering>
      </resource>
    </resources>

    <!--指定jdk的版本-->
    <plugins>
      <plugin>
        <artifactId>maven-compiler-plugin</artifactId>
        <version>3.1</version>
        <configuration>
          <source>1.8</source>
          <target>1.8</target>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

3.创建实体类

在pojo包中创建实体类（根据自己数据库表来创建）
下面是我的数据库结构

创建对应的实体类，我这里是Student类

package com.wenhua.pojo;

import lombok.*;

@Setter
@Getter
@NoArgsConstructor
@AllArgsConstructor
@ToString
public class Student {
    private Integer id;
    private String name;
    private String email;
    private Integer age;
}

我这里加了lombok的依赖，可以直接使用注解来实现有参构造、无参构造、Setter和Getter方法、toString方法。没有加这个依赖的可以正常写参构造、无参构造、Setter和Getter方法、toString方法。

4.创建dao接口和mapper文件

在dao包（数据链路层）下创建StudentDao接口和对应的mapper.xml文件（我这里是写的dao.xml文件，这两者其实是一个东西）

StudentDao

package com.wenhua.dao;

import com.wenhua.pojo.Student;

import java.util.List;

public interface StudentDao {
	//插入方法
    public int insert(Student student);
    
    //查询方法
    public List<Student> queryAll();
}

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

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

    <select id="queryAll" resultType="com.wenhua.pojo.Student">
        select id,name,email,age from students order by id desc
    </select>

</mapper>

ps: 这两个东西名称一定要一致，一定要一致，一定要一致

5.创建mybatis配置文件

<?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>
        <!--name:实体类所在的包名-->
        <package name="com.wenhua.pojo"/>
    </typeAliases>

    <!--sql mapper（sql映射文件）的位置-->
    <mappers>
        <!--第一种方式-->
<!--        <mapper resource="com.wenhua.dao.StudentDao"/>-->
        <!--第二种方式：使用包名
            name：xml文件（mapper文件）所在的包名，这个包中的所有xml文件，一次都能加载给mybatis。
            使用package的要求：
            1.mapper文件名称需要和接口名称一样
            2.mapper文件和dao接口需要在同一目录
        -->
        <package name="com.wenhua.dao"/>
    </mappers>
</configuration>

6.创建service接口和实现类，实现类的属性是dao

在service包（业务层）下创建StudentService和他的实现类
接口StudentService

package com.wenhua.service;

import com.wenhua.pojo.Student;

import java.util.List;

public interface StudentService {
    public int addStudent(Student student);
    public List<Student> selectAll();
}

实现类StudentServiceImpl，这个类有个成员变量StudentDao，用来获取数据库表中的信息

package com.wenhua.service.impl;

import com.wenhua.dao.StudentDao;
import com.wenhua.pojo.Student;
import com.wenhua.service.StudentService;
import lombok.Setter;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Repository;
import org.springframework.stereotype.Service;

import java.util.List;

@Setter
@Service
public class StudentServiceImpl implements StudentService {
    @Autowired
    private StudentDao studentDao;
	
	//增加业务
    @Override
    public int addStudent(Student student) {
        return studentDao.insert(student);
    }

	//查询业务
    @Override
    public List<Student> selectAll() {
        return studentDao.queryAll();
    }
}

7.创建spring的配置文件

我们要将MyBatis所需要的类交由Spring来创建管理：

    1)数据源 DruidDataSource
	2)SqlSessionFactory
	3)dao对象
	4)声明自定义的service

创建Spring配置文件applicationContext

applicationContext.xml

<?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">

    <!--声明数据源DateSources，作用是连接数据库的-->
    <bean id="myDataSources" class="com.alibaba.druid.pool.DruidDataSource" init-method="init" destroy-method="close">
        <!--set注入给DruidDataSource提供连接数据库的信息-->
        <property name="url" value="jdbc:mysql://localhost:3306/wenhuabuzhejian"/>
        <property name="username" value="root"/>
        <property name="password" value="root"/>
        <property name="maxActive" value="20"/>
    </bean>

    <!--声明的是mybatis中提供的SqlSessionFactoryBean类，这个类内部创建SqlSessionFactory的-->
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <!--set注入，把数据库连接池赋给了dataSources属性-->
        <property name="dataSource" ref="myDataSources"/>
        <!--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容器中
        -->
        <property name="basePackage" value="com.wenhua.dao"/>
    </bean>

    <context:component-scan base-package="com.wenhua.service"/>
</beans>

8.创建测试类，获取service对象，通过service调用dao完成数据库的访问

package com.wenhua;

import com.wenhua.dao.StudentDao;
import com.wenhua.pojo.Student;
import com.wenhua.service.StudentService;
import com.wenhua.service.impl.StudentServiceImpl;
import org.junit.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

import java.util.List;

public class MyTest01 {
    @Test
    public void testInsert(){
        String config = "applicationContext.xml";
        ApplicationContext ac = new ClassPathXmlApplicationContext(config);
        StudentDao dao = (StudentDao) ac.getBean("studentDao");
        Student student = new Student(5,"张三丰","zhangsanfeng.@qq.com",19);
        dao.insert(student);
    }

    @Test
    public void testSelectAll(){
        String config = "applicationContext.xml";
        ApplicationContext ac = new ClassPathXmlApplicationContext(config);
        StudentDao dao = (StudentDao) ac.getBean("studentDao");
        List<Student> students = dao.queryAll();
        for (Student student : students){
            System.out.println(student);
        }
    }
}

增加方法结果

数据库中：

插入方法成功！！！

查询方法结果：

查询成功！！！