Mybatis—plus新增插入后返回主键id

2021-11-26

想必很多人都有使用到数据的CRUD操作，为了维持各数据表之间的关系，总需要在插入数据后得到该条数据插入后的id，接下来这里将总结使用Mybatis-Plus如何快速的实现该功能。

添加依赖

进行spring Boot工程初始化后，除了添加 spring-boot-start 依赖、数据库 mysql-connector-java 依赖，还需添加 mybatis-plus-boot-starter 依赖

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

配置

配置application.yml文件，主要为连接数据库

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/testdb?useUnicode=true&characterEncoding=UTF-8&allowMultiQueries=TRUE&useJDBCCompliantTimezoneShift=true&serverTimezone=UTC
    username: root
    password: 123456
    driver-class-name: com.mysql.cj.jdbc.Driver
    type: com.alibaba.druid.pool.DruidDataSource

编码

接下来就是正式实现使用了

创建实体类

@Data
@TableName("label-info")
@AllArgsConstructor
@NoArgsConstructor
public class LabelInfo{

    @TableId(value = "id", type = IdType.AUTO)
    private Integer id;

    //标签名
    private String labelName;

    @TableField(fill = FieldFill.INSERT)
    private Date createTime;

    @TableField(fill = FieldFill.INSERT_UPDATE)
    private Date updateTime;

    @TableField(fill = FieldFill.INSERT_UPDATE)
    @Version
    private Integer version;

    @TableLogic
    @TableField(fill = FieldFill.INSERT)
    private Integer deleted;
}

创建Dao层

1
2
3

@Mapper
public interface LabelDao extends BaseMapper<LabelInfo>{
}

创建service层


@Service
@Transactional
public class LabelServiceImp() implements LabelService{

    @Autowired
    private LabelDao labelDao;

    public Integer inserBackId(){

        LabelInfo info = new LabelInfo();
        info.setLabelName("测试")

        int rec = labelDao.isnert(info);
        int id = info.getId();

        return rec == 1 ? id : 0;

    }
}

创建controller

@Controller
public class testController{

    @Autowired
    private LabelServiceImp labelService;

     //测试mp——insert后自动填充返回实体
    @RequestMapping("/insertBackId")
    public CommonResult testMpInsert(){
        int id = labelService.insertBackId();
        return CommonResult.success(id);
    }
}

使用postman测试接口

测试结果

原理及与 Mabitis 区别

许多人在解决该问题时将 使用Mybatis 原生方法 与使用 Mybatis-Plus 方法搞混了，使用mybatis方法，将Dao层的insert方法进行重写，映射到Mapper.xml文件中，使用自定义sql语句进行结果获取具体方法实现连接，该方法需要书写大量代码，同时也会出现不小心写错方法id、找错namespace的种种问题，如下为Mybatis方法sql部分：

<?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="cn.dao">

    <insert id="insertBack" parameterMap="cn.rmy.common.pojo.po.LabeInfo">
        INSERT INTO label_info (label_name, create_time, update_time)VALUES (#{labelName},#{createTime},#{updateTime})
        <selectKey resultType="java.lang.Integer" keyProperty="id" order="AFTER">
            SELECT LAST_INSERT_ID() AS id
        </selectKey>
    </insert>
</mapper>

与该方法相比，Mybatis-Plus 在插入实体类后，会自动将该条插入数据映射到形参(info)中，我们就可以通过getId()的方法直接拿到插入后数据在数据库中的id值，高效且方便。