MyBatis-Plus(简称 MP)是一个 MyBatis 的增强工具,在 MyBatis 的基础上只做增强不做改变,为简化开发、提高效率而生。
1、功能
2、特性
3、架构
4、代码及文档发布地址
1、配置 MapperScan 注解
启动类中配置:
@SpringBootApplication
@MapperScan("com.example.demo.*.mapper")
public class Application {
public static void main(String[] args) {
SpringApplication.run(QuickStartApplication.class, args);
}
}
自定义配置类中配置:
@EnableTransactionManagement
@Configuration
@MapperScan("com.example.demo.*.mapper")
public class MybatisPlusConfig {
}
2、Mapper CRUD 接口(Mapper接口需要继承BaseMapper
3、Service CRUD 接口(Service接口需要继承IService
4、条件构造器(AbstractWrapper-->QueryWrapper&UpdateWrapper)
注意: 使用的是数据库字段,不是 Java 属性。
5、分页插件
spring XML方式配置:
springboot Bean的配置方式:
@Bean
public PaginationInterceptor paginationInterceptor() {
return new PaginationInterceptor();
}
6、逻辑删除
@Bean
public ISqlInjector sqlInjector() {
return new LogicSqlInjector();
}
逻辑删除: 并不会真正的从数据库中将数据删除掉,而是将当前被删除的这条数据中的一个逻辑删除字段置为删除状态。 即:tbl_user logic_flag = 1 → -1
7、执行分析插件
@Bean
public PerformanceInterceptor performanceInterceptor() {
PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
performanceInterceptor.setFormat(true);
return performanceInterceptor;
}
功能:
8、性能分析插件
spring XML配置方式:
springboot bean的方式:
@Bean
@Profile({"dev","test"})// 设置 dev test 环境开启
public PerformanceInterceptor performanceInterceptor() {
return new PerformanceInterceptor();
}
功能:
9、乐观锁插件
spring XML配置方式:
springboot bean配置方式:
@Bean
public OptimisticLockerInterceptor optimisticLockerInterceptor() {
return new OptimisticLockerInterceptor();
}
乐观锁实现方式:
@Version
必须要的10、ActiveRecord(活动记录)
Active Record(活动记录),是一种领域模型模式,特点是一个模型类对应关系型数据库中的一个表,而模型类的一个实例对应表中的一行记录;
ActiveRecord 一直广受动态语言(PHP 、Ruby等)的喜爱,而 Java 作为准静态语言,对于ActiveRecord往往只能感叹其优雅,所以 MP 也在 AR 道路上进行了一定的探索;
使用 AR 模式:仅仅需要让实体类继承 Model 类且实现主键指定方法,即可开启 AR 之旅。
public class User extends Model {
private Integer id;
......
@Override
protected Serializable pkVal() {
return id;
}
}
package com.example.demo.automatic;
import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
import com.baomidou.mybatisplus.core.toolkit.StringPool;
import com.baomidou.mybatisplus.core.toolkit.StringUtils;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.InjectionConfig;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.config.po.TableInfo;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
import lombok.extern.slf4j.Slf4j;
import java.util.ArrayList;
import java.util.List;
import java.util.Scanner;
import static com.baomidou.mybatisplus.generator.config.rules.DateType.ONLY_DATE;
/**
* 类名:CodeGenerator.java
* 功能:执行 main 方法控制台输入模块表名回车自动生成对应项目目录中
* 描述:
* 创建人:typ
* 创建时间:2018/11/20 15:34
* 修改人:
* 修改描述:
* 修改时间:
*/
@Slf4j
public class CodeGenerator {
/**
* 方法名:
* 功能:读取控制台内容
* 描述:
* 创建人:typ
* 创建时间:2018/11/20 15:34
* 修改人:
* 修改描述:
* 修改时间:
*/
public static String scanner(String tip) {
Scanner scanner = new Scanner(System.in);
StringBuilder help = new StringBuilder();
help.append("请输入" + tip + ":");
System.out.println(help.toString());
if (scanner.hasNext()) {
String ipt = scanner.next();
if (StringUtils.isNotEmpty(ipt)) {
return ipt;
}
}
throw new MybatisPlusException("请输入正确的" + tip + "!");
}
/**
* 方法名:
* 功能:代码生成
* 描述:
* 创建人:typ
* 创建时间:2018/11/20 15:35
* 修改人:
* 修改描述:
* 修改时间:
*/
public static void main(String[] args) {
// 代码生成器
AutoGenerator mpg = new AutoGenerator();
// 1.全局配置
GlobalConfig gc = new GlobalConfig();
String projectPath = "F:/workingExperience/workspace/workIeda/springboot-master/springboot-mybatisplus";
gc.setOutputDir(projectPath + "/src/main/java");
gc.setAuthor("typ"); // 注释作者
gc.setDateType(ONLY_DATE); // 注释时间类型
gc.setOpen(false);
gc.setActiveRecord(true); //是否需要ActiveRecord特性
gc.setEnableCache(false); // mapper.xml中开启二级缓存
gc.setBaseResultMap(true); // mapper.xml 中使用ResultMap
gc.setBaseColumnList(true); // mapper.xml中使用columList
gc.setKotlin(true); //是否生成kotlin代码
gc.setControllerName("%sController"); //自定义controoler类的命名格式,列如:XxxController.java
gc.setServiceName("%sService"); //自定义service接口的命名格式,列如:XxxService.java
gc.setServiceImplName("%sServiceImpl"); //自定义service实现类的命名格式,列如:XxxServiceImpl.java
gc.setMapperName("%sMapper"); //自定义mapper接口的命名格式,列如:XxxMapper.java
gc.setXmlName("%sMapper"); //自定义mapper.xml的命名格式,列如:XxxMapper.xml
mpg.setGlobalConfig(gc);
// 2.数据源配置
DataSourceConfig dsc = new DataSourceConfig();
dsc.setDbType(DbType.MYSQL); // 配置数据库类型
dsc.setUrl("jdbc:mysql://127.0.0.1:3306/test?useUnicode=true&useSSL=false&characterEncoding=utf8");
dsc.setDriverName("com.mysql.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("admin");
mpg.setDataSource(dsc);
// 4.包配置
PackageConfig pc = new PackageConfig();
pc.setModuleName(scanner("模块名")); // 控制台输入方式
pc.setParent("com.example.demo");
// pc.setController("controller");
// pc.setEntity("entity");
// pc.setService("service");
// pc.setServiceImpl("impl");
mpg.setPackageInfo(pc);
// 5.自定义配置
InjectionConfig cfg = new InjectionConfig() {
@Override
public void initMap() {
// to do nothing
}
};
// 6.自定mapper.xml生成路径
List focList = new ArrayList<>();
focList.add(new FileOutConfig("/templates/mapper.xml.ftl") {
@Override
public String outputFile(TableInfo tableInfo) {
// 自定义输入文件名称
return projectPath + "/src/main/resources/mapper/" + pc.getModuleName()
+ "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
}
});
cfg.setFileOutConfigList(focList);
mpg.setCfg(cfg);
mpg.setTemplate(new TemplateConfig().setXml(null));
// 7.策略配置
StrategyConfig strategy = new StrategyConfig();
// strategy.setCapitalMode(true); // 全局大写命名
// strategy.setTablePrefix(new String[]{"tb_","tbs_"}); // 数据库表前缀
strategy.setNaming(NamingStrategy.underline_to_camel); // 表名生成策略
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
strategy.setEntityLombokModel(true);
strategy.setRestControllerStyle(true);
strategy.setInclude(scanner("表名")); // 需要生成的表名
strategy.setSuperEntityColumns("id");
strategy.setControllerMappingHyphenStyle(true);
strategy.setTablePrefix(pc.getModuleName() + "_");
mpg.setStrategy(strategy);
mpg.setTemplateEngine(new FreemarkerTemplateEngine());
mpg.execute();
}
}
1、添加依赖
特别说明: Mybatis 及 Mybatis-Spring 依赖请勿加入项目配置,以免引起版本冲突。Mybatis-Plus 会自动帮你维护!
org.springframework.boot
spring-boot-starter
org.springframework.boot
spring-boot-starter-web
org.springframework.boot
spring-boot-starter-test
test
mysql
mysql-connector-java
5.1.46
com.alibaba
druid
org.projectlombok
lombok
provided
com.alibaba
fastjson
com.baomidou
mybatis-plus-boot-starter
3.0.1
com.baomidou
dynamic-datasource-spring-boot-starter
2.4.2
org.apache.velocity
velocity-engine-core
2.0
org.freemarker
freemarker
2.3.28
2、配置文件
application.yml
server:
port: 8081
# mysql
spring:
profiles:
active: dev
datasource:
type: com.alibaba.druid.pool.DruidDataSource
driverClassName: com.mysql.jdbc.Driver
jackson:
time-zone: GMT+8
date-format: yyyy-MM-dd HH:mm:ss
# 主键策略配置
mybatis-plus:
global-config:
db-config:
id-type: auto
application-dev.yml
spring:
datasource:
url: jdbc:mysql://127.0.0.1:3306/test?autoReconnect=true&useUnicode=true&characterEncoding=utf-8&autoReconnect=true
username: root
password: admin
# 连接池的配置信息
initialSize: 10
minIdle: 10
maxActive: 100
maxWait: 60000
timeBetweenEvictionRunsMillis: 300000
minEvictableIdleTimeMillis: 3600000
validationQuery: SELECT 1 FROM DUAL
testWhileIdle: true
testOnBorrow: false
testOnReturn: false
poolPreparedStatements: true
maxPoolPreparedStatementPerConnectionSize: 20
3、MybatisPlus配置
package com.example.demo.config;
import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor;
import com.baomidou.mybatisplus.extension.plugins.PerformanceInterceptor;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.transaction.annotation.EnableTransactionManagement;
/**
* 路径:com.example.demo.config
* 类名:
* 功能:MybatisPlus配置文件
* 备注:
* 创建人:typ
* 创建时间:2018/11/23 15:56
* 修改人:
* 修改备注:
* 修改时间:
*/
@EnableTransactionManagement
@Configuration
@MapperScan("com.example.demo.*.mapper")
public class MybatisPlusConfig {
/**
* 方法名:
* 功能:mybatis-plus分页插件
* 描述:
* 创建人:typ
* 创建时间:2018/11/23 15:57
* 修改人:
* 修改描述:
* 修改时间:
*/
@Bean
public PaginationInterceptor paginationInterceptor() {
return new PaginationInterceptor();
}
/**
* 方法名:
* 功能:打印 sql
* 描述:SQL执行效率插件【生产环境可以关闭】
* 创建人:typ
* 创建时间:2018/11/27 9:58
* 修改人:
* 修改描述:
* 修改时间:
*/
@Bean
public PerformanceInterceptor performanceInterceptor() {
PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
performanceInterceptor.setFormat(true);
return performanceInterceptor;
}
}
4、编码
实体类
package com.example.demo.crud.entity;
import com.baomidou.mybatisplus.extension.activerecord.Model;
import lombok.Data;
import java.io.Serializable;
/**
* 路径:com.example.demo.crud.entity
* 类名:
* 功能:1.使用mybatis plus的一般形式
* 2.使用myBatis Plus继承Model的形式
* 备注:
* 创建人:typ
* 创建时间:2018/11/23 14:09
* 修改人:
* 修改备注:
* 修改时间:
*/
//1.使用mybatis plus的一般形式
/*@Data
public class User {
private Integer id;
private String username;
private String password;
}*/
//2.使用myBatis Plus继承Model的形式
@Data
public class User extends Model {
private Integer id;
private String username;
private String password;
@Override
protected Serializable pkVal() {
return id;
}
}
mapper接口
package com.example.demo.crud.mapper;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.example.demo.crud.entity.User;
/**
* 路径:com.example.demo.crud.mapper
* 类名:
* 功能:《用一句描述一下》
* 备注:
* 创建人:typ
* 创建时间:2018/11/23 14:09
* 修改人:
* 修改备注:
* 修改时间:
*/
public interface UserMapper extends BaseMapper {
}
service接口
package com.example.demo.crud.service;
import com.baomidou.mybatisplus.core.conditions.Wrapper;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.service.IService;
import com.example.demo.crud.entity.User;
import java.io.Serializable;
import java.util.Collection;
import java.util.List;
import java.util.Map;
/**
* 路径:com.example.demo.crud.service
* 类名:
* 功能:《用一句描述一下》
* 备注:
* 创建人:typ
* 创建时间:2018/11/23 16:21
* 修改人:
* 修改备注:
* 修改时间:
*/
public interface UserService extends IService {
}
service实现类
package com.example.demo.crud.service.impl;
import com.baomidou.mybatisplus.core.conditions.Wrapper;
import com.baomidou.mybatisplus.core.enums.SqlMethod;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import com.example.demo.crud.entity.User;
import com.example.demo.crud.mapper.UserMapper;
import com.example.demo.crud.service.UserService;
import org.apache.ibatis.session.SqlSession;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import java.io.Serializable;
import java.util.Collection;
import java.util.List;
import java.util.Map;
/**
* 路径:com.example.demo.crud.service.impl
* 类名:
* 功能:《用一句描述一下》
* 备注:
* 创建人:typ
* 创建时间:2018/11/23 16:23
* 修改人:
* 修改备注:
* 修改时间:
*/
@Service
public class UserServiceImpl extends ServiceImpl implements UserService {
}
controller层
package com.example.demo.crud.controller;
import com.alibaba.druid.support.json.JSONUtils;
import com.alibaba.fastjson.JSON;
import com.baomidou.mybatisplus.core.conditions.Wrapper;
import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.example.demo.crud.entity.User;
import com.example.demo.crud.service.UserService;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;
import java.security.PublicKey;
/**
* 路径:com.example.demo.crud.controller
* 类名:
* 功能:《用一句描述一下》
* 备注:
* 创建人:typ
* 创建时间:2018/11/23 16:29
* 修改人:
* 修改备注:
* 修改时间:
*/
@Slf4j
@RestController
@RequestMapping("/crud")
public class UserController {
@Autowired
private UserService userService;
@GetMapping("/getById")
public String getById(Integer id) {
log.info("find start id:{}", id);
User user = userService.getById(id);
log.info("find end result:{}", JSON.toJSON(user));
return user.toString();
}
@ResponseBody
@GetMapping("/find")
public IPage find(Integer pageNum, Integer pageSize, String name) {
log.info("find start pageNum:{},pageSize:{},name:{}", pageNum, pageSize, name);
QueryWrapper queryWrapper = new QueryWrapper<>();
queryWrapper.eq("username", name);
IPage page = userService.page(new Page<>(pageNum, pageSize), queryWrapper);
log.info("find end result:{}", JSON.toJSON(page));
return page;
}
}
5、MyBatisPlus功能测试
package com.example.demo.crud;
import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.example.demo.crud.entity.User;
import com.example.demo.crud.mapper.UserMapper;
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 java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* 路径:com.example.demo.crud
* 类名:
* 功能:使用mybatis plus的一般形式
* 备注:
* 创建人:typ
* 创建时间:2018/11/23 14:13
* 修改人:
* 修改备注:
* 修改时间:
*/
@RunWith(SpringRunner.class)
@SpringBootTest
public class UserMapperTest {
@Autowired
UserMapper userMapper;
/**
* 方法名:
* 功能:查询
* 描述:
* 创建人:typ
* 创建时间:2018/11/23 15:07
* 修改人:
* 修改描述:
* 修改时间:
*/
@Test
public void select(){
//------------------selectById------------------------------
User user = userMapper.selectById(1);
System.out.println("user:"+user.toString());
//--------------------selectList--------------------
List list = userMapper.selectList(null);
System.out.println("list:"+ Arrays.toString(list.toArray()));
//------------------------selectByMap----------------
Map map = new HashMap<>();
map.put("id",1);
map.put("username","root");
List maps = userMapper.selectByMap(map);
System.out.println("map:"+maps.toString());
//------------------selectPage------------------------------------
User u = new User();
u.setUsername("AAA");
QueryWrapper query = new QueryWrapper<>(u);
IPage pages = userMapper.selectPage(new Page<>(0,10),query);
System.out.println("pages:"+pages.getRecords());
//---------------------------------selectMapsPage-------------------------------------
User uMap = new User();
uMap.setUsername("AAA");
QueryWrapper queryMap = new QueryWrapper<>(uMap);
IPage
ActiveRecord特性测试,实体类需要集成Model,泛型为当前实体类
package com.example.demo.crud;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.example.demo.crud.entity.User;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;
/**
* 路径:com.example.demo.crud
* 类名:
* 功能:使用myBatis Plus继承Model的形式
* 备注:
* 创建人:typ
* 创建时间:2018/11/27 10:04
* 修改人:
* 修改备注:
* 修改时间:
*/
@RunWith(SpringRunner.class)
@SpringBootTest
public class UserMapperModelTest {
/**
* 方法名:
* 功能:insert
* 描述:
* 创建人:typ
* 创建时间:2018/11/27 10:06
* 修改人:
* 修改描述:
* 修改时间:
*/
@Test
public void testInsert(){
User user = new User();
//注意查询语法,与普通的有所不一样
user.setId(12);
user.setUsername("dhsfg");
user.setPassword("11111");
Boolean result = user.insert();
System.out.println(result);
}
/**
* 方法名:
* 功能:select
* 描述:
* 创建人:typ
* 创建时间:2018/11/27 10:06
* 修改人:
* 修改描述:
* 修改时间:
*/
@Test
public void testSelect(){
User user = new User();
//注意查询语法,与普通的有所不一样
user.setId(12);
User result = user.selectById();
System.out.println(result);
}
/**
* 方法名:
* 功能:selectPage
* 描述:
* 创建人:typ
* 创建时间:2018/11/27 10:06
* 修改人:
* 修改描述:
* 修改时间:
*/
@Test
public void testSelectPage(){
User user = new User();
//注意查询语法,与普通的有所不一样
user.setId(12);
IPage result = user.selectPage(new Page(1,2),null);
System.out.println(result.getRecords());
}
}
更多内容请阅读MyBatis-Plus官网!
欢迎关注