Mybatis-plus

方和顺
2023-12-01

MyBatisPlus

Mybatis 和 Mybatis Plus 的区别

MyBatis:

  • 所有SQL语句全部自己写
  • 手动解析实体关系映射转换为MyBatis内部对象注入容器
  • 不支持Lambda形式调用

Mybatis Plus:

  • 强大的条件构造器,满足各类使用需求
  • 内置的Mapper,通用的Service,少量配置即可实现单表大部分CRUD操作
  • 支持Lambda形式调用
  • 提供了基本的CRUD功能,连SQL语句都不需要编写
  • 自动解析实体关系映射转换为MyBatis内部对象注入容器

入门

  1. 建表
DROP TABLE IF EXISTS user;

CREATE TABLE user
(
	id BIGINT(20) NOT NULL COMMENT '主键ID',
	name VARCHAR(30) NULL DEFAULT NULL COMMENT '姓名',
	age INT(11) NULL DEFAULT NULL COMMENT '年龄',
	email VARCHAR(50) NULL DEFAULT NULL COMMENT '邮箱',
	PRIMARY KEY (id)
);
-- 真实开发中,version(乐观锁)、deleted(逻辑删除)、gmt_create、gmt_modified
  1. 创建工程,导入依赖
    尽量不要同时导入mybatis和mybatisplus,版本差异
	<!--1.数据库驱动-->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <scope>runtime</scope>
    </dependency>
    <!--2.lombok-->
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
    </dependency>
    <!--3.mybatis-plus  版本很重要3.0.5-->
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-boot-starter</artifactId>
        <version>3.0.5</version>
    </dependency>
  1. 连接数据库
 spring.datasource.username=root
 spring.datasource.password=123456
 spring.datasource.url=jdbc:mysql://localhost:3306/mybatisplus_test?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8
 spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
  1. POJO

    • 传统方式:pojo–mapper–mapper.xml文件–service–controller
    • MybatisPlus方式:pojo–mapper–使用
@Data
@AllArgsConstructor
@NoArgsConstructor

public class User {

// id对应数据库中的主键(uuid、自增id、雪花算法、redis、zookeeper)
	private Long id;
	private String name;
	private int age;
	private String email;

}

  1. 编写UserMapper接口,继承BaseMapper类
 @Repository
 //在对应的Mapper上继承BaseMapper
 public interface UserMapper extends BaseMapper<User> {
     //所有的CURD已经完成,不需要在像以前一样写配置文件
 }
  1. 主启动类上添加扫描包的注解
  @MapperScan("com.rainhey.mapper")
  @SpringBootApplication
  public class MybatisplusApplication {
  
      public static void main(String[] args) {
          SpringApplication.run(MybatisplusApplication.class, args);
      }
  
  }
  
  1. 测试,查询成功
 @SpringBootTest
 class MybatisplusApplicationTests {
     //继承了basemapper,所有的方法都来自父类,我们也可以扩展编写自己的方法
     @Autowired
     private UserMapper userMapper;
 
     @Test
     void contextLoads() {
         //查询全部用户
         //参数是一个Wrapper,条件构造器
         List<User> users = userMapper.selectList(null);
         for (User user:users) {
             System.out.println(user);
         }
     }
 }
 
 

配置日志

所有的sql是不可见的,我们希望知道他们是怎么执行的,所以要配置日志

#日志控制台输出
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl  

CRUD扩展

//插入
@Test
    public void testInsert(){
        User user = new User();
        user.setName("rainhey");
        user.setAge(23);
        user.setEmail("2190273698@qq.com");
        int result = userMapper.insert(user);  //可以自动生成id
        System.out.println(result);  //受影响的行数
        System.out.println(user);   //生成的id会自动回填
    }

数据库插入的id,默认为全局的唯一id

