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 包(mybatis-spring 1.3.2)

mysql-connector-java-5.1.21.jar

junit-4.12.jar

在【WEB-INF】文件夹下的【lib】文件夹中放置上面列举的 jar 包,然后添加依赖。

第三步:编写 Spring 配置文件

第三步,编写 Spring 的配置文件:

加载数据库连接文件 “db.properties” 中的数据,建立数据源

配置 sqlSessionFactory 会话工厂对象

头部的信息就是声明 xml 文档配置标签的规则的限制与规范。

“context:property-placeholder”配置是用于读取工程中的静态属性文件,然后在其他配置中使用时,就可以采用 “$” 的方式获取该属性文件中的配置参数值。

配置了一个名为“dataSrouce”的 bean 的信息,实际上是连接数据库的数据源。

设置sqlSessionFactory的 bean 实现类为 MyBatis 与 Spring 整合 jar 包中的SqlSessionFactoryBean类,在其中只需要注入两个参数:一个是 MyBatis 的全局配置文件,一个是上面配置的数据源 bean

第四步:编写 MyBatis 配置文件

第四步,在【mybatis】包下编写 MyBatis 的全局配置文件 SqlMapConfig.xml :

在该配置文件中:

通过settings 配置了一些延迟加载和缓存的开关信息

typeAliases 中设置了一个 package 的别名扫描路径,在该路径下的 Java 实体类都可以拥有一个别名(即首字母小写的类名)

在 mappers 配置中,使用 mapper 标签配置了即将要加载的 Mapper 映射文件的资源路径,当然也可以使用 package 标签,配置 mapper 代理接口所在的包名,以批量加载 mapper 代理对象。

注意:有了 Spring 托管数据源,在 MyBatis 配置文件中仅仅需要关注性能化配置。

第五步:编写 Mapper 以及其他配置文件

第五步,编写 Mapper 映射文件,这里依然定义 Mapper 映射文件的名字为 “UserMapper.xml” (与 SqlMapConfig.xml 中配置一致),为了测试效果,只配置了一个查询类 SQL 映射:

实现 Serializable 接口是为之后使用 Mapper 动态代理做准备,这里没有使用动态代理。

在数据库资源 “db.properties” 中配置了数据库的连接信息,以 “key=value” 的形式配置,String 正是使用 “${}” 获取其中 key 对应的 value 配置的:

另外日志配置和之前的配置一样,我就直接黏贴了:

第六步:编写 DAO 层

第六步,进行数据库交互(Data Access Object)层的编写。

由于该项目只对 User 用户查询,所以 DAO 层就只有一个类,在 “cn.wmyskxz” 包下创建 DAO 层的 interface 接口,其中定义了 findUserById 方法,参数为用户的 id 值(int 类型):

然后在同一个包下创建 UserDAO 接口的实现类 UserDAOImpl:

有几点解释:

UserDAOImpl 不仅实现了 UserDAO 接口,而且继承了 SqlSessionDaoSupport 类。

SqlSessionDaoSupport 类是 MyBatis 与 Spring 整合的 jar 包中提供的,在该类中已经包含了 sqlSessionFactory 对象作为其成员变量,而且对外提供 get 和 set 方法,方便 Spring 从外部注入 sqlSessionFactory 对象。

UserDAOImpl 类要成功获取 sqlSessionFactory 对象,还需要在 Spring 配置文件 applicationContext.xml 中添加 userDAO 的 bean 配置,将其中定义的 sqlSessionFactory 对象当做参数注入进去,这样 UserDAOImpl 继承 SqlSessionDaoSupport 类才会起到作用:

注意:DAO 实现类继承了 SqlSessionDaoSupport 父类后,就无须自己定义获取 SqlSession 会话实例类方法了,该父类会默认加载数据源信息并提供获取 SqlSession 类的方法。

第七步:编写 Service 测试类

运行测试方法,输出结果如下:

动态代理 + 注解实现

上面的实例程序并没有使用 Mapper 动态代理和注解来完成,下面我们就来试试如何用动态代理和注解:

第一步:编写 UserQueryMapper

在【mapper】下新建一个【UserQueryMapper】代理接口,并使用注解:

注意:在默认情况下,该 bean 的名字为 userQueryMapper(即首字母小写)

现在有了代理类,我们需要通知 Spring 在这里来扫描到该类,Mapper 扫描配置对象需要用专门的扫描器:

第二步:编写测试类

这一次我们获取的不再是 userDAO 对象,而是定义的 Mapper 代理对象 userQueryMapper:

运行测试方法,得到正确结果:

可以看到,查询结果和之前非 Mapper 代理的查询结果一样。

原理:在 applicationContext.xml 配置文件中配置的mapper 批量扫描器类,会从 mapper 包中扫描出 Mapper 接口,自动创建代理对象并且在 Spring 容器中注入。自动扫描出来的 Mapper 的 bean 的 id 为 mapper 类名(首字母小写),所以这里获取的就是名为 “userQueryMapper” 的 mapper 代理对象。

参考资料:

《Java EE 互联网轻量级框架整合开发》

《Spring MVC + MyBatis开发从入门到项目实战》

全能的百度和万能的大脑

  • 发表于:
  • 原文链接https://kuaibao.qq.com/s/20180612G0OJL300?refer=cp_1026
  • 腾讯「云+社区」是腾讯内容开放平台帐号(企鹅号)传播渠道之一,根据《腾讯内容开放平台服务协议》转载发布内容。
  • 如有侵权,请联系 yunjia_community@tencent.com 删除。

扫码关注云+社区

领取腾讯云代金券