1、愿景
为简化开发而生,Mybatis的好搭档。
2、特性
- 无侵入:只做增强不做改变,不会对现有工程产生影响
- 损耗小:启动即会自动注入基本 CURD,性能基本无损耗,直接面向对象操作
- 强大的 CRUD 操作:内置通用 Mapper、 Service,通过少量配置即可实现单表大部分 CRUD 操作
- 支持 Lambda 形式调用:通过 Lambda 表达式,方便的编写各类查询条件,无需再担心字段写错
- 支持主键自动生成:支持多达 4 种主键策略(内含分布式唯一 ID 生成器 - Sequence)
- 支持 ActiveRecord 模式:实体类只需继承 Model 类即可进行强大的 CRUD 操作
- 支持自定义全局通用操作:支持全局通用方法注入( Write once, use anywhere )
- 内置代码生成器:采用代码或 Maven 插件快速生成 Mapper 、 Model 、 Service 、 Controller 代码
- 内置分页插件
- 分页插件支持多种数据库
- 内置性能分析插件:可输出 Sql 语句以及其执行时间,能快速揪出慢查询
- 内置全局拦截插件:全表 delete 、 update 操作智能分析阻断,也可自定义拦截规则,预防误操作
3、快速入门
环境:idea+gradle+springboot+mybatis-plus+mysql+jdk1.8
工程:创建一个gradle构建的空的 Spring Boot 工程
(1)依赖
- build.gradle文件
plugins {
id 'org.springframework.boot' version '2.5.2'
id 'io.spring.dependency-management' version '1.0.11.RELEASE'
id 'java'
id 'war'
}
ext {
mybatisplusVersion = '3.4.2'
swaggerFoxVersion = '2.9.2'
swaggerCoreVersion = '1.5.24'
postGisJdbcVersion = '2.5.0'
druidVersion = '1.1.9'
hutoolVersion = '5.3.8'
aspectVersion = '1.8.10'
easyExcelVersion = '2.2.6'
}
group = 'com.mybatisplus'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '1.8'
configurations {
compileOnly {
extendsFrom annotationProcessor
}
}
repositories {
mavenCentral()
}
dependencies {
implementation 'org.springframework.boot:spring-boot-starter-web'
implementation 'org.mybatis.spring.boot:mybatis-spring-boot-starter:2.2.0'
compileOnly 'org.projectlombok:lombok'
annotationProcessor 'org.projectlombok:lombok'
/* MyBatis-Plus */
implementation("com.baomidou:mybatis-plus-boot-starter:${mybatisplusVersion}")
/* Druid 连接池 */
implementation("com.alibaba:druid-spring-boot-starter:${druidVersion}")
/* PostgreSQL */
implementation 'org.postgresql:postgresql:9.4.1212.jre7'
/* PostGis-Jdbc */
implementation("net.postgis:postgis-jdbc:${postGisJdbcVersion}")
compile 'com.alibaba:druid:1.0.27'
compile group: 'org.springframework.boot', name: 'spring-boot-starter-log4j2', version: '1.4.0.RELEASE'
implementation 'junit:junit:4.12'
// 排除冲突
configurations {
mybatisGenerator
compile.exclude module: 'spring-boot-starter-logging'
}
}
test {
useJUnitPlatform()
}
(2)配置
- application.yml 配置文件中添加数据库的相关配置
server:
port: 9080
spring:
datasource:
driver-class-name: org.postgis.DriverWrapper
url: jdbc:postgresql_postGIS://****:*/BOOK?useUnicode=true&characterEncoding=UTF-8
username: ****
password: ****
# ??druid???
type: com.alibaba.druid.pool.DruidDataSource
filters: stat
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
(3)在 Spring Boot 启动类中添加 @MapperScan 注解,扫描 Mapper 文件夹
@SpringBootApplication
@MapperScan("com.mybatisplus.mapper")
public class MybatisplusApplication {
public static void main(String[] args) {
SpringApplication.run(MybatisplusApplication.class, args);
}
}
(4)编码
- 实体类:Users.java
package com.mybatisplus.entity;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Users {
private int id;
private String name;
private int age;
private String email;
}
- Controller层:UserController.java
package com.mybatisplus.controller;
import com.mybatisplus.entity.Users;
import com.mybatisplus.mapper.UserMapper;
import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.List;
@RestController
@RequiredArgsConstructor
public class UserController {
private final UserMapper userMapper;
//查询列表
@GetMapping("/queryallusers")
public List<Users> book() {
List<Users> userList = userMapper.selectList(null);
return userList;
}
}
- DAO层:
UserMapper extends BaseMapper <Users>
package com.mybatisplus.mapper;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.mybatisplus.entity.Users;
import org.apache.ibatis.annotations.Mapper;
@Mapper
public interface UserMapper extends BaseMapper<Users> {
}
(5)数据库
4、Service层
对于service层可选择行要与不要,如果没有业务逻辑处理可以不要,如果需要service层,实体类与Dao层保持不变,其他具体如下:
(1)controller层
- UserController.java
package com.mybatisplus.controller;
import com.mybatisplus.entity.Users;
import com.mybatisplus.service.UsersService;
import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.List;
@RestController
@RequiredArgsConstructor
public class UserController {
private final UsersService usersService;
//查询列表
@GetMapping("/queryallusers")
public List<Users> book() {
List<Users> userList = usersService.list();
return userList;
}
}
(2)service层
- UsersService.java
package com.mybatisplus.service;
import com.baomidou.mybatisplus.extension.service.IService;
import com.mybatisplus.entity.Users;
public interface UsersService extends IService<Users> {
}
- UsersServiceImpl.java
package com.mybatisplus.service;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import com.mybatisplus.entity.Users;
import com.mybatisplus.mapper.UserMapper;
import org.springframework.stereotype.Service;
@Service
public class UsersServiceImpl extends ServiceImpl<UserMapper, Users> implements UsersService {
}
5、执行结果
访问:
http://localhost:9080/queryallusers
结果:
[{"id":1,"name":"张三","age":18,"email":"123456@qq.com"},{"id":2,"name":"李四","age":35,"email":"666666@qq.com"},{"id":3,"name":"王五","age":41,"email":"369852@qq.com"}]