MyBatis-Plus初步使用

在使用mybatis的过程中，我们会发现需要自己写很多的mapper和mapper.xml配置文件，很多时候会写到相当多的重复代码，特别是普通的增删改查，这样不仅会影响我们的开发效率，也会使得代码变的冗余且可读性较差。虽然前面使用了mybatis的自动生成插件generator，但是generator对基类继承显得不太友好。而mybatis-plus对此会有非常友好的支持，使用也很方便简单

简单的说，Mybatis-Plu（简称MP）是一个 Mybatis 的增强工具，在 Mybatis 的基础上只做增强不做改变，为简化开发、提高效率而生。

这个测试案例使用的是SpringBoot的示例，配置方式使用yml文件格式，项目的Git地址为: git@gitee.com:zhoutao825638/mybatisplus_usage_method.git(或者直接访问网址:https://gitee.com/zhoutao825638/mybatisplus_usage_method) 使用Intelij IDEA 直接打开即可。

POM文件引入依赖

• spring-boot-starter-web
• mysql-connector-java
• spring-boot-starter-test
• mybatisplus-spring-boot-starter
• mybatis-plus

<dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

        <!--Mybatis-plus-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatisplus-spring-boot-starter</artifactId>
            <version>1.0.5</version>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus</artifactId>
            <version>2.1.9</version>
        </dependency>
    </dependencies>

创建数据库

为了演示常见的功能，我们这里创建了一个数据库

表结构

DROP TABLE IF EXISTS `tb_area`;
CREATE TABLE `tb_area` (
  `area_id` int(2) NOT NULL AUTO_INCREMENT COMMENT '自增id',
  `area_name` varchar(200) NOT NULL COMMENT '区域名称',
  `priority` int(2) NOT NULL DEFAULT '0' COMMENT '优先级',
  `create_time` datetime DEFAULT NULL COMMENT '创建时间',
  `update_time` datetime DEFAULT NULL COMMENT '最后修改时间',
  PRIMARY KEY (`area_id`),
  UNIQUE KEY `UK_AREA` (`area_name`)
) ENGINE=InnoDB AUTO_INCREMENT=5 DEFAULT CHARSET=utf8;

插入数据

BEGIN;
INSERT INTO `tb_area` VALUES (1, '芜湖', 10, NULL, NULL);
INSERT INTO `tb_area` VALUES (2, '合肥', 1, NULL, NULL);
INSERT INTO `tb_area` VALUES (3, '亳州', 2, NULL, NULL);
INSERT INTO `tb_area` VALUES (4, '安庆', 3, NULL, NULL);
COMMIT;

配置application.yml文件

# 配置数据源
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&useSSL=true
    username: root
    password: administrator
    driver-class-name: com.mysql.jdbc.Driver

#    Mybatis-plus配置内容
mybatis-plus:
	#扫描resource目录下的mapper文件夹中的xml文件
  mapper-locations: classpath:/mapper/*.xml
  global-config:
  #主键类型  0:"数据库ID自增", 1:"用户输入ID",2:"全局唯一ID (数字类型唯一ID)", 3:"全局唯一ID UUID";
    id-type: 3
	#字段策略 0:"忽略判断",1:"非 NULL 判断"),2:"非空判断"
    field-strategy: 2
	#驼峰下划线转换
    db-column-underline: true
    refresh-mapper: true
	#逻辑删除配置
    logic-delete-value: 0
    logic-not-delete-value: 1

Bean配置文件

• MapperScan注解配置了Mapper文件的地址

@Configuration
@MapperScan("com.tao.mybatis_plus.mapper*")
public class MybatisPlusConfig {

    /**
     * mybatis-plus SQL执行效率插件【生产环境可以关闭】
     */
    @Bean
    public PerformanceInterceptor performanceInterceptor() {
        return new PerformanceInterceptor();
    }

    /**
     * mybatis-plus分页插件<br>
     * 文档：http://mp.baomidou.com<br>
     */
    @Bean
    public PaginationInterceptor paginationInterceptor() {
        PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
        // 开启 PageHelper 的支持
        paginationInterceptor.setLocalPage(true);
        return paginationInterceptor;
    }

    /**
     * 注入主键生成器
     */
    @Bean
    public IKeyGenerator keyGenerator() {
        return new H2KeyGenerator();
    }

    /**
     * 注入sql注入器
     */
    @Bean
    public ISqlInjector sqlInjector() {
        return new LogicSqlInjector();
    }

}

三层架构模式

Bean实体对象

• 首先创建了一个实体基类，里面保存了一些基本的数据类型，比如创建时间，更新时间等

public class BaseEntity<T extends Model> extends Model<T> {

    private Date createTime;
    private Date updateTime;

    public Date getCreateTime() {
        return createTime;
    }

    public void setCreateTime(Date createTime) {
        this.createTime = createTime;
    }

    public Date getUpdateTime() {
        return updateTime;
    }

    public void setUpdateTime(Date updateTime) {
        this.updateTime = updateTime;
    }

    @Override
    public String toString() {
        return "BaseEntity{" +
                "createTime=" + createTime +
                ", updateTime=" + updateTime +
                '}';
    }

    @Override
    protected Serializable pkVal() {
        return null;
    }
}

• 然后创建新的实体继承，注意需要使用注解标注表名

@TableName("tb_area")
public class Book extends BaseEntity<Book> implements Serializable {
    @TableId
    private int areaId;
    private String areaName;
    private int priority;

    public int getAreaId() {
        return areaId;
    }

    public void setAreaId(int areaId) {
        this.areaId = areaId;
    }

    public String getAreaName() {
        return areaName;
    }

    public void setAreaName(String areaName) {
        this.areaName = areaName;
    }

    public int getPriority() {
        return priority;
    }

    public void setPriority(int priority) {
        this.priority = priority;
    }

    @Override
    public String toString() {
        return "Book{" +
                "areaId=" + areaId +
                ", areaName='" + areaName + '\'' +
                ", priority=" + priority +
                '}';
    }
}

DAO数据持久层

• 数据持久层创建了两个文件 SuperMapper，作为基类Mapper

import com.baomidou.mybatisplus.mapper.BaseMapper;

public interface SuperMapper<T>  extends BaseMapper<T>{
}

• 另外一个BookMapper，继承了SuperMapper

public interface BookMapper extends SuperMapper<Book> {
}

Service层

• Service层使用接口的方式，创建以下文件

//注意继承MyBatis-Plus的基类Service   IService<Book>
public interface IBookService extends IService<Book>  {

}

Service实现了上面的接口

@Service
public class BookServerImpl extends ServiceImpl<BookMapper,Book> implements IBookService {
}

Controller层

@RestController
@RequestMapping("/book")
public class IndexController {

    @Autowired
    private IBookService bookServer;

    /**
     * 查询图书列表
     * @param index 索引
     * @param page 数量
     * @return String
     */
    @GetMapping("/list/{index}/{page}")
    public String index(@PathVariable("index") int index,@PathVariable("page") int page){
	//已经集成了分页的功能
        Page<Book> bookPage = bookServer.selectPage(new Page<Book>(index, page));
        return JSONObject.toJSONString(bookPage).toString();
    }
}