MybatisPlus介绍以及整合SpringBoot

·  阅读 732

一、MP介绍

1、简述

MybatisPlus在Mybatis的基础上只做增强,不做改变,就像是魂斗罗中的红人和蓝人一样。

官方的介绍:为简化开发而生

2、MP的特性

3、支持的数据库

  • mysql 、 mariadb 、 oracle 、 db2 、 h2 、 hsql 、 sqlite 、 postgresql 、 sqlserver 、 presto
  • 达梦数据库 、 虚谷数据库 、 人大金仓数据库

二、MybatisPlus简单使用

1、引入Maven依赖

2、编写application.yml文件

3、编写实体类User

  • 这里使用了lombok,简化了get,set,构造

  • @TableName注解:指定实体类对应的表名,一般在核心配置文件中添加

    mybatis-plus: global-config: db-config: table-prefix: tb_

@TableId注解:设置id生成策略。

@Data
@NoArgsConstructor
@AllArgsConstructor
@TableName("tb_user")
public class User {
    @TableId(type = IdType.AUTO)
    private Long id;
    private String userName;
    @TableField(select = false)//查询时不返回该字段值
    private String password;
    private String name;
    private Integer age;
    @TableField(value = "email")//指定数据库表中字段名
    private String mail;
    @TableField(exist = false)
    private String address;//数据库表中不存在
}
复制代码

4、编写Mapper持久层,这里继承BaseMapper<实体类>

@Repository
public interface UserMapper extends BaseMapper<User> {
}
复制代码

这里和SpringDataJpa类似,只是不需要再传入主键类型

可以看下BaseMapper中的方法:不得不说国人的的插件就是好用,注释都是中文,不用担心看不懂了

