MyBatis整合Spring
开发环境：
System：Windows
WebBrowser：IE6+、Firefox3+
JavaEE Server：tomcat5.0.2.8、tomcat6
IDE：eclipse、MyEclipse 8
Database：MySQL
开发依赖库：
JavaEE5、Spring 3.0.5、Mybatis 3.0.4、myBatis-spring-1.0、junit4.8.2
配置步骤：
1、 首先新建一个WebProject 命名为MyBatisForSpring，新建项目时，使用JavaEE5 的 lib 库。然后手动添加需要的 jar 包，所需 jar 包如下：
2、 添加spring 的监听及 springMVC 的核心 Servlet ， web.xml 内容，内容如下：
org.springframework.web.context.ContextLoaderListener
contextConfigLocation
classpath*:applicationContext-*.xml
dispatcher
org.springframework.web.servlet.DispatcherServlet
contextConfigLocation
/WEB-INF/dispatcher.xml
1
dispatcher
*.do
characterEncodingFilter
org.springframework.web.filter.CharacterEncodingFilter
encoding
UTF-8
characterEncodingFilter
/*
3、 在WEB-INF 目录中添加 dispatcher.xml ，内容如下：
4、 在src 目录下添加 applicationContext-common.xml ，内容如下：
classpath:com/hoo/resultmap/**/*-resultmap.xml
classpath:com/hoo/entity/*-resultmap.xml
classpath:com/hoo/mapper/**/*-mapper.xml
上面的配置最先配置的是DataSource ，这里采用的是 jdbc 的 DataSource ；
然后是SqlSessionFactoryBean ，这个配置比较关键。 SqlSessionFactoryBean 需要注入 DataSource 数据源，其次还要设置 configLocation 也就是 mybatis 的 xml 配置文件路径，完成一些关于 mybatis 的配置，如 settings 、 mappers 、 plugin 等；
如果使用mapperCannerConfigurer 模式，需要设置扫描根路径也就是你的 mybatis 的 mapper 接口所在包路径；凡是 markerInterface 这个接口的子接口都参与到这个扫描，也就是说所有的 mapper 接口继承这个 SqlMapper 。
如果你不使用自己的transaction 事务，就使用 MapperScannerConfigurer 来完成 SqlSession 的打开、关闭和事务的回滚操作。在此期间，出现数据库操作的如何异常都会被转换成 DataAccessException ，这个异常是一个抽象的类，继承 RuntimeException ；
5、 SqlMapper内容如下：
/**
* function: 所有的Mapper继承这个接口
* @author hoojo
* @createDate 2011-4-12 下午04:00:31
* @file SqlMapper.java
* @package com.hoo.mapper
* @project MyBatisForSpring
* @blog http://blog.csdn.net/IBM_hoojo
* @email [email protected]
* @version 1.0
*/
public interface SqlMapper {
}
6、 实体类和ResultMap.xml
import java.io.Serializable;
import javax.persistence.Entity;
@Entity
public class Account implements Serializable {
private static final long serialVersionUID = -7970848646314840509L;
private Integer accountId;
private Integer status;
private String username;
private String password;
private String salt;
private String email;
private Integer roleId;
//getter、setter
@Override
public String toString() {
return this.accountId + "#" + this.status + "#" + this.username + "#" +
this.password + "#" + this.email + "#" + this.salt + "#" + this.roleId;
}
}
account-resultmap.xml
7、 在src 目录中添加 applicationContext-beans.xml 内容如下：
这里配置bean 对象，一些不能用 annotation 注解的对象就可以配置在这里
8、 在src 目录中添加 mybatis.xml ，内容如下：
在这个文件放置一些全局性的配置，如handler 、 objectFactory 、 plugin 、以及 mappers 的映射路径（由于在 applicationContext-common 中的 SqlSessionFactoryBean 有配置 mapper 的 location ，这里就不需要配置）等
9、 AccountMapper接口，内容如下：
import java.util.List;
import org.apache.ibatis.annotations.Select;
import com.hoo.entity.Account;
/**
* function: 继承SqlMapper，MyBatis数据操作接口；此接口无需实现类
* @author hoojo
* @createDate 2010-12-21 下午05:21:20
* @file AccountMapper.java
* @package com.hoo.mapper
* @project MyBatis
* @blog http://blog.csdn.net/IBM_hoojo
* @email [email protected]
* @version 1.0
*/
public interface AccountMapper extends SqlMapper {
public List getAllAccount();
public Account getAccount();
public Account getAccountById(String id);
public Account getAccountByNames(String spring);
@Select("select * from account where username = #{name}")
public Account getAccountByName(String name);
public void addAccount(Account account);
public void editAccount(Account account);
public void removeAccount(int id);
}
这个接口我们不需要实现，由mybatis 帮助我们实现，我们通过 mapper 文件配置 sql 语句即可完成接口的实现。然后这个接口需要继承 SqlMapper 接口，不然在其他地方就不能从 Spring 容器中拿到这个 mapper 接口，也就是说当我们注入这个接口的时候将会失败。
当然，你不继承这个接口也可以。那就是你需要给买个mapper 配置一个 bean 。配置方法如下：
这里的MapperFactoryBean 可以帮助我们完成 Session 的打开、关闭等操作
10、 在com.hoo.mapper 也就是在 AccountMapper 接口的同一个包下，添加 account-mapper.xml ，内容如下：
username, password
insert into account(account_id, status, username, password)
values(#{accountId}, #{status}, #{username}, #{password})
select cast(random() * 10000 as Integer) a from #Tab
insert into account(account_id, status, username, password)
values(#{accountId}, #{status}, #{username}, #{password})
update account set
status = #{status},
username = #{username},
password = #{password}
where account_id = #{accountId}
delete from account where account_id = #{id}
上面的namespace 和定义接口类路径对应，所有的 sql 语句，如 select 、 insert 、 delete 、 update 的 id 和方法名称对应。关于更多 MyBatis 内容的讲解，这里就不赘述的。这里只完成整合！如果你不懂可以去阅读其他关于 MyBatis 的资料。
11、 为了测试发布，这里使用junit 和 spring 官方提供的 spring-test.jar ，完成 spring 框架整合的测试，代码如下：
import java.util.List;
import javax.inject.Inject;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit38.AbstractJUnit38SpringContextTests;
import com.hoo.entity.Account;
/**
* function: AccountMapper JUnit测试类
* @author hoojo
* @createDate 2011-4-12 下午04:21:50
* @file AccountMapperTest.java
* @package com.hoo.mapper
* @project MyBatisForSpring
* @blog http://blog.csdn.net/IBM_hoojo
* @email [email protected]
* @version 1.0
*/
@ContextConfiguration("classpath:applicationContext-*.xml")
public class AccountMapperTest extends AbstractJUnit38SpringContextTests {
@Inject
//@Named("accountMapper")
private AccountMapper mapper;
public void testGetAccount() {
System.out.println(mapper.getAccount());
}
public void testGetAccountById() {
System.out.println(mapper.getAccountById("28"));
}
public void testGetAccountByName() {
System.out.println(mapper.getAccountByName("user"));
}
public void testGetAccountByNames() {
System.out.println(mapper.getAccountByNames("user"));
}
public void testAdd() {
Account account = new Account();
account.setEmail("[email protected] ");
account.setPassword("abc");
account.setRoleId(1);
account.setSalt("ss");
account.setStatus(0);
account.setUsername("Jack");
mapper.addAccount(account);
}
public void testEditAccount() {
Account acc = mapper.getAccountByNames("Jack");
System.out.println(acc);
acc.setUsername("Zhangsan");
acc.setPassword("123123");
mapper.editAccount(acc);
System.out.println(mapper.getAccountById(acc.getAccountId() + ""));
}
public void testRemoveAccount() {
Account acc = mapper.getAccountByNames("Jack");
mapper.removeAccount(acc.getAccountId());
System.out.println(mapper.getAccountByNames("Jack"));
}
public void testAccountList() {
List acc = mapper.getAllAccount();
System.out.println(acc.size());
System.out.println(acc);
}
}
这里的注入并没有使用@Autowired 、 @Resource 、 @Qualifier 注入，而是使用 @Inject 、 @Named 注入方式， Inject 注入是 JSR330 的标准注入方式；而不局限于某个产品，使用于多个产品的使用，推荐使用这种方式；运行后，没有发现问题，就可以继续后续的编码工作了。
12、 定义AccountDao 接口及实现代码，代码如下：
import java.util.List;
import org.springframework.dao.DataAccessException;
/**
* function: Account数据库操作dao接口
* @author hoojo
* @createDate 2011-4-13 上午10:21:38
* @file AccountDao.java
* @package com.hoo.dao
* @project MyBatisForSpring
* @blog http://blog.csdn.net/IBM_hoojo
* @email [email protected]
* @version 1.0
*/
public interface AccountDao {
/**
* function: 添加Account对象信息
* @author hoojo
* @createDate 2011-4-13 上午11:50:05
* @param entity Account
* @return boolean 是否成功
* @throws DataAccessException
*/
public boolean addAccount(T entity) throws DataAccessException;
/**
* function: 根据id对到Account信息
* @author hoojo
* @createDate 2011-4-13 上午11:50:45
* @param id 编号id
* @return Account
* @throws DataAccessException
*/
public T getAccount(Integer id) throws DataAccessException;
/**
* function: 查询所有Account信息
* @author hoojo
* @createDate 2011-4-13 上午11:51:45
* @param id 编号id
* @return Account
* @throws DataAccessException
*/
public List getList() throws DataAccessException;
}
接口实现
import java.util.List;
import javax.inject.Inject;
import org.springframework.dao.DataAccessException;
import org.springframework.stereotype.Repository;
import com.hoo.dao.AccountDao;
import com.hoo.entity.Account;
import com.hoo.mapper.AccountMapper;
/**
* function: Account数据库操作dao
* @author hoojo
* @createDate 2011-4-13 上午10:25:02
* @file AccountDaoImpl.java
* @package com.hoo.dao.impl
* @project MyBatisForSpring
* @blog http://blog.csdn.net/IBM_hoojo
* @email [email protected]
* @version 1.0
*/
@SuppressWarnings("unchecked")
@Repository
public class AccountDaoImpl implements AccountDao {
@Inject
private AccountMapper mapper;
public boolean addAccount(T entity) throws DataAccessException {
boolean flag = false;
try {
mapper.addAccount(entity);
flag = true;
} catch (DataAccessException e) {
flag = false;
throw e;
}
return flag;
}
public T getAccount(Integer id) throws DataAccessException {
T entity = null;
try {
entity = (T) mapper.getAccountById(String.valueOf(id));
} catch (DataAccessException e) {
throw e;
}
return entity;
}
public List getList() throws DataAccessException {
return (List) mapper.getAllAccount();
}
}
13、 服务层AccountBiz 接口及实现代码
接口：
import java.util.List;
import org.springframework.dao.DataAccessException;
/**
* function: biz层Account接口
* @author hoojo
* @createDate 2011-4-13 上午11:33:04
* @file AccountBiz.java
* @package com.hoo.biz
* @project MyBatisForSpring
* @blog http://blog.csdn.net/IBM_hoojo
* @email [email protected]
* @version 1.0
*/
public interface AccountBiz {
/**
* function: 添加Account对象信息
* @author hoojo
* @createDate 2011-4-13 上午11:50:05
* @param entity Account
* @return boolean 是否成功
* @throws DataAccessException
*/
public boolean addAccount(T entity) throws DataAccessException;
/**
* function: 根据id对到Account信息
* @author hoojo
* @createDate 2011-4-13 上午11:50:45
* @param id 编号id
* @return Account
* @throws DataAccessException
*/
public T getAccount(Integer id) throws DataAccessException;
/**
* function: 查询所有Account信息
* @author hoojo
* @createDate 2011-4-13 上午11:51:45
* @param id 编号id
* @return Account
* @throws DataAccessException
*/
public List getList() throws DataAccessException;
}
实现代码：
import java.util.List;
import javax.inject.Inject;
import org.springframework.dao.DataAccessException;
import org.springframework.stereotype.Service;
import com.hoo.biz.AccountBiz;
import com.hoo.dao.AccountDao;
import com.hoo.entity.Account;
import com.hoo.exception.BizException;
/**
* function: Account Biz接口实现
* @author hoojo
* @createDate 2011-4-13 上午11:34:39
* @file AccountBizImpl.java
* @package com.hoo.biz.impl
* @project MyBatisForSpring
* @blog http://blog.csdn.net/IBM_hoojo
* @email [email protected]
* @version 1.0
*/
//@Component
@Service
public class AccountBizImpl implements AccountBiz {
@Inject
private AccountDao dao;
public boolean addAccount(T entity) throws DataAccessException {
if (entity == null) {
throw new BizException(Account.class.getName() + "对象参数信息为Empty！");
}
return dao.addAccount(entity);
}
public T getAccount(Integer id) throws DataAccessException {
return dao.getAccount(id);
}
public List getList() throws DataAccessException {
return dao.getList();
}
}
上面用到了一个自定义的异常信息，代码如下：
import org.springframework.dao.DataAccessException;
/**
* function: 自定义Biz层异常信息
* @author hoojo
* @createDate 2011-4-13 上午11:42:19
* @file BizException.java
* @package com.hoo.exception
* @project MyBatisForSpring
* @blog http://blog.csdn.net/IBM_hoojo
* @email [email protected]
* @version 1.0
*/
public class BizException extends DataAccessException {
/**
* @author Hoojo
*/
private static final long serialVersionUID = 1L;
public BizException(String msg) {
super(msg);
}
public BizException(String msg, Throwable cause) {
super(msg, cause);
}
} 14、 springMVC
的控制器，
AccountController
代码如下： 这里只是简单的继承，如果还有其他的异常业务或需求可以进行具体的实现
import javax.inject.Inject;
import javax.servlet.http.HttpServletRequest;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RequestMapping;
import com.hoo.biz.AccountBiz;
import com.hoo.entity.Account;
/**
* function: Account控制器
* @author hoojo
* @createDate 2011-4-13 上午10:18:02
* @file AccountController.java
* @package com.hoo.controller
* @project MyBatisForSpring
* @blog http://blog.csdn.net/IBM_hoojo
* @email [email protected]
* @version 1.0
*/
@Controller
@RequestMapping("/account")
public class AccountController {
@Inject
private AccountBiz biz;
@RequestMapping("/add")
public String add(Account acc) {
System.out.println(acc);
biz.addAccount(acc);
return "redirect:/account/list.do";
}
@RequestMapping("/get")
public String get(Integer id, Model model) {
System.out.println("##ID:" + id);
model.addAttribute(biz.getAccount(id));
return "/show.jsp";
}
@RequestMapping("/list")
public String list(Model model) {
model.addAttribute("list", biz.getList());
return "/list.jsp";
}
@ExceptionHandler(Exception.class)
public String exception(Exception e, HttpServletRequest request) {
//e.printStackTrace();
request.setAttribute("exception", e);
return "/error.jsp";
}
} 15、 基本页面代码
index.jsp
<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
<%
String path = request.getContextPath();
String basePath = request.getScheme()+"://"+request.getServerName()+":"+request.getServerPort()+path+"/";
%>
MyBatis 整合 Spring 3.0.5
MyBatis 3.0.4 整合 Spring 3.0.5
查询所有 添加 查询
List.jsp
<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
<%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %>
<%
String path = request.getContextPath();
String basePath = request.getScheme()+"://"+request.getServerName()+":"+request.getServerPort()+path+"/";
%>
all Account Result
id: ${data.accountId }---name: ${data.username }---password: ${data.password }
show.jsp
<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
<%
String path = request.getContextPath();
String basePath = request.getScheme()+"://"+request.getServerName()+":"+request.getServerPort()+path+"/";
%>
show Account
error.jsp
<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
<%
String path = request.getContextPath();
String basePath = request.getScheme()+"://"+request.getServerName()+":"+request.getServerPort()+path+"/";
%>
Error Page
Exception: ${exception }
详细信息
<% Exception ex = (Exception)request.getAttribute("exception"); %>
<% ex.printStackTrace(new java.io.PrintWriter(out)); %>
16、 以上就基本上完成了整个Spring+SpringMVC+MyBatis 的整合了。如果你想添加事务管理，得在 applicationContext-common.xml 中加入如下配置：
同时还需要加入aspectjweaver.jar这个jar 包；
注意的是：Jdbc的 TransactionManager 不支持事务隔离级别，我在整个地方加入其它的 TransactionManager ，增加对 transaction 的隔离级别都尝试失败！
也许可以用于jpa 、 jdo 、 jta 这方面的东西。不知道大家对 MyBatis 的事务是怎么处理的？
17、 对Dao 进行扩展封装，运用 SqlSessionDaoSupport 进行模板的扩展或运用：
BaseDao代码如下：
import java.util.ArrayList;
import java.util.List;
import javax.inject.Inject;
import org.apache.ibatis.session.SqlSessionFactory;
import org.mybatis.spring.support.SqlSessionDaoSupport;
import org.springframework.stereotype.Repository;
import com.hoo.dao.BaseDao;
/**
* function: 运用SqlSessionDaoSupport封装Dao常用增删改方法，可以进行扩展
* @author hoojo
* @createDate 2011-4-13 下午06:33:37
* @file BaseDaoImpl.java
* @package com.hoo.dao.impl
* @project MyBatisForSpring
* @blog http://blog.csdn.net/IBM_hoojo
* @email [email protected]
* @version 1.0
*/
@Repository
@SuppressWarnings({ "unchecked", "unused" })
public class BaseDaoImpl extends SqlSessionDaoSupport implements BaseDao {
@Inject
private SqlSessionFactory sqlSessionFactory;
public boolean add(String classMethod, T entity) throws Exception {
boolean flag = false;
try {
flag = this.getSqlSession().insert(classMethod, entity) > 0 ? true : false;
} catch (Exception e) {
flag = false;
throw e;
}
return flag;
}
public boolean edit(String classMethod, T entity) throws Exception {
boolean flag = false;
try {
flag = this.getSqlSession().update(classMethod, entity) > 0 ? true : false;
} catch (Exception e) {
flag = false;
throw e;
}
return flag;
}
public T get(String classMethod, T entity) throws Exception {
T result = null;
try {
result = (T) this.getSqlSession().selectOne(classMethod, entity);
} catch (Exception e) {
throw e;
}
return result;
}
public List getAll(String classMethod) throws Exception {
List result = new ArrayList();
try {
result = this.getSqlSession().selectList(classMethod);
} catch (Exception e) {
throw e;
}
return result;
}
public boolean remove(String classMethod, T entity) throws Exception {
boolean flag = false;
try {
flag = this.getSqlSession().delete(classMethod, entity) > 0 ? true : false;
} catch (Exception e) {
flag = false;
throw e;
}
return flag;
}
} 继承 SqlSessionDaoSupport 后，可以拿到 SqlSession 完成数据库的操作； 值得说明的是，这个类继承了SqlSessionDaoSupport ，它需要我们帮助它注入 SqlSessionFactory 或是 SqlSessionTemplate ，如果两者都被注入将忽略 SqlSessionFactory 属性，使用 SqlSessionTemplate 模板。
18、 对Dao 进行扩展封装，运用 SqlSessionTemplate 进行模板的扩展或运用：
首先看看这个组件中运用的一个Mapper 的基类接口：
import java.util.List;
import org.springframework.dao.DataAccessException;
/**
* function: BaseSqlMapper继承SqlMapper，对Mapper进行接口封装，提供常用的增删改查组件；
* 也可以对该接口进行扩展和封装
* @author hoojo
* @createDate 2011-4-14 上午11:36:41
* @file BaseSqlMapper.java
* @package com.hoo.mapper
* @project MyBatisForSpring
* @blog http://blog.csdn.net/IBM_hoojo
* @email [email protected]
* @version 1.0
*/
public interface BaseSqlMapper extends SqlMapper {
public void add(T entity) throws DataAccessException;
public void edit(T entity) throws DataAccessException;
public void remvoe(T entity) throws DataAccessException;
public T get(T entity) throws DataAccessException;
public List getList(T entity) throws DataAccessException;
} 看看继承 SqlSessionTemplate 的 BaseMapperDao 代码： 该接口继承SqlMapper 接口，但是该接口没有 MyBatis 的 mapper 实现。需要我们自己的业务 mapper 继承这个接口，完成上面的方法的实现。
import java.util.List;
import javax.inject.Inject;
import org.apache.ibatis.session.SqlSessionFactory;
import org.mybatis.spring.SqlSessionTemplate;
import org.springframework.stereotype.Repository;
import com.hoo.dao.BaseMapperDao;
import com.hoo.mapper.BaseSqlMapper;
/**
* function: 运用SqlSessionTemplate封装Dao常用增删改方法，可以进行扩展
* @author hoojo
* @createDate 2011-4-14 下午12:22:07
* @file BaseMapperDaoImpl.java
* @package com.hoo.dao.impl
* @project MyBatisForSpring
* @blog http://blog.csdn.net/IBM_hoojo
* @email [email protected]
* @version 1.0
*/
@SuppressWarnings("unchecked")
@Repository
public class BaseMapperDaoImpl extends SqlSessionTemplate implements BaseMapperDao {
@Inject
public BaseMapperDaoImpl(SqlSessionFactory sqlSessionFactory) {
super(sqlSessionFactory);
}
private Class mapperClass;
public void setMapperClass(Class mapperClass) {
this.mapperClass = mapperClass;
}
private BaseSqlMapper getMapper() {
return this.getMapper(mapperClass);
}
public boolean add(T entity) throws Exception {
boolean flag = false;
try {
this.getMapper().add(entity);
flag = true;
} catch (Exception e) {
flag = false;
throw e;
}
return flag;
}
public boolean edit(T entity) throws Exception {
boolean flag = false;
try {
this.getMapper().edit(entity);
flag = true;
} catch (Exception e) {
flag = false;
throw e;
}
return flag;
}
public T get(T entity) throws Exception {
return this.getMapper().get(entity);
}
public List getAll() throws Exception {
return this.getMapper().getList(null);
}
public boolean remove(T entity) throws Exception {
boolean flag = false;
try {
this.getMapper().remvoe(entity);
flag = true;
} catch (Exception e) {
flag = false;
throw e;
}
return flag;
}
} 例外的是这个类还有一个关键属性
mapperClass
，这个
class
需要是
BaseSqlMapper
接口或是子接口，然后通过
SqlSessionTemplate
模板获得当前设置的
Class
的
Mapper
对象，完成数据库操作。
上面这个类继承了
SqlSessionTemplate
，这个类需要提供一个构造函数。这里提供的是
SqlSessionFactory
的构造函数，通过该函数注入
SqlSessionFactory
即可完成数据库操作；
该类的测试代码：
@ContextConfiguration("classpath:applicationContext-*.xml")
public class BaseMapperDaoImplTest extends AbstractJUnit38SpringContextTests {
@Inject
private BaseMapperDao dao;
public void init() {
dao.setMapperClass(CompanyMapper.class);
}
public void testGet() throws Exception {
init();
Company c = new Company();
c.setCompanyId(4);
System.out.println(dao.get(c));
}
public void testAdd() throws Exception {
init();
Company c = new Company();
c.setAddress("北京中关村");
c.setName("beijin");
System.out.println(dao.add(c));
}
}
一般情况下，你可以在一个Dao 中注入 BaseMapperDao ，紧跟着需要设置 MapperClass 。只有设置了 MapperClass 后， BaseMapperDao 才能获取对应 mapper ，完成相关的数据库操作。当然你可以在这个 Dao 中将 SqlSessionTemplate 、 SqlSession 暴露出来，当 BaseMapperDao 的方法不够用，可以进行扩展。