主键自动生成策略
uuid、自增id、雪花算法、redis、zookeeper …
雪花算法:snowflake是Twitter开源的分布式ID生成算法,结果是一个long型的ID;其核心思想是:使用41bit作为毫秒数,10bit作为机器的ID(5个bit是数据中心(北京、香港···),5个bit的机器ID),12bit作为毫秒内的流水号(意味着每个节点在每毫秒可以产生 4096 个 ID),最后还有一个符号位,永远是0

主键自增 AUTO

  1. 实体类字段上添加 @TableId(type = IdType.AUTO)
  2. 数据库字段一定要设置成自增
  3. 插入数据测试

更新

@Test
    public void testUpdate(){
        User user = new User();
        user.setId(5L);
        user.setName("test update");
        // 参数是一个对象,通过条件自动拼接动态sql
        int i = userMapper.updateById(user);
        System.out.println(i);
    }

自动填充

例如在表中添加create_time和update_time字段,在插入或更新操作时,代码级别上自动填充这两个字段

  1. 数据库插入这两个字段,类型为datetime

  2. 在实体类字段上面添加注解

	@TableField(fill = FieldFill.INSERT)    //插入时填充
    private Date create_time;
    @TableField(fill = FieldFill.INSERT_UPDATE) // 插入或更新时都填充
    private Date update_time;

  1. 编写处理器处理这个注解–继承MetaObjectHandler接口
    在主启动类同级建包Handler
 @Slf4j
 @Component
 public class MyMetaObjectHandler implements MetaObjectHandler {
     //插入时的填充策略
     @Override
     public void insertFill(MetaObject metaObject) {
         log.info("start insert fill.......");
         this.setFieldValByName("create_time", new Date(),metaObject );
         this.setFieldValByName("update_time", new Date(),metaObject );
     }
     //更新时的填充策略
     @Override
     public void updateFill(MetaObject metaObject) {
         log.info("start update fill.......");
         this.setFieldValByName("update_time", new Date(),metaObject );
 
     }
 }
 
 

乐观锁

乐观锁:总是假设最好的情况,每次去拿数据的时候都认为别人不会修改,所以不会上锁,只在更新的时候会判断一下在此期间别人有没有去更新这个数据

悲观锁:总是假设最坏的情况,每次去拿数据的时候都认为别人会修改,所以每次在拿数据的时候都会上锁,这样别人想拿这个数据就会阻塞,直到它拿到锁

乐观锁实现方式:

  • 取出记录时,获取当前version

  • 更新时,带上这个version

  • 执行更新时,set version = newVersion where version = oldVersion

  • 如果version不对,就更新失败

  • 数据库增加version字段,类型为int ,默认值为1

  • 实体类增加version字段

  • 注册组件,主启动类同级建包config

 @Configuration
 @MapperScan("com.rainhey.mapper")
 @EnableTransactionManagement   //自动管理事务
 public class MyBatisPlusConfig {
     // 注册乐观锁插件
     @Bean
     public OptimisticLockerInterceptor optimisticLockerInterceptor() {
         return new OptimisticLockerInterceptor();
     }
 }

查询

// 单个id删除
@Test
    public void testDeleteById(){
        userMapper.deleteById(1493136123621326849L);
    }

// 批量id删除
@Test
    public void testDeleteBatchId(){
        userMapper.deleteBatchIds(Arrays.asList(1493133498851123201L,1493094593296703489L));
    }

// 条件删除
 @Test
    public void testDeleteMap(){
        HashMap<String, Object> map = new HashMap<>();
        map.put("name", "Sandy");
        userMapper.deleteByMap(map);
    }

分页查询

原始的limit分页
pageHelper第三方插件
MybatisPlus其实也内置了分页插件!

MybatisPlus 分页插件使用

  1. 配置类中配置拦截器组件
@Bean
public PaginationInterceptor paginationInterceptor() {
    return new PaginationInterceptor();
}

  1. 使用Page对象
 @Test
     public void testPage(){
         //  参数一:当前页    参数二:显示数据
         Page<User> Page = new Page<>(1,5);
         userMapper.selectPage(Page, null);
         objectPage.getRecords().forEach(System.out::println);
         //获得总记录数
         System.out.println(objectPage.getTotal());
     }

