Spring boot 整合 Mybatis

前言

1
参考了很多文章,写下这篇仅供以后备忘记录使用

学了 Spring boot,现在刚好和之前学的 Mybatis 整合起来,利用插件可以自动生成代码,减少工作量。

创建一个 Springboot 项目

勾选模块.PNG

使用 MyBatis Generator 逆向生成代码

1.配置 Maven pom.xml 文件

在 pom.xml 增加以下插件:

1
2
3
4
5
6
7
8
9
10
11
12
13
<build>
<plugins>
<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.3.2</version>
<configuration>
<verbose>true</verbose>
<overwrite>true</overwrite>
</configuration>
</plugin>
</plugins>
</build>

配置好 Maven 插件,下面需要配置插件需要配置文件

2.配置插件的要配置文件

在 maven 项目下的 src/main/resources 目录下建立名为 Maven 的项目配置文件存放路径如下图:generatorConfig.xmlgenerator.properties 配置文件,

Maven的项目配置文件存放路径如下图 (图片中的generator.properties写成了generatorCongif.properties,请修改回generator.properties)

目录结构.PNG

generatorConfig.xml 代码如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration
PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
"http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">

<generatorConfiguration>
<!--导入属性配置-->
<properties resource="generator.properties"></properties>

<!--指定特定数据库的jdbc驱动jar包的位置-->
<classPathEntry location="${jdbc.driverLocation}"/>

<context id="default" targetRuntime="MyBatis3">

<!-- optional,旨在创建class时,对注释进行控制 -->
<commentGenerator>
<property name="suppressDate" value="true"/>
<property name="suppressAllComments" value="true"/>
</commentGenerator>

<!--jdbc的数据库连接 -->
<jdbcConnection
driverClass="${jdbc.driverClass}"
connectionURL="${jdbc.connectionURL}"
userId="${jdbc.userId}"
password="${jdbc.password}">
</jdbcConnection>


<!-- 非必需,类型处理器,在数据库类型和java类型之间的转换控制-->
<javaTypeResolver>
<property name="forceBigDecimals" value="false"/>
</javaTypeResolver>


<!-- Model模型生成器,用来生成含有主键key的类,记录类 以及查询Example类
targetPackage 指定生成的model生成所在的包名
targetProject 指定在该项目下所在的路径
-->
<javaModelGenerator targetPackage="com.donlex.mybatiswithspringboot.model"
targetProject="src/main/java">

<!-- 是否允许子包,即targetPackage.schemaName.tableName -->
<property name="enableSubPackages" value="false"/>
<!-- 是否对model添加 构造函数 -->
<property name="constructorBased" value="true"/>
<!-- 是否对类CHAR类型的列的数据进行trim操作 -->
<property name="trimStrings" value="true"/>
<!-- 建立的Model对象是否 不可改变 即生成的Model对象不会有 setter方法,只有构造方法 -->
<property name="immutable" value="false"/>
</javaModelGenerator>

<!--Mapper映射文件生成所在的目录 为每一个数据库的表生成对应的SqlMap文件 -->
<sqlMapGenerator targetPackage="mapping"
targetProject="src/main/resources">
<property name="enableSubPackages" value="false"/>
</sqlMapGenerator>

<!-- 客户端代码,生成易于使用的针对Model对象和XML配置文件 的代码
type="ANNOTATEDMAPPER",生成Java Model 和基于注解的Mapper对象
type="MIXEDMAPPER",生成基于注解的Java Model 和相应的Mapper对象
type="XMLMAPPER",生成SQLMap XML文件和独立的Mapper接口
-->
<javaClientGenerator targetPackage="com.donlex.mybatiswithspringboot.mapper"
targetProject="src/main/java" type="XMLMAPPER">
<property name="enableSubPackages" value="true"/>
</javaClientGenerator>

<!--一个table对应数据库中的一张表-->
<table tableName="info" domainObjectName="Info"
enableCountByExample="false" enableUpdateByExample="false"
enableDeleteByExample="false" enableSelectByExample="false"
selectByExampleQueryId="false">
</table>

