springboot项目里，让tk-mybatis支持可以手写sql的mapper.xml文件

SpringBoot项目通常配合TKMybatis或MyBatis-Plus来做数据的持久化。

对于单表的增删改查，TKMybatis优雅简洁，无需像传统mybatis那样在mapper.xml文件里定义sql。

我们目前的项目呢，有一些数据分析的需求，涉及到多表关联、嵌套子查询等复杂的sql。

那么，TKMybatis是不是可以支持手写sql呢？

答案是yes！

我们知道，springboot集成tk-mybatis需添加2个依赖：

<dependency>    <groupId>tk.mybatis</groupId>    <artifactId>mapper-spring-boot-starter</artifactId>    <version>2.1.5</version></dependency>

<dependency>    <groupId>tk.mybatis</groupId>    <artifactId>mapper</artifactId>    <version>4.1.5</version></dependency>

执行dependency:tree时查看依赖关系，可以看到mapper-spring-boot-starter.jar同时依赖了org.mybatis。

[INFO] +- tk.mybatis:mapper-spring-boot-starter:jar:2.1.5:compile
[INFO] |  +- org.springframework.boot:spring-boot-starter-jdbc:jar:2.1.7.RELEASE:compile
[INFO] |  |  +- com.zaxxer:HikariCP:jar:3.2.0:compile
[INFO] |  |  \- org.springframework:spring-jdbc:jar:5.1.9.RELEASE:compile
[INFO] |  +- org.mybatis:mybatis:jar:3.4.6:compile
[INFO] |  +- org.mybatis:mybatis-spring:jar:1.3.2:compile
[INFO] |  +- tk.mybatis:mapper-core:jar:1.1.5:compile
[INFO] |  +- tk.mybatis:mapper-base:jar:1.1.5:compile
[INFO] |  +- tk.mybatis:mapper-weekend:jar:1.1.5:compile
[INFO] |  +- tk.mybatis:mapper-spring:jar:1.1.5:compile
[INFO] |  +- tk.mybatis:mapper-extra:jar:1.1.5:compile
[INFO] |  \- tk.mybatis:mapper-spring-boot-autoconfigure:jar:2.1.5:compile

那么，在springboot项目里，如果要实现mybatis那样的在mapper文件里手写sql，如下几步轻松搞定。

1）application.yml里：

