MyBatis-Plus教程

1、简介

Mybatis和Hibernate是项目中最常用的两个持久层框架，Hibernate封装的比较完整，可移植性高，而Mybatis仅仅是一个半自动的ORM框架，但是Myabtis更轻量化，灵活性更好，效率更高，可个性化定制，SQL优化相对简单，这也是很多公司为什么选择使用Mybatis，而不是Hibernate的原因，Hibernate已经逐渐被JPA替代，隐退至底层，而不是直接被使用。

使用Mybatis小伙伴的在嘲笑Hibernate臃肿的同时又羡慕人家面向对象操作的便捷，于是，基于Mybatis二次封装的框架应运而生，如TkMybatis、MyBatis-Plus，本文将主要介绍MyBatis-Plus的使用，MyBatis-Plus（简称 MP）是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生，提供了很多面向对象的操作方法。至于其特性和框架结构这里就不赘述了，可以详看官网（官网地址）。

2、与SpringBoot整合使用

划重点：
a.由于MyBatis-Plus更新频率比较快，而且部分版本变化较大，本文会根据官方的更新及时调整文章内容，确保内容的正确性。
b.引入 MyBatis-Plus 之后就不要再次引入 MyBatis 以及 MyBatis-Spring相关包，以避免因版本差异导致问题。

2.1 依赖

		<dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.1.1</version>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>

lombok依赖是为简化实体引入，非必须。
版本说明：使用SpringBoot 2.1.5.RELEAS、JDK1.8、MySQL数据库8.0.16

2.2 建表

先建一张表，这里建一张物流公司表

-- ----------------------------
-- Table structure for logistics
-- ----------------------------
DROP TABLE IF EXISTS `logistics`;
CREATE TABLE `logistics`  (
  `id` mediumint(6) NOT NULL AUTO_INCREMENT,
  `ecode` varchar(20) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '物流公司编码',
  `ename` varchar(200) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '物流公司名称',
  `short_name` varchar(50) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '物流公司简称',
  `logistics_type` varchar(50) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '电子面单物流类型',
  `mailno_regular` varchar(50) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '运单号正则表达式',
  `account_no` varchar(50) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '帐号',
  `password` varchar(50) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '密码',
  `pay_type` varchar(50) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '付款方式',
  `express_type` int(11) NULL DEFAULT NULL COMMENT '快件产品类型',
  `monthly_card_no` varchar(200) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '月结卡号',
  `weight_type` int(11) NULL DEFAULT NULL COMMENT '称重方式',
  `send_city_code` varchar(200) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '发货城市编号',
  `url` varchar(200) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '直连电子面单URL',
  `cainiao_url` varchar(200) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '菜鸟模板URL',
  `ad_org_id` bigint(20) NULL DEFAULT NULL COMMENT '所属组织',
  `isactive` char(1) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT 'Y' COMMENT '是否可用',
  `ad_client_id` bigint(20) NULL DEFAULT NULL COMMENT '所属公司',
  `ownerid` bigint(20) NULL DEFAULT NULL COMMENT '创建人id',
  `ownerename` varchar(50) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '创建人姓名',
  `ownername` varchar(50) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '创建人用户名',
  `creationdate` datetime(0) NULL DEFAULT CURRENT_TIMESTAMP(0) COMMENT '创建时间',
  `modifierid` bigint(20) NULL DEFAULT NULL COMMENT '修改人id',
  `modifierename` varchar(50) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '修改人姓名',
  `modifiername` varchar(50) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '修改人用户名',
  `modifieddate` datetime(0) NULL DEFAULT CURRENT_TIMESTAMP(0) COMMENT '修改时间',
  PRIMARY KEY (`id`) USING BTREE,
  INDEX `id`(`id`) USING BTREE COMMENT 'id'
) ENGINE = InnoDB CHARACTER SET = utf8 COLLATE = utf8_general_ci COMMENT = '物流公司档案' ROW_FORMAT = Dynamic;

SET FOREIGN_KEY_CHECKS = 1;

2.3 application.properties

