一、说明
安装MybatisX插件和引入mybatis-plus依赖,即可自动生成domain、xml文件、映射接口文件、service层接口,提升了开发效率。
二、准备工作
1、IDEA安装MybatisX插件。
2、POM文件中需要引入mybatis-plus-boot-starter:
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.4.2</version>
</dependency>
3、IDEA中配置数据源DataSource:
测试用SQL语句:
CREATE TABLE `user_info` (
`id` int(11) NOT NULL AUTO_INCREMENT COMMENT '主键ID',
`user_name` varchar(64) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '用户名',
`age` int(11) NULL DEFAULT NULL COMMENT '年龄',
`source` tinyint(4) NULL DEFAULT NULL COMMENT '来源',
PRIMARY KEY (`id`) USING BTREE,
INDEX `source_id`(`source`) USING BTREE
) ENGINE = InnoDB AUTO_INCREMENT = 1008 CHARACTER SET = utf8mb4 COLLATE = utf8mb4_general_ci ROW_FORMAT = Dynamic;
4、右键点击MybatisX-Generator生成domain、xml文件、映射接口、service文件:
最后的生成文件示意:
三、配置和编码工作
1、引入mybatis-plus的部分POM文件,生产环境很多会加上数据库连接池提升性能,我们选择druid,可以做数据库连接监控。
<!-- mybatis plus start -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.4.2</version>
</dependency>
<!-- mybatis plus end -->
<!--数据库连接池 start-->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid</artifactId>
<version>1.2.3</version>
</dependency>
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</dependency>
<!--数据库连接池 end-->
POM中依赖的版本对应关系
mybatis-plus-boot-starter | 3.4.2 |
---|---|
mysql-connector-java | 8.0.12 |
druid | 1.2.3 |
spring-boot | 2.3.2.RELEASE |
2、配置properties文件,主要包括mybatis-plus、springboot、druid的配置。
# app
server.port=9001
# spring
spring.application.name=mybatis-plus-demo
spring.datasource.url=jdbc:mysql://x.x.x.x:x/test_db?serverTimezone=UTC&useSSL=false&allowPublicKeyRetrieval=true
spring.datasource.username=x
spring.datasource.password=x
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
# 使用druid做连接池
spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
# druid 配置
spring.datasource.druid.initialSize=5
spring.datasource.druid.minIdle=5
spring.datasource.druid.maxActive=200
spring.datasource.druid.maxWait=60000
spring.datasource.druid.timeBetweenEvictionRunsMillis=60000
spring.datasource.druid.minEvictableIdleTimeMillis=300000
spring.datasource.druid.validationQuery=SELECT 1 FROM DUAL
spring.datasource.druid.testWhileIdle=true
spring.datasource.druid.testOnBorrow=false
spring.datasource.druid.testOnReturn=false
spring.datasource.druid.poolPreparedStatements=true
spring.datasource.druid.max-pool-prepared-statement-per-connection-size=50
spring.datasource.druid.filters=stat,wall,log4j
spring.datasource.druid.useGlobalDataSourceStat=true
spring.datasource.druid.cconnectionProperties=druid.stat.mergeSql=true;druid.stat.slowSqlMillis=500
# 配置监控,用逗号(,)隔开
spring.datasource.druid.aop-patterns=com.yangnk.mybatisSample.mapper.*
# 是否开启 StatView Servlet
spring.datasource.druid.stat-view-servlet.enabled=true
#配置访问网址
spring.datasource.druid.stat-view-servlet.url-pattern=/druid/*
# 访问监控页面 白名单,默认127.0.0.1
spring.datasource.druid.stat-view-servlet.allow=127.0.0.1
# 访问监控页面 黑名单,黑名单不能访问
#spring.datasource.druid.stat-view-servlet.deny=192.168.100.148
# 访问监控页面 登陆账号
spring.datasource.druid.stat-view-servlet.login-username=admin
# 访问监控页面 登陆密码
spring.datasource.druid.stat-view-servlet.login-password=666666
# 是否可以重置数据源
spring.datasource.druid.stat-view-servlet.reset-enable=true
# mybatis-plus
# XML映射文件的位置
mybatis-plus.mapper-locations=classpath:mapper/*Mapper.xml
# 实体类所在的包
mybatis-plus.type-aliases-package=com.yangnk.mybatisplusdemo.domain
# MyBatis-Plus全局配置
# 数据库大写下划线转换
mybatis-plus.global-config.db-config.capital-mode=true
# 逻辑删除值
mybatis-plus.global-config.logic-delete-value=1
# 逻辑未删除值
mybatis-plus.global-config.logic-not-delete-value=0
# MyBatis-plus配置
# 将数据库字段映射为驼峰命名
mybatis-plus.configuration.map-underscore-to-camel-case=true
# 是否启用缓存
mybatis-plus.configuration.cache-enabled=false
# 默认枚举类型处理器
mybatis-plus.configuration.default-enum-type-handler=org.apache.ibatis.type.EnumOrdinalTypeHandler
请求druid默认地址:http://127.0.0.1:9000/druid/index.html,可以查看数据库连接池使用情况。
四、验证工作
写一个controller测试,请求数据库数据,可以打印出来。
五、代码实现
MybatisPlusDemo:https://github.com/yangnk/SpringBoot_Learning/tree/master/MybatisPlusDemo
六、总结
总的来说集成Mybatis-plus和MybatisX插件了有以下优势,(1)可以节省生成Mybatis的Mapper文件和映射接口文件,根据数据库表就能直接生成;(2)Mybatis-plus实现了常见的增删改查接口,简单SQL操作不再需要自己编写方法了。
参考资料
- 三款神器(MyBatis Plus + MyBatisX + MyBatis Plus Join);终于不用写数据库操作代码,一键生成直接调用:https://blog.csdn.net/lupengfei1009/article/details/121689443
- fengwenyi/MyBatis-Plus-ExamplePublic:https://github.com/fengwenyi/MyBatis-Plus-Example
- SpringBoot2.4.x整合Mybatis-Plus3.4.x(详细教程):https://www.cnblogs.com/kenx/p/14966186.html#编写controller主程序
- MyBatis-Plus官网:https://www.baomidou.com/pages/1812u1