SpringBoot3整合mybatis-plus的实现
作者:黑猫kaherine
Mybatis简介
MyBatis-Plus是一个基于MyBatis的增强工具,它简化了与数据库的交互和操作。它提供了一系列的便利功能,可以减少编写重复的SQL代码和简化数据访问层的开发。
MyBatis-Plus的主要特点和功能:
- 代码生成器:MyBatis-Plus提供了一个代码生成器,可以根据数据库表结构自动生成实体类、Mapper接口和XML映射文件的代码,减少了手动编写重复的CRUD操作的工作量。
- 通用CRUD操作:MyBatis-Plus提供了一套通用的CRUD操作方法,包括插入、更新、删除和查询等,可以大大简化数据库操作的代码编写。
- 强大的查询构建器:MyBatis-Plus提供了一个灵活而强大的查询构建器,可以通过链式调用的方式构建复杂的查询条件,支持动态条件拼接和排序等操作。
- 分页查询支持:MyBatis-Plus内置了分页查询的支持,可以方便地进行分页查询操作。
- 逻辑删除支持:MyBatis-Plus支持逻辑删除,可以通过配置实现将删除操作转换为更新操作,便于数据的恢复和管理。
- 自动填充字段:MyBatis-Plus支持自动填充字段的功能,可以在插入和更新操作时自动填充指定的字段值,例如创建时间和更新时间等。
- 乐观锁支持:MyBatis-Plus提供了乐观锁的支持,可以通过版本号或时间戳等机制实现并发控制,避免数据冲突和并发更新问题。
快速入门
1、添加依赖
<!-- MySql驱动 --> <dependency> <groupId>com.mysql</groupId> <artifactId>mysql-connector-j</artifactId> <scope>runtime</scope> </dependency> <!-- MyBatisPlus --> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>3.5.3.1</version> </dependency>
2、添加配置
#mybatis mybatis-plus: mapper-locations: classpath*:/mapper/**/*.xml,classpath:/META-INF/modeler-mybatis-mappings/*.xml #实体扫描,多个package用逗号或者分号分隔 typeAliasesPackage: com.kopensoft.modules.*.entity global-config: #数据库相关配置 db-config: #主键类型 id-type: ASSIGN_ID banner: false spring: datasource: driver-class-name: com.mysql.cj.jdbc.Driver url: jdbc:mysql://localhost:3306/study?allowPublicKeyRetrieval=true&useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai&nullCatalogMeansCurrent=true username: root password: 123456
3、增加包扫描的注解
@MapperScan(basePackages = “com.kopensoft.modules.*.mapper”)
package com.kopensoft; import org.mybatis.spring.annotation.MapperScan; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; @MapperScan(basePackages = "com.kopensoft.modules.*.mapper") @SpringBootApplication public class KopensoftAdminApplication { public static void main(String[] args) { SpringApplication.run(KopensoftAdminApplication.class, args); } }
4、用户实例加测试
创建表
-- study.sys_user definition CREATE TABLE `sys_user` ( `id` int NOT NULL AUTO_INCREMENT, `username` varchar(100) DEFAULT NULL, `password` varchar(100) DEFAULT NULL, PRIMARY KEY (`id`), KEY `sys_user_id_IDX` (`id`) USING BTREE ) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci;
创建实体类
import com.baomidou.mybatisplus.annotation.IdType; import com.baomidou.mybatisplus.annotation.TableField; import com.baomidou.mybatisplus.annotation.TableId; import com.baomidou.mybatisplus.annotation.TableName; import lombok.Data; import nonapi.io.github.classgraph.json.Id; @TableName("sys_user") @Data public class UserEntity { @TableId(type = IdType.AUTO) // 主键ID,自增策略 private Long id; // 用户名 private String username; // 密码 private String pwd; }
MyBatis-Plus中常用的注解主要包括以下几种:
@TableName:用于指定实体类对应的数据库表名,可以在注解中设置表名。
@TableId:用于指定实体类中的字段作为主键,并指定主键生成策略。常用的主键生成策略包括:
IdType.AUTO
:自增主键。IdType.NONE
:无主键。IdType.INPUT
:手动输入主键。IdType.ID_WORKER
:全局唯一ID,数字类型。IdType.UUID
:全局唯一ID,字符串类型。
@TableField:用于指定实体类中的字段与数据库表中的字段的映射关系。常用的属性包括:
value
:指定数据库表中的字段名。exist
:指定该字段是否在数据库表中存在,默认为true。fill
:指定该字段是否为自动填充字段,默认为false。insertStrategy
:指定插入操作的填充策略。updateStrategy
:指定更新操作的填充策略。whereStrategy
:指定查询操作的填充策略。
@TableLogic:用于指定逻辑删除字段,标记该字段为逻辑删除字段。逻辑删除是通过修改字段的值来表示删除状态,而不是直接从数据库中删除记录。
@Version:用于乐观锁字段的标记,标记该字段为乐观锁字段。乐观锁是一种并发控制机制,通过比较字段的值来实现并发更新的控制。
@EnumValue:用于枚举类型字段的标记,标记该字段为枚举类型字段。
创建 mapper
import com.baomidou.mybatisplus.core.mapper.BaseMapper; import com.kopensoft.common.modules.security.entity.UserEntity; import org.apache.ibatis.annotations.Mapper; @Mapper public interface UserMapper extends BaseMapper<UserEntity> { }
MyBatis-Plus的BaseMapper是一个通用的Mapper接口,提供了一系列常用的数据库操作方法。通过继承BaseMapper接口,可以直接使用这些方法,无需手动编写SQL语句。
以下是BaseMapper接口的一些常用方法:
- insert:插入一条记录到数据库表中。
- deleteById:根据主键ID删除数据库表中的一条记录。
- updateById:根据主键ID更新数据库表中的一条记录。
- selectById:根据主键ID查询数据库表中的一条记录。
- selectList:查询数据库表中的所有记录。
- selectPage:分页查询数据库表中的记录。
- selectCount:查询数据库表中的记录总数。
- selectOne:根据条件查询数据库表中的一条记录。
- 除了上述常用方法,BaseMapper还提供了一些其他方法,如条件查询、批量操作、逻辑删除等,具体可以根据需求查看官方文档。
创建mapper对应的xml
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd"> <mapper namespace="com.kopensoft.modules.sys.mapper.UserMapper"> </mapper>
mapper对应的xml中常用标签
:XML文件的根元素,用于定义Mapper接口的映射配置。
:用于定义查询操作的映射关系。
id:查询操作的唯一标识符。
resultType:查询结果的映射类型,即返回的实体类类型。
parameterType:查询参数的映射类型,即传入的参数类型。
:用于动态拼接SQL语句的条件判断。
:用于循环遍历集合,并生成对应的SQL语句片段。
:用于定义插入操作的映射关系。
id:插入操作的唯一标识符。
parameterType:插入参数的映射类型,即传入的参数类型。
:用于获取插入操作生成的主键值。
:用于定义更新操作的映射关系。
id:更新操作的唯一标识符。
parameterType:更新参数的映射类型,即传入的参数类型。
:用于定义删除操作的映射关系。
id:删除操作的唯一标识符。
parameterType:删除参数的映射类型,即传入的参数类型。
:用于定义结果集的映射关系。
id:结果集的唯一标识符。
type:结果集的映射类型,即返回的实体类类型。
:用于定义字段与实体类属性的映射关系。
:用于定义可重用的SQL语句片段。
id:SQL片段的唯一标识符。
:用于引入可重用的SQL语句片段。
refid:引用的SQL片段的唯一标识符。
使用测试类测试一下
package com.kopensoft; import com.kopensoft.modules.sys.mapper.entity.UserEntity; import com.kopensoft.modules.sys.mapper.UserMapper; import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder; @SpringBootTest public class UserMapperTest { @Autowired private UserMapper userMapper; @Test public void testInsert() { BCryptPasswordEncoder encoder = new BCryptPasswordEncoder(); UserEntity user = new UserEntity(); user.setUsername("admin"); user.setPwd(encoder.encode("123456")); userMapper.insert(user); } }
使用Mybatis-Plus插件生成代码
https://baomidou.com/pages/ba5b24/
到此这篇关于SpringBoot3整合mybatis-plus的实现的文章就介绍到这了,更多相关SpringBoot整合mybatis-plus内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!
您可能感兴趣的文章:
- SpringBoot3.x版本与Mybatis-Plus不兼容问题
- springboot3集成mybatis-plus报sqlSession异常的问题解决
- SpringBoot3.2.2整合MyBatis Plus3.5.5的详细过程
- SpringBoot3.2.2整合MyBatis-Plus3.5.5依赖不兼容的问题解决
- SpringBoot3和mybatis-plus整合出现的问题解决办法
- 解决springboot3.2集成mybatis-plus3.5.4.1报错的问题
- springboot3.2整合mybatis-plus详细代码示例
- Springboot3整合Mybatis-plus3.5.3报错问题解决
- Spring Boot3整合Mybatis Plus的详细过程(数据库为MySQL)