删除

// 单个id删除
@Test
    public void testDeleteById(){
        userMapper.deleteById(1493136123621326849L);
    }

// 批量id删除
@Test
    public void testDeleteBatchId(){
        userMapper.deleteBatchIds(Arrays.asList(1493133498851123201L,1493094593296703489L));
    }

// 条件删除
 @Test
    public void testDeleteMap(){
        HashMap<String, Object> map = new HashMap<>();
        map.put("name", "Sandy");
        userMapper.deleteByMap(map);
    }

逻辑删除

物理删除:从数据库中直接删除
逻辑删除:数据库中没有被删除,通过一个变量来让它失效 deleted=0----->deleted=1

管理员可以查看删除记录!防止数据丢失,类似于回收站

测试:

  1. 在数据表中增加一个 deleted 字段,类型为 int ,默认值为0
  2. 实体类中增加属性
@TableLogic   // 逻辑删除
    private int deleted;
  1. 配置类配置
//逻辑删除组件
@Bean
public ISqlInjector sqlInjector(){
    return new LogicSqlInjector();
}
  1. 配置文件配置
# 逻辑删除
mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0

条件构造器

区别

(QueryWrapper,LambdaQueryWrapper 比较)

1 QueryWrapper使用方式

        QueryWrapper<User> wrapper = new QueryWrapper<User>()
                .eq(StringUtils.isNotBlank(user.getNickName()), "nick", user.getNickName())
                .eq(user.getId() != null,"id", user.getId());
        List<User> userList = userDao.selectList(wrapper);

2 LambdaQueryWrapper 使用方式

 LambdaQueryWrapper<User> wrapper = new LambdaQueryWrapper<User>()
                .eq(StringUtils.isNotBlank(user.getNickName()), User::getNickName, user.getNickName())
                .eq(user.getId() != null, User::getId, user.getId());
        List<User> userList = userDao.selectList(wrapper);

3 使用区别
QueryWrapper 的列名匹配使用的是 “数据库中的字段名(一般是下划线规则)”
LambdaQueryWrapper 的列名匹配使用的是“Lambda的语法,偏向于对象”

4 LambdaQueryWrapper的优势
不同写“列名”,而是使用纯java的方式,避免了拼写错误(LambdaQueryWrapper的写法如果有错,则在编译期就会报错,而QueryWrapper需要运行的时候调用该方法才会报错)

条件查询器 Wrapper

	@Test
    void contextLoads() {
        //查询name不为空,email不为空,age大于12的用户
        QueryWrapper<User> QueryWrapper = new QueryWrapper<>();
        QueryWrapper.isNotNull("name")
                .isNotNull("email")
                .ge("age", 12);
        List<User> users = userMapper.selectList(QueryWrapper);
        users.forEach(System.out::println);
    }


public void test2(){
        // 按名字查询
        QueryWrapper<User> Wrapper = new QueryWrapper<>();
        Wrapper.eq("name", "Jack");
        User user = userMapper.selectOne(Wrapper);   //只查询一条,查询结果如果有多条则报错
        System.out.println(user);
    }

@Test
    public void test3(){
        //查询年龄在20-25
        QueryWrapper<User> Wrapper = new QueryWrapper<>();
        Wrapper.between("age", 20, 25);
        Integer integer = userMapper.selectCount(Wrapper);   //查询符合条件的个数
        System.out.println(integer);
    }

