SpringBoot集成MyBatis(详细)
前言
JPA和MyBatis，JPA是SpringBoot官方的，前身就是著名的三大框架之一的Hibernate，好处是不用手写SQL（当然它也支持手写，如果必要的话），而MyBatis灵活性非常高，但是需要手写SQL语句。
第一步，配置pom.xml文件
创建一个Maven项目，配置pom.xml文件
添加相关依赖
<!-- 父依赖 -->
<parent>
<artifactId>spring-boot-starter-parent</artifactId>
<groupId>org.springframework.boot</groupId>
<version>2.7.1</version>
</parent>
<dependencies>
<!--springboot其他依赖-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
</dependency>
<!-- MyBatis 启动器 -->
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>2.1.4</version>
</dependency>
<!-- MySQL驱动器 -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
</dependencies>
第二步，编写配置文件
此处配置文件采用YAML文件形式
YAML是JSON的一个超集，可以非常方便地将外部配置以层次结构形式存储起来。当项目的类路径有SnakeYAML库（spring-boot-starter 中已经被包含）时，SpringApplicaton类将自动支持YAML作为properties的替代。
# DB Configuration
spring:
datasource:
driver-class-name: com.mysql.jdbc.Driver #mysql是8版本以上的用com.mysql.jc.jdbc.Driver
url: jdbc:mysql://localhost:3306/weblogs?useUnicode=true&characterEncoding=utf8&useSSL=false&serverTimezone=GMT #localhost为连接地址，3306为mysql端口号，weblogs为数据库名，剩下的就是解决一些奇怪问题(时钟不同步...)的方法
username: root
password: 1234
#logging
logging:
level:
com.peng: debug #com.peng为自己程序包名
注意各个字段的缩进位置
第三步，创建实体类
package com.peng.entity;
public class EveryDay {
private String psv;
private String month;
private String day;
public String getPsv() {
return psv;
}
public void setPsv(String psv) {
this.psv = psv;
}
public String getMonth() {
return month;
}
public void setMonth(String month) {
this.month = month;
}
public String getDay() {
return day;
}
public void setDay(String day) {
this.day = day;
}
}
添加Lombk依赖后，调用下列参数，将不用手动敲写get/set方法
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
Lombok常用的几个注解：
@Data ： 注在类上，提供类的get、set、equals、hashCode、canEqual、toString方法
@AllArgsConstructor ： 注在类上，提供类的全参构造
@NoArgsConstructor ： 注在类上，提供类的无参构造
@Setter ： 注在属性上，提供 set 方法
@Getter ： 注在属性上，提供 get 方法
@EqualsAndHashCode ： 注在类上，提供对应的 equals 和 hashCode 方法
@Log4j/@Slf4j ： 注在类上，提供对应的 Logger 对象，变量名为 log
第四步，编写Mapper(Dao)
package com.peng.mapper;
import com.peng.entity.EveryDay;
import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Select;
import java.util.List;
@Mapper//是MyBatis框架用于声明Mapper接口的注解
public interface EveryDayMapper {
//查询所有记录
@Select("select * from dw_pvs_everyday")//用于映射查询SQL语句的注解
List<EveryDay> getAllEveryDays();
}
第五步，编写Service
首先创建一个接口文件EveryDayService，用来定义方法
package com.peng.service;
import com.peng.entity.EveryDay;
import java.util.List;
public interface EveryDayService {
//查询所有
List<EveryDay> getAllEveryDays();
}
然后在用目录下创建一个impl文件，在该文件里创建一个EveryDayService接口的实现类
package com.peng.service.impl;
import com.peng.entity.EveryDay;
import com.peng.mapper.EveryDayMapper;
import com.peng.service.EveryDayService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;
import java.util.List;
@Service //把EveryServiceImpl类放入到容器中
@Transactional //做事务处理的注解
public class EveryDayServiceImpl implements EveryDayService {
//注入数据Mapper
@Autowired//表示你需要这个对象，直接从容器中拿
private EveryDayMapper everyDayMapper;
//查询所有数据
public List<EveryDay> getAllEveryDays(){
return this.everyDayMapper.getAllEveryDays();
}
}
第六步，编写Controller
package com.peng.controller;
import com.peng.entity.EveryDay;
import com.peng.service.EveryDayService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.List;
@RestController//把这个类放入到容器中
@RequestMapping("/everyday")//访问路径
public class EveryDayController {
//注入数据Service
@Autowired
private EveryDayService everyDayService;
//查询所有数据
@RequestMapping("/everydayList")
public List<EveryDay> getAllEveryDays(){
List<EveryDay> list = this.everyDayService.getAllEveryDays();
return list;
}
}
@RestController 返回的是内容
@Cotroller 返回的是页面
运行结果：
扩充
链接Mysql另一种方法
一键生成SpringBoot三层结构
package com.pzb.covid19;
import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.IdType;
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.TableFill;
import com.baomidou.mybatisplus.generator.config.po.TableInfo;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
import java.util.ArrayList;
import java.util.List;
import java.util.Scanner;
public class MysqlGenerator {
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();
// 全局配置 注意导入com.baomidou.mybatisplus.generator.AutoGenerator
GlobalConfig gc = new GlobalConfig();
//String projectPath = System.getProperty("user.dir");
//输入项目的路径
String projectPath="D:\\\\IDEA";
//设置生成代码位置 请修改为自己项目路径
gc.setOutputDir(projectPath + "/covid19_project/covid19Echarts/src/main/java");
//设置作者
gc.setAuthor("pzb");
gc.setOpen(false);
gc.setIdType(IdType.AUTO);//设置全局id自增
//gc.setBaseResultMap(true);//设置生成BaseResultMap
// gc.setSwagger2(true); 实体属性 Swagger2 注解
mpg.setGlobalConfig(gc);
// 数据源配置 请修改为自己数据源配置
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl("jdbc:mysql://hadoop111/bigdata_pzb?useUnicode=true&useSSL=false&characterEncoding=utf8&serverTimezone=Asia/Shanghai");
// dsc.setSchemaName("public");
dsc.setDriverName("com.mysql.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("1234");
mpg.setDataSource(dsc);
// 包配置 请在控制台输入修改为自己的子包名
PackageConfig pc = new PackageConfig();
//weblog
pc.setModuleName(scanner("模块名"));
//设置父包名
pc.setParent("com.pzb");
mpg.setPackageInfo(pc);
// 自定义配置
InjectionConfig cfg = new InjectionConfig() {
@Override
public void initMap() {
// to do nothing
}
};
// 如果模板引擎是 freemarker 从依赖包的 templates下查找模板
String templatePath = "/templates/mapper.java.ftl";
// 如果模板引擎是 velocity
// String templatePath = "/templates/mapper.xml.vm";
// 自定义输出配置
List<FileOutConfig> focList = new ArrayList<>();
// 自定义配置会被优先输出
focList.add(new FileOutConfig(templatePath) {
@Override
//注意导包，core下也有同名的包
// com.baomidou.mybatisplus.generator.config.po.TableInfo
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");
strategy.setEnableSqlFilter(false);//开启支持输入正则表达式 生成所有表对应模块代码：\w*
strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
strategy.setControllerMappingHyphenStyle(true);
strategy.setTablePrefix("dw_");
//设置生成自动填充注解的表字段
ArrayList<TableFill> list = new ArrayList<>();
list.add(new TableFill("update_date", FieldFill.INSERT_UPDATE));
list.add(new TableFill("create_date", FieldFill.INSERT));
list.add(new TableFill("del_flag", FieldFill.INSERT));
strategy.setTableFillList(list);
strategy.setLogicDeleteFieldName("del_flag");//设置生成逻辑删除注解对应表字段名
mpg.setStrategy(strategy);
//设置对应模板的引擎
mpg.setTemplateEngine(new FreemarkerTemplateEngine());
mpg.execute();
}
}
此文件跟启动类同一个目录
