Spring-Boot与MyBatis Generator
由于最近刚换工作，来了新项目之后发现技术栈和自己之前用的很多不一致，因此决定边学习边记录一下。今天看代码的时候发现很多文件里居然没有注释，还有大量的xml配置文件，瞬间感觉脑壳痛，仔细研究了一下才发现是自动生成的，囧~
今天就来记录一下Spring-Boot与MyBatis Generator的使用
1.简介
MyBatis Generator(MBG)的官方介绍在这里Introduction to MyBatis Generator，简而言之就是通过数据库的表结构来生成我们所需的代码，比如POJO与mapper等等。
2.环境
- 操作系统：macOS
- IDE：IntelliJ IDEA
- 数据库：mysql
3.创建工程
使用IDEA创建一个Spring-Boot项目是非常简单的，操作步骤如下：
点击Create New Project->Spring Initializr，选择SDK之后点击Next按钮，如下图：
创建Spring-Boot项目.png
之后更改
Group和Artifact再点击Next按钮
更改项目名称
在弹出的界面中选中了
web选项(在这里也可以选中数据库之类的依赖，我在这里只选择了web，后续依赖都是自己加到pom.xml中的)，点击Next按钮后再点击Finish按钮即可。
选择依赖.png
创建出来的项目结构如下图所示：
项目结构
- pom.xml是maven的配置文件
- SbootApplication是我们的启动类
- resources目录下的application.properties文件是我们的主配置文件，个人更喜欢yaml配置，所以把这个文件改为appl.yaml
4.引入依赖
详细的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>
<groupId>com.atticus</groupId>
<artifactId>sboot</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>jar</packaging>
<name>sboot</name>
<description>Demo project for Spring Boot</description>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.0.5.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version>
</properties>
<dependencies>
<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>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
<!-- https://mvnrepository.com/artifact/org.mybatis.spring.boot/mybatis-spring-boot-starter -->
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>1.3.2</version>
</dependency>
<!-- https://mvnrepository.com/artifact/org.mybatis/mybatis -->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.4.6</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.12</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.3.7</version>
<dependencies>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.12</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
</project>
我们导入了MyBatis Generator的Maven插件，在依赖下载完成之后，点开IDEA右边侧栏的Maven Projects标签，在Plugins下看到mybatis-generator即说明成功(若看不到，则点击左上角的刷新按钮)，如下图所示。
maven插件
5.准备数据库
进入mysql数据库，在attiicus库中创建一个students表：
CREATE TABLE `atticus`.`students` (
`id` INT NOT NULL,
`name` VARCHAR(45) NULL,
`age` INT NULL,
`sign` VARCHAR(45) NULL,
PRIMARY KEY (`id`));
6.配置generatorConfig.xml
在resources目录下新建generatorConfig.xml文件，具体内容如下：
<?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>
<context id="mysql" targetRuntime="MyBatis3">
<!--去除注释 -->
<commentGenerator>
<property name="suppressAllComments" value="true" />
</commentGenerator>
<!--数据库连接 -->
<jdbcConnection driverClass="com.mysql.jdbc.Driver"
connectionURL="jdbc:mysql://localhost:3306/atticus"
userId="root"
password="123456">
</jdbcConnection>
<!--默认false
Java type resolver will always use java.math.BigDecimal if the database column is of type DECIMAL or NUMERIC.
-->
<javaTypeResolver >
<property name="forceBigDecimals" value="false" />
</javaTypeResolver>
<!--生成实体类 指定包名 以及生成的地址 （可以自定义地址，但是路径不存在不会自动创建 使用Maven生成在target目录下，会自动创建） -->
<javaModelGenerator targetPackage="com.atticus.sboot.model" targetProject="/Users/didi/workspace/sboot/src/main/java/">
<property name="enableSubPackages" value="false" />
<property name="trimStrings" value="true" />
</javaModelGenerator>
<!--生成SQLMAP.xml文件 -->
<sqlMapGenerator targetPackage="com.atticus.sboot.map" targetProject="/Users/didi/workspace/sboot/src/main/java">
<property name="enableSubPackages" value="false" />
</sqlMapGenerator>
<!--生成mapper接口文件-->
<javaClientGenerator type="XMLMAPPER" targetPackage="com.atticus.sboot.mappers" targetProject="/Users/didi/workspace/sboot/src/main/java">
<property name="enableSubPackages" value="false" />
</javaClientGenerator>
<!--对应数据库表 mysql可以加入主键自增 字段命名 忽略某字段等-->
<table tableName="students" domainObjectName="Students" >
</table>
</context>
</generatorConfiguration>
需要注意以下几点：
- 数据库的连接地址，用户名，密码以及数据库名
- 生成配置所在的目录
- 需要生成的表名与类名的对应
配置保存好之后我们在右侧边栏中点击上文提到的mybatis-generator:generate按钮，等待生成后的文件如下：
生成的配置
一般来讲配置资源我们都放在resources目录下，因此将生成的map目录整个移动到resources目录下。
7.配置application.yaml
这是我们启动程序的主配置，内容如下：
mybatis:
mapper-locations: classpath:map/*.xml
type-aliases-package: com.atticus.sboot.model
spring:
datasource:
url: jdbc:mysql://127.0.0.1:3306/atticus?useUnicode=true&characterEncoding=utf-8
username: root
password: 123456
driverClassName: com.mysql.cj.jdbc.Driver
8.插入操作
首先在我们的SbootApplication类加上@MapperScan注解，代表要扫描这些包下的所有Mapper类，如果不在此加，也可以在每个Mapper类上加@Mapper注解。
package com.atticus.sboot;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@MapperScan("com.atticus.sboot.mappers")
@SpringBootApplication
public class SbootApplication {
public static void main(String[] args) {
SpringApplication.run(SbootApplication.class, args);
}
}
在sboot下创建一个service包并建立一个MyService类
package com.atticus.sboot.service;
import com.atticus.sboot.mappers.StudentsMapper;
import com.atticus.sboot.model.Students;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
@Service
public class MyService {
@Autowired
StudentsMapper studentsMapper;
//插入单条数据
public int insert(Students students){
return studentsMapper.insert(students);
}
}
在sboot下创建一个controller包并建立一个MyController类
package com.atticus.sboot.controller;
import com.atticus.sboot.model.Students;
import com.atticus.sboot.service.MyService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class MyController {
@Autowired
MyService myService;
@RequestMapping("/insert")
public int insert(Students students){
return myService.insert(students);
}
}
接下来启动当前应用，为了调试方便，我这里使用了Postman工具发送请求：
插入成功请求
可以看到绿色框内返回了1，代表请求成功，为了验证，我们查询一下数据库中的数据：
数据库
没有问题，这条数据成功插入了。那如果插入过程失败会如何呢，我们尝试把刚才的数据重复插入一次：
插入失败
执行出错了，真正开发中我们会将返回数据格式化，并做统一的异常处理等，这里就不演示了。
9.查询操作
更改MyController类，添加一个查询方法
package com.atticus.sboot.controller;
import com.atticus.sboot.model.Students;
import com.atticus.sboot.service.MyService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.List;
@RestController
public class MyController {
@Autowired
MyService myService;
@RequestMapping("/insert")
public int insert(Students students){
return myService.insert(students);
}
@RequestMapping("/select")
public List<Students> selectByExample(Integer id){
return myService.selectByExample(id);
}
}
然后更改MyService类
package com.atticus.sboot.service;
import com.atticus.sboot.mappers.StudentsMapper;
import com.atticus.sboot.model.Students;
import com.atticus.sboot.model.StudentsExample;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import java.util.List;
@Service
public class MyService {
@Autowired
StudentsMapper studentsMapper;
//插入单条数据
public int insert(Students students){
return studentsMapper.insert(students);
}
public List<Students> selectByExample(Integer id){
StudentsExample studentsExample = new StudentsExample();
StudentsExample.Criteria criteria = studentsExample.createCriteria();
criteria.andIdEqualTo(id);
return studentsMapper.selectByExample(studentsExample);
}
}
重新启动应用，发送select请求，传入参数id：
查询结果
正确的查询到了我们需要的结果。
10.总结
总体来说MyBatis Generator是一套很方便的工具，大大节省了开发时间，提高了开发效率，这里只是很简单的列出了使用方法，作为自己的一点记录。
