美文网首页IT技术篇Spring Boot 从入门到上瘾程序员
SpringBoot 快速整合MyBatis (去XML化)

SpringBoot 快速整合MyBatis (去XML化)

作者: 一只袜子 | 来源:发表于2017-10-07 22:08 被阅读1181次

    序言:
    此前,我们主要通过XML来书写SQL和填补对象映射关系。在SpringBoot中我们可以通过注解来快速编写SQL并实现数据访问。(仅需配置:mybatis.configuration.map-underscore-to-camel-case=true)。

    具体步骤

    1. 引入依赖

    在pom.xml 引入ORM框架(Mybaits-Starter)和数据库驱动(MySQL-Conn)的依赖。

    <?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <!--继承信息 -->
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.0.0.M4</version>
            <relativePath/>
        </parent>
    
        <!--依赖管理 -->
        <dependencies>
            <dependency> <!--添加Web依赖 -->
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            <dependency> <!--添加Mybatis依赖 -->
                <groupId>org.mybatis.spring.boot</groupId>
                <artifactId>mybatis-spring-boot-starter</artifactId>
                <version>1.3.1</version>
            </dependency>
            <dependency><!--添加MySQL驱动依赖 -->
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <scope>runtime</scope>
            </dependency>
            <dependency><!--添加Test依赖 -->
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
        </dependencies>
    </project>
    

    2. 添加数据源

    在application.yml 添加数据源,以及开启Mybaits的驼峰映射功能。

    spring:
      datasource:
        url: jdbc:mysql://localhost:3306/socks?useSSL=false
        username: root
        password: root
        driver-class-name: com.mysql.jdbc.Driver
    
    mybatis:
      configuration:
       map-underscore-to-camel-case: true #开启驼峰映射
    

    3. 编写数据层代码

    // POJO类如下:
    public class User {
        private String userId;
        private String username;
        private String password;
        // Getters & Setters ..
    }
    // 数据层代码如下:
    public interface UserMapper {
    
        @Select("select * from t_user where 1=1")
        List<User> list();
    
        @Select("select * from t_user where username like #{username}")
        List<User> findByUsername(String username);
    
        @Select("select * from t_user where user_id like #{userId}")
        User getOne(String userId);
    
        @Delete("delete from t_user where user_id like #{userId}")
        int delete(String userId);
    }
    

    4. 添加数据库记录

    在Navicat 连接本地数据库,随便打开查询窗口,复制下面这段脚本,点击执行即可。

    DROP DATABASE IF EXISTS `socks`;
    CREATE DATABASE `socks`;
    USE `SOCKS`;
    DROP TABLE IF EXISTS `t_user`;
    CREATE TABLE `t_user` (
      `USER_ID` varchar(50) ,
      `USERNAME` varchar(50) ,
      `PASSWORD` varchar(50) 
    ) ;
    
    INSERT INTO `t_user` VALUES ('1', 'admin', 'admin');
    INSERT INTO `t_user` VALUES ('2', 'yizhiwazi', '123456');
    

    5. 启动项目

    @SpringBootApplication
    @MapperScan("com.hehe.mapper")  //扫描Mapper接口
    public class MybatisApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(MybatisApplication.class, args);
        }
    }
    

    6. 单元测试

    import static org.assertj.core.api.Assertions.assertThat;
    
    @RunWith(SpringRunner.class)
    @SpringBootTest
    public class MybatisApplicationTest {
    
        @SuppressWarnings("all")
        @Autowired
        UserMapper userMapper;
    
        @Test
        public void test_db() {
            //开始进行测试
            assertThat(userMapper.list().size()).isGreaterThan(1);
            assertThat(userMapper.getOne("1")).isNotEqualTo(null);
            assertThat(userMapper.getOne("xxx")).isEqualTo(null);
        }
    }
    

    文档资料

    源码下载:SpringBoot+MyBatis+Annotation

    专题阅读:《SpringBoot 布道系列》

    相关文章

      网友评论

      • 一只袜子:【2017.11.3】 更新《注解进阶教程》 http://www.jianshu.com/p/828d2bd12b2f
      • eisenxu:谢谢作者的文章,学习了。配置去 xml 化我和作者一样非常认同。但是采用注解写 SQL 的方式仅适用于比较简单的 SQL 语句吧,对于复杂的情况,我认为有两个问题。一个是 java 对长字符串的支持不好,所以注解很长,还要自己进行回车排版,即便有 IDE 的支持依然显得很难看。另一个是对于比较复杂的数据读取可能有复杂的读模型,就是那种包含了 association 和 collection 的 ResultMap,我不知道这种在注解里如何处理,不知道作者有没有好的办法处理。
        一只袜子:@eisenxu 是的 基于JPA 和 Mybatis动态SQL套多了一层
        eisenxu:@yizhiwazi 恩,对付复杂的还是放在 xml 里面吧。你所提到的通用 mapper 插件我没有使用过,刚才看了一下给我的感觉是它有点像是 Hibernate 的那种注解?我这样理解对吗
        一只袜子:推荐使用通用Mapper插件,因为这样可以节省在数据层编写基于单个对象的增删改查的SQL编写,这个节省了很多功夫。对于一般复杂的SQL(不超3表连接),可以考虑在业务层拆成多个单表即单实体操作,这样的好处是零SQL,一定程序上缓解了面向过程的问题。对于很复杂的报表SQL则建议统一放置在某个文件内,考虑用JSON的格式去存取。还有你提到的1:N的关系,在XML可以很详细的定义,对应在Mybatis注解也是有相应的功能的,这个属于入门进阶,我后期会把比较详细的用法单独写一篇文章,欢迎关注Github或简书。
      • 吾三省_b821:可以使用动态sql吗?
        一只袜子:有的,根据@SelectProvider 注解就可以动态拼接SQL。(我们常用的通用Mapper插件就是基于这个原理来构建的,具体的代码可以参考Github源码)
        2bb84e08d233: @吾三省_b821 看样子是不行
      • 知识学者:这篇文章,我怎么好像看过,github点了一颗星,:smiley: 哪里不太熟悉。
        一只袜子:哈哈 第三颗星 (PS:我是按最简单的思路来写的,用户案例应该最为熟悉的了哈哈哈哈)

      本文标题:SpringBoot 快速整合MyBatis (去XML化)

      本文链接:https://www.haomeiwen.com/subject/dohsyxtx.html