Spring Boot整合Mybatis框架在扩展文件编写自己的sql语句

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目录,如图

Paste_Image.png

蓝色部分是扩展类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();
}

浏览器中访问,结果如下:

Paste_Image.png

通过上面的方式,就可以愉快的编写自定义sql语句了,从而充分发挥mybatis框架的灵活性。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,547评论 6 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,399评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,428评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,599评论 1 274
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,612评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,577评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,941评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,603评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,852评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,605评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,693评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,375评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,955评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,936评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,172评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,970评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,414评论 2 342

推荐阅读更多精彩内容