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 互联网轻量级框架整合开发》
第一步:创建测试工程
第一步,首先在 idea 中新建一个名为【mybatisandspring】的 webproject 工程:
然后在【src】中创建 4 个空包:
- cn.wmyskxz.dao(放置 dao 数据交互层处理类)
- cn.wmyskxz.mapper(放置 mapper 代理接口)
- cn.wmyskxz.pojo(放置 java 实体类)
- cn.wmyskxz.test(放置测试类)
接着新建源文件夹【config】,用于放置各种资源配置文件:
- 在【config / mybatis】下创建一个空的名为 “sqlmapconfig.xml” 的 mybatis 全局配置文件在【config / spring】下创建一个空的名为 “applicationcontext.xml” 的 spring 资源配置文件
- 在【config / sqlmap】下创建一个空的名为 “usermapper.xml” 的 mapper 映射文件。
- 在【config】下创建两个 properties 属性文件,分别为 “db.properties” 和 “log4j.properties”,用于数据库连接和日志系统参数设置。
再在【web】文件夹下新建一个【web-inf】默认安全文件夹,并在其下创建一个【classes】和【lib】,并将项目的输出位置,改在【classes】下:
工程的完整初始结构如下:
第二步:引入依赖 jar 包
第二步,就是要准备项目的依赖 jar 包:
- mybatis 的包(mybatis 3.4.6)
- spring 的 jar 包(spring 4.3.15)
- mybatis 与 spring 的整合 jar 包()
- mysql-connector-java-5.1.21.
- jarjunit-4.12.jar
在【web-inf】文件夹下的【lib】文件夹中放置上面列举的 jar 包,然后添加依赖。
第三步:编写 spring 配置文件
第三步,编写 spring 的配置文件:
- 加载数据库连接文件 “db.properties” 中的数据,建立数据源
- 配置 sqlsessionfactory 会话工厂对象
<?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 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> <!-- sqlsessionfactory --> <bean id="sqlsessionfactory" class="org.mybatis.spring.sqlsessionfactorybean"> <!-- 加载 mybatis 的配置文件 --> <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】包下编写 mybatis 的全局配置文件 sqlmapconfig.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> <!-- settings --> <settings> <!-- 打开延迟加载的开关 --> <setting name="lazyloadingenabled" value="true"/> <!-- 将积极加载改为消极加载(即按需加载) --> <setting name="aggressivelazyloading" value="false"/> <!-- 打开全局缓存开关(二级缓存)默认值就是 true --> <setting name="cacheenabled" value="true"/> </settings> <!-- 别名定义 --> <typealiases> <package name="cn.wmyskxz.pojo"/> </typealiases> <!-- 加载映射文件 --> <mappers> <!-- 通过 resource 方法一次加载一个映射文件 --> <mapper resource="sqlmap/usermapper.xml"/> <!-- 批量加载mapper --> <package name="cn.wmyskxz.mapper"/> </mappers> </configuration>
在该配置文件中:
- 通过 settings 配置了一些延迟加载和缓存的开关信息在 typealiases 中设置了一个 package 的别名扫描路径,
- 在该路径下的 java 实体类都可以拥有一个别名(即首字母小写的类名)
- 在 mappers 配置中,使用 mapper 标签配置了即将要加载的 mapper 映射文件的资源路径,当然也可以使用 package 标签,配置 mapper 代理接口所在的包名,以批量加载 mapper 代理对象。
- 注意: 有了 spring 托管数据源,在 mybatis 配置文件中仅仅需要关注性能化配置。
第五步:编写 mapper 以及其他配置文件
第五步,编写 mapper 映射文件,这里依然定义 mapper 映射文件的名字为 “usermapper.xml” (与 sqlmapconfig.xml 中配置一致),为了测试效果,只配置了一个查询类 sql 映射:
<?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="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.wmyskxz.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/mybatis?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
第六步:编写 dao 层
第六步,进行数据库交互(data access object)层的编写。
由于该项目只对 user 用户查询,所以 dao 层就只有一个类,在 “cn.wmyskxz” 包下创建 dao 层的 interface 接口,其中定义了 finduserbyid 方法,参数为用户的 id 值(int 类型):
package cn.wmyskxz.dao; import cn.wmyskxz.pojo.user; public interface userdao { // 根据 id 查询用户信息 public user finduserbyid(int id) throws exception; }
然后在同一个包下创建 userdao 接口的实现类 userdaoimpl:
package cn.wmyskxz.dao; import cn.wmyskxz.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 类才会起到作用:
<!-- 原始 dao 接口 --> <bean id="userdao" class="cn.wmyskxz.dao.userdaoimpl"> <property name="sqlsessionfactory" ref="sqlsessionfactory"/> </bean>
注意: dao 实现类继承了 sqlsessiondaosupport 父类后,就无须自己定义获取 sqlsession 会话实例类方法了,该父类会默认加载数据源信息并提供获取 sqlsession 类的方法。
第七步:编写 service 测试类
在 “cn.wmyskxz.test” 包下创建【userservicetest】测试类:
package cn.wmyskxz.test; import cn.wmyskxz.dao.userdao; 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 对象 userdao userdao = (userdao) applicationcontext.getbean("userdao"); // 调用 userdao 的方法 user user = userdao.finduserbyid(1); // 输出用户信息 system.out.println(user.getid() + ":" + user.getusername()); } }
运行测试方法,输出结果如下:
动态代理 + 注解实现
上面的实例程序并没有使用 mapper 动态代理和注解来完成,下面我们就来试试如何用动态代理和注解:
第一步:编写 userquerymapper
在【mapper】下新建一个【userquerymapper】代理接口,并使用注解:
package cn.wmyskxz.mapper; import cn.wmyskxz.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 扫描配置对象需要用专门的扫描器:
<!-- mapper 扫描器 --> <bean class="org.mybatis.spring.mapper.mapperscannerconfigurer"> <!-- 扫描 cn.wmyskxz.mapper 包下的组件 --> <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 的完美整合方法,希望对大家有所帮助