server.port=9006
###########数据库连接信息###############
spring.datasource.driverClassName=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/test?serverTimezone=UTC&characterEncoding=utf-8
spring.datasource.username=root
spring.datasource.password=123456

2.4 实体类

既然是映射框架，肯定需要将表与实体类、表字段与实体属性一一对应。

@TableName(value = "logistics")
@Data
public class Logistics {

    @TableField(fill = FieldFill.INSERT)
    @TableId(value = "id", type = IdType.INPUT)
    private Long id;

    @TableField(value = "ecode")
    private String ecode;

    private String ename;

    private String shortName;

    private String logisticsType;

    private String mailnoRegular;

    private String accountNo;

    private String password;

    private String payType;

    private Integer expressType;

    private String monthlyCardNo;

    private Integer weightType;

    private String sendCityCode;

    private String url;

    private String cainiaoUrl;

    private Long adOrgId;

    private String isactive;

    private Long adClientId;

    private Long ownerid;

    private String ownerename;

    private String ownername;

    private Date creationdate;

    private Long modifierid;

    private String modifierename;

    private String modifiername;

    private Date modifieddate;
}

实体类注解说明：
（1）@TableName 表名注解，用来确立表和实体的关系
（2）@TableId 主键注解，这个不用多说，肯定是置于ID属性上了。
（3）@TableField 字段注解(非主键)，确立实体属性与表字段的关系。
如果和数据库表字段一致或者表字段使用了下划线，实体属性将下划线替换为大写，也就是驼峰，如is_delete对应isDelete，就可以省略该注解。因为我建的表字段都满足，因此全部省略。
属性可以比字段少，如果属性没有对应的表字段，应该使用注解的exist属性标识（是否为数据库表字段）。
字段为null的更不更新跟字段的策略有关，默认不更新。改变策略strategy=FieldStrategy.IGNORED，就会忽略null值的判断，null就会进行更新。
字段策略源码：

/**
 * 字段策略枚举类
 *
 * @author hubin
 * @since 2016-09-09
 */
public enum FieldStrategy {
    /**
     * 忽略判断
     */
    IGNORED,
    /**
     * 非NULL判断
     */
    NOT_NULL,
    /**
     * 非空判断(只对字符串类型字段,其他类型字段依然为非NULL判断)
     */
    NOT_EMPTY,
    /**
     * 默认的,一般只用于注解里
     * 
1. 在全局里代表 NOT_NULL
     * 
2. 在注解里代表 跟随全局
     */
    DEFAULT
}

（4）@Version 乐观锁注解、标记 @Verison 在字段上
（5）@EnumValue 通用枚举类注解(注解在枚举字段上)，这个会在后面详解。
（6）@TableLogic 表字段逻辑处理注解（逻辑删除）
（7）@SqlParser 租户注解
（8）@KeySequence 序列主键策略 oracle

2.5 使用1--------Mapper CRUD 接口

映射关系已经确立好了，只需要创建XXMapper 接口, 并继承 BaseMapper 接口。

@Mapper
public interface LogisticsMapper extends BaseMapper<Logistics> {
}

至此，我们就可以使用MyBatis-Plus封装的各种方法了。
注意：如果觉得在每个mapper接口上加一个@Mapper比较麻烦，可以选择去掉所有接口的注解，而在启动类上加上@MapperScan(“com.mybatisPlus.mapper”)进行统一扫描，value是mapper接口所在路径。

2.5.1 新增

@RunWith(SpringRunner.class)
@SpringBootTest
public class MybatisPlusApplicationTests {
    @Autowired
    private LogisticsMapper LogisticsMapper;

    @Test
    public void test025() {
        Logistics logistics = new Logistics();
        logistics.setEcode("123");
        logistics.setEname("顺丰快递");
        logistics.setShortName("SF");
        int insert = LogisticsMapper.insert(logistics);
    }
}

MybatisPlus会自动把当前插入对象在数据库中的id写回到该实体中，通过get方法得到id。
注入mapper接口，这里IDEA可能会报无法注入，这个不用管，属于误报。

2.5.2 修改

根据id修改

