> 文档中心 > mybatis-plus入门使用

mybatis-plus入门使用

mybatis-plus入门使用

    • 一、前言
    • 二、配置
      • 1.依赖配置
      • 2.基本属性的配置
      • 3.建立数据库
      • 4.建立映射bean
      • 5.建立映射的mapper
      • 6.乐观锁的添加
      • 7.配置自动装载机制
    • 三、注解的使用
      • 1.默认注解
      • 2.自定义sql语句的注解
      • 3.使用
      • 4.需要注意的
    • 四、QueryWapper的使用
    • 五、总结

一、前言

之前一段时间做springboot项目的数据库的操作是使用JDBC进行的,非常的繁琐,当时自己app端使用的就是封装好的orm模型,然后找到了mybatis-plus,很容易上手,但是当时是初学,摸清基本原理还是花了不少时间,当时的主要参考资料就是plus作者的官方文档地址

本文主要适用于那些从未接触过后端数据库操作,想要快速完成后端开发任务的朋友

二、配置

1.依赖配置

在gradle下添加以下语句完成mybatis-plus的集成

implementation "com.baomidou:mybatis-plus-boot-starter:3.4.2"

如果使用的是maven进行开发也比较容易的进行转换,基本上没有难度

<dependency>    <groupId>com.baomidou</groupId>    <artifactId>mybatis-plus-boot-starter</artifactId>    <version>3.5.1</version></dependency>

2.基本属性的配置

spring.datasource.url=jdbc:mysql://localhost:3306/数据库名spring.datasource.username=用户名spring.datasource.password=用户密码//驱动名称spring.datasource.driver-class-name=com.mysql.jdbc.Driver//mybatis-plus方面的配置//当然还有好多配置,这里只配置最基本的mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImplmybatis-plus.global-config.banner=true

3.建立数据库

这部分由于是之前建好的数据库,就没有利用代码进行建库了,有兴趣可以参考官方文档的建库操作

4.建立映射bean

这部分,可以自己用相关的插件完成bean的创建,我这里使用的是kotlin的data类一行即可完成bean的搭建

data class City(val name:String, val state:String)

5.建立映射的mapper

着部分需要进行继承基类baseMapper,然后无需配置mapper的xml文件

interface FundMapper:BaseMapper<City> {}

这部分要完成mapper的自动扫描需要在application上添加自动扫描的注解

//这部分与mapper的创建位置有关//这里即在包名的路径下完成mapper包的建立,然后扫描的都是mapper包下的mapper@MapperScan("包名.mapper")

6.乐观锁的添加

这个需要在包名下创建一个config的包,包下添加配置类,着部分采用kotlin进行编写,fun即方法名,翻译成Java应该没有难度

@Configurationclass MybatisPlusConfig {    @Bean    fun mybatisPlusInterceptor(): MybatisPlusInterceptor { val interceptor = MybatisPlusInterceptor() //添加乐观锁插件 interceptor.addInnerInterceptor(OptimisticLockerInnerInterceptor()) return interceptor    }}

至此配置已经完全结束了,下面开始介绍使用

7.配置自动装载机制

这部分和官方的稍微不一样,Kotlin这边貌似只支持@Resource注解,@Autowire注解使用不了

@Resourcelateinit var cityMapper:CityMapper

如果是Java的话使用以下方式完成

@Autowiredprivate CityMapper cityMapper;

三、注解的使用

1.默认注解

使用默认注解需要接受mybatis-plus的规范,首先数据库字段必须以下划线作为单词的分隔,映射的类使用myName这种驼峰式的写法

//类似myName需要写成my_name

默认注解有常用的insert,delete,update,还有默认查询全部的selectList

  • insert

    cityMapper.insert()
  • delete

    cityMapper.delete()
  • update

    这方面由于没有使用它提供的注解进行建表导致,不能直接使用,需要使用下面即将要讲的QueryWapper

    //第一个是更新的对象,第二个是条件cityMapper.update(city,queryWrapper)

2.自定义sql语句的注解

这部分需要在mapper里面进行编写相关的sql语句

interface FundMapper:BaseMapper<City> {    @Select("select * from city")    fun selectAll():List<City> //如果是带参数的    @Select("select * from city where name = #{name}")    fun selectPart(@Param("name")name:String):List<City> //其他的注解,类似update,delete等等都是一样的道理 //如果是选择部分列,返回值只需要设置好相关bean即可,这里做示范是相同的,自己可以自定义返回的bean    @Select("select name,state from city")    fun part():List<City>}

3.使用

使用就很简单了,操作jdbc mybatis-plus已经帮你做好了

@Resourcelateinit var cityMapper: FundMapper@GetMapping("/search")fun searchCity():String{    val cityList = cityMapper.selectPart("us")}

4.需要注意的

这个踩过坑,如果是bean有默认值值记得与数据库的顺序相同,不然就会出现类型不匹配的问题,当时找了好久的原因,如果不想考虑这些事,建议bean全部采用String类型的进行处理,这样只需要转换完成值的变换,如果没有默认值的话是正常的

四、QueryWapper的使用

这个QueryWapper封装了常用的操作,类似等于,大于等等的条件,有时候很方便,不需要编写mapper,主要是配合一些默认注解的条件的,类似update,更多使用可以见官网的详细介绍

val queryWrapper = QueryWrapper<City>()queryWrapper.eq("name","us")cityMapper.update(city,queryWrapper)

五、总结

通过以上的讲解,你可以获得基本的数据CRUD的能力,告别jdbc的繁琐操作,如果想要深入学习,上面这些介绍是远远不够的,希望对大家初步学习mybatis-plus有帮助。