前戏:
本职web前端,个人学习的首个springboot项目搭建记录篇。
公司有使用springboot2+mybatis的项目案例,第一感觉与springBoot3+mybatis-plus比较大不同的点:
1、springboot2+mybatis的只生成了entity和mapper文件,Service与Controller相关需自行实现;而springBoot3+mybatis-plus生成全套代码
2、springboot2+mybatis生成的xml文件有sql的实现语句代码;而springBoot3+mybatis-plus生成的xml文件默认没有sql语句代码,代码更简洁(被集成到了BaseMapper里面)
3、生成代码配置文件不太一样
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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>3.2.3</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.example</groupId>
<artifactId>demoPLC</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>demoPLC</name>
<description>demoPLC</description>
<properties>
<java.version>17</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.11</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<!-- modbus工具包,按业务需要引入 -->
<dependency>
<groupId>com.intelligt.modbus</groupId>
<artifactId>jlibmodbus</artifactId>
<version>1.2.9.7</version>
</dependency>
<!-- 【核心包】mybatis-plus -->
<!-- 注意:官网【快速入门/安装】位置有说明,springboot2/3版本不同使用包不一样 -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-spring-boot3-starter</artifactId>
<version>3.5.5</version>
</dependency>
<!-- 【核心包】mybatis-plus代码生成器 -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.5.5</version>
</dependency>
<!-- 【相关包】注解形式简化代码,mybatis-plus配置有使用到 -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<!-- 【核心包】模板引擎,mybatis-plus配置有使用到以此包代码模板进行生成(可按需求更换) -->
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
<version>2.3.32</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
application.properties文件配置:
server.port=8080
# 配置数据库
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/plcdemo?serverTimezone=UTC&useSSL=false&useUnicode=true&characterEncoding=utf-8
spring.datasource.username=root
spring.datasource.password=123456
# 配置mybatis-plus扫描的xml文件路径(路径按项目生成代码后的路径)
# 注册后在 Mapper 对应的 XML 文件中可以直接使用类名,而不用使用全限定的类名(即 XML 中调用的时候不用包含包名)
mybatis-plus.mapper-locations=classpath:*/mapperXml/*.xml
Application.java文件配置:
// 指定要扫描的 Mapper 接口所在的包(根据生成的代码路径配置)
@MapperScan("com.example.demoplc.model.mapper")
@SpringBootApplication
// 开启Spring的任务调度功能
@EnableScheduling
public class DemoPlcApplication {
public static void main(String[] args) {
SpringApplication.run(DemoPlcApplication.class, args);
System.out.println("程序启动完成!!");
}
}
MyBatisPlusApplication.java文件配置(自行创建文件):
配置完执行该文件的main方法进行代码生成。
package com.example.demoplc.myBatisPlus;
import com.baomidou.mybatisplus.generator.FastAutoGenerator;
import com.baomidou.mybatisplus.generator.config.rules.DbColumnType;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
import java.sql.Types;
/**
* MyBatisPlus官网 https://baomidou.com/
*/
public class MyBatisPlusApplication {
public static void main(String[] args) {
// 生成的代码文件包输出根目录
String outPath = "E:/javaDemo/demoPLC/src/main/java";
// 数据库
String sqlUrl = "jdbc:mysql://127.0.0.1:3306/plcdemo?serverTimezone=UTC&useSSL=false&useUnicode=true&characterEncoding=utf-8";
String sqlUserName = "root";
String sqlPassword = "123456";
// 需要生成的数据表名,多表用逗号隔开(生成的代码会按此数据表字段进行生成对应文件)
String tables = "aa,bb";
/**
* 数据库配置
*/
FastAutoGenerator fastAutoGenerator = FastAutoGenerator.create(sqlUrl, sqlUserName, sqlPassword);
/**
* 全局配置
*/
fastAutoGenerator.globalConfig(builder -> {
builder.author("YYYY") // 设置作者
.outputDir(outPath)
.disableOpenDir() // 禁止自动打开输出目录
.commentDate("yyyy-MM-dd HH:mm:dd");//注释日期
});
/**
* 数据库配置
* 兼容旧版本转换成Integer
*/
fastAutoGenerator.dataSourceConfig(builder -> builder.typeConvertHandler((globalConfig, typeRegistry, metaInfo) -> {
int typeCode = metaInfo.getJdbcType().TYPE_CODE;
if (typeCode == Types.SMALLINT) {
// 自定义类型转换
return DbColumnType.INTEGER;
}
return typeRegistry.getColumnType(metaInfo);
}));
/**
* 包配置
*/
fastAutoGenerator.packageConfig(builder -> {
builder.parent("com.example.demoplc") // 设置父包名 - 生成文件夹的父文件(默认在根目录生成,java文件夹下的整个路径)
.moduleName("") // 设置父包模块名
.entity("model.entity") // entity 包名 (前面model.代表在entity上面会再生成个父文件夹)
.service("model.service") // service 包名
.serviceImpl("model.impl") // impl 包名
.mapper("model.mapper") // mapper 包名
.xml("model.mapperXml") // Mapper XML 包名
.controller("controller"); // Controller 包名(该生成后的必须与项目启动类Application.java路径同层)
// 注意:留意生成文件第一行代码(package com.example.demoplc.model.mapper;)路径是否正确,不正确的路径启动项目正常但是无法正常访问controller接口
});
/**
* 策略配置
* entityBuilder().naming: 默认下划线转驼峰命
* 重点注意:可以通过不同文件夹的策略配置设置enableFileOverride()确定是否覆盖原文件,防止自定义代码被覆盖
*/
fastAutoGenerator.strategyConfig(builder -> {
// 设置需要生成的表名,多个表名用逗号隔开如:"aa,bb"
builder.addInclude(tables).
entityBuilder() // 【Entity 策略配置】
.enableTableFieldAnnotation() // 【Entity 策略配置】 开启生成实体时生成字段注解
.enableFileOverride() // 【Entity 策略配置】 开启覆盖已生成文件
.enableLombok() // 【Entity 策略配置】 开启 lombok 模型
.controllerBuilder() // 【Controller 策略配置】
.enableRestStyle() // 【Controller 策略配置】 开启 @RestController注解
// .enableFileOverride() // 【Controller 策略配置】 开启覆盖已生成文件
.mapperBuilder() // 【mapper 策略配置】
.enableMapperAnnotation() // 【mapper 策略配置】 开启 @Mapper 注解
// .serviceBuilder() // 【service 策略配置】
// .enableFileOverride() // 【service 策略配置】 开启覆盖已生成文件
;
});
/**
* 生成代码模板
*/
fastAutoGenerator.templateEngine(new FreemarkerTemplateEngine()); // 使用Freemarker引擎模板,默认的是Velocity引擎模板
/**
* 运行生成
*/
fastAutoGenerator.execute();
}
}
生成后项目文件结构效果:
生成后entity文件效果:
package com.example.demoplc.model.entity;
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import java.io.Serializable;
import lombok.Getter;
import lombok.Setter;
/**
* <p>
* 测试用表
* </p>
*
* @author YYYY
* @since 2024-03-28 15:59:28
*/
@Getter
@Setter
@TableName("aa")
public class Aa implements Serializable {
private static final long serialVersionUID = 1L;
/**
* 主键
*/
@TableId("id")
private Integer id;
/**
* 姓名
*/
@TableField("a")
private String a;
/**
* 年龄
*/
@TableField("b")
private String b;
/**
* 性别
*/
@TableField("c")
private String c;
/**
* 驼峰测试字段
*/
@TableField("test_a")
private String testA;
/**
* 驼峰测试字段b
*/
@TableField("test_b")
private String testB;
}
生成后mapper文件效果:
package com.example.demoplc.model.mapper;
import com.example.demoplc.model.entity.Aa;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
/**
* <p>
* 测试用表 Mapper 接口
* </p>
*
* @author YYYY
* @since 2024-03-28 15:03:28
*/
public interface AaMapper extends BaseMapper<Aa> {
}
生成后mapperXML文件效果:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.example.demoplc.model.mapper.AaMapper">
</mapper>
生成后impl文件效果:
package com.example.demoplc.model.impl;
import com.example.demoplc.model.entity.Aa;
import com.example.demoplc.model.mapper.AaMapper;
import com.example.demoplc.model.service.IAaService;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import org.springframework.stereotype.Service;
/**
* <p>
* 测试用表 服务实现类
* </p>
*
* @author YYYY
* @since 2024-03-28 15:03:28
*/
@Service
public class AaServiceImpl extends ServiceImpl<AaMapper, Aa> implements IAaService {
}
生成后Service文件效果:
package com.example.demoplc.model.service;
import com.example.demoplc.model.entity.Aa;
import com.baomidou.mybatisplus.extension.service.IService;
/**
* <p>
* 测试用表 服务类
* </p>
*
* @author YYYY
* @since 2024-03-28 15:03:28
*/
public interface IAaService extends IService<Aa> {
}
生成后Controller文件效果:
package com.example.demoplc.controller;
import com.example.demoplc.model.entity.Aa;
import com.example.demoplc.model.mapper.AaMapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
/**
* <p>
* 测试用表 前端控制器
* </p>
*
* @author YYYY
* @since 2024-03-28 15:03:28
*/
@RestController
@RequestMapping("/aa")
public class AaController {
}