Logistics logistics = new Logistics();
logistics.setId(10L);
logistics.setEcode("123");
logistics.setEname("天天快递");
logistics.setShortName("TT");
int i = LogisticsMapper.updateById(logistics);

根据条件修改
将ename是“天天快递”的全部更新

 int update = LogisticsMapper.update(logistics, new UpdateWrapper().eq("ename", "天天快递"));

构造器说明：
xxxWrapper是条件构造器，可以构造不同的组合条件，下面是构造器的继承图，可以根据不同的场景选择不同的构造器：

构造器条件	说明
eq	等于 =
ne	不等于 <>
gt	大于 >
ge	大于等于 >=
lt	小于 <
le	小于等于 <=
between	BETWEEN 值1 AND 值2
notBetween	NOT BETWEEN 值1 AND 值2
like	LIKE ‘%值%’
notLike	NOT LIKE ‘%值%’
likeLeft	LIKE ‘%值’
likeRight	LIKE ‘值%’
isNull	字段 IS NULL
isNotNull	字段 IS NOT NULL
in / inSql	字段 IN (value.get(0), value.get(1), …)，例: in(“age”,{1,2,3})—>age in (1,2,3)
notIn / notInSql	字段NOT IN (value.get(0), value.get(1), …)
groupBy	分组：GROUP BY 字段, …
orderBy / orderByAsc	排序：ORDER BY 字段, … ASC
orderByDesc	排序：ORDER BY 字段, … DESC
having	HAVING ( sql语句 )
or	注意事项:主动调用or表示紧接着下一个方法不是用and连接!(不调用or则默认为使用and连接)
and	AND 嵌套
last	无视优化规则直接拼接到 sql 的最后
exists	拼接 EXISTS ( sql语句 )
notExists	拼接 NOT EXISTS ( sql语句 )
nested	正常嵌套 不带 AND 或者 OR 例: nested(i -> i.eq(“code”, “123”).ne(“status”, “1”))—>(code= ‘123’ and status <> ‘1’)

2.5.3 删除

根据id删除

int delete = LogisticsMapper.deleteById(10);

根据id集合批量删除

List list = new ArrayList<>();
list.add(1L);
list.add(2L);
int i = LogisticsMapper.deleteBatchIds(list);

根据条件删除—map构造条件

Map map = new HashMap<>();
map.put("ecode", 123);
map.put("ename", "顺丰");
int delete = LogisticsMapper.deleteByMap(map);

注意：map构造的条件之间是and的关系，并且key是表中的字段名，而不是属性名。
根据条件删除—Wrapper构造器（不常用）

 int delete = LogisticsMapper.delete(new Wrapper<Logistics>() {
            @Override
            public Logistics getEntity() {
                Logistics logistics = new Logistics();
                logistics.setEcode("123");
                logistics.setEname("中通");
                return logistics;
            }

            @Override
            public MergeSegments getExpression() {
                //合并 SQL 片段
                return null;
            }

            @Override
            public String getCustomSqlSegment() {
                return null;
            }

            @Override
            public String getSqlSegment() {
                return null;
            }
        });

2.5.4 查询

根据id查询，返回一个实体；

T selectById(Serializable id)

根据id集批量查询，返回实体集；

List selectBatchIds(idList)

根据map构造条件查询，注意是and关系；

List selectByMap(columnMap);

根据Wrapper条件构造器查询，返回实体，要确保结果唯一，否则会抛出异常；

T selectOne(@Param(Constants.WRAPPER) Wrapper queryWrapper);

根据Wrapper条件构造器查询记录数；

Integer selectCount(@Param(Constants.WRAPPER) Wrapper queryWrapper);

根据Wrapper条件构造器查询，返回实体集；

List selectList(@Param(Constants.WRAPPER) Wrapper queryWrapper);

根据Wrapper条件构造器查询，返回字段映射对象 Map 集合

List> selectMaps(@Param(Constants.WRAPPER) Wrapper queryWrapper);

根据Wrapper条件构造器查询，返回第一个字段的值集合，如表第一个字段是id，那就返回id集合；

List