<table tableName="order" domainObjectName="Order"
enableCountByExample="false" enableUpdateByExample="false"
enableDeleteByExample="false" enableSelectByExample="false"
selectByExampleQueryId="false">
</table>
<table tableName="product" domainObjectName="Product"
enableCountByExample="false" enableUpdateByExample="false"
enableDeleteByExample="false" enableSelectByExample="false"
selectByExampleQueryId="false">
</table>
<table tableName="receive" domainObjectName="Receive"
enableCountByExample="false" enableUpdateByExample="false"
enableDeleteByExample="false" enableSelectByExample="false"
selectByExampleQueryId="false">
</table>
<table tableName="shopping" domainObjectName="Shopping"
enableCountByExample="false" enableUpdateByExample="false"
enableDeleteByExample="false" enableSelectByExample="false"
selectByExampleQueryId="false">
</table>
<table tableName="user" domainObjectName="User"
enableCountByExample="false" enableUpdateByExample="false"
enableDeleteByExample="false" enableSelectByExample="false"
selectByExampleQueryId="false">
</table>
</context>
</generatorConfiguration>

generator.propertites 代码如下:

1
2
3
4
5
jdbc.driverLocation=D:\\Firefox\\download\\mysql-connector-java-5.1.44\\mysql-connector-java-5.1.44-bin.jar
jdbc.driverClass=com.mysql.jdbc.Driver
jdbc.connectionURL=jdbc:mysql:///shopstore
jdbc.userId=root
jdbc.password=123456

3.设置并运行插件

在 Intellij IDEA 中点击 菜单 run 中 Edit Configurations,点击 + 号,选择 maven,会出现,在 Commond line 填上mybatis-generator:generate -e,apply 和 ok。步骤参考下图

maven2.PNG

最后点击 generator运行,生成 model,mapper,mapping
运行插件.png

逆向生成的目录结构如下
mapper.PNG

添加service和controller

在与mapper同级的目录下创建service目录,在里面创建UserService

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
package com.donlex.mybatiswithspringboot.service;

import com.donlex.mybatiswithspringboot.mapper.UserMapper;
import com.donlex.mybatiswithspringboot.model.User;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;


@Service //注意添加这个注解
public class UserService {

@Autowired
private UserMapper userMapper;

public User getOneUser() {
User user = userMapper.selectByPrimaryKey(1);
return user;
}
}

在与mapper同级的目录下创建controller目录,在里面创建UserController

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
package com.donlex.mybatiswithspringboot.controller;

import com.donlex.mybatiswithspringboot.model.User;
import com.donlex.mybatiswithspringboot.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;


@RestController
public class UserController {
@Autowired
private UserService userService;

@RequestMapping("/query")
public String getAllUser() {
User user = userService.getOneUser();
return "Uid:"+user.getUid()+" Username:"+user.getUsername();
}
}

目录结构如图:
last.PNG

添加 application.yml 配置文件

删除原有的 application.properties 文件,添加 application.yml 文件中的配置如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
server:
port: 8080

spring:
datasource:
url: jdbc:mysql://localhost:3306/shopstore?useUnicode=true&characterEncoding=UTF-8&useSSL=false
username: root
password: 123456
driver-class-name: com.mysql.jdbc.Driver

## 该配置节点为独立的节点,如果将这个配置放在spring的节点下,导致配置无法被识别
mybatis:
mapper-locations: classpath:mapping/*.xml #注意:一定要对应mapper映射xml文件的所在路径

设置扫描Mapper包

在启动类中添加包扫描注解

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
package com.donlex.mybatiswithspringboot;

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

@MapperScan("com.donlex.mybatiswithspringboot.mapper")//注意添加这个注解,并且配置正确的包名
@SpringBootApplication
public class MybatiswithspringbootApplication {

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

}

启动测试

启动项目,访问对应的 URL 即可。
test.PNG

0%