跳至主要內容

Mybatis-Plus文档

李鹏军...大约 4 分钟开源教程文档

Mybatis-Plus文档

简介

MyBatis-Plus(简称 MP)是一个 MyBatis 的增强工具,在 MyBatis 的基础上只做增强不做改变,为简化开发、提高效率而生。

为什么使用MP

  • 无侵入:只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑
  • 损耗小:启动即会自动注入基本 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 操作智能分析阻断,也可自定义拦截规则,预防误操作

支持数据库

任何能使用 MyBatis 进行 CRUD, 并且支持标准 SQL 的数据库,具体支持情况如下,如果不在下列表查看分页部分教程 PR 您的支持。

  • MySQL,Oracle,DB2,H2,HSQL,SQLite,PostgreSQL,SQLServer,Phoenix,Gauss ,ClickHouse,Sybase,OceanBase,Firebird,Cubrid,Goldilocks,csiidb,informix,TDengine,redshift

  • 达梦数据库,虚谷数据库,人大金仓数据库,南大通用(华库)数据库,南大通用数据库,神通数据库,瀚高数据库,优炫数据库,星瑞格数据库

框架结构

/img/start/13/img.png
/img/start/13/img.png

使用步骤

添加依赖

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus</artifactId>
    <scope>3.5.3</scope>
</dependency>

XML配置

<!-- SqlSessionFactory MyBatisPlus Config -->
<bean id="sqlSessionFactory" class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean">
    <property name="typeAliasesPackage" value="com.platform.entity"/>
    <property name="dataSource" ref="dataSource"/>
    <property name="globalConfig">
        <bean class="com.baomidou.mybatisplus.core.config.GlobalConfig">
            <property name="dbConfig">
                <bean class="com.baomidou.mybatisplus.core.config.GlobalConfig.DbConfig">
                    <!-- 表关键词 key 生成器 -->
                    <property name="keyGenerators">
                        <bean class="com.baomidou.mybatisplus.extension.incrementer.OracleKeyGenerator"/>
                    </property>
                    <!-- 主键类型  0:"数据库ID自增", 1:"用户输入ID",2:"全局唯一ID (数字类型唯一ID)", 3:"全局唯一ID UUID"; -->
                    <property name="idType" value="AUTO"/>
                    <property name="capitalMode" value="true"/>
                    <!-- 逻辑删除配置 -->
                    <property name="logicDeleteField" value="isDelete"/>
                    <property name="logicDeleteValue" value="0"/>
                    <property name="logicNotDeleteValue" value="1"/>
                </bean>
            </property>
            <property name="banner" value="false"/>
        </bean>
    </property>
    <property name="configuration">
        <bean class="com.baomidou.mybatisplus.core.MybatisConfiguration">
            <!-- 是否开启自动驼峰命名规则(camel case)映射,即从A_COLUMN(下划线命名) 到Java 属性名 aColumn(驼峰命名) 的类似映射。 -->
            <property name="mapUnderscoreToCamelCase" value="true"/>
            <!-- 全局地开启或关闭配置文件中的所有映射器已经配置的任何缓存,默认为 true。 -->
            <property name="cacheEnabled" value="false"/>
            <!--指定当结果集中值为 null 的时候是否调用映射对象的 Setter(Map 对象时为 put)方法,通常运用于有 Map.keySet() 依赖或 null 值初始化的情况。
                通俗的讲,即 MyBatis 在使用 resultMap 来映射查询结果中的列,如果查询结果中包含空值的列,则 MyBatis 在映射的时候,不会映射这个字段,这就
                导致在调用到该字段的时候由于没有映射,取不到而报空指针异常。-->
            <property name="callSettersOnNulls" value="false"/>
            <!-- 配置JdbcTypeForNull, oracle数据库必须配置 -->
            <property name="jdbcTypeForNull" value="NULL"/>
            <property name="autoMappingUnknownColumnBehavior" value="WARNING"/>
        </bean>
    </property>
    <property name="plugins">
        <array>
            <bean class="com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor">
                <property name="interceptors">
                    <list>
                        <!-- 乐观锁 -->
                        <bean class="com.baomidou.mybatisplus.extension.plugins.inner.OptimisticLockerInnerInterceptor"/>
                    </list>
                </property>
            </bean>
        </array>
    </property>
</bean>

更多配置:https://baomidou.com/pages/56bac0/open in new window

MP官方文档

https://baomidou.com/open in new window