Spring与Mybatis整合例子(基于MapperScannerConfigurer的整合)
前言
最近在尝试 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 写错了,注意要匹配哦。