mybatis-plus简单入门实例

桃扇骨 2023-08-17 16:18 61阅读 0赞

mybatis-plus从名字上看，就知道是一个mybatis的加强版，这个加强版的确帮助我们简化了一部分配置，另外，也帮助我们默认提供了一些新的操作API。以前我们在做mybatis的时候，至少需要mapper隐射配置文件，即使不用配置文件，我们也需要通过注解的方式来在Mapper接口中的方法上写上sql。比如@Select("select \* from user")。有了mybatis-plus这些简单的增删改查操作就不需要我们来写sql了。因为BaseMapper<T>帮助我们声明了一些常用的操作。我们在定义dao层的接口时只需要继承BaseMapper<T>即可。我们可以看看BaseMapper接口提供的方法：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZlaW5pZmk_size_16_color_FFFFFF_t_70][]

有了这些默认的方法，如果没有复杂的操作，我们在dao层的接口中，就只需要继承自BaseMapper<T>即可。另外，我们在mybatis的使用中，我们需要指定映射文件的位置，比如 mybatis.mapper-locations: classpath/\*.mapper.xml。在这里因为不存在映射文件，所以就无需指定。

mybatisplus里面默认帮助我们实现了一些基本的操作，那么它就有一些规则，比如表与实体映射，字段与属性映射，这里有个基本的规则，实体与表就是首字母大写转小写，属性字段通过驼峰转下划线，id默认是主键，举例来说就是：

实体->表：User->user

属性->列字段：createDate->create\_date

有了这些规则，如果我们想定制怎么办呢？我就想User表映射为users，我就想属性userName映射为username，我就需要userId作为主键。这时候就需要注解出场了。

@TableName("users")指定表名

@TableField("username")指定列字段

@TableId("user\_id")指定主键

有一些属性，不想在表中做映射，怎么办？就是我们需要在表中排除这个字段，这里有以下三种种办法去除字段。

1) transient修饰符

private transient String remark;

2) static修饰符

private static String remark;

3) 另外再加一个注解属性，@TableField(exist=false)

@TableField(exist=false)
    private String remark;

以上这些就是介绍了mybatis-plus在mybatis基础上做的一些改进和增强，从某一方面说更加的简化了，但是很多工作是框架帮我们做了， 底层还是很多依赖mybatis来实现的。

下面我们通过实战来了解一下mybatis-plus，看看如何简化了配置。这里直接结合springboot使用，因为实际中我们几乎不可能单独使用。都是在springboot项目中使用。这里构建maven工程，pom.xml引入的依赖如下：

<parent>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-parent</artifactId>
     <version>2.0.3.RELEASE</version>
    </parent>
    
    <dependencies>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <scope>test</scope>
    </dependency>
    
    <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-test</artifactId>
    </dependency>
    <dependency>
    	<groupId>org.projectlombok</groupId>
    	<artifactId>lombok</artifactId>
    </dependency>
     <dependency>
       <groupId>com.baomidou</groupId>
       <artifactId>mybatis-plus-boot-starter</artifactId>
       <version>3.2.0</version>
    </dependency>
    <dependency>
       <groupId>mysql</groupId>
       <artifactId>mysql-connector-java</artifactId>
    </dependency>
    </dependencies>

这里还引入了lombok，帮助我们更进一步简化实体类。也加入了spring-boot-starter-test，帮助我们做单元测试。

定义一个简单的实体User.java

package com.xxx.mybatisplus.entity;
    import java.util.Date;
    
    import com.baomidou.mybatisplus.annotation.TableField;
    
    import lombok.Data;
    @Data
    public class User {
    	private Integer id;
    	private String name;
    	private int age;
    	private String email;
    	@TableField("createdate")
    	private Date createDate;
    	@TableField("modifydate")
    	private Date modifyDate;
    	@TableField(exist=false)
    	private String remark;
    }

准备表与数据：

