springboot mybatis plus 使用入门
因为最近入职新公司，dao层选型mybatis，所以研究下mybatis plus脚手架，其优点，具体可以去官网查看，例子选的版本mybatis-plus-boot-starter 版本 3.0.4，代码生成器版本，mybatis-plus-generator 版本 3.0.3
。
教程分为两部门：
1.从数据库层反向生成 dao,service,controller。
2.测试单元增删改成。
1.从数据库层反向生成 dao,service,controller。
1.1 mysql 数据结构准备
/*
Navicat MySQL Data Transfer
Source Server : db
Source Server Version : 50528
Source Host : localhost:3306
Source Database : myth
Target Server Type : MYSQL
Target Server Version : 50528
File Encoding : 65001
Date: 2019-02-17 14:25:40
*/
SET FOREIGN_KEY_CHECKS=0;
-- ----------------------------
-- Table structure for myth_inventory
-- ----------------------------
DROP TABLE IF EXISTS `myth_inventory`;
CREATE TABLE `myth_inventory` (
`trans_id` varchar(64) COLLATE utf8mb4_unicode_ci NOT NULL,
`target_class` varchar(256) COLLATE utf8mb4_unicode_ci DEFAULT NULL,
`target_method` varchar(128) COLLATE utf8mb4_unicode_ci DEFAULT NULL,
`retried_count` int(3) NOT NULL,
`create_time` datetime NOT NULL,
`last_time` datetime NOT NULL,
`version` int(6) NOT NULL,
`status` int(2) NOT NULL,
`invocation` longblob,
`role` int(2) NOT NULL,
`error_msg` text COLLATE utf8mb4_unicode_ci,
PRIMARY KEY (`trans_id`),
KEY `status_last_time` (`last_time`,`status`) USING BTREE
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
-- ----------------------------
-- Table structure for myth_order
-- ----------------------------
DROP TABLE IF EXISTS `myth_order`;
CREATE TABLE `myth_order` (
`trans_id` varchar(64) COLLATE utf8mb4_unicode_ci NOT NULL,
`target_class` varchar(256) COLLATE utf8mb4_unicode_ci DEFAULT NULL,
`target_method` varchar(128) COLLATE utf8mb4_unicode_ci DEFAULT NULL,
`retried_count` int(3) NOT NULL,
`create_time` datetime NOT NULL,
`last_time` datetime NOT NULL,
`version` int(6) NOT NULL,
`status` int(2) NOT NULL,
`invocation` longblob,
`role` int(2) NOT NULL,
`error_msg` text COLLATE utf8mb4_unicode_ci,
PRIMARY KEY (`trans_id`),
KEY `status_last_time` (`last_time`,`status`) USING BTREE
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
1.2 pom 坐标引入
4.0.0
org.springframework.boot
spring-boot-starter-parent
2.1.3.RELEASE
com.hys
mybatis
0.0.1-SNAPSHOT
mybatis
Demo project for Spring Boot
1.8
org.springframework.boot
spring-boot-starter
org.springframework.boot
spring-boot-starter-web
org.springframework.boot
spring-boot-starter-test
test
org.projectlombok
lombok
true
com.baomidou
mybatis-plus-boot-starter
3.0.4
mysql
mysql-connector-java
6.0.4
com.baomidou
mybatis-plus-generator
3.0.3
org.freemarker
freemarker
org.springframework.boot
spring-boot-maven-plugin
1.3 代码生成器根据数据库反向生成java
springboot 配置文件
application.properties
spring.profiles.active=dev
application-dev.properties
spring.datasource.url=jdbc:mysql://localhost:3306/myth?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.username=root
spring.datasource.password=root
package com.hys.mybatis;
import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.GlobalConfig;
import com.baomidou.mybatisplus.generator.config.PackageConfig;
import com.baomidou.mybatisplus.generator.config.StrategyConfig;
import com.baomidou.mybatisplus.generator.config.converts.MySqlTypeConvert;
import com.baomidou.mybatisplus.generator.config.rules.DbColumnType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
/**
*
* 代码生成器演示
*
*/
public class MpGenerator {
public static void main(String[] args) {
// assert (false) : "代码生成属于危险操作，请确定配置后取消断言执行代码生成！";
AutoGenerator mpg = new AutoGenerator();
// 选择 freemarker 引擎，默认 Velocity
mpg.setTemplateEngine(new FreemarkerTemplateEngine());
// 全局配置
GlobalConfig gc = new GlobalConfig();
gc.setAuthor("ahys");
gc.setOutputDir("G:\\springboot-mybatis\\src\\main\\java");
gc.setFileOverride(false);// 是否覆盖同名文件，默认是false
gc.setActiveRecord(true);// 不需要ActiveRecord特性的请改为false
gc.setEnableCache(false);// XML 二级缓存
gc.setBaseResultMap(true);// XML ResultMap
gc.setBaseColumnList(false);// XML columList
/* 自定义文件命名，注意 %s 会自动填充表实体属性！ */
gc.setMapperName("%sDao");
// gc.setXmlName("%sDao");
//gc.setServiceName("%sService");
//gc.setServiceImplName("%sServiceImpl");
// gc.setControllerName("%sAction");
mpg.setGlobalConfig(gc);
// 数据源配置
DataSourceConfig dsc = new DataSourceConfig();
dsc.setDbType(DbType.MYSQL);
dsc.setTypeConvert(new MySqlTypeConvert());
dsc.setDriverName("com.mysql.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("root");
dsc.setUrl("jdbc:mysql://localhost:3306/myth?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai");
mpg.setDataSource(dsc);
// 策略配置
StrategyConfig strategy = new StrategyConfig();
// strategy.setCapitalMode(true);// 全局大写命名 ORACLE 注意
//strategy.setTablePrefix(new String[] { "user_" });// 此处可以修改为您的表前缀
strategy.setNaming(NamingStrategy.underline_to_camel);// 表名生成策略
//strategy.setInclude(new String[] { "user" }); // 需要生成的表
// strategy.setExclude(new String[]{"test"}); // 排除生成的表
// 自定义实体父类
// strategy.setSuperEntityClass("com.baomidou.demo.TestEntity");
// 自定义实体，公共字段
// strategy.setSuperEntityColumns(new String[] { "test_id", "age" });
// 自定义 mapper 父类
// strategy.setSuperMapperClass("com.baomidou.demo.TestMapper");
// 自定义 service 父类
// strategy.setSuperServiceClass("com.baomidou.demo.TestService");
// 自定义 service 实现类父类
// strategy.setSuperServiceImplClass("com.baomidou.demo.TestServiceImpl");
// 自定义 controller 父类
// strategy.setSuperControllerClass("com.baomidou.demo.TestController");
// 【实体】是否生成字段常量（默认 false）
// public static final String ID = "test_id";
// strategy.setEntityColumnConstant(true);
// 【实体】是否为构建者模型（默认 false）
// public User setName(String name) {this.name = name; return this;}
// strategy.setEntityBuilderModel(true);
mpg.setStrategy(strategy);
// 包配置
PackageConfig pc = new PackageConfig();
pc.setParent("com.hys.mybatis.mapper");
// pc.setModuleName("test");
mpg.setPackageInfo(pc);
// 注入自定义配置，可以在 VM 中使用 cfg.abc 【可无】
// InjectionConfig cfg = new InjectionConfig() {
// @Override
// public void initMap() {
// Map map = new HashMap();
// map.put("abc", this.getConfig().getGlobalConfig().getAuthor() +
// "-mp");
// this.setMap(map);
// }
// };
//
// // 自定义 xxList.jsp 生成
// List focList = new ArrayList<>();
// focList.add(new FileOutConfig("/template/list.jsp.vm") {
// @Override
// public String outputFile(TableInfo tableInfo) {
// // 自定义输入文件名称
// return "D://my_" + tableInfo.getEntityName() + ".jsp";
// }
// });
// cfg.setFileOutConfigList(focList);
// mpg.setCfg(cfg);
//
// // 调整 xml 生成目录演示
// focList.add(new FileOutConfig("/templates/mapper.xml.vm") {
// @Override
// public String outputFile(TableInfo tableInfo) {
// return "/develop/code/xml/" + tableInfo.getEntityName() + ".xml";
// }
// });
// cfg.setFileOutConfigList(focList);
// mpg.setCfg(cfg);
//
// // 关闭默认 xml 生成，调整生成 至 根目录
// TemplateConfig tc = new TemplateConfig();
// tc.setXml(null);
// mpg.setTemplate(tc);
// 自定义模板配置，可以 copy 源码 mybatis-plus/src/main/resources/templates 下面内容修改，
// 放置自己项目的 src/main/resources/templates 目录下, 默认名称一下可以不配置，也可以自定义模板名称
// TemplateConfig tc = new TemplateConfig();
// tc.setController("...");
// tc.setEntity("...");
// tc.setMapper("...");
// tc.setXml("...");
// tc.setService("...");
// tc.setServiceImpl("...");
// 如上任何一个模块如果设置 空 OR Null 将不生成该模块。
// mpg.setTemplate(tc);
// 执行生成
mpg.execute();
// 打印注入设置【可无】
// System.err.println(mpg.getCfg().getMap().get("abc"));
}
}
运行上述代码，生成如图代码结构，
2.测试单元增删改成。
直接上代码
package com.hys.mybatis;
import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor;
import com.baomidou.mybatisplus.extension.plugins.PerformanceInterceptor;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Profile;
@SpringBootApplication
@MapperScan("com.hys.mybatis.mapper.mapper")
public class MybatisApplication {
public static void main(String[] args) {
SpringApplication.run(MybatisApplication.class, args);
}
/**
* 分页插件
*/
@Bean
public PaginationInterceptor paginationInterceptor() {
return new PaginationInterceptor();
}
/**
* SQL执行效率插件
*/
@Bean
@Profile({"dev","test"})// 设置 dev test 环境开启
public PerformanceInterceptor performanceInterceptor() {
return new PerformanceInterceptor();
}
}
package com.hys.mybatis;
import com.baomidou.mybatisplus.core.conditions.Wrapper;
import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.core.conditions.update.UpdateWrapper;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.core.toolkit.CollectionUtils;
import com.baomidou.mybatisplus.core.toolkit.support.Property;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.hys.mybatis.mapper.entity.MythInventory;
import com.hys.mybatis.mapper.mapper.MythInventoryDao;
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 java.time.LocalDateTime;
import java.util.Date;
import java.util.List;
@RunWith(SpringRunner.class)
@SpringBootTest
public class MybatisApplicationTests {
@Autowired
MythInventoryDao mythInventoryDao;
//查询
@Test
public void select() {
// List lambdaUsers = userMapper.selectList(new QueryWrapper().lambda().eq(User::getRoleId, 2L));
MythInventory mythInventory = mythInventoryDao.selectOne(new QueryWrapper ().lambda().eq(MythInventory::getTransId, "1"));//mythInventoryDao.selectById("1");
System.out.println(mythInventory);
}
//插入
@Test
public void inset() {
MythInventory mythInventory = new MythInventory();
mythInventory.setErrorMsg("1111");
mythInventory.setTargetClass("class2");
mythInventory.setStatus(1);
mythInventory.setTransId("2");
mythInventory.setRetriedCount(1);
mythInventory.setCreateTime(new Date());
mythInventory.setLastTime(new Date());
mythInventory.setRole(1);
mythInventory.setVersion(1);
mythInventoryDao.insert(mythInventory);
}
//更新
@Test
public void update(){
/*MythInventory mythInventory = mythInventoryDao.selectOne(new QueryWrapper ().lambda().eq(MythInventory::getTransId, "1"));//mythInventoryDao.selectById("1");
System.out.println(mythInventory);
mythInventory.setTargetClass("更新class");
mythInventoryDao.updateById(mythInventory);*/
MythInventory mythInventory2 =new MythInventory();
UpdateWrapper wrapper = new UpdateWrapper <>();
wrapper.lambda().eq(MythInventory::getTransId,"23");
mythInventory2.setErrorMsg("错误哦信息");
mythInventoryDao.update(mythInventory2,wrapper);
}
@Test
public void wapperSelect(){
//sql 语法
List mythInventories = mythInventoryDao.selectList(new QueryWrapper ().lambda().inSql(MythInventory::getTransId, "select 1 from dual"));
System.out.println("sql: "+mythInventories.size());
}
//分页
@Test
public void page(){
Page page = new Page<>(1, 2);
QueryWrapper queryWrapper = new QueryWrapper<>();
queryWrapper.lambda().orderByDesc(MythInventory::getCreateTime).orderByAsc(MythInventory::getVersion);
IPage pageList = mythInventoryDao.selectPage(page, queryWrapper);
print(pageList.getRecords());
}
@Test
public void selectBySql(){
List mythInventories = mythInventoryDao.queryForSql("2");
print(mythInventories);
}
private void print(List list) {
if (!CollectionUtils.isEmpty(list)) {
list.forEach(System.out::println);
}
}
}
最后代码下载地址