MyBatis-Plus 学习笔记-配置(一)

625 阅读4分钟

# 特性

  • 无侵入:只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑
  • 损耗小:启动即会自动注入基本 CURD,性能基本无损耗,直接面向对象操作
  • 强大的 CRUD 操作:内置通用 Mapper、通用 Service,仅仅通过少量配置即可实现单表大部分 CRUD 操作,更有强大的条件构造器,满足各类使用需求
  • 支持 Lambda 形式调用:通过 Lambda 表达式,方便的编写各类查询条件,无需再担心字段写错
  • 支持主键自动生成:支持多达 4 种主键策略(内含分布式唯一 ID 生成器 - Sequence),可自由配置,完美解决主键问题
  • 支持 ActiveRecord 模式:支持 ActiveRecord 形式调用,实体类只需继承 Model 类即可进行强大的 CRUD 操作
  • 支持自定义全局通用操作:支持全局通用方法注入( Write once, use anywhere )
  • 内置代码生成器:采用代码或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller 层代码,支持模板引擎,更有超多自定义配置等您来使用
  • 内置分页插件:基于 MyBatis 物理分页,开发者无需关心具体操作,配置好插件之后,写分页等同于普通 List 查询
  • 分页插件支持多种数据库:支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer 等多种数据库
  • 内置性能分析插件:可输出 SQL 语句以及其执行时间,建议开发测试时启用该功能,能快速揪出慢查询
  • 内置全局拦截插件:提供全表 delete 、 update 操作智能分析阻断,也可自定义拦截规则,预防误操作

# 安装

  • JDK 8+
  • Maven or Gradle

Spring Boot2

中心仓库地址 其他版本

central.sonatype.com/artifact/co…

Maven

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

Spring Boot3

中心仓库地址 其他版本

central.sonatype.com/artifact/co…

Maven

<dependency>
   <groupId>com.baomidou</groupId>
   <artifactId>mybatis-plus-spring-boot3-starter</artifactId>
   <version>3.5.9</version>
</dependency>

# 配置

mybatis-plus:

config-location

指定 MyBatis 配置文件的位置。

mybatis-plus
   
    config-location: classpath:/mybatis-config.xml    #指定 MyBatis 配置文件的位置。
    

mapper-locations

指定 Mapper 映射文件的位置。

mybatis-plus

    mapper-locations: classpath:/mapper/**.xml       #指定 Mapper 映射文件的位置。

配置多个mapper路径,逗号分隔

 mybatis-plus:
   
   mapper-locations: classpath:mapper/*.xml,classpath:mapper/other/*.xml

type-aliases-package && type-aliases-super-type

指定实体类包位置。与type-aliases-super-type可以一起使用

 mybatis-plus
 
    type-aliases-package: com.your.domain #指定实体类包位置。
    
    type-aliases-super-type: com.your.domain.BaseEntity  #仅扫描指定父类的子类。
    

type-handlers-package

指定 TypeHandler 扫描路径,用于注册自定义类型转换器。 如数据加密,数据格式转换等

mybatis-plus

     type-handlers-package: com.example.demo.typeHandler #指定 TypeHandler 扫描路径,用于注册自定义类型转换器。

type-handlers-package使用 自定义TypeHandler

package com.example.demo.typeHandler;
import org.apache.ibatis.type.JdbcType;
import org.apache.ibatis.type.MappedJdbcTypes;
import org.apache.ibatis.type.MappedTypes;
import org.apache.ibatis.type.TypeHandler;

import javax.xml.crypto.Data;
import java.sql.CallableStatement;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;

@MappedJdbcTypes({JdbcType.BIGINT})     //对应数据库类型
@MappedTypes({String.class})            //java数据类型
public class MyDateTypeHandler implements TypeHandler<String> {


    /**
     * 入库前的类型转换
     */
    @Override
    public void setParameter(PreparedStatement ps, int i, String parameter, JdbcType jdbcType) throws SQLException {
        System.out.println("setParameter:" + parameter);
        String s = "parameter";
        System.out.println("转换后:" + s);
        ps.setString(i, s);
    }

    /**
     * 查询后的数据处理   根据列名获取返回结果
     */
    @Override
    public String getResult(ResultSet rs, String columnName) throws SQLException {
        String originRes = rs.getString(columnName);
        System.out.println("getResult:" + originRes);
        return originRes+"";
    }
    /**
     * 查询后的数据处理   根据列下标获取返回结果
     */
    @Override
    public String getResult(ResultSet rs, int columnIndex) throws SQLException {
        return null;
    }
    /**
     * 查询后的数据处理   根据列下标获取返回结果(存储过程)
     */
    @Override
    public String getResult(CallableStatement cs, int columnIndex) throws SQLException {
        return null;
    }
}

使用

<!-- 通用查询映射结果 -->
<resultMap id="BaseResultMap" type="">
    <id column="id" property="id" />
    <result column="name" property="name"/>
    <result column="age" property="age" typeHandler="com.example.demo.typeHandler.MyDateTypeHandler" />
</resultMap>

<!-- 新增 -->
<insert id="insertEncrypt">
    insert into account (id, name, age)
    values (#{id}, #{name}, #{age, typeHandler=com.example.demo.typeHandler.MyDateTypeHandler})
</insert>

check-config-location (spring boot专属)

指定启动时是否检查 MyBatis XML 文件的存在 默认不检查

mybatis-plus
    check-config-location: true #指定启动时是否检查 MyBatis XML 文件的存在
    

executor-type (spring boot专属)

指定 MyBatis 的执行器类型,包括 SIMPLE、REUSE 和 BATCH。

  • SIMPLE是默认执行器,根据对应的sql直接执行,不会做一些额外的操作。

  • REUSE 是重用执行器,可以重用预处理语句,可以提高批量操作的性能。

  • BATCH是批量执行器,可以批量执行sql,可以提高批量操作的性能。

     mybatis-plus
          executor-type: reuse  #指定 MyBatis 的执行器类型,包括 SIMPLE、REUSE 和 BATCH。
    

configuration-properties

指定 MyBatis 配置属性文件,用于抽离配置,实现不同环境的配置部署。

mybatis-plus
    configuration-properties: classpath:/mybatis-properties.properties #指定 MyBatis 配置属性文件,用于抽离配置。