Spring boot2+Mybais+Mysql+flyway简单集成Demo

最新推荐文章于 2024-08-14 16:51:21 发布

CircleMouse

最新推荐文章于 2024-08-14 16:51:21 发布

阅读量910

点赞数

本文链接：https://blog.csdn.net/sinat_27956747/article/details/97135398

版权

SpringBoot 同时被 3 个专栏收录

11 篇文章 0 订阅

订阅专栏

MySQL

5 篇文章 0 订阅

订阅专栏

Mybatis

3 篇文章 0 订阅

订阅专栏

步骤0

项目准备
1.JDK1.8 安装配置
2.Maven 3.6安装配置
3.IDEA 2019安装
4.Navicat 12安装
5.MariaDB 安装支撑MySQL 数据库

步骤1 项目层级结构

首先搭建一个简单的Spring boot项目
然后在src/main/java 中分别添加不同的层级目录，在这个小demo中，测试的用例：User Worker
pension层级结构

步骤2 maven依赖

项目所需要的maven 依赖，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 http://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>2.1.6.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.circle</groupId>
    <artifactId>demo</artifactId>
    <version>1.0.0</version>
    <name>dtdream</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!--lombok依赖-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.16.20</version>
            <scope>provided</scope>
        </dependency>

        <!-- test依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

        <!-- mysql依赖 -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.40</version>
        </dependency>

        <!--添加JPA的依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-jpa</artifactId>
        </dependency>

        <!-- mybatis轻量级依赖 -->
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>1.3.1</version>
        </dependency>
        <!--flyway的依赖-->
        <dependency>
            <groupId>org.flywaydb</groupId>
            <artifactId>flyway-core</artifactId>
        </dependency>
        <!--JDBC的依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jdbc</artifactId>
        </dependency>
        <!--热部署配置 自动应用代码更改到最新的App上面-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <optional>true</optional>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <!-- 要使生成的jar可运行，需要加入此插件 -->
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
            <plugin>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.7.0</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.flywaydb</groupId>
                <artifactId>flyway-maven-plugin</artifactId>
                <version>5.2.4</version>
            </plugin>
            <!--开启热部署的插件依赖-->
            <plugin>
                <groupId>org.springframework</groupId>
                <artifactId>springloaded</artifactId>
                <version>1.2.6.RELEASE</version>
                <configuration><fork>true</fork></configuration>
            </plugin>
        </plugins>
    </build>
</project>

步骤3

Model层

编写两个类 User 和 Worker

User实体类

import lombok.Data;

@Data
public class User {

    private String name;
    private Integer id;
    private Integer age;
    private String password;
    private String email;

    public User(String name) {
        this.name = name;
    }
    public User() {
        super();
    }

    public User(String name, Integer id, Integer age, String password, String email) {
        this.name = name;
        this.id = id;
        this.age = age;
        this.password = password;
        this.email = email;
    }

    @Override
    public String toString() {
        return "Student{" +
                "name='" + name + '\'' +
                ", id='" + id + '\'' +
                ", age=" + age +
                '}';
    }
}

Worker实体类

import lombok.Data;

@Data
public class Worker {
    private Integer id;
    private String name;
    private String password;
    private String email;

    public Worker(String name) {
        this.name = name;
    }

    public Worker(Integer id, String name, String password, String email) {
        this.id = id;
        this.name = name;
        this.password = password;
        this.email = email;
    }

    @Override
    public String toString() {
        return "Worker{" +
                "id=" + id +
                ", name='" + name + '\'' +
                ", password='" + password + '\'' +
                ", email='" + email + '\'' +
                '}';
    }
}

lombok

该依赖在pom.xml文件中已经有了依赖，@Data注解在类上, 为类提供读写属性（get,set）, 此外还提供了 equals()、hashCode()、toString() 方法

DAO层

@Mapper

@Mapper注解，标注该类属于DAO层，目的就是为了不再写mapper映射文件，添加了@Mapper注解之后这个接口在编译时会生成相应的实现类。
注意：这个接口中不可以定义同名的方法，因为会生成相同的id，也就是说这个接口是不支持重载的

WorkerDAO

import com.circle.demo.model.Worker;
import org.apache.ibatis.annotations.Mapper;

@Mapper
public interface WorkerDao {
    Worker getWorkerById( Integer id);
}

UserDAO（可自行编写）

Service层

该层级结构一般用来书写接口，这一层的结构添加**@Service注解进行容器管理**

WorkerService

import com.circle.demo.model.Worker;
import org.springframework.stereotype.Service;

