spring与mybatis集成

转载

mb5ff9827b65e5b 2021-10-08 13:54:00

文章标签 spring sql xml 配置文件数据源 文章分类 代码人生

Spring 集成 MyBatis

将 MyBatis与 Spring 进行整合，主要解决的问题就是将 SqlSessionFactory 对象交由 Spring来管理。所以，该整合，只需要将 SqlSessionFactory 的对象生成器 SqlSessionFactoryBean 注册在 Spring 容器中，再将其注入给 Dao 的实现类即可完成整合。

实现 Spring 与 MyBatis 的整合常用的方式：扫描的 Mapper 动态代理 Spring 像插线板一样，mybatis 框架是插头，可以容易的组合到一起。插线板 spring 插上 mybatis，两个框架就是一个整体。

1.1 MySQL 创建数据库 springdb, 新建表 Student

spring与mybatis集成_xml

1.2 maven 依赖 pom.xml

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

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

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

插件：

<resources>
<resource>
<directory>src/main/java</directory><!--所在的目录-->
<includes><!--包括目录下的.properties,.xml 文件都会扫描到-->
<include>**/*.properties</include>
<include>**/*.xml</include>
</includes>
<filtering>false</filtering>
</resource>
</resources>

1.3 定义实体类 Student

package com.g0rez.entity;

public class Student {
private Integer id;
private String name;
private String email;
private Integer age;

public Student(Integer id, String name, String email, Integer age) {
this.id = id;
this.name = name;
this.email = email;
this.age = age;
    }

public Student() {
    }

@Override
public String toString() {
return "Student{" +
"id=" + id +
", name='" + name + '\'' +
", email='" + email + '\'' +
", 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;
    }
}

1.4 定义 StudentDao 接口

package com.g0rez.dao;

import com.g0rez.entity.Student;

import java.util.List;

public interface StudentDao {
int insertStudent(Student student);
List<Student> selectStudents();
}

1.5 定义映射文件 mapper

在 Dao 接口的包中创建 MyBatis 的映射文件 mapper，命名与接口名相同，本例为

StudentDao.xml。mapper 中的 namespace 取值也为 Dao 接口的全限定性名。

<?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.g0rez.dao.StudentDao">
<insert id="insertStudent">
        insert into student values (#{id},#{name},#{email},#{age})
</insert>
<select id="selectStudents" resultType="com.g0rez.entity.Student">
        select id,name,email,age from student order by id desc
</select>
</mapper>

1.6 定义 Service 接口和实现类

接口定义：

package com.g0rez.service;

import com.g0rez.entity.Student;

import java.util.List;

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

实现类定义：

package com.g0rez.service.impl;

import com.g0rez.dao.StudentDao;
import com.g0rez.entity.Student;
import com.g0rez.service.StudentService;

import java.util.List;

public class StudentServiceImpl implements StudentService {
private StudentDao studentDao;
//使用set注入
public void setStudentDao(StudentDao studentDao) {
this.studentDao = studentDao;
    }

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

@Override
public List<Student> queryStudents() {
List<Student> students = studentDao.selectStudents();
return students;
    }
}

1.7 定义 MyBatis 主配置文件

在 src 下定义 MyBatis 的主配置文件，命名为 mybatis.xml。

这里有两点需要注意：

（1）主配置文件中不再需要数据源的配置了。因为数据源要交给 Spring 容器来管理了。

（2）这里对 mapper 映射文件的注册，使用标签，即只需给出 mapper 映射文件

所在的包即可。因为 mapper 的名称与 Dao 接口名相同，可以使用这种简单注册方式。这种

方式的好处是，若有多个映射文件，这里的配置也是不用改变的。当然，也可使用原来的

标签方式。

<?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="com.g0rez.entity" />
</typeAliases>
<mappers>
<package name="com.g0rez.dao"/>
</mappers>
</configuration>

1.8 修改 Spring 配置文件

1.8.1. 数据源的配置( 掌握)

使用 JDBC 模板，首先需要配置好数据源，数据源直接以 Bean 的形式配置在 Spring 配

置文件中。根据数据源的不同，其配置方式不同：

Druid 数据源 DruidDataSource

Druid 是阿里的开源数据库连接池。是 Java 语言中最好的数据库连接池。Druid 能

够提供强大的监控和扩展功能。Druid 与其他数据库连接池的最大区别是提供数据库的

配置连接池：

<!--    声明数据源DataSource 作用是连接数据库的-->
<bean id="myDataSource" class="com.alibaba.druid.pool.DruidDataSource" init-method="init"
destroy-method="close">
<!--setter注入给DruidDataSource数据源连接数据库的信息-->
<property name="url" value="${jdbc.url}" /><!--setUrl（）-->
<property name="name" value="${jdbc.username}" />
<property name="password" value="${jdbc.password}" />
<property name="maxActive" value="${jdbc.maxActive}" />
</bean>

Spring 配置文件：

1.8.2. 从属性文件读取数据库连接信息

为了便于维护，可以将数据库连接信息写入到属性文件中，使 Spring 配置文件从中读取数据。属性文件名称自定义，但一般都是放在 src 下。

Spring 配置文件从属性文件中读取数据时，需要在的 value 属性中使用${ }，

将在属性文件中定义的 key 括起来，以引用指定属性的值。该属性文件若要被 Spring 配置文件读取，其必须在配置文件中进行注册。使用标签。

context:property-placeholder/ 方式( 掌握)

该方式要求在 Spring 配置文件头部加入 spring-context.xsd 约束文件

context:property-placeholder/标签中有一个属性 location，用于指定属性文件的位置。

<context:property-placeholder location="jdbc.properties" />

1.8.3. 注册 SqlSessionFactoryBean

    <!--声明的是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>

1.8.4. 定义 Mapper 扫描配置器 MapperScannerConfigurer

Mapper 扫描配置器 MapperScannerConfigurer 会自动生成指定的基本包中 mapper 的代

理对象。该 Bean 无需设置 id 属性。basePackage 使用分号或逗号设置多个包。

    <!--创建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.g0rez.dao" />
</bean>

1.9 向 Service 注入接口名

向 Service 注入 Mapper 代理对象时需要注意，由于通过 Mapper 扫描配置器

MapperScannerConfigurer 生成的 Mapper 代理对象没有名称，所以在向 Service 注入 Mapper

代理时，无法通过名称注入。但可通过接口的简单类名注入，因为生成的是这个 Dao 接口

的对象。

    <bean id="studentService" class="com.g0rez.service.impl.StudentServiceImpl">
<property name="studentDao" ref="studentDao" />

</bean>

1.10 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">
<context:property-placeholder location="jdbc.properties" />
<!--    声明数据源DataSource 作用是连接数据库的-->
<bean id="myDataSource" class="com.alibaba.druid.pool.DruidDataSource" init-method="init"
destroy-method="close">
<!--setter注入给DruidDataSource数据源连接数据库的信息-->
<property name="url" value="${jdbc.url}" /><!--setUrl（）-->
<property name="name" value="${jdbc.username}" />
<property name="password" value="${jdbc.password}" />
<property name="maxActive" value="${jdbc.maxActive}" />
</bean>
<!--声明的是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的容器中的。
-->
<property name="basePackage" value="com.g0rez.dao" />
</bean>
<bean id="studentService" class="com.g0rez.service.impl.StudentServiceImpl">
<property name="studentDao" ref="studentDao" />

</bean>
</beans>