前言
本章记录一下SpringBoot集成druid数据源,集成mybatis-plus,为了开发方便,基于mybatis-plus的代码生成器,实现对业务最基本的增删改查操作。
准备工作
- 在mysql数据库中新建cloud库,并创建sys_user表:
DROP TABLE IF EXISTS `sys_user`;
CREATE TABLE `sys_user` (
`id` varchar(32) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL,
`name` varchar(20) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '姓名',
`sex` tinyint(0) NULL DEFAULT NULL COMMENT '性别,0:男性,1:女生',
`birthday` date NULL DEFAULT NULL COMMENT '出生日期',
`create_time` datetime(0) NULL DEFAULT NULL COMMENT '创建时间',
`create_by` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '创建人',
`update_time` datetime(0) NULL DEFAULT NULL COMMENT '更新时间',
`update_by` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '更新人',
`del_flag` tinyint(0) NULL DEFAULT 0 COMMENT '删除标记,0:未删除,1:已删除',
PRIMARY KEY (`id`) USING BTREE
) ENGINE = InnoDB CHARACTER SET = utf8 COLLATE = utf8_general_ci ROW_FORMAT = Dynamic;
集成Druid
- 在父工程的pom.xml中,增加如下配置,用于版本号的统一配置:
<druid.version>1.2.1</druid.version>
<!-- 省略**** -->
<!-- alibaba druid数据源主版本管理 -->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid</artifactId>
<version>${druid.version}</version>
</dependency>
- 在cloud-user微服务的pom.xml中增加mysql驱动依赖以及druid数据源依赖:
<!-- Mysql数据库驱动依赖 -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<!-- 阿里巴巴数据源 -->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid</artifactId>
</dependency>
- 登录nacos控制台,编辑cloud-user-dev.yml,增加数据源的相关配置:
spring:
datasource:
#数据源基本配置
type: com.alibaba.druid.pool.DruidDataSource
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://127.0.0.1:3306/cloud?useUnicode=true&characterEncoding=utf-8&allowMultiQueries=true&serverTimezone=UTC&useSSL=false
username: root
password: root
#数据源其他配置
initialSize: 5
minIdle: 5
maxActive: 20
maxWait: 60000
timeBetweenEvictionRunsMillis: 60000
minEvictableIdleTimeMillis: 300000
validationQuery: SELECT 1 FROM DUAL
testWhileIdle: true
testOnBorrow: false
testOnReturn: false
poolPreparedStatements: true
#配置监控统计拦截的filters,去掉后监控界面sql无法统计,'wall'用于防火墙
filters: stat,wall
maxPoolPreparedStatementPerConnectionSize: 20
useGlobalDataSourceStat: true
connectionProperties: druid.stat.mergeSql=true;druid.stat.slowSqlMillis=500
stat-view-servlet:
enabled: true
url-pattern: /druid/*
具体druid的的参数配置可以去官网看看 druid指南
虽然配置了druid连接池的其它属性,但是不会生效。因为默认是使用的java.sql.Datasource的类来获取属性的,有些属性datasource没有。如果我们想让配置生效,需要手动创建Druid的配置文件。
- 在main/src/java下创建com.mingx.user.config包,创建DruidConfig.java配置类:
package com.lyc.user.config;
import com.alibaba.druid.pool.DruidDataSource;
import com.alibaba.druid.support.http.StatViewServlet;
import com.alibaba.druid.support.http.WebStatFilter;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.boot.web.servlet.ServletRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
/**
* @author 茶轴的青春
* @Description TODO Druid配置
* @date 2020/10/13 14:05
*/
@Configuration
public class DruidConfig {
@ConfigurationProperties(prefix = "spring.datasource")
@Bean
public DruidDataSource druidDataSource() {
return new DruidDataSource();
}
/**
* 配置监控服务器
*
* @return 返回监控注册的servlet对象
* @author SimpleWu
*/
@SuppressWarnings({"rawtypes", "unchecked"})
@Bean
public ServletRegistrationBean statViewServlet() {
ServletRegistrationBean servletRegistrationBean = new ServletRegistrationBean(new StatViewServlet(), "/druid" +
"/*");
// 添加IP白名单
servletRegistrationBean.addInitParameter("allow", "127.0.0.1");
// 添加IP黑名单,当白名单和黑名单重复时,黑名单优先级更高
// servletRegistrationBean.addInitParameter("deny", "127.0.0.1");
// 添加控制台管理用户
servletRegistrationBean.addInitParameter("loginUsername", "cloud");
servletRegistrationBean.addInitParameter("loginPassword", "123456");
// 是否能够重置数据
servletRegistrationBean.addInitParameter("resetEnable", "false");
return servletRegistrationBean;
}
/**
* 配置服务过滤器
*
* @return 返回过滤器配置对象
*/
@SuppressWarnings({"rawtypes", "unchecked"})
@Bean
public FilterRegistrationBean statFilter() {
FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean(new WebStatFilter());
// 添加过滤规则
filterRegistrationBean.addUrlPatterns("/*");
// 忽略过滤格式
filterRegistrationBean.addInitParameter("exclusions", "*.js,*.gif,*.jpg,*.png,*.css,*.ico,/druid/*,");
return filterRegistrationBean;
}
}
- 启动mingx-user微服务成功后,浏览器中访问http://127.0.0.1:9001/druid/index,就可以来到druid控制台的登录页面,使用DuridConfig.java中配置的用户名密码cloud/123456登录,可以在控制台中看到数据库相关状况:
至此集成druid完成
Mybatis-Plus
Mybatis-Plus简称MP)是一个 Mybatis 的增强工具,在 Mybatis 的基础上只做增强不做改变,为简化开发、提高效率而生,具体请查看 MyBatis Plus
集成Mybatis-Plus
- 在父项目的pom.xml中,增加如下配置,用于版本号的统一配置:
<mybatis-plus.version>3.3.2</mybatis-plus.version>
<!-- mybatis-plus主版本管理 -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>${mybatis-plus.version}</version>
</dependency>
<!-- mybatis-plus代码生成器 -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>${mybatis-plus.version}</version>
</dependency>
- 在cloud-user微服务的pom.xml中增加Mybatis-Plus的依赖及码生成器与模板引擎的依赖:
<!-- Mybatis-Plus依赖 -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
</dependency>
<!-- mybatis-plus代码生成器与模板引擎的依赖 -->
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
</dependency>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
</dependency>
- 在com.lyc.user.config包下创建MybatisPlusConfig配置类:
@Configuration
@MapperScan("com.lyc.user.mapper")
public class MybatisPlusConfig {
/**
* 分页插件
*/
@Bean
public PaginationInterceptor paginationInterceptor() {
return new PaginationInterceptor();
}
}
- 登录nacos控制台,编辑cloud-user-dev.yml,增加Mybatis-Plus的相关配置:
mybatis-plus:
global-config: #主键生成策略
db-config:
id-type: uuid
mapper-locations: classpath:/mapper/*.xml
# 打印sql日志
configuration:
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
map-underscore-to-camel-case: true
cache-enabled: true #开启缓存
- 在com.lyc包下创建CodeGenerator.java文件,利用代码生成工具类,将需要的mapper、service、controller进行自动生成。根据实际情况进行代码中数据源信息的配置:
package com.lyc.user;
import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
import com.baomidou.mybatisplus.core.toolkit.StringPool;
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 org.apache.commons.lang3.StringUtils;
import java.util.ArrayList;
import java.util.List;
import java.util.Scanner;
/**
* @author 茶轴的青春
* @Description TODO 代码生成工具,执行前先确认对应的数据库连接信息
* 执行main方法控制台输入模块表名回车自动生成对应项目目录中
* @date 2020/10/13 15:33
*/
public class CodeGenerator {
/**
* <p>
* 读取控制台内容
* </p>
*/
@SuppressWarnings("resource")
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 + "!");
}
public static void main(String[] args) {
// 代码生成器
AutoGenerator mpg = new AutoGenerator();
// 全局配置 D:\idea_files\cloud_demo\cloud-user
GlobalConfig gc = new GlobalConfig();
//String projectPath = System.getProperty("user.dir");
String projectPath="D:\\idea_files\\cloud_demo\\cloud-user";
gc.setOutputDir(projectPath + "/src/main/java");
gc.setAuthor("Jonas");
gc.setOpen(false);
mpg.setGlobalConfig(gc);
// 数据源配置
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl("jdbc:mysql://127.0.0.1:3306/cloud?useUnicode=true&characterEncoding=utf-8&allowMultiQueries" +
"=true&serverTimezone=UTC&useSSL=false");//数据库
dsc.setDriverName("com.mysql.cj.jdbc.Driver"); //设置数据库驱动,因为我的数据库版本是mysql5.7,所以使用该驱动
dsc.setUsername("root"); //数据库名称
dsc.setPassword("root@"); //数据库密码
mpg.setDataSource(dsc);
// 包配置
PackageConfig pc = new PackageConfig();
pc.setModuleName(scanner("模块名"));
pc.setParent("com.lyc");
mpg.setPackageInfo(pc);
// 自定义配置
InjectionConfig cfg = new InjectionConfig() {
@Override
public void initMap() {
// to do nothing
}
};
// 如果模板引擎是 freemarker
String templatePath = "/templates/mapper.xml.ftl";
// 如果模板引擎是 velocity
// String templatePath = "/templates/dao.xml.vm";
// 自定义输出配置
List<FileOutConfig> focList = new ArrayList<>();
// 自定义配置会被优先输出
focList.add(new FileOutConfig(templatePath) {
@Override
public String outputFile(TableInfo tableInfo) {
// 自定义输出文件名 , 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化!!
return projectPath + "/src/main/resources/mapper/"
+ tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
}
});
cfg.setFileOutConfigList(focList);
mpg.setCfg(cfg);
// 配置模板
TemplateConfig templateConfig = new TemplateConfig();
// 配置自定义输出模板
//指定自定义模板路径,注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别
// templateConfig.setEntity("templates/entity2.java");
// templateConfig.setService();
// templateConfig.setController();
templateConfig.setXml(null);
mpg.setTemplate(templateConfig);
// 策略配置
StrategyConfig strategy = new StrategyConfig();
strategy.setNaming(NamingStrategy.underline_to_camel);
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
//strategy.setSuperEntityClass("com.baomidou.ant.common.BaseEntity");
strategy.setEntityLombokModel(true);
strategy.setRestControllerStyle(true);
// 公共父类
//strategy.setSuperControllerClass("com.mingx.common.controller.BaseController");
// 写于父类中的公共字段
//strategy.setSuperEntityColumns("id");
strategy.setInclude(scanner("表名,多个英文逗号分割").split(","));
strategy.setControllerMappingHyphenStyle(true);
strategy.setTablePrefix(pc.getModuleName() + "_");
mpg.setStrategy(strategy);
mpg.setTemplateEngine(new FreemarkerTemplateEngine());
mpg.execute();
}
}
- 运行CodeGenerator,在控制台输入模块名称user,输入生成代码对应的数据库表名sys_user,回车执行代码生成操作:
- 刷新项目,可以发现包下生成了相应代码,之前提到的cloud-user-pojo微服务是专为用于放pojo类的,所以可以将com.lyc.user.entity下生成的实体类抽离出来。
创建mingx-user-pojo微服务项目,按照之前创建cloud-user步骤一样,修改pojo项目下的pom.xml文件,进行如下设置:
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>cloud_demo</artifactId>
<groupId>com.lyc</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<groupId>com.lyc</groupId>
<modelVersion>4.0.0</modelVersion>
<artifactId>cloud-user-pojo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>jar</packaging>
<dependencies>
<!-- lombok依赖 -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
</dependencies>
</project>
- 在cloud-user-pojo微服务src/main/java目录下创建com.lyc.user.entity包,将生成的实体类放入该包下。
在cloud-user项目中删除com.lyc.user.entity包,并在pom.xml文件中需要将mingx-user-pojo引入。
在标签下增:
<dependency>
<groupId>com.lyc</groupId>
<artifactId>cloud-user-pojo</artifactId>
<version>0.0.1-SNAPSHOT</version>
</dependency>
- 在cloud-user微服务中,在生成的SysUserController控制类中,增加查询数据库用户的方法,进行数据库查询操作,来验证是否正常与数据库建立联系:
@RestController
@RequestMapping("/user")
public class SysUserController {
@Autowired
private ISysUserService sysUserService;
@GetMapping("/queryUserById")
public String queryUserById(String userId) {
return sysUserService.getById(userId).toString();
}
}
- 启动cloud-user微服务,在浏览器中访http://127.0.0.1:9001/user/queryUserById?userId=1,查看响应结果:
至此整合Mybatis-Plus以及代码生成功能已经实现。
PS:
集成过程中可能会出现SpringBoot+MyBatis Plus报错:
数据库字段类型:
原因::
mp版本从3.1.0及以下版本升级到高版本,JDK8日期新类型LocalDateTime等无法映射(报错)
MP_3.1.0及之前的版本,依赖的是mybatis 3.5.0,
MP_3.1.1升级了mybatis的依赖到3.5.1, 而mybatis 3.5.1 对于新日期类型,需要JDBC driver支持JDBC 4.2 API.
如果你的jdbc驱动版本不支持,那么就会出现新日期类型报错。
3.1.0之前版本没问题,针对3.1.1以及后续版本出现上述问题
现象: 集成druid数据源,使用3.1.0之前版本没问题,升级mp到3.1.1+后,运行时报错:java.sql.SQLFeatureNotSupportedException
原因: mp3.1.1+使用了新版jdbc,LocalDateTime等新日期类型处理方式升级,但druid在1.1.21版本之前不支持
解决方案:
- 升级druid到1.1.21解决这个问题;
- 保持mp版本3.1.0;
- 紧跟mp版本,换掉druid数据源
- 修改LocalDateTime为date类型