@Service
public interface WorkerService {
    Worker getWorkerById(Integer id);
}

UserService(自行编写)

ServiceImpl层

该层是对Service层接口的实现类，添加**@Service注解进行容器管理**

WorkerServieImpl

import com.circle.demo.dao.WorkerDao;
import com.circle.demo.model.Worker;
import com.circle.demo.service.WorkerService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class WorkServiceImpl implements WorkerService {

    @Autowired(required=false)
    WorkerDao workerDao;

    @Override
    public Worker getWorkerById(Integer id) {
        return workerDao.getWorkerById(id);
    }
}

注意：@Autowired(required=false)
1.在使用spring开发过程中，我们基本上都是使用@Autowired这个注解，用来注入已有的bean，且默认的required=true
2.@Autowired(required=false)：表示忽略当前要注入的bean，如果有直接注入，没有跳过
3.解析：在容器的启动过程中，会初始化很多bean，这也是spring的核心之一（IOC）。但是在注入的过程中，扫描到公共方法中要注入的bean，并未找到，强行注入就会注入失败。所以我们采取的思想就是有bean就注入，没有就不注入。解决办法就是@Autowired(required=false)。

@Autowired @Resource @Qualifier区别

参考链接

@Resource的作用相当于@Autowired，只不过@Autowired按byType自动注入，而@Resource默认按 byName自动注入
@Autowired默认按类型装配（这个注解是属业spring的）,默认情况下必须要求依赖对象必须存在，如果要允许null值，可以设置它的required属性为false，如：@Autowired(required=false) ，如果我们想使用名称装配可以结合@Qualifier注解进行使用
@Resource，默认按照名称进行装配（这个注解属于J2EE的），名称可以通过name属性进行指定，如果没有指定name属性，当注解写在字段上时，默认取字段名进行安装名称查找，如果注解写在setter方法上默认取属性名进行装配。当找不到与名称匹配的bean时才按照类型进行装配。但是需要注意的是，如果name属性一旦指定，就只会按照名称进行装配。

@Autowired()@Qualifier("baseDao")
private BaseDao baseDao;

@Resource(name="baseDao")
private BaseDao baseDao;

UserServieImpl(自行编写)

Controller层

WokerController

这里编写简单胡两个测试方法，hello方法，getWorkerById方法
@RestController 注解作用就是@ResponseBody + @Controller 注解将返回的数据以json的形式传递到网页前端
@RequestMapping 表示该controller请求的路径，在类上添加该注解表示，该类的所有方法的统一路径，其路径下可以有子路径，常用参数RequestMethod，其值可以有，RequestMethod.POST, RequestMethod.GET,不一一列举
@PostMapping @GetMapping 则表示RequestMapping 的Post请求，Get 请求
@PathVariable 表示url路径请求的时候，传入的值1，形式为url /id/1
@RequestParam 表示请求的路径传入的参数值1，形式为url ？id=1

import com.circle.demo.model.Worker;
import com.circle.demo.service.WorkerService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

@RestController
public class WorkerController {

    @Autowired
    WorkerService workerService ;

    @GetMapping( "/hello")
    public String hello(){
        System.out.println("hello");
        return "hello";
    }

    @GetMapping("/id/{id}")
    public Worker getWorkerById(@PathVariable("id") Integer id){
        System.out.println(workerService.getWorkerById(id).toString());
       return  workerService.getWorkerById(id);
    }
}

步骤4

Mybatis 文件的配置，mapper.xml 以及mybatis 在application.yml文件的配置

WorkerMapper.xml 和DtdreamApplication 类

@MapperScan(basePackages = {“com.circle.demo.dao”}) 扫描标注@Maper的类

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
@MapperScan(basePackages = {"com.circle.demo.dao"})
public class DtdreamApplication {

    public static void main(String[] args) {
        SpringApplication.run(DtdreamApplication.class, args);
    }
}

#和$符号的区别

#：占位符号，可以防止sql注入（替换结果会增加单引号‘’）,解析为一个 JDBC 预编译语句（prepared statement）的参数标记符
美元符号 $: s q l 拼接符号（替换结果不会增加单引号 ‘ ’ ，$ { } 仅仅为一个纯碎的 string 替换，在动态 SQL 解析阶段将会进行变量替换。使用场景：like和order by后使用，存在sql注入问题，需手动代码中过滤）

注意：

type=“com.circle.demo.model.Worker” ，这里是Worker的所在的包名的类的位置
**mapper.xml文件中，设置查看jdbcType和javaType的数据类型
参考1
参考2

