# 一、项目创建可以选择SpringIntializr创建也可以使用Maven方式创建 ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/953ca911c86e477aa355f8e0e5fc8c92~tplv-k3u1fbpfcp-zoom-1.image) 选好之后点击下一步这里只需要选中最基本的依赖项，后续依赖我们会在pom.xml中引入 ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/5bf9caca2653409b865d492bc64a3cea~tplv-k3u1fbpfcp-zoom-1.image) # 二、引入依赖 spring Initializr创建项目需要在pom.xml文件的标签中添加如下依赖 ``` mysql mysql-connector-java org.projectlombok lombok com.baomidou mybatis-plus-boot-starter 3.4.2 ``` 如果是Maven方式创建项目，若想使用SpringBoot还需添加SpringBoot相关依赖 ``` 4.0.0 org.springframework.boot spring-boot-starter-parent 2.7.0 com.example MybatisPlus-Demo 0.0.1-SNAPSHOT MybatisPlus-Demo MybatisPlus-Demo 1.8 org.springframework.boot spring-boot-starter-web org.springframework.boot spring-boot-starter-test test mysql mysql-connector-java org.projectlombok lombok com.baomidou mybatis-plus-boot-starter 3.4.2 org.springframework.boot spring-boot-maven-plugin ``` # 三、创建数据库及引入数据库 ## 1. 创建数据库若已经有数据库则跳过至步骤二我这里使用的是Navicat创建数据库 ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/e6610e5e6ff64597bcbbae62abba9f22~tplv-k3u1fbpfcp-zoom-1.image) 完成数据库创建后添加数据表 ``` -- 判断要创建的表名称是否已经存在 DROP TABLE IF EXISTS student; CREATE TABLE student( 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 '邮箱', -- 设置id主键 PRIMARY KEY (id), -- 在id字段创建普通索引 index(id) ); -- 插入数据 INSERT INTO student (id, name, age, email) VALUES (1001, 'Jone', 18, 'test1@baomidou.com'), (1002, 'Jack', 20, 'test2@baomidou.com'), (1003, 'Tom', 28, 'test3@baomidou.com'), (1004, 'Sandy', 21, 'test4@baomidou.com'), (1005, 'Billie', 24, 'test5@baomidou.com'); ``` 创建表时详细索引参考->[文档地址](https://blog.51cto.com/u_15311900/3179585) ## 2. 引入数据库 ### 2.1 连接数据库数据库连接语句在resource资源目录下的application.properties文件中书写 ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/c32fc1b29112437a9a4ae0458eb2ee06~tplv-k3u1fbpfcp-zoom-1.image) 在MySQL8.0版本后，连接语句发生了变化（[相关文档](https://blog.csdn.net/weixin_54738777/article/details/121543231)）。 MySQL8.0版本后的语句书写 ``` # 数据库连接配置 spring.datasource.username=root spring.datasource.password=root spring.datasource.url=jdbc:mysql://localhost:3306/mybatisPlus_demo?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8 spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver # 配置日志 sql语句在执行时不可见，所以为了便于错误排查，需要通过日志打印语句。 mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl 注意：如果你是5.*数据库版本，就需要将com.mysql.cj.jdbc.Driver改为：com.mysql.jdbc.Driver。 ``` ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/947fe3038d6048ce9ca26c2e3948e3b2~tplv-k3u1fbpfcp-zoom-1.image) yml文件书写语句 ``` server: port: 8080 spring: application: name: mybatis-plus datasource: url: jdbc:mysql://www.xlz.com/mybatis-plus? useEncoding=utf8mb4&serverTimezone=Asia/Shanghai&useSSL=false username: root password: 123456 driver-class-name: com.mysql.cj.jdbc.Driver ``` # 四、自动创建对应实体类及接口和xml文件 ##### 1 在idea中引入数据源 ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/979df1b9b5f541d4aea919a73c8f523e~tplv-k3u1fbpfcp-zoom-1.image) 进入数据源后填写相关信息，点击下方测试链接通过后，点击确定按钮 ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/b6074d131a9c440597df63b54c72b44c~tplv-k3u1fbpfcp-zoom-1.image) ##### 2 使用Mybatis-generator自动创建在导入完数据源后，找到要映射的数据表。右键选择**mybatis-generator**选项 ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/60afe90f9862401ca5a9c69620c0a9b8~tplv-k3u1fbpfcp-zoom-1.image) 进入**mybatis-generate tool，填写对应信息** ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/fbf72f91843246caacec352c78b0da0c~tplv-k3u1fbpfcp-zoom-1.image) 点击ok后，在指定路径总计生成三个文件（文件因路径不同，生成位置不同）。至此自动配置完成。 ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/d32b1ce03b4a4ddbbc042d3c42c48e37~tplv-k3u1fbpfcp-zoom-1.image) \ **也可以使用语句生成** [代码生成器（旧） | MyBatis-Plus](https://baomidou.com/pages/d357af/) # 五、接口测试一般创建SpringBoot项目中有内置Junit5的，这时可以通过使用快捷键**alt+Insert**快捷生成测试 ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/94b894ec99274c31b7a19a6da072e804~tplv-k3u1fbpfcp-zoom-1.image) 书写如下代码，测试是否有数据输出。 ``` @SpringBootTest class StudentMapperTest{ @Autowired StudentMapper studentMapper; @Test void selectByPrimaryKey (){ Student student = studentMapper.selectByPrimaryKey (1001L); System.out.println (student); } } ``` # 六、日志打印日志主要体现在当运行程序的时候，将会在控制台将会打印日志信息使用在 application.[xml](https://so.csdn.net/so/search?q=xml&spm=1001.2101.3001.7020) 文件中加入 ``` mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl ``` \ # 七、MybatisPlus常用注解 ## 7.1 @MapperScan **作用：** 为了集成Spring而写的注解，该注解主要是扫描某个包目录下的Mapper，将Mapper接口类交给Spring进行管理。 **使用位置：** 在Springboot启动类上添加 **示例：** ``` @SpringBootApplication @MapperScan("com.example.mybatisplusdemo") public class MybatisPlusDemoApplication{ public static void main (String[] args){ SpringApplication.run (MybatisPlusDemoApplication.class , args); } } ``` ## 7.2 @Mapper **作用：** 在接口类上添加了@Mapper，在运行时会生成相应的接口实现类，这个要一个一个去加，不如用@MapperScan全部扫描添加\ **添加位置：** 接口类上面 **示例：** ``` @Mapper public interface StudentMapper extends BaseMapper{ ... } ``` ## 7.3 @TableName **作用：** 用于标识实体类对应的表名 **添加位置：** 实体类之上 **示例：** ``` @TableName("user") public class User { ... } ``` ## 7.4 @Data **作用：** 简化开发，使用这个注解，就可以省略getter()、setter()、toString()、重写该类的equals()和hashCode()方法 **使用位置：** 实体类之上 **示例：** ``` @Data public class User { ... } ``` ## 7.5 @TableId **作用：** 用于标识主键列，MyBatis-Plus在实现增删改查时，会默认将id作为主键列，在插入数据时，若对应字段为空，则默认使用基于雪花算法的策略生成id。当使用@TableId(value = "id")语句时，若实体类和表中表示主键的不是id，而是其他字段，例如代码中的uid，MyBatis-Plus会自动识别uid为主键列，否则就会报错。当使用@TableId(value = "id",type = IdType.AUTO)语句时，代表着使用数据库的自增策略，注意，该类型请确保数据库设置了id自增，否则无效！ @TableId的功能，也可以写在application.yml配置文件中，配置如下： ``` mybatis-plus: global-config: banner: false db-config: # 配置MyBatis-Plus操作表的默认前缀 table-prefix: "t_" # 配置MyBatis-Plus的主键策略 id-type: auto # 配置MyBatis日志 configuration: log-impl: org.apache.ibatis.logging.stdout.StdOutImpl ``` **使用位置：** 主键映射字段之上示例： ``` /** * student * @author */ @Data @TableName("mybatisplus_demo") public class Student implements Serializable { /** * 主键ID,学号 */ @TableId(value = "id",type = IdType.AUTO ) private Long id; } ``` ## 7.6 @TableField **作用：** 用于保证实体类中的属性名与数据表中字段名一致。 **注：** 若实体类中的属性使用的是驼峰命名风格，而表中的字段使用的是下划线命名风格。例如实体类属性userName，表中字段user_name，此时MyBatis-Plus会自动将下划线命名风格转化为驼峰命名风格 **若实体类中的属性和表中的字段不满足上述条件**，例如实体类属性name，表中字段username，此时需要在实体类属性上使用@TableField("username")设置属性所对应的字段名 **使用位置：** 实体类除主键字段外其他映射字段之上 ``` @Data @TableName("mybatisplus_demo") public class Student implements Serializable { /** * 主键ID,学号 */ @TableId(value = "id",type = IdType.AUTO ) private Long id; /** * 姓名 */ @TableField(value = "name") private String name; } ``` ## 7.7 @TableLogic **作用：** 逻辑删除，并不会永久删除数据，实体类加上这个注解再执行删除方法的时候会变成修改。前台再根据所加注解字段进行显隐即可达到逻辑删除效果。 ``` @Data @TableName("mybatisplus_demo") public class Student implements Serializable { /** * 主键ID,学号 */ @TableId(value = "id",type = IdType.AUTO ) private Long id; /* 删除标识 @TableLogic(value=“原值”,delval=“修改值”) 注解参数 value = “” 未删除的值，默认值为0 delval = “” 删除后的值，默认值为1 */ @TableField(value = "del") @TableLogic(value = "0",delval = "1") private Integer del; } ``` \ 调用BaseMapper的deleteById(id)或者调用IService的removeById(id) ``` 效果: 没有@TableLogic注解调用deleteById/removeById,直接删除数据。 SQL:delete from table where id = 1 有注解走Update方法 SQL：Update table set isDelete = 1 where id = 1 ``` \ ## 7.8 @Param 作用：用于标识传入参数的名称使用位置：形参列表 **示例：** ``` @Mapper public interface StudentMapper extends BaseMapper{ int insert(@Param (value = "record") Student record); } ``` 与之对应的XML文件就可以使用${record}变量 ## 7.9 @Version **作用：** 可以在实体 bean 中使用@Version 注解，通过这种方式可添加对乐观锁定的支持，一个类中只能有一个@Version注解。 | 不可选属性 | String | | | | ----- | ------ | ------- | ---- | | 可选属性 | int | Integer | Long | ``` @Data @TableName("mybatisplus_demo") public class Student implements Serializable { /** * 主键ID,学号 */ @TableId(value = "id",type = IdType.AUTO ) private Long id; /** * 版本号 */ @Version (value = "version") private int version; } ``` ## 7.10 @EnumValue 和 JsonValue **@JsonValue**\ 可以用在get方法或者属性字段上，一个类只能用一个，当加上@JsonValue注解时，该类的json化结果，只有这个get方法的返回值，而不是这个类的属性键值对. **案例：** 男，女，后台存储的是1，2，前端展示的是男女 **第一步：** 创建枚举类，在需要存储数据库的属性上添加 **@EnumValue**注解，在需要前端展示的属性上添加 **@JsonValue**注解； ``` package com.demo.mybatisplus.constant; import com.baomidou.mybatisplus.annotation.EnumValue; import com.fasterxml.jackson.annotation.JsonValue; public enum SexEnum { MAN(1, "男"), WOMAN(2, "女"); @EnumValue private Integer key; @JsonValue private String display; SexEnum(Integer key, String display) { this.key = key; this.display = display; } public Integer getKey() { return key; } public String getDisplay() { return display; } } ``` **第二步：** **application.properties**文件里添加配置，定义扫描枚举类的包路径； ``` #配置枚举支持通配符 * 或者 ; 分割 mybatis-plus.type-enums-package=com.demo.mybatisplus.constant #mybatis-plus.configuration.default-enum-type-handler=org.apache.ibatis.type.EnumOrdinalTypeHandler ``` **application.yml**则配置 ``` #配置枚举支持通配符 * 或者 ; 分割 mybatis-plus: type-enums-package: com.demo.mybatisplus.constant configuration: default-enum-type-handler: org.apache.ibatis.type.EnumOrdinalTypeHandler ``` **第三步：** pojo中的sex属性设置为枚举SexEnum； ``` @ApiModelProperty(value = "性别") @TableField("sex") private SexEnum sex; ``` 测试： ``` @Test public void insert() { UserInfo userInfo = new UserInfo(); userInfo.setAge(22); userInfo.setName("李四"); userInfo.setSex(SexEnum.WOMAN); userInfoMapper.insert(userInfo); System.out.println(userInfo); } ``` 注意事项： 1. @EnumValue标记的枚举类属性的类型要和数据库字段的类型对应，否则在查询数据的时候无法转化为枚举类型，并显示为null； 1. 如果查询的时候，数据库字段的值匹配不到枚举，程序运行时并不会报错，而是显示为null； 1. 在保存的时候，前端需要传递@JsonValue标记的枚举类属性的值，即"男/女"；因为Enum的属性ordinal(int)，在测试过程中，传枚举值在枚举类中的定义顺序(或者称为索引，顺序从0开始)，也可以转换为相应的枚举值，比如：上面定义的SexEnum枚举，前端传0或者"0"，会转换成MAN，传1或者"1"会转换成WOMAN；传其他值会报异常：com.fasterxml.jackson.databind.exc.InvalidFormatException: Cannot deserialize value of type com.demo.mybatisplus.constant.SexEnum from String "3": not one of the values accepted for Enum class: [女, 男]或com.fasterxml.jackson.databind.exc.InvalidFormatException: Cannot deserialize value of type com.demo.mybatisplus.constant.SexEnum from number 3: index value outside legal index range [0..2]； # 八、MybatisPlus常用方法 ## 8.1 条件构造器 Wrapper \ ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/1500775677fa4543b1e677970c2daf9e~tplv-k3u1fbpfcp-zoom-1.image) 介绍： - 上图绿色框为抽象类abstract - 蓝色框为正常class类，可new对象 - 黄色箭头指向为父子类关系，箭头指向为父类 wapper介绍： - Wrapper ：条件构造抽象类，最顶端父类，抽象类中提供4个方法西面贴源码展示 - AbstractWrapper ：用于查询条件封装，生成 sql 的 where 条件 - AbstractLambdaWrapper ： Lambda 语法使用 Wrapper统一处理解析 lambda 获取 column。 - LambdaQueryWrapper ：看名称也能明白就是用于Lambda语法使用的查询Wrapper - LambdaUpdateWrapper ： Lambda 更新封装Wrapper - QueryWrapper ： Entity 对象封装操作类，不是用lambda语法 - UpdateWrapper ： Update 条件封装，用于Entity对象更新操作 ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/5506e181f61a401287dde67c6e8fa899~tplv-k3u1fbpfcp-zoom-1.image) \ 常用条件 ### 比较大小： (=,<>,>,>=,<,<=) ``` eq(R column, Object val); // 等价于 =，例: eq("name", "老王") ---> name = '老王' ne(R column, Object val); // 等价于 <>，例: ne("name", "老王") ---> name <> '老王' gt(R column, Object val); // 等价于 >，例: gt("name", "老王") ---> name > '老王' ge(R column, Object val); // 等价于 >=，例: ge("name", "老王") ---> name >= '老王' lt(R column, Object val); // 等价于 <，例: lt("name", "老王") ---> name < '老王' le(R column, Object val); // 等价于 <=，例: le("name", "老王") ---> name <= '老王' ``` ### 范围：（between、not between、in、not in） ``` between(R column, Object val1, Object val2); // 等价于 between a and b, 例： between("age", 18, 30) ---> age between 18 and 30 notBetween(R column, Object val1, Object val2); // 等价于 not between a and b, 例： notBetween("age", 18, 30) ---> age not between 18 and 30 in(R column, Object... values); // 等价于字段 IN (v0, v1, ...),例: in("age",{1,2,3}) ---> age in (1,2,3) notIn(R column, Object... values); // 等价于字段 NOT IN (v0, v1, ...), 例: notIn("age",{1,2,3}) ---> age not in (1,2,3) inSql(R column, Object... values); // 等价于字段 IN (sql 语句), 例: inSql("id", "select id from table where id < 3") ---> id in (select id from table where id < 3) notInSql(R column, Object... values); // 等价于字段 NOT IN (sql 语句) ``` ### 模糊匹配：（like） ``` // 等价于 LIKE '%值%'，例: like("name", "王") ---> name like '%王%' like(R column, Object val); // 等价于 NOT LIKE '%值%'，例: notLike("name", "王") ---> name not like '%王%' notLike(R column, Object val); // 等价于 LIKE '%值'，例: likeLeft("name", "王") ---> name like '%王' likeLeft(R column, Object val); // 等价于 LIKE '值%'，例: likeRight("name", "王") ---> name like '王%' likeRight(R column, Object val); ``` ### 空值比较：（isNull、isNotNull） ``` isNull(R column); // 等价于 IS NULL，例: isNull("name") ---> name is null isNotNull(R column); // 等价于 IS NOT NULL，例: isNotNull("name") ---> name is not null ``` ### 分组、排序：（group、having、order） ``` groupBy(R... columns); // 等价于 GROUP BY 字段, ...，例: groupBy("id", "name") ---> group by id,name orderByAsc(R... columns); // 等价于 ORDER BY 字段, ... ASC，例: orderByAsc("id", "name") ---> order by id ASC,name ASC orderByDesc(R... columns); // 等价于 ORDER BY 字段, ... DESC，例: orderByDesc("id", "name") ---> order by id DESC,name DESC having(String sqlHaving, Object... params); // 等价于 HAVING ( sql语句 )，例: having("sum(age) > {0}", 11) ---> having sum(age) > 11 ``` ### 拼接、嵌套 sql：（or、and、nested、apply） ``` or(); // 等价于 a or b，例：eq("id",1).or().eq("name","老王") ---> id = 1 or name = '老王' or(Consumer consumer); // 等价于 or(a or/and b)，or 嵌套。例: or(i -> i.eq("name", "李白").ne("status", "活着")) ---> or (name = '李白' and status <> '活着') and(Consumer consumer); // 等价于 and(a or/and b)，and 嵌套。例: and(i -> i.eq("name", "李白").ne("status", "活着")) ---> and (name = '李白' and status <> '活着') nested(Consumer consumer); // 等价于 (a or/and b)，普通嵌套。例: nested(i -> i.eq("name", "李白").ne("status", "活着")) ---> (name = '李白' and status <> '活着') apply(String applySql, Object... params); // 拼接sql（若不使用 params 参数，可能存在 sql 注入），例: apply("date_format(dateColumn,'%Y-%m-%d') = {0}", "2008-08-08") ---> date_format(dateColumn,'%Y-%m-%d') = '2008-08-08'") last(String lastSql); // 无视优化规则直接拼接到 sql 的最后，可能存若在 sql 注入。 exists(String existsSql); // 拼接 exists 语句。例: exists("select id from table where age = 1") ---> exists (select id from table where age = 1) ``` ### QueryWrapper 条件： ``` select(String... sqlSelect); // 用于定义需要返回的字段。例： select("id", "name", "age") ---> select id, name, age select(Predicate predicate); // Lambda 表达式，过滤需要的字段。 lambda(); // 返回一个 LambdaQueryWrapper ``` ### UpdateWrapper 条件： ```` set(String column, Object val); // 用于设置 set 字段值。例: set("name", null) ---> set name = null etSql(String sql); // 用于设置 set 字段值。例: setSql("name = '老李头'") ---> set name = '老李头' lambda(); // 返回一个 LambdaUpdateWrapper``` ```` ## 8.2 Page<>类属性源码 ``` public class Page implements IPage { private static final long serialVersionUID = 8545996863226528798L; // 用来存放查询出来的数据 protected List records; // 返回记录的总数 protected long total; // 每页显示条数，默认 10 protected long size; // 当前页,默认1 protected long current; // 排序字段信息 protected List orders; // 自动优化 COUNT SQL,默认true protected boolean optimizeCountSql; // 是否进行 count 查询,默认true protected boolean isSearchCount; // 是否命中count缓存,默认false protected boolean hitCount; protected String countId; protected Long maxLimit; } ``` \ ## 8.3 mapper层（接口定义层）可以用BaseMapper<> 例如 ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/ebccb0d1f978437b91e94a0aa8f4de0e~tplv-k3u1fbpfcp-zoom-1.image) ### 内部方法总览 ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/595d12b74afd47dbb324b4a920996ea8~tplv-k3u1fbpfcp-zoom-1.image) ### 方法详细介绍 #### 汇总 ``` 【添加数据：（增）】 int insert(T entity); // 插入一条记录注： T 表示任意实体类型 entity 表示实体对象【删除数据：（删）】 int deleteById(Serializable id); // 根据主键 ID 删除 int deleteByMap(@Param(Constants.COLUMN_MAP) Map columnMap); // 根据 map 定义字段的条件删除 int delete(@Param(Constants.WRAPPER) Wrapper wrapper); // 根据实体类定义的条件删除对象 int deleteBatchIds(@Param(Constants.COLLECTION) Collection idList); // 进行批量删除注： id 表示主键 ID columnMap 表示表字段的 map 对象 wrapper 表示实体对象封装操作类，可以为 null。 idList 表示主键 ID 集合（列表、数组），不能为 null 或 empty 【修改数据：（改）】 int updateById(@Param(Constants.ENTITY) T entity); // 根据 ID 修改实体对象。 int update(@Param(Constants.ENTITY) T entity, @Param(Constants.WRAPPER) Wrapper updateWrapper); // 根据 updateWrapper 条件修改实体对象注： update 中的 entity 为 set 条件，可以为 null。 updateWrapper 表示实体对象封装操作类（可以为 null,里面的 entity 用于生成 where 语句）【查询数据：（查）】 T selectById(Serializable id); // 根据主键 ID 查询数据 List selectBatchIds(@Param(Constants.COLLECTION) Collection idList); // 进行批量查询 List selectByMap(@Param(Constants.COLUMN_MAP) Map columnMap); // 根据表字段条件查询 T selectOne(@Param(Constants.WRAPPER) Wrapper queryWrapper); // 根据实体类封装对象查询一条记录 Integer selectCount(@Param(Constants.WRAPPER) Wrapper queryWrapper); // 查询记录的总条数 List selectList(@Param(Constants.WRAPPER) Wrapper queryWrapper); // 查询所有记录（返回 entity 集合） List> selectMaps(@Param(Constants.WRAPPER) Wrapper queryWrapper); // 查询所有记录（返回 map 集合） List