將 MyBatis與 Spring 進行整合,主要解決的問題就是將 SqlSessionFactory 對象交由 Spring來管理。所以,該整合,只需要將 SqlSessionFactory 的對象生成器 SqlSessionFactoryBean 注冊在 Spring 容器中,再將其注入給 Dao 的實現類即可完成整合
實現 Spring 與 MyBatis 的整合常用的方式:掃描的 Mapper 動態代理
一、建立數據庫及新表
二、maven依賴pom.xml
- spring依賴
- mybatis依賴
- mysql驅動
- spring的事務依賴
- mybatis和spring集成的依賴
完整的pom.xml文件
<?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>
三、創建實體類
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 +
'}';
}
}
四、創建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();
}
五、定義映射文件mapper
和dao在同一目錄下,名字和dao接口的一樣,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.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>
六、創建mybatis主配置文件
在 src /main/resources下定義 MyBatis 的主配置文件,命名為 mybatis.xml
注意:
- 主配置文件中不再需要數據源的配置了。因為數據源要交給 Spring 容器來管理了
- 這里對 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>
七、創建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;
}
}
八、創建spring的配置文件
在 src /main/resources下定義 Spring的主配置文件,命名為 applicationContext.xml
聲明mybatis的對象交給spring創建
1. 數據源DateSource
使用 JDBC 模板,首先需要配置好數據源,數據源直接以 Bean 的形式配置在 Spring 配置文件中。根據數據源的不同,其配置方式不同:
這里使用的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>
九、創建測試類
@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));
}
整體目錄結構
十、總結
- 新建maven項目
- 加入maven依賴
- spring依賴
- mybatis依賴
- mysql驅動
- spring的事務依賴
- mybatis和spring集成的依賴
- 德魯伊,數據庫連接池的依賴
- 創建實體類
- 創建dao接口和mapper文件
- 創建mybatis主配置文件
- 創建Service接口和實現類,屬性是dao
- 創建spring的配置文件:聲明mybatis的對象交給spring創建
- 數據源DateSource
- SqlSessionFactory
- Dao對象
- 聲明自定義的service
- 創建測試類,獲取Service對象,通過service調用dao完成數據庫的訪問