当前位置：首页 > news >正文

SpringBoot中使用MyBatis-Plus详细介绍

news 来源：原创 2025/7/1 18:28:55

一、MyBatis-Plus的使用步骤

1.引入MybatisPlus的起步依赖

2.定义Mapper（也叫dao）层的接口

3.MyBatis-Plus中常用注解

4. 使用MyBatis-Plus时要做如下配置

5.条件构造器 Wrapper

一、MyBatis-Plus的使用步骤

1.引入MybatisPlus的起步依赖

MyBatisPlus官方提供了starter依赖包,其中集成了Mybatis和MybatisPlus的所有功能，并且实现了自动装配效果。
因此我们可以用MybatisPlus的starter直接代替Mybatis的starter:

<!--Mybatisplus-->
<dependency><groupId>com.baomidou</groupId><artifactId>mybatis-plus-boot-starter</artifactId><version>3.5.3.1</version>
</dependency>

2.定义Mapper（也叫dao）层的接口

用我们自定义的dao接口继承MybatisPlus提供的BaseMapper接口：

public interface UserMapper extends BaseMapper<User> {
}

在该接口中，提供了许多基本的sql增删改查方法，我们无需写sql语句，直接调用这些方法即可完成对数据的增删改查；

3.MyBatis-Plus中常用注解

MyBatisPlus会通过扫描实体类，并基于反射获取实体类的属性名称，然后匹配到数据库表中相应字段。具体关系如下图：

因此，我们在定义实体类和数据库表时，应该遵循MP中一些默认的约定（规范）来确保字段名和属性名正确的匹配到。约定如下：

类名：蛇峰转下刘线作为表名
名为id的属性：作为表中的主键
变量名：陀峰转下刘线作为表的字段名

如果在写Java代码时，我们某些代码不想符合上述三条约定的写法；也可以使用MP中的常见注解来自定义约定，如下：

4. 使用MyBatis-Plus时要做如下配置

（1）如果是在Spring Boot 工程中，要配置Mapper接口所在的包：在Spring Boot的启动类上添加@MapperScan注解，并指定Mapper接口所在的包路径。

@SpringBootApplication
@MapperScan("com.baomidou.mybatisplus.samples.quickstart.mapper")
public class Application {
public static void main(String[] args) {SpringApplication.run(Application.class, args);}

}

注意：在该例子中："com.baomidou.mybatisplus.samples.quickstart.mapper" 是 MyBatis-Plus 官方示例项目中的一个包路径，用于存放示例的 Mapper 接口。在实际应用中，你应该将 @MapperScan 注解中的字符串参数替换为你自己的项目中 Mapper 接口所在的包路径。

（2）在Spring MVC工程中使用MyBatis-Plus要做如下配置

①首先，在.xml配置文件中配置 MapperScan 注解：

<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer"><property name="basePackage" value="com.baomidou.mybatisplus.samples.quickstart.mapper"/>
</bean>

②然后，调整 SqlSessionFactory 为 MyBatis-Plus 的 SqlSessionFactory

<bean id="sqlSessionFactory" class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean"><property name="dataSource" ref="dataSource"/>
</bean>

③通常来说，一般的简单工程，通过以上配置即可正常使用 MyBatis-Plus，具体可参考以下链接： Spring Boot 快速启动示例 Spring Boot 快速启动示例，

Spring MVC 快速启动示例 Spring MVC 快速启动示例。

同时 MyBatis-Plus 提供了大量的个性化配置来满足不同复杂度的工程，大家可根据自己的项目按需取用，详细配置请参考链接：

使用配置https://baomidou.com/reference/

Spring Boot 配置

在 Spring Boot 项目中，可以通过 application.yml 或 application.properties 文件来配置 MyBatis-Plus。

yml配置文件中MyBatisPlus的配置项继承了MyBatis.原生配置和一些自己特有的配置。例如：

mybatis-plus:type-aliases-package: com.yzx.xxx.po #别名扫描包mapper-locations: "classpath*:/mapper/**/*,Xml" #Mapper.Xml文件地址configuration:map-underscore-to-camel-case: true #是否开启下划线和驼峰的映射cache-enabled: false #是否开启二级缓存global-config:db-config:id-type: assign_id #id为雪花算法生成update-strategy: not_null #设置更新策略：只更新非空字段

代码中globa-config下的配置表示全局其优先级小于实体类中注解的优先级。

如下图：

Spring MVC 配置

在传统的 Spring MVC 项目中，可以通过 XML 配置文件来配置 MyBatis-Plus。

<bean id="sqlSessionFactory" class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean"><property name="dataSource" ref="dataSource"/><property name="mapperLocations" value="classpath*:mapper/**/*.xml"/><property name="typeAliasesPackage" value="com.your.domain"/><!-- 其他配置 -->
</bean>

5.条件构造器 Wrapper

前提： BaseMapper接口中自带的增删改查方法都是通过数据的Id作为条件进行的；如果想要自定义查询条件则需要用到条件构造器：Wrapper

Wrapper类与其字类的继承关系如下：

Wrapper类中提供的，用于自定义构建查询条件的一些方法：

下面，我们以最常用的QueryWrapper（查询条件构造器）为例，来演示如何使用条件构造器来构造我们的sql查询

QueryWrapper（查询语句的条件构造器）：它拓展了select的功能，可以指定查找哪些字段：

使用方法：

首先，构造一个Wrapper对像，并通过该对象来编写查询条件
然后，将刚刚创建的Wrapper对象作为参数传入查询方法中

例如我们要进行一个如下的sql查询：

查询出名字中带o的，存款大于等于1000元的人的id、用户名（username）、信息（info）和收入（balance）

SQL语句如下：

SELECT id,username,info,balance
FROM user
WHERE username LIKE '%o%'
AND balance >= 1000;

用QueryWrapper（条件构造器）来实现上述SQL语句的代码如下：

@Test
public void testQuerywrapper(){//1.构建查询条件QueryWrapper<user> wrapper = new QueryWrapper<user>().select("id","username","info","balance").like("username","o").ge("balance",1000);//2.查询List<user> users = userMapper.selectList(wrapper);
}

条件构造器Wrapper中的函数所对应的sql语法，具体对应表如下：

另外：在 MyBatis-Plus 中的IService<T>接口是对service层的一个加强，继承了IService接口的service会自带一些方法：（感兴趣的小伙伴可以自行探索）

其中：save ()方法是一个非常重要的功能，它用于将实体对象保存到数据库中。具体地说，save 方法会根据实体对象的 ID（主键）来决定是执行插入（insert）操作还是更新（update）操作。

插入操作：如果传入的实体对象的 ID 为空（即该对象在数据库中尚不存在），save 方法会执行插入操作，将该对象插入到数据库中，并自动生成一个 ID（如果使用了自动增长的主键策略）。

更新操作：如果传入的实体对象的 ID 不为空（即该对象在数据库中已经存在），save 方法会执行更新操作，将该对象的属性更新到数据库中对应的记录上。这里需要注意的是，MyBatis-Plus 默认只会更新非空属性，即如果实体对象的某个属性为 null，则不会将该属性更新到数据库中（除非你进行了特殊的配置）。

一、MyBatis-Plus的使用步骤

1.引入MybatisPlus的起步依赖

2.定义Mapper（也叫dao）层的接口

3.MyBatis-Plus中常用注解

4. 使用MyBatis-Plus时要做如下配置

Spring Boot 配置

Spring MVC 配置

5.条件构造器 Wrapper

相关文章：