MyBatis 和 Spring 两大框架已经成了 Java 互联网技术主流框架组合,它们经受住了大数据量和大批量请求的考验,在互联网系统中得到了广泛的应用。这篇文章主要介绍了MyBatis 与 Spring 整合,需要的朋友可以参考下
MyBatis—Spring 项目
目前大部分的 Java 互联网项目,都是用 Spring MVC + Spring + MyBatis 搭建平台的。
使用 Spring IoC 可以有效的管理各类的 Java 资源,达到即插即拔的功能;通过 Spring AOP 框架,数据库事务可以委托给 Spring 管理,消除很大一部分的事务代码,配合 MyBatis 的高灵活、可配置、可优化 SQL 等特性,完全可以构建高性能的大型网站。
毫无疑问,MyBatis 和 Spring 两大框架已经成了 Java 互联网技术主流框架组合,它们经受住了大数据量和大批量请求的考验,在互联网系统中得到了广泛的应用。使用 MyBatis-Spring 使得业务层和模型层得到了更好的分离,与此同时,在 Spring 环境中使用 MyBatis 也更加简单,节省了不少代码,甚至可以不用 SqlSessionFactory、 SqlSession 等对象,因为 MyBatis-Spring 为我们封装了它们。
摘自:《Java EE 互联网轻量级框架整合开发》
接着新建源文件夹【config】,用于放置各种资源配置文件:
再在【web】文件夹下新建一个【WEB-INF】默认安全文件夹,并在其下创建一个【classes】和【lib】,并将项目的输出位置,改在【classes】下:
工程的完整初始结构如下:
第二步,就是要准备项目的依赖 jar 包:
点击链接下载jar
第三步,编写 Spring 的配置文件:
package com.menghang.test;
<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
http://www.springframework.org/schema/context/spring-context.xsd">
<context:property-placeholder location="classpath:db.properties"/>
<bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource">
<property name="driverClassName" value="${jdbc.driver}"/>
<property name="url" value="${jdbc.url}"/>
<property name="username" value="${jdbc.username}"/>
<property name="password" value="${jdbc.password}"/>
bean>
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
<property name="configLocation" value="mybatis/SqlMapConfig.xml"/>
<property name="dataSource" ref="dataSource"/>
bean>
beans>
头部的信息就是声明 xml 文档配置标签的规则的限制与规范。
“context:property-placeholder” 配置是用于读取工程中的静态属性文件,然后在其他配置中使用时,就可以采用 “${属性名}” 的方式获取该属性文件中的配置参数值。
配置了一个名为 “dataSrouce” 的 bean 的信息,实际上是连接数据库的数据源。
设置 sqlSessionFactory 的 bean 实现类为 MyBatis 与 Spring 整合 jar 包中的 SqlSessionFactoryBean 类,在其中只需要注入两个参数:一个是 MyBatis 的全局配置文件,一个是上面配置的数据源 bean
第四步,在【mybatis】包下编写 MyBatis 的全局配置文件 SqlMapConfig.xml :
<configuration>
<settings>
<setting name="lazyLoadingEnabled" value="true"/>
<setting name="aggressiveLazyLoading" value="false"/>
<setting name="cacheEnabled" value="true"/>
settings>
<typeAliases>
<package name="cn.wmyskxz.pojo"/>
typeAliases>
<mappers>
<mapper resource="sqlmap/UserMapper.xml"/>
<package name="cn.llc.mh.mapper"/>
mappers>
configuration>
在该配置文件中:
第五步,编写 Mapper 映射文件,这里依然定义 Mapper 映射文件的名字为 “UserMapper.xml” (与 SqlMapConfig.xml 中配置一致),为了测试效果,只配置了一个查询类 SQL 映射:
<mapper namespace="test">
<select id="findUserById" parameterType="_int" resultType="user">
SELECT * FROM USER WHERE id = #{id}
select>
mapper>
在该配置中,输出参数的映射为 “user” ,这是因为之前在 SqlMapConfig.xml 中配置了 “cn.wmyskxz.pojo” 包下的实体类使用别名(即首字母小写的类名),所以这里只需在 “cn.wmyskxz.pojo” 包下,创建 “finduserById” 对应的
Java 实体类 User:
package cn.llc.mh.pojo;
import java.io.Serializable;
public class User implements Serializable {
private int id;
private String username;
/* getter and setter */
}
实现 Serializable 接口是为之后使用 Mapper 动态代理做准备,这里没有使用动态代理。
在数据库资源 “db.properties” 中配置了数据库的连接信息,以 “key=value” 的形式配置,String 正是使用 “${}” 获取其中 key 对应的 value 配置的:
jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/自己的数据库?characterEncoding=UTF-8
jdbc.username=root
jdbc.password=root
另外日志配置和之前的配置一样,我就直接黏贴了:
# Global logging configuration
# 在开发环境下日志级别要设置成 DEBUG ,生产环境设为 INFO 或 ERROR
log4j.rootLogger=DEBUG, stdout
# Console output...
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%5p [%t] - %m%n
第六步,进行数据库交互(Data Access Object)层的编写。
由于该项目只对 User 用户查询,所以 DAO 层就只有一个类,在 “cn.wmyskxz” 包下创建 DAO 层的 interface 接口,其中定义了 findUserById 方法,参数为用户的 id 值(int 类型):
package cn.llc.mh.dao;
import cn.wmyskxz.pojo.User;
public interface UserDAO {
// 根据 id 查询用户信息
public User findUserById(int id) throws Exception;
}
然后在同一个包下创建 UserDAO 接口的实现类 UserDAOImpl:
package cn.mh.dao;
import cn.mh.pojo.User;
import org.apache.ibatis.session.SqlSession;
import org.mybatis.spring.support.SqlSessionDaoSupport;
public class UserDAOImpl extends SqlSessionDaoSupport implements UserDAO {
@Override
public User findUserById(int id) throws Exception {
// 继承 SqlSessionDaoSupport 类,通过 this.getSqlSession() 得到 sqlSession
SqlSession sqlSession = this.getSqlSession();
User user = sqlSession.selectOne("test.findUserById", id);
return user;
}
}
有几点解释:
UserDAOImpl 不仅实现了 UserDAO 接口,而且继承了 SqlSessionDaoSupport 类。
SqlSessionDaoSupport 类是 MyBatis 与 Spring 整合的 jar 包中提供的,在该类中已经包含了 sqlSessionFactory 对象作为其成员变量,而且对外提供 get 和 set 方法,方便 Spring 从外部注入 sqlSessionFactory 对象。
UserDAOImpl 类要成功获取 sqlSessionFactory 对象,还需要在 Spring 配置文件 applicationContext.xml 中添加 userDAO 的 bean 配置,将其中定义的 sqlSessionFactory 对象当做参数注入进去,这样 UserDAOImpl 继承 SqlSessionDaoSupport 类才会起到作用:
<bean id="userDAO" class="cn.llc.mh.dao.UserDAOImpl">
<property name="sqlSessionFactory" ref="sqlSessionFactory"/>
bean>
注意: DAO 实现类继承了 SqlSessionDaoSupport 父类后,就无须自己定义获取 SqlSession 会话实例类方法了,该父类会默认加载数据源信息并提供获取 SqlSession 类的方法。
第七步:编写 Service 测试类
在 “cn.llc.mh.test” 包下创建【UserServiceTest】测试类:
package cn.llc.mh.test;
import cn.llc.mh.dao.UserDAO;
import cn.llc.mh.pojo.User;
import org.junit.Before;
import org.junit.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
public class UserServiceTest {
private ApplicationContext applicationContext;
// 在执行测试方法之前首先获取 Spring 配置文件对象
// 注解@Before在执行本类所有测试方法之前先调用这个方法
@Before
public void setup() throws Exception {
applicationContext = new
ClassPathXmlApplicationContext("classpath:spring/applicationContext.xml");
}
@Test
public void testFindUserById() throws Exception {
// 通过配置资源对象获取 userDAO 对象
UserDAO userDAO = (UserDAO) applicationContext.getBean("userDAO");
// 调用 UserDAO 的方法
User user = userDAO.findUserById(1);
// 输出用户信息
System.out.println(user.getId() + ":" + user.getUsername());
}
}
动态代理 + 注解实现
上面的实例程序并没有使用 Mapper 动态代理和注解来完成,下面我们就来试试如何用动态代理和注解:
在【mapper】下新建一个【UserQueryMapper】代理接口,并使用注解:
package cn.llc.mh.mapper;
import cn.llc.mh.pojo.User;
import org.apache.ibatis.annotations.Select;
public interface UserQueryMapper {
@Select("SELECT * FROM USER WHERE id = #{id}")
public User findUserById(int id) throws Exception;
}
注意: 在默认情况下,该 bean 的名字为 userQueryMapper(即首字母小写)
现在有了代理类,我们需要通知 Spring 在这里来扫描到该类,Mapper 扫描配置对象需要用专门的扫描器:
<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
<property name="basePackage" value="cn.wmyskxz.mapper"/>
bean>
这一次我们获取的不再是 userDAO 对象,而是定义的 Mapper 代理对象 userQueryMapper:
package cn.wmyskxz.test;
import cn.wmyskxz.mapper.UserQueryMapper;
import cn.wmyskxz.pojo.User;
import org.junit.Before;
import org.junit.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
public class UserServiceTest {
private ApplicationContext applicationContext;
// 在执行测试方法之前首先获取 Spring 配置文件对象
// 注解@Before在执行本类所有测试方法之前先调用这个方法
@Before
public void setup() throws Exception {
applicationContext = new
ClassPathXmlApplicationContext("classpath:spring/applicationContext.xml");
}
@Test
public void testFindUserById() throws Exception {
// 通过配置资源对象获取 userDAO 对象
UserQueryMapper userQueryMapper = (UserQueryMapper) applicationContext.getBean("userQueryMapper");
// 调用 UserDAO 的方法
User user = userQueryMapper.findUserById(1);
// 输出用户信息
System.out.println(user.getId() + ":" + user.getUsername());
}
}
可以看到,查询结果和之前非 Mapper 代理的查询结果一样。
以上所述是小刘给大家介绍的MyBatis 与 Spring 的完美整合方法 ! 如果有帮到你 点个关注呗!
不需要向别人解释你自己,因为喜欢你的人不需要,不喜欢你的人不会相信。何必向别人证明什么,活得更好是为了自己,若无其事,原来是最好的状态 加油 ! 你是最棒的