Mybatis Plus的真香体验——配置与CURD

Mybatis Plus的真香体验——配置与CURD

序言

在初学java的时候,对于数据库的操作还停留在jdbc时代,代码又臭又长,还不易维护,后来学习了hibernate,又觉得代码维护很繁琐,各种映射关系处理起来让人头疼,知道学习了JdbcTemplate,才觉得代码对于数据库的操作略显轻松,之后又开始使用了Mybatis,对于数据库的操作更加灵活方便,而今开始学习使用MyBatis-Plus(简称 MP),它是一个 MyBatis 的增强工具,在 MyBatis 的基础上只做增强不做改变,为简化开发、提高效率而生。在此记录下一点心得,诸君可做饭后谈资,亦或共同学习。

环境配置

  • Spring boot 2.2.6.RELEASE
  • maven 3.6
  • jdk 1.8
  • mysql
  • lombok 1.18.12(IDE要安装插件)

项目结构

项目结构

  1. 创建数据表
CREATE TABLE `t_sys_user` (
 `id` varchar(100) NOT NULL COMMENT '主键id',
 `user_login` varchar(100) NOT NULL COMMENT '登录名',
 `user_pass` varchar(150) DEFAULT NULL COMMENT '登录密码',
 `user_slat` varchar(100) NOT NULL COMMENT '密码盐',
 `user_status` tinyint(1) unsigned DEFAULT '1' COMMENT '用户状态:1、正常',
 `user_phone` varchar(12) DEFAULT NULL COMMENT '用户手机号',
 `create_time` datetime DEFAULT NULL COMMENT '创建时间',
 `create_by` varchar(100) DEFAULT NULL COMMENT '创建人id',
 `update_time` datetime DEFAULT NULL COMMENT '维护时间',
 `update_by` varchar(100) DEFAULT NULL COMMENT '维护人id',
 PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
  1. 创建spring boot项目
    pom.xml
<properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <maven.compiler.source>1.8</maven.compiler.source>
    <maven.compiler.target>1.8</maven.compiler.target>
    <junit.version>4.12</junit.version>
    <spring.boot.version>2.2.6.RELEASE</spring.boot.version>
    <apache.commons.lang3.version>3.10</apache.commons.lang3.version>
    <mysql.java.version>8.0.16</mysql.java.version>
    <mybatis-plus.version>3.3.1</mybatis-plus.version>
    <fastjson.version>1.2.68</fastjson.version>
    <druid.spring.boot.version>1.1.20</druid.spring.boot.version>
    <lombok.version>1.18.12</lombok.version>



    <mybatis.spring.boot.version>2.1.0</mybatis.spring.boot.version>
    <shiro.version>1.4.1</shiro.version>
    <shiro-freemarker-tags.versoin>1.0.1</shiro-freemarker-tags.versoin>
  </properties>
<dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
        </dependency>

        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid-spring-boot-starter</artifactId>
        </dependency>

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

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <scope>provided</scope>
        </dependency>

        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>3.3.1</version>
        </dependency>

        <dependency>
            <groupId>org.apache.velocity</groupId>
            <artifactId>velocity-engine-core</artifactId>
            <version>2.2</version>
        </dependency>
    </dependencies>

application.yml

server:
  port: 8080

spring:
  application:
    name: so-easy
  freemarker:
    enabled: true
    template-loader-path: classpath:/templates/
    suffix: .html
    charset: utf-8
    content-type: text/html
    cache: false
  datasource:
    type: com.alibaba.druid.pool.DruidDataSource
    druid:
      url: jdbc:mysql://localhost:3306/so-easy?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=UTC
      username: root
      password: root
      driver-class-name: com.mysql.cj.jdbc.Driver
      maxActive: 20
      initialSize: 1
      maxWait: 60000
      minIdle: 1
      timeBetweenEvictionRunsMillis: 60000
      minEvictableIdleTimeMillis: 300000
      validationQuery: select 'x'
      testWhileIdle: true
      testOnBorrow: false
      testOnReturn: false
      poolPreparedStatements: true
      maxOpenPreparedStatements: 20

# mybatis-plus相关配置
mybatis-plus:
  # xml扫描,多个目录用逗号或者分号分隔(告诉 Mapper 所对应的 XML 文件位置)
  mapper-locations: classpath:mapper/*.xml
  # 以下配置均有默认值,可以不设置
  global-config:
    db-config:
      #主键类型 AUTO:"数据库数字型ID自增" INPUT:"用户输入ID",ID_WORKER:"全局唯一ID (数字类型唯一ID)", ASSIGN_UUID:"全局唯一ID UUID,设置后新增数据会自动生成id,并在插入成功后返回id";
      id-type: ASSIGN_UUID
      #字段策略 IGNORED:"忽略判断"  NOT_NULL:"!== NULL 判断")  NOT_EMPTY:"非空判断 !=null and !=''"
      field-strategy: NOT_NULL
      #数据库类型
      db-type: MYSQL
  configuration:
    # 是否开启自动驼峰命名规则映射:从数据库列名到Java属性驼峰命名的类似映射
    map-underscore-to-camel-case: true
    # 如果查询结果中包含空值的列,则 MyBatis 在映射的时候,不会映射这个字段
    call-setters-on-nulls: true
    # 这个配置会将执行的sql打印出来,在开发或测试的时候可以用
#    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

BaseEntityMeta .java

package com.yml.esay.meta;

import lombok.Data;
import java.util.Date;

/**
 * @author: YML
 * @create: 2020-04-12 21:18
 */
@Data
public class BaseEntityMeta {
    private String id,createBy,updateBy;
    private Date createTime,updateTime;
}

SysUserEntity.java

package com.yml.easy.entity;

import com.baomidou.mybatisplus.annotation.TableName;
import com.yml.esay.meta.BaseEntityMeta;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.experimental.Accessors;

/**
 * <p>
 * 
 * </p>
 *
 * @author YML
 * @since 2020-04-13
 */
@Data
@EqualsAndHashCode(callSuper = true)
@Accessors(chain = true)
@TableName("t_sys_user")
public class SysUserEntity extends BaseEntityMeta {

    private static final long serialVersionUID=1L;

    /**
     * 登录名
     */
    private String userLogin;

    /**
     * 登录密码
     */
    private String userPass;

    /**
     * 密码盐
     */
    private String userSlat;

    /**
     * 用户状态:1、正常
     */
    private Boolean userStatus;

    /**
     * 用户手机号
     */
    private String userPhone;


}

SysUserDao.java

package com.yml.easy.dao;

import com.yml.easy.entity.SysUserEntity;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;

/**
 * <p>
 *  Mapper 接口
 * </p>
 *
 * @author YML
 * @since 2020-04-13
 */
public interface SysUserDao extends BaseMapper<SysUserEntity> {

}

至此,就已经可以运行常规的CURD操作了!!!

CURD操作

	@Resource
    private SysUserDao sysUserDao;
    
    public void curd(){
        //新增,返回id INSERT INTO t_sys_user ( id, user_login, user_pass, user_slat, create_time ) VALUES ( ?, ?, ?, ?, ? )
        SysUserEntity user = new SysUserEntity();
        user.setUserLogin("admin");
        user.setUserPass("admin");
        user.setUserSlat("admin");
        user.setCreateTime(new Date());
        sysUserDao.insert(user);

        //根据id修改  UPDATE t_sys_user SET user_pass=? WHERE id=?
       user.setId("6d5d23e513ebed86b88b20ad7498057f");
       user.setUserPass("123123");
       sysUserDao.updateById(user);

        //自定义条件修改  UPDATE t_sys_user SET user_pass=? WHERE (user_status = ?)
        user.setUserPass("yyyyyy");
        UpdateWrapper<SysUserEntity> updateWrapper = Wrappers.update();
        QueryWrapper<SysUserEntity> queryWrapper = Wrappers.query();
        //jdk1.8之后可以使用lambada
        LambdaUpdateWrapper<SysUserEntity> lambdaUpdateWrapper = Wrappers.lambdaUpdate();
        LambdaQueryWrapper<SysUserEntity> lambdaQueryWrapper = Wrappers.lambdaQuery();
        lambdaUpdateWrapper.eq(SysUserEntity::getUserStatus,2);
        sysUserDao.update(user,lambdaUpdateWrapper);

        //删除
        sysUserDao.deleteById("6d5d23e513ebed86b88b20ad7498057f");
        //...
    }

常用方法

参照BaseMapper.java

/**
     * 插入一条记录
     *
     * @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)
     */
    <E extends IPage<T>> E selectPage(E page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

    /**
     * 根据 Wrapper 条件,查询全部记录(并翻页)
     *
     * @param page         分页查询条件
     * @param queryWrapper 实体对象封装操作类
     */
    <E extends IPage<Map<String, Object>>> E selectMapsPage(E page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

条件构造器

在处理一些多条件查询或操作的时候,需要使用到条件构造器,常见的构造器实例:

        UpdateWrapper<SysUserEntity> updateWrapper = Wrappers.update();
        QueryWrapper<SysUserEntity> queryWrapper = Wrappers.query();
        //jdk1.8之后可以使用lambada
        LambdaUpdateWrapper<SysUserEntity> lambdaUpdateWrapper = Wrappers.lambdaUpdate();
        LambdaQueryWrapper<SysUserEntity> lambdaQueryWrapper = Wrappers.lambdaQuery();

需要注意的是:

QueryWrapper(LambdaQueryWrapper) 和UpdateWrapper(LambdaUpdateWrapper) 的父类用于生成 sql 的 where 条件, entity 属性也用于生成 sql 的 where 条件
注意: entity 生成的 where 条件与 使用各个 api 生成的 where 条件没有任何关联行为

使用方式可以参照官方文档 MP条件构造器

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值