public interface BaseMapper<T> extends Mapper<T> {
    /**
     * 插入一条记录
     *
     * @param entity 实体对象
     */
    int insert(T entity);
    /**
     * 根据 ID 删除
     *
     * @param id 主键ID
     */
    int deleteById(Serializable id);
    /**
     * 根据 columnMap 条件,删除记录
     *
     * @param columnMap 表字段 map 对象
     */
    int deleteByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);
    /**
     * 根据 entity 条件,删除记录
     *
     * @param wrapper 实体对象封装操作类(可以为 null)
     */
    int delete(@Param(Constants.WRAPPER) Wrapper<T> wrapper);
    /**
     * 删除(根据ID 批量删除)
     *
     * @param idList 主键ID列表(不能为 null 以及 empty)
     */
    int deleteBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);
    /**
     * 根据 ID 修改
     *
     * @param entity 实体对象
     */
    int updateById(@Param(Constants.ENTITY) T entity);
    /**
     * 根据 whereEntity 条件,更新记录
     *
     * @param entity        实体对象 (set 条件值,可以为 null)
     * @param updateWrapper 实体对象封装操作类(可以为 null,里面的 entity 用于生成 where 语句)
     */
    int update(@Param(Constants.ENTITY) T entity, @Param(Constants.WRAPPER) Wrapper<T> updateWrapper);
    /**
     * 根据 ID 查询
     *
     * @param id 主键ID
     */
    T selectById(Serializable id);
    /**
     * 查询(根据ID 批量查询)
     *
     * @param idList 主键ID列表(不能为 null 以及 empty)
     */
    List<T> selectBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);
    /**
     * 查询(根据 columnMap 条件)
     *
     * @param columnMap 表字段 map 对象
     */
    List<T> selectByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);
    /**
     * 根据 entity 条件,查询一条记录
     *
     * @param queryWrapper 实体对象封装操作类(可以为 null)
     */
    T selectOne(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
    /**
     * 根据 Wrapper 条件,查询总记录数
     *
     * @param queryWrapper 实体对象封装操作类(可以为 null)
     */
    Integer selectCount(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
    /**
     * 根据 entity 条件,查询全部记录
     *
     * @param queryWrapper 实体对象封装操作类(可以为 null)
     */
    List<T> selectList(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
    /**
     * 根据 Wrapper 条件,查询全部记录
     *
     * @param queryWrapper 实体对象封装操作类(可以为 null)
     */
    List<Map<String, Object>> selectMaps(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
    /**
     * 根据 Wrapper 条件,查询全部记录
     * <p>注意: 只返回第一个字段的值</p>
     *
     * @param queryWrapper 实体对象封装操作类(可以为 null)
     */
    List<Object> selectObjs(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
    /**
     * 根据 entity 条件,查询全部记录(并翻页)
     *
     * @param page         分页查询条件(可以为 RowBounds.DEFAULT)
     * @param queryWrapper 实体对象封装操作类(可以为 null)
     */
    IPage<T> selectPage(IPage<T> page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
    /**
     * 根据 Wrapper 条件,查询全部记录(并翻页)
     *
     * @param page         分页查询条件
     * @param queryWrapper 实体对象封装操作类
     */
    IPage<Map<String, Object>> selectMapsPage(IPage<T> page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
}
复制代码

5、编写测试类,测试下CRUD操作

@RunWith(SpringRunner.class)
@SpringBootTest
public class TestUserMapper {
    @Autowired
    private UserMapper userMapper;
    @Test
    public void testInsert() {
        User user = new User();
        user.setMail("123@qq.com");
        user.setAge(12);
        user.setName("张三123");
        user.setPassword("123");
        user.setUserName("zahngsan");
        int insert = this.userMapper.insert(user);
        System.out.println(insert);
        //获取自增长后的id值
        System.out.println(user.getId());
    }
    @Test
    public void testSelectById() {
        User user = this.userMapper.selectById(1L);
        System.out.println(user);
    }
复制代码

小结:

1、新增:

使用insert()方法,传入实体类对象,结果返回受影响的行数,新增成功后会将新增后的数据重新封装到user对象中,可以直接获取自增长后的id值

2、删除:

这里有MP提供了4种删除方法

delete(Wrapper wrapper): 根据wrapper中设定的条件来删除

deleteBatchIds:根据id批量删除数据

deleteById:根据id删除

deleteByMap:根据map删除数据,多条件之间是and关系

3、修改:

update:传入User实体和wrapper规则,进行修改

upateById:传入user实体,根据实体中的id进行删除

4、查询

  • selectList:根据传入的wrapper规则进行查询
  • selectPage:根据传入的Ipage对象,wrapper规则进行分页查询
  • selectOne:根据传入的查询条件,返回单个对象
  • selectBatchIds:根据传入的ids,进行id批量查询
  • selectById:根据传入的id,返回单个对象

三:MybatisPlus的高级整合

1、分页

1.1、简单分页

有了MP自带的分页插件,再也不用自己写limit业务逻辑了,让分页变得更简单,只需要关注数据即可

分页使用selectPage方法,传入Page对象和查询的条件

Page类的构造方法参数:current:当前页数,size:页大小

1.2、分页+排序

排序时只需要在wrapper中定义排序规则即可

2、排序

排序时只需要在wrapper中自定义排序规则即可

这里看下wrapper中的源码规则:

/**
     * ignore
     */
default Children orderByAsc(R column) {
        return orderByAsc(true, column);
    }
    /**
     * ignore
     */
    default Children orderByAsc(R... columns) {
        return orderByAsc(true, columns);
    }
    /**
     * 排序:ORDER BY 字段, ... ASC
     * <p>例: orderByAsc("id", "name")</p>
     *
     * @param condition 执行条件
     * @param columns   字段数组
     * @return children
     */
    default Children orderByAsc(boolean condition, R... columns) {
        return orderBy(condition, true, columns);
    }
    /**
     * ignore
     */
    default Children orderByDesc(R column) {
        return orderByDesc(true, column);
    }
    /**
     * ignore
     */
    default Children orderByDesc(R... columns) {
        return orderByDesc(true, columns);
    }
    /**
     * 排序:ORDER BY 字段, ... DESC
     * <p>例: orderByDesc("id", "name")</p>
     *
     * @param condition 执行条件
     * @param columns   字段数组
     * @return children
     */
    default Children orderByDesc(boolean condition, R... columns) {
        return orderBy(condition, false, columns);
    }
    /**
     * 排序:ORDER BY 字段, ...
     * <p>例: orderBy(true, "id", "name")</p>
     *
     * @param condition 执行条件
     * @param isAsc     是否是 ASC 排序
     * @param columns   字段数组
     * @return children
     */
    Children orderBy(boolean condition, boolean isAsc, R... columns);
复制代码

3、逻辑查询

@Test
    public void testOr() {
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.eq("name", "王五").or().eq("age", 21);
        //SELECT id,user_name,password,name,age,email FROM tb_user ORDER BY age DESC
        List<User> users = this.userMapper.selectList(wrapper);
        for (User user : users) {
            System.out.println(user);
        }
    }
复制代码

4、Select

在MP中,查询时默认查询所有的数据,可以使用select来指定具体需要哪个字段值

@Test
    public void testSelect() {
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        //指定查询的字段
        wrapper.eq("name", "王五").or().eq("age", 21).select("id", "name", "age");
        List<User> users = this.userMapper.selectList(wrapper);
        for (User user : users) {
            System.out.println(user);
        }
    }
复制代码

四:MybatisPlus超级好用插件

MybatisX 是一款基于 IDEA 的快速开发插件,为效率而生。 安装方法:打开 IDEA,进入 File -> Settings -> Plugins -> Browse Repositories,输入 mybatisx 搜索并安装。

功能:

  • Java 与 XML 调回跳转
  • Mapper 方法自动生成 XML

今天就先分享到这儿了,记得点赞+关注哦~

分类:
后端
标签:
分类:
后端
标签: