一、常规整合
依赖
再spring的基础上导入
-
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
1.编写 Spring 配置文件
-
加载数据库连接文件 “db.properties” 中的数据,建立数据源或直接在spring中固定写死
-
配置 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
2.编写Mybatis-config
<?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.cvs.pojo"/>
</typeAliases>
<!-- 加载映射文件 -->
<mappers>
<!-- 通过 resource 方法一次加载一个映射文件 -->
<mapper resource="sqlmap/UserMapper.xml"/>
<!-- 包扫描批量加载mapper -->
<package name="cn.cvs.mapper"/>
</mappers>
</configuration>
-
通过 settings 配置了一些延迟加载和缓存的开关信息
-
在 typeAliases 中设置了一个 package 的别名扫描路径,在该路径下的 Java 实体类都可以拥有一个别名(即首字母小写的类名)
-
在 mappers 配置中,使用 mapper 标签配置了即将要加载的 Mapper 映射文件的资源路径,当然也可以使用 package 标签,配置 mapper 代理接口所在的包名,以批量加载 mapper 代理对象。
-
注意: 有了 Spring 托管数据源,在 MyBatis 配置文件中仅仅需要关注性能化配置。
3.编写 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>
创建 “finduserById” 对应的 Java 实体类 User:
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
日志配置log4j.properties:
# 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
4.编写 Dao 层
Dao接口:
public interface UserDAO {
// 根据 id 查询用户信息
public User findUserById(int id) throws Exception;
}
Dao实现:
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 类的方法。
5.编写 Service 测试类
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());
}
}
二、常规整合2
依赖
<dependencies>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>5.2.2.RELEASE</version>
</dependency>
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</dependency>
<dependency>
<groupId>aopalliance</groupId>
<artifactId>aopalliance</artifactId>
<version>1.0</version>
</dependency>
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjweaver</artifactId>
<version>1.8.9</version>
</dependency>
<dependency>
<groupId>commons-dbcp</groupId>
<artifactId>commons-dbcp</artifactId>
<version>1.4</version>
</dependency>
<dependency>
<groupId>commons-pool</groupId>
<artifactId>commons-pool</artifactId>
<version>1.6</version>
</dependency>
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis-spring</artifactId>
<version>2.0.3</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-jdbc</artifactId>
<version>5.2.2.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-tx</artifactId>
<version>5.2.2.RELEASE</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.44</version>
</dependency>
</dependencies>
1.创建实体类
-
SysUser实体类
public class SysUser {
private Integer id;
private String account;
private String realName;
private String password;
private Integer sex;
private Date birthday;
private String phone;
private String address;
private Integer roleId;
private Integer createdUserId;
private Date createdTime;
private Integer updatedUserId;
private Date updatedTime;
private Integer age;
private String roleName;
/* 省略getter setter 封装方法 */
}
2.编写 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="cn.cvs.pojo"/>
</typeAliases>
</configuration>
3.编写业务流程
-
Dao 接口
public interface SysUserMapper {
/* 查询用户列表 */
List<SysUser> selectSysUserList(SysUser sysUser);
}
-
Dao 实现类
实现类代码:
public class SysUserMapperImpl implements SysUserMapper {
private SqlSessionTemplate sqlSession;
/* 查询用户列表 */
public List<SysUser> selectSysUserList(SysUser sysUser) {
return sqlsession.selectList("cn.cvs.dao.sysUser.SysUserMapper.selectSysUserList",sysUser);
}
public SqlSessionTemplate getSqlSession(){
return sqlSession;
}
public void setSqlSession(SqlSessionTemplate sqlSession) {
this.sqlSession = sqlSession;
}
}
注:这里采用了直接注入SqlSessionTemplate,如果要使用继承SqlSessionDaoSupport则需要在Spring容器先配置SqlSessionTemplate再将SysUserMapperImpl实现类中的SqlSessionTemplate属性值赋为创建好的SqlSessionTemplate对象具体如下:
<!-- 配置 SqlSessionFactoryBean -->
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
<!-- 引用数据源组件 -->
<property name="dataSource" ref="dataSource"/>
<!-- 引用Mybatis配置文件中的配置 -->
<property name="configLocation" value="classpath:mybatis-config.xml"/>
<!-- 配置SQL映射文件信息 -->
<property name="mapperLocations">
<list>
<value>classpath:cn/cvs/dao/**/*.xml</value>
</list>
</property>
</bean>
<!-- 配置SqlSessionTemplate -->
<bean id="sqlSessionTemplate" class="org.mybatis.spring.SqlSessionTemplate">
<constructor-arg name="sqlSessionFactory" ref="sqlSessionFactory"/>
</bean>
<!-- 配置DAO -->
<bean id="sysUserMapper" class="cn.cvs.dao.sysUser.SysUserMapperImpl">
<property name="sqlSession" ref="sqlSessionTemplate"/>
<property name="sqlSessionFactory" ref="sqlSessionFactory"/>
</bean>
<!-- 配置业务bean -->
<bean id="sysUserService" class="cn.cvs.service.impl.sysUser.SysUserServiceImpl">
<property name="sysUserMapper" ref="sysUserMapper"/>
</bean>
-
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="cn.cvs.dao.sysUser.SysUserMapper">
<!-- 当数据库中的字段信息与对象的属性不一致时需要通过resultMap来映射 -->
<resultMap id="SysUserResult" type="cn.cvs.pojo.SysUser">
<result property="roleName" column="roleName"/>
</resultMap>
<!-- 查询用户列表 -->
<select id="selectSysUserList" parameterType="cn.cvs.pojo.SysUser" resultMap="SysUserResult">
select u.*,r.roleName from t_sys_user u,t_sys_role r where u.roleId = r.id
and u.roleId = #{roleId}
and u.realName like concat('%',#{realName},'%')
</select>
</mapper>
-
service
public interface SysUserService {
List<SysUser> getList(SysUser sysUser);
}
-
service实现
public class SysUserServiceImpl implements SysUserService {
private SysUserMapper sysUserMapper;
public List<SysUser> getList(SysUser sysUser) {
try{
return sysUserMapper.selectSysUserList(sysUser);
}catch (RuntimeException e){
e.printStackTrace();
throw e;
}
}
public SysUserMapper getSysUserMapper() {
return sysUserMapper;
}
public void setSysUserMapper(SysUserMapper sysUserMapper) {
this.sysUserMapper = sysUserMapper;
}
}
4.编写Spirng配置文件
1.配置数据源
2.配置SqlSessionFactoryBean
3.配置实现业务属性
<?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:aop="http://www.springframework.org/schema/aop"
xmlns:tx="http://www.springframework.org/schema/tx" xmlns:context="http://www.springframework.org/schema/context"
xsi:schemaLocation="
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-3.0.xsd
http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-3.0.xsd
http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.0.xsd">
<!-- 配置数据源 -->
<bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource" destroy-method="close">
<property name="driverClassName" value="com.mysql.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://127.0.0.1:3306/cvs_db?useUnicode=true&characterEncoding=utf8&serverTimezone=Asia/Shanghai"/>
<property name="username" value="root"/>
<property name="password" value="root"/>
</bean>
<!-- 配置 SqlSessionFactoryBean -->
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
<!-- 引用数据源组件 -->
<property name="dataSource" ref="dataSource"/>
<!-- 引用Mybatis配置文件中的配置 -->
<property name="configLocation" value="classpath:mybatis-config.xml"/>
<!-- 配置SQL映射文件信息 -->
<property name="mapperLocations">
<list>
<value>classpath:cn/cvs/dao/**/*.xml</value>
</list>
</property>
</bean>
<!-- 配置SqlSessionTemplate -->
<bean id="sqlSessionTemplate" class="org.mybatis.spring.SqlSessionTemplate">
<constructor-arg name="sqlSessionFactory" ref="sqlSessionFactory"/>
</bean>
<!-- 配置DAO -->
<bean id="sysUserMapper" class="cn.cvs.dao.sysUser.SysUserMapperImpl">
<property name="sqlSession" ref="sqlSessionTemplate"/>
<property name="sqlSessionFactory" ref="sqlSessionFactory"/>
</bean>
<!-- 配置业务bean -->
<bean id="sysUserService" class="cn.cvs.service.impl.sysUser.SysUserServiceImpl">
<property name="sysUserMapper" ref="sysUserMapper"/>
</bean>
</beans>
5.测试类
public class SysUserTest {
private Logger logger = Logger.getLogger(SysUserTest.class);
@Test
public void testGetUserList(){
ApplicationContext ctx = new ClassPathXmlApplicationContext("applicationContext.xml");
SysUserService userService = (SysUserService) ctx.getBean("sysUserService");
List<SysUser> userList = new ArrayList<SysUser>();
SysUser userCondition = new SysUser();
userCondition.setRealName("赵");
userCondition.setRoleId(2);
userList = userService.getList(userCondition);
for (SysUser sysUser : userList) {
logger.debug("testGetUserList account:"+sysUser.getAccount()+" and realName:"+sysUser.getRealName()+" and roleId:"+sysUser.getRoleId()
+"and roleName:"+sysUser.getRoleName()+" and address:"+sysUser.getAddress());
}
}
核心概念: 独立的Myabtis文件sqlSessionFactory是通过Mybaits来配置数据源,并且一步步创建具体实现,使用Spring整合就是将Mybatis的数据源以及SqlSessionFactory在Spring容器中注入完成,将数据源以及SqlSessionFactory对象都配置完整,所以我们可以通过Spring容器获得一个直接执行的SqlSessionFactory对象