MyBatis-Plus 详解

淡淡的烟草味﹌ 2022-11-03 15:25 50阅读 0赞

mybatispuls ：[\- - > 直达MyBatis Plus 官方文档][- - _ _MyBatis Plus]

（在这里 MyBatis Plus 的特性不做介绍，可以前往官方文档进行浏览，下文直接通过代码进行解释说明）

1、项目搭建  
直接使用idea的springboot的快速初始化进行构建项目  
进行依赖的添加，使用下方5个依赖即可，之后next进行构建即可，  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ0OTczMTU5_size_16_color_FFFFFF_t_70]  
在构建项目的时候等待的时间略长，等待项目的构建完成，我们在使用mybatis plus 首先添加依赖到pom.xml文件当中，等待依赖添加完成，这个时候spring boot项目就构建好了。

2、依赖导入和数据源设置

在pom.xml文件当中添加mybatis-plus的依赖，依赖添加完成之后import导入依赖

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

在resources文件夹下的applicant.properties文件当中进行定义：

# 数据库启动
    spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
    # 使用到哪一个数据库
    spring.datasource.url=jdbc:mysql://localhost:3306/springboot?characterEncoding=utf-8
    # 数据库的账号密码
    spring.datasource.username=root
    spring.datasource.password=root
    # 打印日志文件
    mybatis-plus.configuration.log-impl= org.apache.ibatis.logging.stdout.StdOutImpl

3、java代码定义

在上面定义了使用了哪一个库，我们在这个数据库当中的一个表，创建其对应的实体类。并且使用lombok注解进行方法生成。

package com.lzq.mybatisplus.entity;
    
    import com.fasterxml.jackson.annotation.JsonFormat;
    import lombok.AllArgsConstructor;
    import lombok.Data;
    import lombok.NoArgsConstructor;
    import lombok.ToString;
    import lombok.experimental.Accessors;
    
    @Data
    @AllArgsConstructor
    @NoArgsConstructor
    @ToString
    @Accessors(chain = true)
    public class User { 
        private int id;
        private String name;
        @JsonFormat(pattern = "yyyy-MM-dd")
        private String birthday;
        private String sex;
        private String address;
    }

之后我们创建一个Mapper文件，继承至Basemapper

package com.lzq.mybatisplus.mapper;
    
    import com.baomidou.mybatisplus.core.mapper.BaseMapper;
    import com.lzq.mybatisplus.entity.User;
    
    public interface UserMapper extends BaseMapper<User> { 
    }

在这里我们就基本实现了mybatisplus，相对于mybatis而言更加简单，我们的interface不需要编写实现类，在这里使用的是动态代理生成实现类，所以在这里我们看不到这个实现类，而接口继承过来，我们就可以直接使用这个BaseMapper的SQL语句。  
我们最后直接编写一个Tes类进行方法调用测试，

package com.lzq.mybatisplus.mapper;
    
    import org.junit.jupiter.api.Test;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.boot.test.context.SpringBootTest;
    
    import static org.junit.jupiter.api.Assertions.*;
    
    @SpringBootTest
    class UserMapperTest { 
    
        @Autowired
        private UserMapper userMapper;
    
        @Test
        void test(){ 
            userMapper.selectList(null).forEach(System.out::println);
        }
    }

并且在springboot启动类当中加上一个扫描mapper的注解：（到mapper这个包）

@MapperScan("com.lzq.mybatisplus.mapper")

之后我们直接run这个测试类，查看打印输出：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ0OTczMTU5_size_16_color_FFFFFF_t_70 1]  
4、常用注解

4.1、@TableName @TableId @TableField

在上面我们，我们没有添加任何关于表名提及，那么mybatis-plus是如何找到这个user表的呢？这是因为在这里是直接使用类名映射到表名。

我们将原先的User类名修改之后，重新run，会出现报错，表示这个表不存在。我们只需要在类名上面加上注释，使用如下注释：

@TableName(value = "user")

而同理，我们的类的属性值就是直接喝表的列进行对应。当类的属性和列名不一致时，直接运行还是会出现错误，表示列名无法映射，所以我们需要对属性添加注解，对于主键我们使用 @TableId 这个注解有两个参数，value 表示映射的 列名，type 则表示数据类型

@TableId(value = "id", type = IdType.AUTO)

