Spring Boot整合Mybatis基础参考文章: Spring Boot一步步整合Mybatis框架
Mybatis中每一个实体类都有一个对应的mapper.xml文件,这个文件除了用工具根据数据库表生成的源码外,我们还可以加入自己的sql语句。
但是直接在这个文件中加入自己的sql语句话,会比较麻烦。
比如说当你要在某张表新增字段时候,就需要重新生成这个表对应的mapper.xml文件,这时候你写的sql语句还要手动复制过来,显然这样子不太方便。
如果把我们自己写的sql语句放在一个扩展文件中,那样的话就显得比较方便了,那么该怎么做呢?下面以user表为例说明
1、dao层的定义
创建扩展基类BaseMapperExt.java,以后有什么公共方法定义在这个接口文件就可以了
package com.beibei.doc.dao.base;
import java.util.List;
import com.beibei.doc.util.Page;
/**
* 扩展基类
* @author beibei
*
* @param <M> 实体类
* @param <E> 实体类对应的example类
*/
public interface BaseMapperExt<M, E> {
}
创建UserMapperExt.java接口类,继承基类,再定义一个方法用于测试
package com.beibei.doc.dao.user.ext;
import com.beibei.doc.model.user.User;
public interface UserMapperExt extends BaseMapperExt<User, UserExample> {
public User selectById(Integer id);
}
2、重新调整mybatis目录,如图
蓝色部分是扩展类UserMapperExt.java放置的目录,mybatis目录中新建两个文件夹,base中放置生成的mapper.xml文件,ext文件夹中放置扩展的mapper.xml文件,这样做主要是为了方便构建SqlSessionFactory时候读取,统一匹配 classpath:/mybatis/*/*/*.xml
(注:最新发现用两个星号 ** 可以匹配路径中零到多个目录,即可以匹配classpath:/mybatis/**/*.xml可以同时匹配mybatis/*.xml,也可以匹配mybatis/base*.xml和mybatis/base/user*.xml等等)
public SqlSessionFactory sqlSessionFactory(){
SqlSessionFactory factory = null;
try {
SqlSessionFactoryBean sessionFactoryBean = new SqlSessionFactoryBean();
sessionFactoryBean.setDataSource(dataSource());
//读取mybatis各个类的 *mapper.xml文件,这个地方的locationPattern一定要写对,不然会找不到输入的mapper.xml文件
String locationPattern = "classpath*:/mybatis/*/*/*.xml";
PathMatchingResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
Resource[] resources = resolver.getResources(locationPattern);
List<Resource> filterResourceList = new ArrayList<Resource>();
List<String> fileNameList = new ArrayList<String>();
for (int i=0; i<resources.length; i++){
Resource resource = resources[i];
if(!fileNameList.contains(resource.getFilename())){
filterResourceList.add(resource);
fileNameList.add(resource.getFilename());
}
}
Resource[] result = new Resource[filterResourceList.size()];
sessionFactoryBean.setMapperLocations(filterResourceList.toArray(result));
factory = (SqlSessionFactory) sessionFactoryBean.getObject();
} catch (Exception e) {
e.printStackTrace();
}
return factory;
}
3、UserMapper.xml中代码如下:
<?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="com.beibei.doc.dao.user.ext.UserMapperExt" >
<resultMap id="ExtResultMap" extends="com.beibei.doc.dao.user.UserMapper.BaseResultMap" type="com.beibei.doc.model.user.User" >
</resultMap>
<select id="selectById" resultMap="ExtResultMap" parameterType="java.lang.Integer" >
select
<include refid="com.beibei.doc.dao.user.UserMapper.Base_Column_List"></include>
from user
where id = #{id,jdbcType=INTEGER}
</select>
</mapper>
说明: <resultMap标签中可通过命名空间.id来继承另外一个mapper文件中的代码片段,比如代码中extends="com.beibei.doc.dao.user.UserMapper.BaseResultMap"可以继承UserMapper.xml中BaseResultMap,里面的一些代码就可以不用重复写了。
<include标签中可以可通过命名空间.id来引用另外一个mapper文件中的代码片段,比如refid="com.beibei.doc.dao.user.UserMapper.Base_Column_List"中就是引用UserMapper.xml中的Base_Column_List。
4、在service层中加入业务方法引用我们自定义的mapper方法。
UserService.java中定义方法:
public User selectById(Integer id);
UserServiceImpl.java中实现,UserMapperExt对象同样用@Autowired自动注入:
@Autowired
private UserMapperExt userMapperExt;
@Override
public User selectById(Integer id) {
return this.userMapperExt.selectById(id);
}
5、在接口中调用测试
@Autowired
private UserService userService;
@RequestMapping(value="/say")
public String say(){
User user = userService.selectById(1);
if(user == null){
return null;
}
return user.getUsername() + ", 年龄=" + user.getAge();
}
浏览器中访问,结果如下:
通过上面的方式,就可以愉快的编写自定义sql语句了,从而充分发挥mybatis框架的灵活性。