@Test
    public void test4(){
        //名字中不包含e
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.notLike("name", "r")
                .likeRight("email", "t");   //left、right指%在那边,这里是右边,匹配“t%”
        List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
        for (Map<String, Object> map : maps) {
            System.out.println(map);
        }

@Test
    public void test6(){
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        // 按id降序查询
        wrapper.orderByDesc("id");
        List<User> users = userMapper.selectList(wrapper);
        for (User user : users) {
            System.out.println(user);
        }
    }

代码自动生成器

AutoGenerator 是 MyBatis-Plus 的代码生成器,通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码,极大的提升了开发效率

  1. 添加依赖
    MyBatis-Plus 从 3.0.3 之后移除了代码生成器与模板引擎的默认依赖,需要手动添加相关依赖
    模板引擎依赖,MyBatis-Plus 支持 Velocity(默认)、Freemarker、Beetl,用户可以选择自己熟悉的模板引擎,如果都不满足您的要求,可以采用自定义模板引擎
	<dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-boot-starter</artifactId>
        <version>3.0.5</version>
    </dependency>

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

  1. 编写代码
public class rainheyCode {
    public static void main(String[] args) {
    //我们需要构建一个代码生成器对象
    AutoGenerator mpg = new AutoGenerator();
    //全局配置
    GlobalConfig gc = new GlobalConfig();

    String projectPath = System.getProperty("user.dir");   //获取当前项目工程目录
    gc.setOutputDir(projectPath+"/src/main/java");         // 代码生成目录
    gc.setAuthor("rainhey");   //作者
    gc.setOpen(false);         //程序执行后是否自动打开生成目录
    gc.setFileOverride(false);  //是否覆盖同名文件
    gc.setServiceName("%sService");//自定义文件命名,注意 %s 会自动填充表实体属性
    gc.setIdType(IdType.ID_WORKER);  //主键自增类型
    gc.setDateType(DateType.ONLY_DATE);
    gc.setSwagger2(true);   //实体属性 Swagger2 注解
    mpg.setGlobalConfig(gc);
    //2、设置数据源
    DataSourceConfig dsc = new DataSourceConfig();
    dsc.setUsername("root");
    dsc.setPassword("123456");
    dsc.setUrl("jdbc:mysql://localhost:3306/mybatisplus_test?useSSL=false&serverTimezone=GMT%2B8&useUnicode=true&characterEncoding=utf-8");
    dsc.setDriverName("com.mysql.cj.jdbc.Driver");
    dsc.setDbType(DbType.MYSQL);
    mpg.setDataSource(dsc);
    //3、包的配置
    PackageConfig pc = new PackageConfig();
    pc.setModuleName("testgenerator");
    pc.setParent("com.rainhey");
    pc.setEntity("pojo");
    pc.setMapper("mapper");
    pc.setService("service");
    pc.setController("controller");
    mpg.setPackageInfo(pc);
    //4、策略配置
    StrategyConfig strategy = new StrategyConfig();
    strategy.setInclude("user");//设置要映射的表名,只需改这里即可
    // strategy.setInclude("admin","danyuan","building","room");//设置要映射的表名
    strategy.setNaming(NamingStrategy.underline_to_camel);  //表名
    strategy.setColumnNaming(NamingStrategy.underline_to_camel);  //字段名
    strategy.setEntityLombokModel(true);//是否使用lombok开启注解
    strategy.setLogicDeleteFieldName("deleted");
    mpg.setStrategy(strategy);
    //自动填充配置
    TableFill gmtCreate = new TableFill("create_time", FieldFill.INSERT);
    TableFill gmtUpdate = new TableFill("update_time", FieldFill.INSERT_UPDATE);
    ArrayList<TableFill> tableFills = new ArrayList<>();
    tableFills.add(gmtCreate);
    tableFills.add(gmtUpdate);
    strategy.setTableFillList(tableFills);
    //乐观锁配置
    strategy.setVersionFieldName("version");
    strategy.setRestControllerStyle(true); //controller 使用restful风格
    strategy.setControllerMappingHyphenStyle(true); //请求写成localhost:8080/hello_id_2类型
    mpg.setStrategy(strategy);
    mpg.execute();//执行
	}
}
 类似资料: