mybatis踩坑初体验

我在之前的项目中使用的都是spring data jpa，开发起来十分快速。几个标签注解一加，repository一继承，一个基本的增删改查就有了。缺点就是写比较复杂的SQL的时候不够灵活，只能以HQL的形式写在注解@Query里，如果碰上子查询， union，之类的复杂查询代码阅读起来就很费力。
　　在新项目里，采用了mybatis作为ORM框架，此文记录一下我在初次接触mybatis中踩的众多坑中的一部分，同时也作为一个知识点总结梳理。

项目结构

先构建了一个maven项目，pom文件：

        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>1.3.2</version>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>

  • mybatis-spring-boot-starter
    此包为mybatis的springboot启动包，里面包含了大量的默认配置和mybatis的核心类，没有去细看里面有什么了

  • spring-boot-starter 与 spring-boot-starter-web
    是springboot基础包，提供基本web功能

  • mysql-connector-java
    我用的是mysql，如果用oracle的需要注意一下包文件不能直接下的。

文件结构：

图片.png
项目配置

mybatis 可以使用传统的xml进行配置也可以使用注解。注解和xml各有各的优势，当然也可以混合起来使用。

使用注解进行配置

首先找到springboot的配置文件，我用的是application.yml

server:
    port: 9090
    address: localhost

spring:
    datasource:
        jdbc-url: jdbc:mysql://localhost:3306/boot?useUnicode=true&characterEncoding=utf8&useSSL=true
        username: root
        password: 123456
        driver-class-name: com.mysql.jdbc.Driver

mybatis:
    typeAliasesPackage: com.boot.domain
    config-locations: classpath:com/boot/config/mybatis/mybatis-config.xml

  • typeAliasesPackage
    　　对应实体类所在的包，会自动获取包中的简单类的名字的别名，多个不同路径的包可以用逗号或者冒号号分割，需要写全类名。这个别名是在查询中parameterType 参数类型用的，如果没有配别名就需要写为parameterType="cn.core.bean.xxx"。 也可以 用@Alias(article)手动设置别名。

  • config-locations
    这是本地配置文件路径，这里的classpath是指打包后的classes目录（图我放最后了）。我这个配置文件只配置了一些基础类的映射如

<typeAlias alias="Integer" type="java.lang.Integer" />
  • spring: datasource: jdbc-url
    这里有个坑，之前的都是url，现在要用jdbc-url不然会数据源报错，原因未知。可能的原因

在主类xxxApplication的main方法上加个标签@MapperScan("com.xxx.mapper")

@SpringBootApplication
@MapperScan("com.boot.mapper")
@EnableTransactionManagement
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}
  • @MapperScan
    这个标签会扫描指定目录下的mapper文件，同样可以用逗号隔开配置多个。但是如果是需要扫描动态路径的话就蛋疼了，需要自定义一个MapperScanner，这里有篇参考文章SpringBoot 为MapperScan添加动态扫描(占位符)功能
  • @EnableTransactionManagement
    开启springboot 事务支持

实体的mapper类接口

@Mapper
public interface UserMapper {
    @Select("SELECT * FROM user")
    @Results({
            @Result(property = "id",  column = "id", javaType = Long.class),
            @Result(property = "name", column = "name", javaType = String.class),
            @Result(property = "sex", column = "sex")
    })
    List<User> getAll();

    @Select("Select * from user where name = #{name}")
    User findUserByName(@Param("name") String name);
}

简单的实体类

public class User {
    Long id;
    String name;
    String sex;
    //省略了getter与setter
}

到此就没有mybatis的事了，再上一个简单的mvc结构

@Service
public class UserServiceImpl implements UserService {

    @Autowired
    private UserMapper userMapper;

    @Override
    public List<User> findAll() {
        return userMapper.getAll();
    }
}

这里有个问题，mapper接口是什么时候被spring容器接管的，为什么可以直接@Autowired 把UserMapper 进行注入？在最初的时候，配置使用的是xml形式，这里很明显是定义成了一个bean，在spring启动的时候被加载进容器。

<bean id="articleMapper" class="org.mybatis.spring.mapper.MapperFactoryBean">
<property name="mapperInterface" value="com.boot.mapper.ArticleMapper" />
<property name="sqlSessionFactory" ref="sqlSessionFactory" />
</bean>

现在使用@Mapper就可以。但是每个都这么加有点麻烦的，所以main方法上的@MapperScan 包扫描帮你解决了这个问题。

写个controller测试一下


@RestController
@RequestMapping("/article")
public class ArticleController {
    @Autowired
    private ArticleService articleService;

    @GetMapping("/getAll")
    public String getAll(){
        List<Article> users = articleService.findAll();
        return String.valueOf(users.size());
    }
}

启动程序，测试一下

2018-06-19 12:29:41.923 DEBUG 9668 --- [0.1-9090-exec-8] com.boot.mapper.UserMapper.getAll        : ==>  Preparing: SELECT * FROM user 
2018-06-19 12:29:41.924 DEBUG 9668 --- [0.1-9090-exec-8] com.boot.mapper.UserMapper.getAll        : ==> Parameters: 
2018-06-19 12:29:41.925 DEBUG 9668 --- [0.1-9090-exec-8] com.boot.mapper.UserMapper.getAll        : <==      Total: 1

OK，正常查询。基于注解来进行查询直接把烦人的xml文件给干掉了，缺点就是语句不能太复杂，否则一旦SQL多起来，代码很难阅读。

使用配置文件进行配置

虽然是使用配置文件，但是也不会完全不用注解。在main方法上面任然是添加@MapperScan标签。
article简单的实体类

public class Article {
    Long id;
    String title;
    String author;
    String content;
    //todo getter and setter
}

实体类的mapper接口很干净的方法定义。

public interface ArticleMapper {
    List<Article> findAll();
}

之后写一个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.boot.mapper.ArticleMapper" >
    <resultMap id="BaseResultMap" type="com.boot.domain.Article" >
        <id column="id" property="id" jdbcType="BIGINT" />
        <result column="title" property="title" jdbcType="VARCHAR" />
        <result column="author" property="author" jdbcType="VARCHAR" />
        <result column="content" property="content" jdbcType="VARCHAR" />
    </resultMap>

    <sql id="Base_Column_List" >
        id, title, author, content
    </sql>

    <select id="findAll" resultMap="BaseResultMap"  >
        SELECT
        <include refid="Base_Column_List" />
        FROM article
    </select>
</mapper>

如何实现mapper与xml的对应呢。<mapper namespace="com.boot.mapper.ArticleMapper" > namespace属性就是来绑定mapper接口的，绑定接口后，可以不用写接口实现类，mybatis会通过该绑定自动帮你找到对应要执行的SQL语句。

好了，坑的地方来了，spring并没有接管xml文件，他可找不到xml对应的mapper，但是依照习惯优于配置的原则，mapper和xml在同一目录下，他们就能够正常对应的。其实这个xml的文件位置可以有多种形式
1.直接写在mapper文件的同级目录下，但是我们知道maven打包的时候java目录下的xml文件是会被忽略的，所以需要配置一下pom文件的<build>。

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>

        <resources>
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>**/*.xml</include>
                </includes>
            </resource>
            <resource>
                <directory>src/main/resources</directory>
                <includes>
                    <include>**/*</include>
                </includes>
            </resource>
        </resources>
    </build>

2.第二种。既然java目录下的xml不会被打包进去，那么把xml写在resource文件下不就行了吗。于是在resource下创建与mapper一致的目录结构。目的就是为了让打包后xml与mapper在一个目录下。
3.第三种。指定xml的文件路径，这里就要配点东西了，我以标签的形式加个配置

@Configuration
@MapperScan(basePackages = "com.boot.mapper", sqlSessionTemplateRef = "SqlSessionTemplate")
public class MybatisConfig {