/*
    Navicat MySQL Data Transfer
    
    Source Server         : localhost
    Source Server Version : 50711
    Source Host           : localhost:3306
    Source Database       : mybatisplus
    
    Target Server Type    : MYSQL
    Target Server Version : 50711
    File Encoding         : 65001
    
    Date: 2019-09-28 09:09:02
    */
    
    SET FOREIGN_KEY_CHECKS=0;
    
    -- ----------------------------
    -- Table structure for user
    -- ----------------------------
    DROP TABLE IF EXISTS `user`;
    CREATE TABLE `user` (
      `id` int(11) NOT NULL AUTO_INCREMENT,
      `name` varchar(20) DEFAULT NULL,
      `age` int(11) DEFAULT NULL,
      `email` varchar(20) DEFAULT NULL,
      `createdate` datetime DEFAULT NULL,
      `modifydate` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
      PRIMARY KEY (`id`)
    ) ENGINE=InnoDB AUTO_INCREMENT=4 DEFAULT CHARSET=utf8;
    
    -- ----------------------------
    -- Records of user
    -- ----------------------------
    INSERT INTO `user` VALUES ('1', 'aa', '18', 'aa@126.com', '2019-09-27 22:15:22', '2019-09-28 09:08:12');
    INSERT INTO `user` VALUES ('2', 'yy', '20', 'yy@sina.com', '2019-09-27 22:15:22', '2019-09-28 09:08:18');
    INSERT INTO `user` VALUES ('3', 'dd', '22', 'dd@qq.com', '2019-09-27 22:15:22', '2019-09-28 09:08:26');

定义dao层接口：

package com.xxx.mybatisplus.dao;
    
    import com.baomidou.mybatisplus.core.mapper.BaseMapper;
    import com.xxx.mybatisplus.entity.User;
    
    public interface UserDao extends BaseMapper<User> {
    
    }

准备配置文件application.yml：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZlaW5pZmk_size_16_color_FFFFFF_t_70 1][]

准备启动类：

package com.xxx.mybatisplus;
    
    import org.mybatis.spring.annotation.MapperScan;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    @SpringBootApplication
    @MapperScan("com.xxx.mybatisplus.dao")
    public class App {
        public static void main( String[] args ){
        	SpringApplication.run(App.class, args);
        }
    }

准备单元测试类：

package com.xxx.mybatisplus;
    
    import java.util.List;
    
    import org.junit.Assert;
    import org.junit.Test;
    import org.junit.runner.RunWith;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.boot.test.context.SpringBootTest;
    import org.springframework.test.context.junit4.SpringRunner;
    
    import com.xxx.mybatisplus.dao.UserDao;
    import com.xxx.mybatisplus.entity.User;
    
    @RunWith(SpringRunner.class)
    @SpringBootTest
    public class UserTest {
    	@Autowired
    	private UserDao userDao;
    	
    	@Test
    	public void select(){
    		User user = userDao.selectById(1);
    		Assert.assertEquals("aa", user.getName());
    	}
    	
    	@Test
    	public void list(){
    		List<User> users = userDao.selectList(null);
    		users.forEach(System.out::println);
    	}
    }

运行第一个查询测试：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZlaW5pZmk_size_16_color_FFFFFF_t_70 2][]

运行第二个列表测试：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZlaW5pZmk_size_16_color_FFFFFF_t_70 3][]

至此，mybatis-plus算是入门了，后续就是看怎么做复杂的操作了，定制SQL，分页。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZlaW5pZmk_size_16_color_FFFFFF_t_70]: /images/20230810/7f2f8c7757fa4452b8932db2c0e0a6ed.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZlaW5pZmk_size_16_color_FFFFFF_t_70 1]: /images/20230810/f2d3b07348064b39a019e949609bbb11.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZlaW5pZmk_size_16_color_FFFFFF_t_70 2]: /images/20230810/3aa8960a16d840349bd6b4d05118a7a6.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZlaW5pZmk_size_16_color_FFFFFF_t_70 3]: /images/20230810/23b236aace6c4355a2af0b1aecf12c26.png