mybatis:
  mapper-locations: classpath:mapper/*.xml
  configuration:
    map-underscore-to-camel-case: true
  type-aliases-package: com.draft.entity

2）在resources/mapper目录下创建 SpiderDraftsMapper.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.draft.dao.SpiderDraftsMapper">
    <resultMap id="columnMap" type="com.draft.entity.SpiderDrafts">
        <result column="order_id" property="orderId" jdbcType="VARCHAR"/>
        <result column="interest_days" property="interestDays"/>
        <result column="draft_owner" property="draftOwner"/>
    </resultMap>
    <select id="getfoo" resultMap="columnMap">
        select * from spider_drafts
        where order_id in(select order_id from spider_draft)
    </select>
    <select id="getfoo1" resultType="com.draft.entity.SpiderDrafts">
        select interest_days, order_id as orderId,draft_owner from spider_drafts
        where order_id in(select order_id from spider_draft)
    </select>
</mapper>

3）在com.draft.entity包下，创建pojo实体类 SpiderDrafts.java（可以用代码生成器生成）：

package com.draft.entity;

import lombok.Data;

import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.Table;
import java.io.Serializable;

@Data
//@Table(name = "spider_drafts")
@Entity
public class SpiderDrafts implements Serializable {
//    @Column(name = "interest_days")
    private String interestDays;
    private String orderId;
    private String draftOwner;
}

4）数据访问接口类统一定义在com.draft.dao包下，项目启动程序直接通过@MapperScan("com.draft.dao")来进行扫描。 如下是SpiderDraftsMapper.java：

package com.draft.dao;

import com.draft.entity.SpiderDrafts;
import tk.mybatis.mapper.common.Mapper;

import java.util.List;

public interface SpiderDraftsMapper extends Mapper<SpiderDrafts> {
    List<SpiderDrafts> getfoo();

    List<SpiderDrafts> getfoo1();
}

以上几步，完美搞定。单标操作直接用tkmybatis，复杂sql则写在mapper.xml文件里。

注意：getfoo与getfoo1两个方法都是可用的，只是为了测试下划线命名方式的表字段与驼峰式命名的pojo属性的映射（mybatis.configuration.map-underscore-to-camel-case属性），见后文说明。

【几点说明】

1）map-underscore-to-camel-case：数据库里表的字段是下划线命名，pojo的属性是驼峰命名。打开这个属性可实现这种转换。不用再依靠mybatis那样的resultMap了。
    <resultMap id="columnMap" type="com.draft.entity.SpiderDrafts">
        <result column="order_id" property="orderId" jdbcType="VARCHAR"/>
        <result column="interest_days" property="interestDays"/>
        <result column="draft_owner" property="draftOwner"/>
    </resultMap>
数据库里表的字段是下划线命名，pojo的属性是驼峰命名。另外，打开这个属性后，pojo涉及到下划线式字段与驼峰式属性这种对应关系的，就可以去掉@Table和@Column注解。
2）type-aliases-package：

mapper.xml文件中resultMap的type或者parameterType或者resultType会使用程序里定义的pojo，
此时可以用完全限定名来指定这些POJO的引用，例如 <select id="getfoo1" resultType="com.draft.entity.SpiderDrafts">，
又或者你可以通过在 application.yml/application.properties 中指定POJO扫描包来让mybatis自动扫描到POJO，这时mapper.xml里pojo就可以不用带上包名了。

【后记】

这是个新建的工程，在执行dependency:tree时查看依赖关系时，maven报错：

[Maven] Project build error: ‘packaging‘ with value ‘jar‘ is invalid. Aggregator projects require ‘pom‘ as packaging.

人家提示了：聚合项目（父级项目）需要用pom作为打包方式。父pom文件得加上配置：

<packaging>pom</packaging>

原文地址：https://www.cnblogs.com/buguge/p/11663606.html

时间： 2024-10-09 21:09:38

springboot项目里，让tk-mybatis支持可以手写sql的mapper.xml文件的相关文章

MyBatis 入门到精通(二) SQL语句映射XML文件

MyBatis 真正强大之处就在这些映射语句,也就是它的魔力所在.对于它的强大功能,SQL 映射文件的配置却非常简单. 如果您比较SQL 映射文件配置与JDBC 代码,您很快可以发现,使用SQL 映射文件配置可以节省95%的代码量.MyBatis 被创建来专注于SQL,但又给您自己的实现极大的空间. 需要配置的基本元素 1. cache – 配置给定模式的缓存 2. cache-ref – 从别的模式中引用一个缓存 3. resultMap – 这是最复杂而却强大的一个元素了,它描述如何从结果集

mybatis公用代码抽取到单独的mapper.xml文件

同任何的代码库一样,在mapper中,通常也会有一些公共的sql代码段会被很多业务mapper.xml引用到,比如最常用的可能是分页和数据权限过滤了,尤其是在oracle中的分页语法.为了减少骨架性代码,通常将它们抽象到sql中,但是肯定又不能在每个mapper中也包含,这样就没有意义了.此时,可以将这部分移到专门的mapper.xml中,比如common.xml,其中包含如下: <?xml version="1.0" encoding="UTF-8"?>

【MyBatis】Mapper XML 文件

Mapper XML文件 MyBatis 的真正强大在于它的映射语句,也是它的魔力所在.由于它的异常强大,映射器的 XML 文件就显得相对简单.如果拿它跟具有相同功能的 JDBC 代码进行对比,你会立即发现省掉了将近 95% 的代码.MyBatis 就是针对 SQL 构建的,并且比普通的方法做的更好. SQL 映射文件有很少的几个顶级元素(按照它们应该被定义的顺序): cache – 给定命名空间的缓存配置. cache-ref – 其他命名空间缓存配置的引用. resultMap – 是最复杂

MyBatis Mapper.xml文件中 $和#的区别

MyBatis Mapper.xml文件中 $和#的区别 网上有很多,总之,简略的写一下,作为备忘.例子中假设参数名为 paramName,类型为 VARCHAR . 1.优先使用#{paramName,jdbcType=VARCHAR} 写法,除了可以防止sql注入以外,它还能在参数里含有单引号的时候自动转义, 而${paramName}由于是类似于拼接sql的写法,不具备此功能. 2.注意,使用 #{paramName,jdbcType=VARCHAR} 写法的时候,模糊查询的写法为:'%'

mybatis自动生成dao, model, mapper xml文件

用mybatis的时候,手写xml或model文件是一个力气活,所以可以用mybatis-gennerator插件自动生成mybatis所需要的dao.bean.mapper xml文件 (原文地址:http://blog.csdn.net/tolcf/article/details/50835165) 附件下载地址:http://files.cnblogs.com/files/cc-robot/generator.rar 把附件解压到本地,我放在d:\web\java目录下了 只需要修改下面x

MyBatis中SQL映射的XML文件

Mappers 既然MyBatis的行为已经由上篇介绍的MyBatis配置文件的元素配置完了,我们现在就要定义SQL映射语句了.但是,首先我们需要告诉MyBatis到哪里去找到这些配置.Java在这方面没有提供一个很好的方法,所以最佳的方式是告诉MyBatis去哪里去找映射文件.你可以使用相对于类路径的资源引用,或者字符表示,或url应用的完全限定名. MyBatis架构中,POJOs对象对象一个映射器接口,映射器接口和对应的SQL映射的XML在同一包下. SQL映射的XML文件 MyBatis

【转】Mybatis 3.1中 Mapper XML 文件 的学习详解

MyBatis 真正的力量是在映射语句中.这里是奇迹发生的地方.对于所有的力量,SQL 映射的 XML 文件是相当的简单.当然如果你将它们和对等功能的 JDBC 代码来比较,你会发现映射文件节省了大约 95%的代码量.MyBatis 的构建就是聚焦于 SQL 的,使其远离于普通的方式. SQL 映射文件有很少的几个顶级元素(按照它们应该被定义的顺序): cache – 配置给定命名空间的缓存. cache-ref – 从其他命名空间引用缓存配置. resultMap – 最复杂,也是最有力量的元

Mybatis 3.1中 Mapper XML 文件 的学习详解

转:http://blog.csdn.net/zhll3377/article/details/8203440 MyBatis 真正的力量是在映射语句中.这里是奇迹发生的地方.对于所有的力量,SQL 映射的 XML 文件是相当的简单.当然如果你将它们和对等功能的 JDBC 代码来比较,你会发现映射文件节省了大约 95%的代码量.MyBatis 的构建就是聚焦于 SQL 的,使其远离于普通的方式. SQL 映射文件有很少的几个顶级元素(按照它们应该被定义的顺序): cache – 配置给定命名空间

MyBatis Mapper XML 文件 的学习详解

MyBatis 真正的力量是在映射语句中.这里是奇迹发生的地方.对于所有的力量,SQL 映射的 XML 文件是相当的简单.当然如果你将它们和对等功能的 JDBC 代码来比较,你会发现映射文件节省了大约 95%的代码量.MyBatis 的构建就是聚焦于 SQL 的,使其远离于普通的方式. SQL 映射文件有很少的几个顶级元素(按照它们应该被定义的顺序): cache – 配置给定命名空间的缓存. cache-ref – 从其他命名空间引用缓存配置. resultMap – 最复杂,也是最有力量的元