Springboot整合（2）——MyBatis整合

yierxiansheng

2018-02-08

关注关注

Springboot整合（2）——MyBatis整合

1. 配置

1. 1 在pom文件中添加依赖

<groupId>mysql</groupId>

<artifactId>mysql-connector-java</artifactId>

</dependency>

<groupId>org.mybatis.spring.boot</groupId>

<artifactId>mybatis-spring-boot-starter</artifactId>

</dependency>

<groupId>org.mybatis.generator</groupId>

<artifactId>mybatis-generator-core</artifactId>

</dependency>

1.2 在application.yml文件中增加数据库和mybatis的配置

spring:

datasource:

url: jdbc:mysql://localhost:3306/knowledgeisland?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&allowMultiQueries=true

username: root

password: root

driver-class-name: com.mysql.jdbc.Driver

mybatis:

##配置mapper.xml扫描路径

mapper-locations: classpath:mapper/*Mapper.xml,classpath:mapper/auto/*Mapper.xml

##配置实体类所在的包

type-aliases-package: tect.luoyu.ki.entity

1.3 在启动类Application里配置mapper接口的扫描路径

@MapperScan("tech.luoyu.ki.mapper")

Springboot整合（2）——MyBatis整合

2. 使用mybatis-generator生成代码

mybatis官方提供的代码生成工具可以为我们自动生成entity，mapper接口类以及mapper.xml。本节将使用基类产生相应的代码。

2.1 创建表并插入一条数据

CREATE TABLE `sys_user` (

`id` varchar(36) NOT NULL COMMENT '主键uuid',

`userName` varchar(30) NOT NULL COMMENT '用户名',

`mobilephone` varchar(11) DEFAULT NULL COMMENT '联系电话',

`loginName` varchar(30) NOT NULL COMMENT '登录账号',

`loginPassword` varchar(50) NOT NULL COMMENT '登录密码',

`creater` varchar(36) NOT NULL COMMENT '创建人',

`createTime` datetime NOT NULL,

`updater` varchar(36) NOT NULL COMMENT '更新人',

`updateTime` datetime NOT NULL,

`dataStatus` tinyint(4) NOT NULL,

PRIMARY KEY (`id`)

) ENGINE=InnoDB DEFAULT CHARSET=utf8;

INSERT INTO `sys_user` VALUES ('1', '风木羽', '18666666666', 'admin', 'admin', '1', '2018-01-01 10:52:00', '1', '2018-01-01 10:52:00', '1');

Springboot整合（2）——MyBatis整合

2.2 创建基类，基类包含以下6个基本属性（具体情况按需）。

private String id;

private String creater;

private Date createTime;

private String updater;

private Date updateTime;

private Byte dataStatus;

...getter,setter,toString,equals,hashCode...

注：创建基类的目的在于可以为所有的entity对象添加一些通用方法，如preInsert（插入前做预插入工作：生成ID，设置creater，设置createTime），preUpdate（更新前做预更新工作：生成ID，设置updater，设置updateTime）

publicvoid preInsert() {

setId(UUID.randomUUID().toString());

this.updater = "1";

this.creater = "1";

this.updateTime = new Date();

this.createTime = this.updateTime;

bytedataStatus = 1;

setDataStatus(dataStatus);

}

publicvoid preUpdate() {

this.updater = "1";

this.updateTime = new Date();

}

2.3 创建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">

<!-- 自动识别数据库关键字，默认false，如果设置为true，根据SqlReservedWords中定义的关键字列表；

一般保留默认值，遇到数据库关键字（Java关键字），使用columnOverride覆盖

-->

</commentGenerator>

<jdbcConnection driverClass="com.mysql.jdbc.Driver"

connectionURL="jdbc:mysql://localhost:3306/knowledgeisland"

userId="root"

password="root">

</jdbcConnection>

</javaTypeResolver>

</javaModelGenerator>

</sqlMapGenerator>

</javaClientGenerator>

</table>

</context>

</generatorConfiguration>

注：红色字体为重点和需要按实际分包修改的内容，注意包名需要与1.2和1.3配置的内容一致，本章末尾会给出当前已分包的结构目录截图

附：JSR303Plugin类的代码

package tech.luoyu.ki.generator;

import java.sql.Types;

import java.util.List;

import org.mybatis.generator.api.IntrospectedColumn;

import org.mybatis.generator.api.IntrospectedTable;

import org.mybatis.generator.api.PluginAdapter;

import org.mybatis.generator.api.dom.java.Field;

import org.mybatis.generator.api.dom.java.TopLevelClass;

publicclass JSR303Plugin extends PluginAdapter {

@Override

publicboolean validate(List<String> warnings) {

returntrue;

}

@Override

publicboolean modelFieldGenerated(Field field, TopLevelClass topLevelClass, IntrospectedColumn introspectedColumn,

IntrospectedTable introspectedTable, ModelClassType modelClassType) {

if (true == introspectedColumn.isStringColumn()) {

if (false == introspectedColumn.isNullable()) {

topLevelClass.addImportedType("org.hibernate.validator.constraints.NotBlank");

field.addAnnotation("@NotBlank");

}

topLevelClass.addImportedType("javax.validation.constraints.Size");

field.addAnnotation(

"@Size(min = 0, max = " + introspectedColumn.getLength() + " , message = \"长度必须在{min}和{max}之间\")");

}

if (introspectedColumn.getJdbcType() == Types.INTEGER) {

if (false == introspectedColumn.isNullable()) {

topLevelClass.addImportedType("javax.validation.constraints.NotNull");

field.addAnnotation("@NotNull");

}

topLevelClass.addImportedType("javax.validation.constraints.Max");

field.addAnnotation("@Max(value=2147483647,message=\"最大值不能高于{value}\")");

topLevelClass.addImportedType("javax.validation.constraints.Min");

field.addAnnotation("@Min(value=-2147483648,message=\"最小值不能低于{value}\")");

}

returnsuper.modelFieldGenerated(field, topLevelClass, introspectedColumn, introspectedTable, modelClassType);

}

2.4 编写生成代码类：Generator.java，该类里用到一个FileTool工具类，就是一个删除文件夹和删除文件的功能，此处就不贴出代码了

* To change this license header, choose License Headers in Project Properties.

* To change this template file, choose Tools | Templates

* and open the template in the editor.

package tech.luoyu.ki.generator;

import java.io.File;

import java.io.IOException;

import java.io.InputStream;

import java.sql.SQLException;

import java.util.ArrayList;

import java.util.List;

import java.util.logging.Level;

import java.util.logging.Logger;

import org.mybatis.generator.api.MyBatisGenerator;

import org.mybatis.generator.config.Configuration;

import org.mybatis.generator.config.xml.ConfigurationParser;

import org.mybatis.generator.exception.InvalidConfigurationException;

import org.mybatis.generator.exception.XMLParserException;

import org.mybatis.generator.internal.DefaultShellCallback;

import tech.luoyu.ki.util.FileTool;

public class Generator {

public static void main(String[] args) {

generate();

}

@SuppressWarnings(value = "all")

private static void generate() {

String singleFileName = null;// single

// singleFileName = "SysUserMapper.xml";

// 1. 删除已经存在的mapper.xml

File file = new File(Generator.class.getResource("/").getFile());

File parentFile = file.getParentFile().getParentFile();

String autoMapperRelativePath = "src\\main\\resources\\mapper\\auto";

File autoMapperFile = new File(parentFile.getAbsolutePath() + File.separator + autoMapperRelativePath);

System.out.println(autoMapperFile.getAbsolutePath());

System.out.println(autoMapperFile.exists());

if (singleFileName == null) {

if (autoMapperFile.exists()) {

FileTool.delDir(autoMapperFile.getAbsolutePath(), true);

}

autoMapperFile.mkdirs();

} else {

autoMapperFile = new File(parentFile.getAbsolutePath() + File.separator + autoMapperRelativePath

+ File.separator + singleFileName);

if (autoMapperFile.exists()) {

FileTool.delFile(autoMapperFile.getAbsolutePath());

}

// 2. 重新生成mapper.xml

try {

List<String> warnings = new ArrayList<String>();

boolean overwrite = true;

ConfigurationParser cp = new ConfigurationParser(warnings);

InputStream stream = Generator.class.getClassLoader().getResourceAsStream("generatorConfig.xml");

Configuration config = cp.parseConfiguration(stream);

DefaultShellCallback callback = new DefaultShellCallback(overwrite);

MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);

myBatisGenerator.generate(null);

} catch (IOException ex) {