一、MyBatis-Plus简介
MyBatis-Plus(简称 MP)是一个 MyBatis 的增强工具,在 MyBatis 的基础上只做增强不做改变,为简化开发、提高效率而生。
网址: https://mp.baomidou.com/guide/#%E6%A1%86%E6%9E%B6%E7%BB%93%E6%9E%84
二、Maven依赖
<mybatisplus.version>3.1.2</mybatisplus.version>
<!--mybatis-plus 插件-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>${mybatisplus.version}</version>
</dependency>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus</artifactId>
<version>${mybatisplus.version}</version>
</dependency>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>${mybatisplus.version}</version>
</dependency>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-dts</artifactId>
<version>${mybatisplus.version}</version>
</dependency>
<!--jdbc 数据源-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>
三、配置
- 配置类
@EnableTransactionManagement
@Configuration
@MapperScan("com.xtsz.admin.modules.*.mapper")
public class MybatisPlusConfig {
/**
* 分页插件
*/
@Bean
public PaginationInterceptor paginationInterceptor() {
return new PaginationInterceptor();
}
}
- 配置文件
## 数据库配置com.mysql.cj.jdbc.Driver com.mysql.jdbc.Driver
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/xxxx?useUnicode=true&characterEncoding=UTF-8&useSSL=false&autoReconnect=true&failOverReadOnly=false&serverTimezone=GMT%2b8
spring.datasource.username=
spring.datasource.password=
# 数据库连接池
spring.datasource.type=com.zaxxer.hikari.HikariDataSource
# 最小空闲连接数量
spring.datasource.hikari.minimum-idle=5
# 连接池最大连接数,默认是10
spring.datasource.hikari.maximum-pool-size=15
#此属性控制从池返回的连接的默认自动提交行为,默认值:true
spring.datasource.hikari.auto-commit=true
spring.datasource.hikari.idle-timeout=30000
spring.datasource.hikari.pool-name=UserHikariCP
# 此属性控制池中连接的最长生命周期,值0表示无限生命周期,默认1800000即30分钟
spring.datasource.hikari.max-lifetime=1800000
#数据库连接超时时间,默认30秒,即30000
spring.datasource.hikari.connection-timeout=30000
#指定校验连接合法性执行的sql语句
spring.datasource.hikari.connection-test-query=SELECT 1
## mybatis-plus配置
mybatis-plus.mapper-locations=classpath*:/mappers/**/*.xml
# 实体扫描,多个package用逗号或者分号分隔
mybatis-plus.type-aliases-package=com.xtsz.admin.modules.*.entity
# 配置banner
mybatis-plus.global-config.banner=false
# #主键类型 AUTO:"数据库ID自增", INPUT:"用户输入ID",ID_WORKER:"全局唯一ID (数字类型唯一ID)", UUID:"全局唯一ID UUID";
mybatis-plus.global-config.db-config.id-type=id_worker
# 字段策略 IGNORED:"忽略判断",NOT_NULL:"非 NULL 判断"),NOT_EMPTY:"非空判断"
#mybatis-plus.global-config.db-config.field-strategy=not_empty
# 驼峰下划线转换
mybatis-plus.global-config.db-column-underline=true
# 刷新mapper 调试神器
mybatis-plus.global-config.refresh-mapper=true
# 逻辑删除全局值(1表示已删除,这也是Mybatis Plus的默认配置)
mybatis-plus.global-config.db-config.logic-delete-value=1
#逻辑未删除全局值(0表示未删除,这也是Mybatis Plus的默认配置)
mybatis-plus.global-config.db-config.logic-not-delete-value=0
# 配置返回数据库(column下划线命名&&返回java实体是驼峰命名),
# 自动匹配无需as(没开启这个,SQL需要写as: select user_id as userId)
mybatis-plus.configuration.map-underscore-to-camel-case=true
mybatis-plus.configuration.cache-enabled=false
# 设置全局属性用于控制数据库的类型
mybatis-plus.configuration-properties.dbType=mysql
#在格式:logging.level.Mapper类的包=debug 会在控制台打印出sql语句
logging.level.com.xtsz.admin.modules.system.mapper=debug
三、实体注解
@TableName 表名注解
@TableName("system_user")
public class User{
}
@TableId
@TableName("system_user")
public class User{
@TableId(value = "id", type = IdType.UUID)
private String id;
@TableField(value = "last_login_ip", fill = FieldFill.INSERT_UPDATE)
private String lastLoginIp;
}
FieldFill.DEFAULT 字段自动填充策略
INSERT 插入时填充字段
UPDATE 更新时填充字段
三、Mapper接口
// mapper 父类,注意这个类不要让 mp 扫描到!!
@Mapper
public interface UserMapper extends BaseMapper<User> {
// 这里可以放一些公共的方法
}
四、代码生成器
public class MysqlGenerator {
/**
* <p>
* 读取控制台内容
* </p>
*/
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();
// 全局配置
GlobalConfig gc = new GlobalConfig();
String projectPath = System.getProperty("user.dir");
gc.setOutputDir(projectPath + "/iot-manage/src/main/java");
gc.setAuthor("侯建军");
gc.setOpen(false);
mpg.setGlobalConfig(gc);
// 数据源配置
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl("jdbc:mysql://127.0.0.1:3306/xxxxx?useUnicode=true&characterEncoding=UTF-8&useSSL=false&autoReconnect=true&failOverReadOnly=false&serverTimezone=GMT%2b8");
dsc.setSchemaName("public");
// com.mysql.cj.jdbc.Driver--com.mysql.jdbc.Driver
dsc.setDriverName("com.mysql.jdbc.Driver");
// 用户名
dsc.setUsername("root");
// 密码
dsc.setPassword("xxxx");
mpg.setDataSource(dsc);
// 包配置
PackageConfig pc = new PackageConfig();
pc.setModuleName(scanner("模块名"));
// 包名
pc.setParent("com.xtsz.admin.modules");
mpg.setPackageInfo(pc);
// 自定义配置
InjectionConfig cfg = new InjectionConfig() {
@Override
public void initMap() {
// to do nothing
}
};
List<FileOutConfig> focList = new ArrayList<>();
// 加载模板
focList.add(new FileOutConfig("/templates/mapper.xml.ftl") {
@Override
public String outputFile(TableInfo tableInfo) {
// 自定义输入文件名称
return projectPath + "/iot-manage/src/main/resources/mappers/" + pc.getModuleName()
+ "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
}
});
cfg.setFileOutConfigList(focList);
mpg.setCfg(cfg);
mpg.setTemplate(new TemplateConfig().setXml(null));
// 策略配置
StrategyConfig strategy = new StrategyConfig();
strategy.setNaming(NamingStrategy.underline_to_camel);
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
// 实体类基类地址
strategy.setSuperEntityClass("com.xtsz.iot.core.BaseEntity");
strategy.setEntityLombokModel(true);
// strategy.setRestControllerStyle(true);
// 控制器基类地址
// strategy.setSuperControllerClass("com.xtsz.admin.modules.system.controller.BaseController");
strategy.setInclude(scanner("表名"));
strategy.setSuperEntityColumns("id");
strategy.setControllerMappingHyphenStyle(true);
strategy.setTablePrefix(pc.getModuleName() + "_");
mpg.setStrategy(strategy);
// 选择 freemarker 引擎需要指定如下加,注意 pom 依赖必须有!
mpg.setTemplateEngine(new FreemarkerTemplateEngine());
mpg.execute();
}
}
代码生成器
六、条件构造器
条件构造器wapper介绍 :
Wrapper : 条件构造抽象类,最顶端父类,抽象类中提供4个方法西面贴源码展示
AbstractWrapper : 用于查询条件封装,生成 sql 的 where 条件
AbstractLambdaWrapper : Lambda 语法使用 Wrapper统一处理解析 lambda 获取 column。
LambdaQueryWrapper :看名称也能明白就是用于Lambda语法使用的查询Wrapper
LambdaUpdateWrapper : Lambda 更新封装Wrapper
QueryWrapper : Entity 对象封装操作类,不是用lambda语法
UpdateWrapper : Update 条件封装,用于Entity对象更新操作
条件
1. Wrapper
2. UpdateWrapper
@PutMapping(value = "{id}/update")
public Result update(@PathVariable("id") String id,@Valid @RequestBody User user){
UpdateWrapper<User> updateWrapper = new UpdateWrapper<>();
updateWrapper.ge("id",id);
if(userService.update(user,updateWrapper)){
return Result.success("用户修改成功");
}
return Result.fail("用户修改失败");
}
3. 分页查询
@Test
public void testPage() {
QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.like("username","admin");
Page page = new Page<>(1, 2);
// 分页查询
IPage<User> iPage = iUserService.page(page,queryWrapper);
log.info(Result.success(iPage).toString());
}
4. 排序
if(StringUtils.isEmpty(usersRequeset.getSort())){
queryWrapper.orderByDesc("create_time");
}
七、常见问题:
-
org.apache.ibatis.binding.BindingException: Invalid bound statement (not found):
包没导全,只导入了mybatis-plus或mybatis-plus-boot-starter。 -
java.sql.SQLException: Unknown system variable 'tx_isolation'
jdbc版本低。 -
The valid characters are defined in RFC 7230 and RFC 3986
RFC3986文档规定,Url中只允许包含英文字母(a-zA-Z)、数字(0-9)、-_.~4个特殊字符以及所有保留字符。
RFC3986中指定了以下字符为保留字符:! * ’ ( ) ; : @ & = + $ , / ? # [ ]
不安全字符:还有一些字符,当他们直接放在Url中的时候,可能会引起解析程序的歧义。这些字符被视为不安全字符,原因有很多。
空格:Url在传输的过程,或者用户在排版的过程,或者文本处理程序在处理Url的过程,都有可能引入无关紧要的空格,或者将那些有意义的空格给去掉。
引号以及<>:引号和尖括号通常用于在普通文本中起到分隔Url的作用
井号(#) 通常用于表示书签或者锚点
%:百分号本身用作对不安全字符进行编码时使用的特殊字符,因此本身需要编码
{}|^[]`~:某一些网关或者传输代理会篡改这些字符
原因:
get方法使用json数据在swagger中有问题,原因为提交不是json格式。
使用postman没有问题。
解决:
将json数据进行urlencode编码,需修改tomcat设置。
网友评论