    @Bean(name = "MybatisDS")
    @ConfigurationProperties(prefix = "spring.datasource")
    public DataSource DataSource() {
        return DataSourceBuilder.create().build();
    }

    @Bean(name = "SqlSessionFactory")
    public SqlSessionFactory SqlSessionFactory(@Qualifier("MybatisDS") DataSource dataSource) throws Exception {
        SqlSessionFactoryBean bean = new SqlSessionFactoryBean();
        bean.setDataSource(dataSource);
        bean.setMapperLocations(
                new PathMatchingResourcePatternResolver().getResources("classpath:com/boot/mapper/imp/*.xml"));
        return bean.getObject();
    }

    @Bean(name = "TransactionManager")
    public DataSourceTransactionManager TransactionManager(@Qualifier("MybatisDS") DataSource dataSource) {
        return new DataSourceTransactionManager(dataSource);
    }

    @Bean(name = "SqlSessionTemplate")
    public SqlSessionTemplate SqlSessionTemplate(@Qualifier("SqlSessionFactory") SqlSessionFactory sqlSessionFactory)
            throws Exception {
        return new SqlSessionTemplate(sqlSessionFactory);
    }
}

标签与xml没有什么区别。

    @Bean(name = "MybatisDS")
    @ConfigurationProperties(prefix = "spring.datasource")
    public DataSource DataSource() {
        return DataSourceBuilder.create().build();
    }

这个是springboot里封装的jdbc的数据源，简单看一下，在无参的情况下生成了一个com.zaxxer.hikari.HikariDataSource数据源，嗯嗯~没什么研究，貌似是一个最新的高效率数据源，成功的干死了c3p0与tomcat自带的jndi。

接下来是mybatis的核心SqlSessionFactory，这个东西可以看看官网怎么说的：

每个基于 MyBatis 的应用都是以一个 SqlSessionFactory 的实例为中心的。SqlSessionFactory 的实例可以通过 SqlSessionFactoryBuilder 获得。而 SqlSessionFactoryBuilder 则可以从 XML 配置文件或一个预先定制的 Configuration 的实例构建出 SqlSessionFactory 的实例。

官网很详细的介绍了这个，链接在这里
我这个写法有点丑，SqlSessionFactory里面setMapperLocations方法指定路径即可。
TransactionManager是spring的事务管理，这里让spring的事务管理接管一下。
SqlSessionTemplate也是mybatis的核心类。这个类负责管理MyBatis的SqlSession,调用MyBatis的SQL方法
这样配好之后mapper接口就可以找到对应的实现xml文件了。
这是一张打包好的项目结构图：

图片.png

其实最简单的就是第二种方法，但是我就是想折腾一下。
此文，简单的回顾了一下我用springBoot与mybatis整合的过程，文件的两种配置方式和mapper/xml映射的基本原理。 还留了很多坑，比如mybatis缓存等等。。在之后会补上的

参考资料：
mybatis官方简介
关于sqlSessionTemplate
Mybatis SqlSessionTemplate 源码解析
Spring Boot 实践折腾记（三）：三板斧，Spring Boot下使用Mybatis 强烈推荐
spring mybatis mapper接口注解方式注入
@Mappe与@MapperScan关系
spring是怎样管理mybatis的及注入mybatis mapper bean的

感谢前辈们的分享，有什么问题欢迎在评论区指出。

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 205,033评论 6赞 478
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 87,725评论 2赞 381
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 151,473评论 0赞 338
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 54,846评论 1赞 277
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 63,848评论 5赞 368
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 48,691评论 1赞 282
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 38,053评论 3赞 399
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 36,700评论 0赞 258
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 42,856评论 1赞 300
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,676评论 2赞 323
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,787评论 1赞 333
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 33,430评论 4赞 321
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 39,034评论 3赞 307
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,990评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,218评论 1赞 260
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 45,174评论 2赞 352
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 42,526评论 2赞 343

推荐阅读更多精彩内容