<?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.circle.demo.dao.WorkerDao">
    <!--设置model类和数据库中表的字段一一对应，注意数据库字段和domain类中的字段名称不致，此处一定要！-->
    <resultMap id="BaseResultMap" type="com.circle.demo.model.Worker">
        <id column="id" property="id" jdbcType="INTEGER" />
        <result column="name" property="name" jdbcType="CHAR" />
        <result column="password" property="password" jdbcType="CHAR" />
        <result column="email" property="email" jdbcType="CHAR" />
    </resultMap>
    <!-- 查询单条记录 -->
    <select id="getWorkerById" parameterType="INTEGER" resultMap="BaseResultMap">
        SELECT * FROM auth_worker WHERE id = #{id}
    </select>
</mapper>

大坑！！！WorkerMapper.xml文件中，id，type等不可以有多余的空格，否则报错

UserMapper.xml(自行编写)

步骤5 application.yml

spring:
  datasource:
    password: root
    driver-class-name: com.mysql.jdbc.Driver
    url: jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=utf8&mysqlEncoding=utf8
    username: root
    hikari:
      minimum-idle: 5
      maximum-pool-size: 20
  jpa:
    show-sql: true
    hibernate:
      ddl-auto: create
    database-platform: org.hibernate.dialect.MySQL5InnoDBDialect
  flyway:
    baselineVersion: 1.0.0
    outOfOrder: true
    locations: classpath:db/migration
    baselineOnMigrate: true
    enabled: true
mybatis:
  #config-location: classpath:config/mybatis-config.xml
  mapper-locations: classpath:com/circle/mapper/*.xml
  #type-aliases-package: com.circle.demo.model

sql文件和mapper文件存放位置

步骤6 flyway插件

flyway 自动化执行的脚本文件：V1.2.1__addworkertable.sql

SET FOREIGN_KEY_CHECKS=0;

DROP TABLE IF EXISTS `auth_worker`;
CREATE TABLE `auth_worker` (
  `id` int(11) NOT NULL AUTO_INCREMENT COMMENT '主键',
  `name` char(30)  NULL COMMENT '姓名',
  `password` char(10)  NULL COMMENT '密码',
  `email` char(30)  NULL COMMENT '邮箱',
  PRIMARY KEY (`id`),
  KEY `IDX_NAME` (`name`)
) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8;

INSERT INTO auth_worker (id, name, password, email) VALUES (1, '林炳文', '1234567@', 'ling20081005@126.com');
INSERT INTO auth_worker (id, name, password, email) VALUES (2, 'evan', '123', 'fff@126.com');
INSERT INTO auth_worker (id, name, password, email) VALUES (3, 'kaka', 'cadg', 'fwsfg@126.com');
INSERT INTO auth_worker (id, name, password, email) VALUES (4, 'simle', 'cscs', 'fsaf@126.com');
INSERT INTO auth_worker (id, name, password, email) VALUES (5, 'arthur', 'csas', 'fsaff@126.com');
INSERT INTO auth_worker (id, name, password, email) VALUES (6, '小德', 'yuh78', 'fdfas@126.com');
INSERT INTO auth_worker (id, name, password, email) VALUES (7, '小小', 'cvff', 'fsaf@126.com');
INSERT INTO auth_worker (id, name, password, email) VALUES (8, '林林之家', 'gvv', 'lin@126.com');
INSERT INTO auth_worker (id, name, password, email) VALUES (9, '林炳文', 'dfsc', 'ling2008@126.com');
INSERT INTO auth_worker (id, name, password, email) VALUES (10, 'apple', 'uih6', 'ff@qq.com');

DROP TABLE IF EXISTS `auth_user`;
CREATE TABLE `auth_user` (
  `id` int(11) NOT NULL AUTO_INCREMENT COMMENT '主键',
  `name` char(30)  NULL COMMENT '姓名',
  `password` char(10)  NULL COMMENT '密码',
  `email` char(30)  NULL COMMENT '邮箱',
  `age` int(11) NULL COMMENT '年龄',
  PRIMARY KEY (`id`),
  KEY `IDX_NAME` (`name`)
) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8;

测试

访问hello方法
在这里插入图片描述
 访问getId方法

总结

参考链接

flyway的命名规范
flyway 自动化脚本执行，将数据迁移到Navbicate的时候，解决中文乱码问题，配置数据的时候，url尾部添加 useUnicode=true&characterEncoding=utf8&mysqlEncoding=utf8
Spring boot集成 Mybatis 的时候，注解的添加和理解，@Mapper 以及@MapperScan,Mappe的.xml文件的检查
项目源码