mybatis pluse+Spring boot 使用笔记(一)新建Spring boot项目+代码器生成代码
- 1.新建Spring boot项目
- 2.逆向生成mybatis-pluse代码
- 3.搭建连接 数据库的环境
- 3.1在配置文件application.properties配置文件中粘贴入以下代码==同理标------也是需要注意然后进行修改的==
- 3.2将启动类恢复到原来的样子,(把添加的逆向生成代码的文件去掉,把之前注释掉的原代码恢复为原来的样子)并且加上@MapperScan
- 3.3随便写一个测试接口测试一下
- 3.4启动的过程中可能出现的错误
- 3.4.1 No active profile set, falling back to default profiles: default
- 3.4.2 No MyBatis mapper was found in '[com.demo_pluse]' package. Please check your configuration.
- 3.4.3 Error creating bean with name 'XXX': Unsatisfied dependency expressed through field 'XXX';
- 3.4.4 Field testUserService in com.demo.controller.TestUserController required a single bean, but 2 were found:
- 3.5启动成功后测试(打开浏览器直接访问接口即可)
1.新建Spring boot项目
1.1 打开idea按以下步骤新建一个项目 File–>New–>Project
1.2 按照图片的默认即可,Project SDK(版本可能与我的不同)
1.2 按照图片解释,填写自己的(然后next)
1.3 这一步是选依赖包的步骤,我这里直接跳过了,在下边会把需要的依赖包贴过来。直接next进入下一个步骤。
1.4这个步骤是选择项目的存储路径.(选择完之后finsh即可)
1.5生成之后的成品图
2.逆向生成mybatis-pluse代码
2.1 添加pom文件依赖(从标签开始直接替换即可)
<dependencies>
<!--代码生成器,MyBatis-Plus 从 3.0.3 之后移除了代码生成器与模板引擎的默认依赖,需要手动添加相关依赖-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.4.0</version>
</dependency>
<!--freemarker模板引擎-->
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
<version>2.3.30</version>
</dependency>
<!--mybatis-plus(springboot版)-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.4.1</version>
</dependency>
<!--mybatis持久层-->
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>2.1.3</version>
</dependency>
<!--jackson注解jar包,时间格式化注解@JsonFormat就在里面-->
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-annotations</artifactId>
<version>2.11.1</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-core</artifactId>
<version>2.11.1</version>
</dependency>
<!--一些校验的依赖,不然启动会报NoClassDefFoundError: javax/validation/constraints/Min-->
<dependency>
<groupId>javax.validation</groupId>
<artifactId>validation-api</artifactId>
<version>2.0.1.Final</version>
</dependency>
<!--SpringBoot单服务架构使用最新版的knife4j依赖,继承swagger依赖,同时增强UI实现-->
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>2.0.3</version>
</dependency>
<!--lombok-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
<version>1.18.12</version>
</dependency>
<!--springboot整合druid连接池-->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid-spring-boot-starter</artifactId>
<version>1.1.9</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
<version>8.0.21</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-tomcat</artifactId>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
<exclusions>
<exclusion>
<groupId>org.junit.vintage</groupId>
<artifactId>junit-vintage-engine</artifactId>
</exclusion>
</exclusions>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
2.2在启动类设置代码生成器
这个是需要导的包,需要参考的可以看一下
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 org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import java.util.ArrayList;
import java.util.List;
import java.util.Scanner;
首先在启动类添加一个scanner扫描方法,用于手动输入表明(也可直接把表明配置在代码生成器中)
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.isNotBlank(ipt)) {
return ipt;
}
}
throw new MybatisPlusException("请输入正确的" + tip + "!");
}
然后把代码生成器的代码复制在启动类的main方法中一定记得将main方法下面代码第一行代码注释掉(SpringApplication.run(DemoPluseApplication.class, args);)
--------------------------标记的地方都是需要修改的地方!!!
{
// SpringApplication.run(DemoPluseApplication.class, args);
//===================配置 GlobalConfig(全局配置)
// 代码生成器
AutoGenerator mpg = new AutoGenerator();
// 全局配置
GlobalConfig gc = new GlobalConfig();
//获取项目根目录
String projectPath = System.getProperty("user.dir");
//代码生成目录
gc.setOutputDir(projectPath + "/src/main/java");
//开发人员--------------------------------------------------------
gc.setAuthor("XXX");
// 是否打开输出目录(默认值:null)
gc.setOpen(false);
//实体属性 Swagger2 注解
gc.setSwagger2(true);
// 是否覆盖已有文件(默认值:false)
gc.setFileOverride(true);
//把全局配置添加到代码生成器主类
mpg.setGlobalConfig(gc);
//=================== 配置 DataSourceConfig(数据源配置)
// 数据源配置
DataSourceConfig dsc = new DataSourceConfig();
//数据库连接--------------------------------------------------------
dsc.setUrl("jdbc:mysql://localhost:3306/test?useUnicode=true&useSSL=false&characterEncoding=utf8&serverTimezone=GMT%2B8");
// 数据库类型--------------------------------------------------------
dsc.setDbType(DbType.MYSQL) ;
// 驱动名称 也可改为自己的
dsc.setDriverName("com.mysql.cj.jdbc.Driver");
//用户名--------------------------------------------------------
dsc.setUsername("root");
//密码--------------------------------------------------------
dsc.setPassword("");
//把数据源配置添加到代码生成器主类
mpg.setDataSource(dsc);
//=================== 配置PackageConfig(包名配置)
// 包配置
PackageConfig pc = new PackageConfig();
// 父包名。如果为空,将下面子包名必须写全部, 否则就只需写子包名
// ----------------------------------包名这个地方可以设置自己的----------------------
pc.setParent("com.demo");
// Service包名
pc.setService("service");
// Entity包名
pc.setEntity("entity");
// ServiceImpl包名
pc.setServiceImpl("service.impl");
// Mapper包名
pc.setMapper("mapper");
// Controller包名
pc.setController("controller");
// Mapper.xml包名
pc.setXml("mapper");
// 把包配置添加到代码生成器主类
mpg.setPackageInfo(pc);
//=================== 配置InjectionConfig(自定义配置)
// 自定义配置
InjectionConfig cfg = new InjectionConfig() {
@Override
public void initMap() {
// to do nothing
}
};
// 如果模板引擎是 freemarker
String templatePath = "/templates/mapper.xml.ftl";
// 自定义输出配置
List<FileOutConfig> focList = new ArrayList<>();
// 自定义配置会被优先输出
focList.add(new FileOutConfig(templatePath) {
@Override
public String outputFile(TableInfo tableInfo) {
// 自定义输出文件名 , 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化!!
return projectPath + "/src/main/resources/mapper/" + pc.getModuleName()
+ "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
}
});
cfg.setFileOutConfigList(focList);
mpg.setCfg(cfg);
//=================== 配置TemplateConfig(模板配置)
// 配置模板
TemplateConfig templateConfig = new TemplateConfig();
templateConfig.setXml(null);
mpg.setTemplate(templateConfig);
//=================== 配置StrategyConfig(策略配置)
// 策略配置,我喜欢叫数据库表配置
StrategyConfig strategy = new StrategyConfig();
// 数据库表映射到实体的命名策略:下划线转驼峰
strategy.setNaming(NamingStrategy.underline_to_camel);
// 数据库表字段映射到实体的命名策略, 未指定按照 naming 执行
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
// 实体是否为lombok模型(默认 false)
strategy.setEntityLombokModel(true);
// 生成 @RestController 控制器
strategy.setRestControllerStyle(true);
// 实体类主键名称设置--------------------------------------------------------
// 这个地方如果不注释的话生成的对象类就没有id这个地段
// strategy.setSuperEntityColumns("id");
// 需要包含的表名,允许正则表达式
//这里我做了输入设置
strategy.setInclude(scanner("表名,多个英文逗号分割").split(","));
// 需要排除的表名,允许正则表达式
//strategy.setExclude("***");
// 是否生成实体时,生成字段注解 默认false;
strategy.setEntityTableFieldAnnotationEnable(true);
// 驼峰转连字符
strategy.setControllerMappingHyphenStyle(true);
// 表前缀
strategy.setTablePrefix(pc.getModuleName() + "_");
// 把数据库配置添加到代码生成器主类
mpg.setStrategy(strategy);
// 在代码生成器主类上配置模板引擎
mpg.setTemplateEngine(new FreemarkerTemplateEngine());
//生成
mpg.execute();
}
2.3然后启动spring的启动类就可以了 下面这个就是我的生成效果图
如果对逆向生成代码还要问题的可以参考博客:
https://blog.csdn.net/xzys430/article/details/109089884
3.搭建连接 数据库的环境
3.1在配置文件application.properties配置文件中粘贴入以下代码同理标------也是需要注意然后进行修改的
#应用名称------------------------
spring.application.name=demo_pluse
#访问端口号
server.port=8081
#编码格式
server.tomcat.uri-encoding=utf-8
#数据库相关配置----------------------
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=utf-8&serverTimezone=UTC
spring.datasource.username=root
spring.datasource.password=
#
spring.datasource.max-idle=10
spring.datasource.max-wait=10000
spring.datasource.min-idle=5
spring.datasource.initial-size=5
#session生命周期
server.servlet.session.timeout=30m
3.2将启动类恢复到原来的样子,(把添加的逆向生成代码的文件去掉,把之前注释掉的原代码恢复为原来的样子)并且加上@MapperScan
@SpringBootApplication
@MapperScan("/com.demo")
public class DemoPluseApplication {
public static void main(String[] args) {
SpringApplication.run(DemoPluseApplication.class, args);
}
}
3.3随便写一个测试接口测试一下
来到controller层
@RestController
@RequestMapping("/test-user")
public class TestUserController {
// 自动注入service层
// 切记testUserServiceImpl这个地方要和service层实现层的名称保持一致
@Autowired
ITestUserService testUserServiceImpl;
@RequestMapping("/list")
public Object list(){
// 这个就是Iservice中的直接调用即可
return testUserServiceImpl.list();
}
}
3.4启动的过程中可能出现的错误
3.4.1 No active profile set, falling back to default profiles: default
报错图:
解决方法: 打开pom文件 找到
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-tomcat</artifactId>
<scope>provided</scope>
</dependency>
删掉(更新一下pom文件) 重新启动 问题解决
3.4.2 No MyBatis mapper was found in ‘[com.demo_pluse]’ package. Please check your configuration.
解决方法
按图示将启动类挪动对应的包下即可
问题解决
3.4.3 Error creating bean with name ‘XXX’: Unsatisfied dependency expressed through field ‘XXX’;
报错图
解决方法:
检查启动类是否有@MapperScan注解或者注解是否正确 参考目录3.2有解释
3.4.4 Field testUserService in com.demo.controller.TestUserController required a single bean, but 2 were found:
报错图:
解决方法:
检查controller层自动注入的地方 目录3.3 代码注释有强调,可以参考
3.5启动成功后测试(打开浏览器直接访问接口即可)
如图可以访问到数据库的内容就代表成功了