搭建Springboot项目并集成Mybatis-Plus

1. idea创建Springboot项目


创建项目:
搭建Springboot项目并集成Mybatis-Plus_第1张图片

2. 创建数据库表


表结构如下

id name age email
1 Jone 18 test1@baomidou.com
2 Jack 20 test2@baomidou.com
3 Tom 28 test3@baomidou.com
4 Sandy 21 test4@baomidou.com
5 Billie 24 test5@baomidou.com

其对应的数据库 Schema 脚本如下:

DROP TABLE IF EXISTS user;

CREATE TABLE user
(
 id BIGINT(20) NOT NULL COMMENT '主键ID',
 name VARCHAR(30) NULL DEFAULT NULL COMMENT '姓名',
 age INT(11) NULL DEFAULT NULL COMMENT '年龄',
 email VARCHAR(50) NULL DEFAULT NULL COMMENT '邮箱',
 PRIMARY KEY (id)
);

其对应的数据库 Data 脚本如下:

DELETE FROM user;

INSERT INTO user (id, name, age, email) VALUES
(1, 'Jone', 18, 'test1@baomidou.com'),
(2, 'Jack', 20, 'test2@baomidou.com'),
(3, 'Tom', 28, 'test3@baomidou.com'),
(4, 'Sandy', 21, 'test4@baomidou.com'),
(5, 'Billie', 24, 'test5@baomidou.com');

3.添加依赖


引入 Spring Boot Starter 父工程:


    org.springframework.boot
    spring-boot-starter-parent
    2.3.5.RELEASE
    

引入 spring-boot-starterspring-boot-starter-testmybatis-plus-boot-starterlombokdruidmysql-connector-javamybatis-plus-generatorvelocity-engine-corefreemarker等依赖:


  org.springframework.boot
 spring-boot-starter-web
 
  org.springframework.boot
 spring-boot-starter-test
 test
   org.junit.vintage
 junit-vintage-engine
   
 
 
 org.projectlombok
 lombok
 true
 
 
 
 com.baomidou
 mybatis-plus-generator
 3.4.0
 
 
 
 org.apache.velocity
 velocity-engine-core
 2.2
 
 
 
 org.freemarker
 freemarker
 2.3.30
 
 
 
 com.baomidou
 mybatis-plus-boot-starter
 3.4.0
 
 
 
 mysql
 mysql-connector-java
 runtime
 
 
  
 com.alibaba
 druid
 1.2.1
 

4.配置


把resource包下的application.properties复制一份再粘贴名字改成application.yml,在 application.yml 配置文件中添加 mysql 数据库的相关配置:

# 端口配置
server:
  port: 8080
 servlet:
    context-path: /
# 数据源配置
spring:
  application:
    name: springboot-mybatis-plus
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
 url: jdbc:mysql://localhost:3306/mybatis_plus?useUnicode=true&characterEncoding=utf-8&useSSL=true&serverTimezone=UTC
    type: com.alibaba.druid.pool.DruidDataSource
 username: root
    password: root
  jackson:
    date-format: yyyy-MM-dd HH:mm:ss
    time-zone: GMT+8
# Mybatis-Plus配置
mybatis-plus:
  # 如果是放在src/main/java目录下 classpath:/com/yourpackage/*/mapper/*Mapper.xml # 如果是放在resource目录 classpath:/mapper/*Mapper.xml mapper-locations: classpath*:com/frame/**/**.xml,classpath*:mapper/*.xml
  #实体扫描,多个package用逗号或者分号分隔
 typeAliasesPackage: com.frame.**.entity,com.frame.**.dto
  global-config:
    #刷新mapper 调试神器
 db-config:
      #主键类型 0:"数据库ID自增", 1:"用户输入ID",2:"全局唯一ID (数字类型唯一ID)", 3:"全局唯一ID UUID";
 id-type: UUID
 #字段策略 IGNORED:"忽略判断"  NOT_NULL:"非 NULL 判断")  NOT_EMPTY:"非空判断"
 field-strategy: NOT_EMPTY
      #数据库类型
 db-type: MYSQL
      #逻辑删除配置
 logic-delete-value: 1 # 逻辑已删除值(默认为 1) logic-not-delete-value: 0 # 逻辑未删除值(默认为 0) #驼峰下划线转换
 column-underline: false
      #数据库大写下划线转换
 #      capital-mode: true
 refresh: true
  configuration:
    # 是否开启自动驼峰命名规则映射:从数据库列名到Java属性驼峰命名的类似映射
 map-underscore-to-camel-case: true
 # 如果查询结果中包含空值的列,则 MyBatis 在映射的时候,不会映射这个字段
 call-setters-on-nulls: true
 cache-enabled: false
 #配置JdbcTypeForNull, oracle数据库必须配置
 jdbc-type-for-null: 'null'
 # 这个配置会将执行的sql打印出来,在开发或测试的时候可以用
 log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
 database-id: mysql

