前言
最近在嘗試 Spring 與 Mybatis 的整合,所參考的是 黑馬程序員 編著的ssm框架教材,書中提及一共有三種整合方式,這裏就不一一列舉了,只列舉最簡單,也最常用的方式,那就是基於 MapperScannerConfigurer 的整合。
使用工具 :IDEA
JDK版本 :1.8
例子 :通過id查找用戶的信息
創建spring項目並添加maven依賴
首先,創建一個IDEA 項目,添加spring框架(項目創建過程不再敘述,大家自行百度),再添加maven依賴
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>groupId</groupId>
<artifactId>my</artifactId>
<version>1.0-SNAPSHOT</version>
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.3</version>
<scope>test</scope>
</dependency>
<!--配置mybatis需要的依賴包-->
<dependency>
<groupId>asm</groupId>
<artifactId>asm</artifactId>
<version>3.3.1</version>
</dependency>
<dependency>
<groupId>cglib</groupId>
<artifactId>cglib</artifactId>
<version>2.2.2</version>
</dependency>
<dependency>
<groupId>commons-logging</groupId>
<artifactId>commons-logging</artifactId>
<version>1.1.1</version>
</dependency>
<dependency>
<groupId>org.javassist</groupId>
<artifactId>javassist</artifactId>
<version>3.17.1-GA</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.6</version>
</dependency>
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.7</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>1.7.5</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-log4j12</artifactId>
<version>1.7.5</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.3.0</version>
</dependency>
<!--dbcp和連接池的jar包-->
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-dbcp2</artifactId>
<version>2.1.1</version>
</dependency>
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-pool2</artifactId>
<version>2.2</version>
</dependency>
<!--兩個框架的中間件-->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis-spring</artifactId>
<version>1.3.1</version>
</dependency>
</dependencies>
<build>
<resources>
<resource>
<directory>src/main/java</directory>
<includes>
<include>**/*.xml</include>
</includes>
</resource>
</resources>
</build>
</project>
配置xml文件
在 resources 文件中創建 db.properties、Spring的配置文件、Mybatis配置文件以及日誌文件
db.properties
#MySQL
jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/mybatis?useUnicode=true&characterEncoding=UTF-8&allowMultiQueries=true
jdbc.username=root
jdbc.password=123456
jdbc.maxTotal=30
jdbc.maxIdle=10
jdbc.initialSize=5
Spring配置文件 spring-config.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"
xmlns:tx="http://www.springframework.org/schema/tx"
xsi:schemaLocation="
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context.xsd
http://www.springframework.org/schema/tx
http://www.springframework.org/schema/tx/spring-tx.xsd">
<!--讀取db.properties-->
<context:property-placeholder location="classpath:db.properties"/>
<!--配置數據源-->
<bean id="dataSource"
class="org.apache.commons.dbcp2.BasicDataSource">
<!--數據庫驅動-->
<property name="driverClassName" value="${jdbc.driver}"/>
<property name="url" value="${jdbc.url}" />
<property name="username" value="${jdbc.username}" />
<property name="password" value="${jdbc.password}" />
<!-- 初始化連接大小 -->
<property name="initialSize" value="${jdbc.initialSize}"/>
<!-- 連接池最大數量 -->
<property name="maxTotal" value="${jdbc.maxTotal}"/>
<!-- 連接池最大空閒 -->
<property name="maxIdle" value="${jdbc.maxIdle}"/>
<!-- 驗證時使用的SQL語句 -->
<property name="validationQuery" value="SELECT 1" />
<!-- 借出連接時不要測試,否則很影響性能 -->
<property name="testOnBorrow" value="false"/>
</bean>
<!--事務管理器,依賴於數據源-->
<bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
<property name="dataSource" ref="dataSource" />
</bean>
<!--開啓事務註解-->
<tx:annotation-driven transaction-manager="transactionManager"/>
<!--配置Mybatis 工廠-->
<bean id="sqlSessionFactory"
class="org.mybatis.spring.SqlSessionFactoryBean">
<!--注入數據源-->
<property name="dataSource" ref="dataSource"/>
<!--指定核心配置文件位置-->
<property name="configLocation" value="classpath:mybatis-config.xml"/>
</bean>
<!--實例化Dao-->
<!--<bean id="customerDao" class="com.dao.impl.CustomerDaoImpl">-->
<!--注入sqlsessionfactory 對象實例-->
<!--<property name="sqlSessionFactory" ref="sqlSessionFactory"/>-->
<!--</bean>-->
<!--Mapper 代理開發(基於MapperScannerConfigurer)-->
<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
<property name="basePackage" value="com.dao.mapper"/>
</bean>
</beans>
Mybatis配置文件 mybatis-config.xml
<?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>
<!--配置別名-->
<typeAliases>
<package name="com.dao"/>
</typeAliases>
</configuration>
Spring-config.xml配置解釋
在學習mybatis的時候,連接池的配置是寫在mybatis的配置文件中的,但是這裏以讀取properties 文件的方式,配置在 spring-config.xml 文件中,也就是配置數據源,然後配置了Mybatis工廠,並且把數據源注入到Mybatis工廠中。其中,配置工廠時候有兩個參數,一個是數據源,一個爲mybatis配置文件的路徑,這樣子Spring的Ioc容器就會在初始化id爲sqlSessionFactory的bean時解析MyBatis的配置文件,並與數據源一同保存到Spring 的bean中。
簡單的說 :就是爲了整合兩個框架,把連接池的配置寫在了spring文件中,並且配置了一個mybatis的鏈接工具,以後要用的時候,就把你這個工具配置到你要鏈接數據庫的bean裏,就可以實現數據庫的鏈接啦。
日誌文件 log4j.properties
### 設置Logger輸出級別和輸出目的地 ###
log4j.rootLogger=debug,stdout,logfile
### 把日誌信息輸出到控制檯 ###
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
#log4j.appender.stdout.Target=System.err
log4j.appender.stdout.layout=org.apache.log4j.SimpleLayout
### 把日誌信息輸出到文件:jbit.log ###
log4j.appender.logfile=org.apache.log4j.FileAppender
log4j.appender.logfile.File=jbit.log
log4j.appender.logfile.layout=org.apache.log4j.PatternLayout
log4j.appender.logfile.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %F %p %m%n
###顯示SQL語句部分
log4j.logger.com.ibatis=DEBUG
log4j.logger.com.ibatis.common.jdbc.SimpleDataSource=DEBUG
log4j.logger.com.ibatis.common.jdbc.ScriptRunner=DEBUG
log4j.logger.com.ibatis.sqlmap.engine.impl.SqlMapClientDelegate=DEBUG
log4j.logger.java.sql.Connection=DEBUG
log4j.logger.java.sql.Statement=DEBUG
log4j.logger.java.sql.PreparedStatement=DEBUG
如圖所示:
實體類編寫
以你的數據庫爲例,編寫屬於你的實體類,這裏實體類名爲Customer
package com.po;
/**
* 客戶持久化類
* time:2019年4月8日14:07:19
*/
public class Customer {
private Integer id;
private String username;
private String jobs;
private String phone;
public Integer getId() {
return id;
}
public void setId(Integer id) {
this.id = id;
}
public String getUsername() {
return username;
}
@Override
public String toString() {
return "Customer{" +
"id=" + id +
", username='" + username + '\'' +
", jobs='" + jobs + '\'' +
", phone='" + phone + '\'' +
'}';
}
public void setUsername(String username) {
this.username = username;
}
public String getJobs() {
return jobs;
}
public void setJobs(String jobs) {
this.jobs = jobs;
}
public String getPhone() {
return phone;
}
public void setPhone(String phone) {
this.phone = phone;
}
}
接口以及mapper.xml編寫
接口類:CustomerMapper
package com.dao.mapper;
import com.po.Customer;
public interface CustomerMapper {
//通過id查找用戶
public Customer findCustomerById(Integer id);
}
注意:接口名稱要和mapper.xml名稱相同,並且在同一個文件下
映射文件:CustomerMapper.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.dao.mapper.CustomerMapper">
<!--根據id查詢用戶信息-->
<select id="findCustomerById" parameterType="Integer"
resultType="com.po.Customer">
select * from t_customer where id= #{id}
</select>
</mapper>
測試類
import com.dao.mapper.CustomerMapper;
import com.po.Customer;
import org.junit.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
/**
* Dao測試類
* TIME:2019年4月8日14:33:18
*/
public class DaoTest {
@Test
public void findCustomerByIdDaoTest(){
ApplicationContext applicationContext=new ClassPathXmlApplicationContext("spring-config.xml");
CustomerMapper customerMapper= (CustomerMapper) applicationContext.getBean("customerMapper");
Customer customer=customerMapper.findCustomerById(2);
System.out.println(customer.toString());
}
}
文件目錄結構
說明
以上,例子就寫完了。
我們在學習spring框架的時候知道,爲了實現控制反轉,需要在spring的配置文件中配置我們需要控制反轉的類的bean,所以以原始的方式整合兩大框架的話,開發者不僅需要寫dao層接口,還要在spring配置文件中配置bean,這樣會讓spring配置文件變得臃腫,而且這樣子還會加大開發者的工作量。
所以,本例子是基於MapperScannerConfigurer的整合,只需要在spring的配置文件中寫上
<!--Mapper 代理開發(基於MapperScannerConfigurer)-->
<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
<property name="basePackage" value="com.dao.mapper"/>
</bean>
那麼,項目會自動幫我們掃描配置的包名下的接口來生成映射器,並且完成映射,也就是自己組裝bean,這樣可以很大提高開發效率。
那麼,你學會了嗎。
小插曲
編寫過程中,報過這樣一個錯誤:
org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'customerMapper' defined in file [D:\software\Paper_Workspace\my\target\classes\com\dao\mapper\CustomerMapper.class]: Invocation of init method failed; nested exception is java.lang.IllegalArgumentException: org.apache.ibatis.builder.BuilderException: Error parsing Mapper XML. Cause: org.apache.ibatis.builder.BuilderException: Wrong namespace. Expected 'com.dao.mapper.CustomerMapper' but found 'com.po.CustomerMapper'.
原因是:mapper.xml文件下的 namespace 寫錯了,注意要匹配哦。