这里的type取值也是和平常见到的数据类型也不一样，我们可以点进这个IdType枚举类，如下所示：并且在使用input的时候，开发者没有进行赋值，则会进行默认自增。[官方详解 数据类型枚举][Link 1]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ0OTczMTU5_size_16_color_FFFFFF_t_70 2]  
而 @TableField注解则是用来映射其他列名

4.2、其余注解

在官方文档当中进行浏览，不是很常用：[https://mp.baomidou.com/guide/annotation.html\#version][https_mp.baomidou.com_guide_annotation.html_version]

5、CRUD

增删改查语句参考官方文档：[https://baomidou.com/guide/crud-interface.html\#service-crud][https_baomidou.com_guide_crud-interface.html_service-crud]

6、代码生成器

在使用Mybatis-plus 可以自动生成相对应的Java代码，根据数据表自动生成实体类、Mapper、 Service、 Servicelmpl、 Controller

首先我们需要导入依赖：

<dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-generator</artifactId>
                <version>3.3.1</version>
            </dependency>
            <dependency>
                <groupId>org.apache.velocity</groupId>
                <artifactId>velocity-engine-core</artifactId>
                <version>2.3</version>
            </dependency>

之后我们直接编写一个类用来生成文件

package com.lzq.mybatisplus;
    
    import com.baomidou.mybatisplus.annotation.DbType;
    import com.baomidou.mybatisplus.generator.AutoGenerator;
    import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
    import com.baomidou.mybatisplus.generator.config.GlobalConfig;
    import com.baomidou.mybatisplus.generator.config.PackageConfig;
    import com.baomidou.mybatisplus.generator.config.StrategyConfig;
    import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
    
    public class Main { 
        public static void main(String[] args) { 
            AutoGenerator autoGenertor = new AutoGenerator();
            //创建数据源
            DataSourceConfig dataSourceConfig = new DataSourceConfig();
            // 数据库
            dataSourceConfig.setDbType(DbType.MYSQL);
            //数据库连接
            dataSourceConfig.setUrl("jdbc:mysql://localhost:3306/springboot?characterEncoding=utf-8");
            dataSourceConfig.setUsername("root");
            dataSourceConfig.setPassword("root");
            dataSourceConfig.setDriverName("com.mysql.cj.jdbc.Driver");
            //将数据源放到Generator对象当中
            autoGenertor.setDataSource(dataSourceConfig);
            //全局配置
            GlobalConfig globalConfig = new GlobalConfig();
            //生成路径
            globalConfig.setOutputDir(System.getProperty("user.dir")+"/src/main/java");
            globalConfig.setOpen(false);
            globalConfig.setAuthor("lizuoqun");
            autoGenertor.setGlobalConfig(globalConfig);
            //包信息
            PackageConfig packageConfig = new PackageConfig();
            packageConfig.setParent("com.lzq.mybatisplus");
            packageConfig.setModuleName("genertor");
            packageConfig.setController("controller");
            packageConfig.setMapper("mapper");
            packageConfig.setService("service");
            packageConfig.setServiceImpl("service.impl");
            packageConfig.setEntity("entity");
            autoGenertor.setPackageInfo(packageConfig);
            //生成策略
            StrategyConfig strategyConfig = new StrategyConfig();
            strategyConfig.setEntityLombokModel(true);
            strategyConfig.setColumnNaming(NamingStrategy.underline_to_camel);
            autoGenertor.setStrategy(strategyConfig);
            //执行Genertor
            autoGenertor.execute();
        }
    }

[- - _ _MyBatis Plus]: https://baomidou.com/guide/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ0OTczMTU5_size_16_color_FFFFFF_t_70]: /images/20221023/33f6f8b7daaf4520810db58f49755af1.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ0OTczMTU5_size_16_color_FFFFFF_t_70 1]: /images/20221023/06e34ad04dce48ad9c11b89d8bd66ef1.png
[Link 1]: https://baomidou.com/guide/annotation.html#tableid
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ0OTczMTU5_size_16_color_FFFFFF_t_70 2]: /images/20221023/ba43e3d69d684b828336426f45ecd8a8.png
[https_mp.baomidou.com_guide_annotation.html_version]: https://mp.baomidou.com/guide/annotation.html#version
[https_baomidou.com_guide_crud-interface.html_service-crud]: https://baomidou.com/guide/crud-interface.html#service-crud-%E6%8E%A5%E5%8F%A3