5.代码生成器


AutoGenerator 是 MyBatis-Plus 的代码生成器,通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码

 /**
 * 

* 读取控制台内容 *

*/ 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 + "!"); } public static void main(String[] args) { // 代码生成器 AutoGenerator mpg = new AutoGenerator(); // 全局配置 GlobalConfig gc = new GlobalConfig(); String projectPath = System.getProperty("user.dir"); gc.setOutputDir(projectPath + "/src/main/java"); gc.setAuthor("wulongbo"); gc.setOpen(false); // gc.setSwagger2(true); 实体属性 Swagger2 注解 mpg.setGlobalConfig(gc); // 数据源配置 DataSourceConfig dsc = new DataSourceConfig(); dsc.setUrl("jdbc:mysql://localhost:3306/mybatis_plus?useUnicode=true&characterEncoding=utf-8&autoReconnect=true&useSSL=false&serverTimezone=Asia/Shanghai"); // dsc.setSchemaName("public"); dsc.setDriverName("com.mysql.jdbc.Driver"); dsc.setUsername("root"); dsc.setPassword("root"); mpg.setDataSource(dsc); // 包配置 PackageConfig pc = new PackageConfig(); // pc.setModuleName(scanner("模块名")); pc.setParent("com.mybatis.plus"); 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/mapper.xml.vm"; // 自定义输出配置 List 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.setFileCreate(new IFileCreate() { @Override public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) { // 判断自定义文件夹是否需要创建 checkDir("调用默认方法创建的目录,自定义目录用"); if (fileType == FileType.MAPPER) { // 已经生成 mapper 文件判断存在,不想重新生成返回 false return !new File(filePath).exists(); } // 允许生成模板文件 return true; } }); */ 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("你自己的父类实体,没有就不用设置!"); strategy.setEntityLombokModel(true); strategy.setRestControllerStyle(true); // 公共父类 // strategy.setSuperControllerClass("你自己的父类控制器,没有就不用设置!"); // 写于父类中的公共字段 // strategy.setSuperEntityColumns("id"); //删掉,不删的话实体类没有id strategy.setInclude(scanner("表名,多个英文逗号分割").split(",")); strategy.setControllerMappingHyphenStyle(true); // strategy.setTablePrefix("sys" + "_");//去掉表前缀 strategy.setTablePrefix("tbl" + "_");//去掉表前缀 mpg.setStrategy(strategy); mpg.setTemplateEngine(new FreemarkerTemplateEngine()); mpg.execute(); }

执行 main 方法控制台输入模块表名【user】回车自动生成对应项目目录,目录结构如下:
搭建Springboot项目并集成Mybatis-Plus_第2张图片

6.启动Springboot项目


必须要在springboot启动类上加上扫包注解@MapperScan(basePackages = "com.xxx.xxx"),或者在Dao层上加上@Mapper 或 @Repository注解来注入Mapper文件,在这里选用主程序扫包的方式注入
搭建Springboot项目并集成Mybatis-Plus_第3张图片
install一下,然后启动项目,如果启动失败,则需要跳过测试,在pom文件中添加配置跳过测试


   org.springframework.boot
 spring-boot-maven-plugin
  true
   
 
 org.apache.maven.plugins
 maven-surefire-plugin
 2.22.2
  true
   

启动成功后如图,至此Springboot集成Mybatis-Plus就OK了
【参考文档】Mybatis-Plus官网链接:Mybatis-Plus官网
由于公司性质,所有代码加密了,外网github上传不了所以这里就不提供github链接了。

你可能感兴趣的