集成Mybatis Generator

新建数据库、数据库用户、数据库连接

• 新建数据库：wikidev
• 新建专用账户：wikidev/test@123
• IDEA中新建数据库连接：wikidev@localhost

集成Mybatis Generator

MyBatis Generator，简称MBG，最新版本是1.4.0，发布于2019年11月24日。
MyBatis Generator生成的文件包含三类：

• Model实体类文件，一个数据库表对应生成一个Model实体
• Mapper接口文件，数据操作方法都在此接口中定义
• Mapper XML配置文件

安装MyBatis Generator插件后，配置generatorConfig.xml文件(默认路径${basedir}/src/main/resources/generatorConfig.xml，当然，可以通过configurationFile进行自定义配置)，然后通过命令运行MyBatis Generator即可生成以上文件。

接下里，来动手试试。

• 首先，在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 https://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.4.4</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>
	<groupId>com.jepcc</groupId>
	<artifactId>wiki</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<name>wiki</name>
	<description>Jepcc Wiki</description>
	<properties>
		<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-devtools</artifactId>
		</dependency>
<!--		集成mybatis-->
		<dependency>
			<groupId>org.mybatis.spring.boot</groupId>
			<artifactId>mybatis-spring-boot-starter</artifactId>
			<version>2.1.3</version>
		</dependency>
<!--		集成mysql连接-->
		<dependency>
			<groupId>mysql</groupId>
			<artifactId>mysql-connector-java</artifactId>
			<version>8.0.22</version>
		</dependency>

	</dependencies>
	<build>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
				<version>2.4.4</version>
			</plugin>
			<plugin>
				<groupId>org.mybatis.generator</groupId>
				<artifactId>mybatis-generator-maven-plugin</artifactId>
				<version>1.4.0</version>
				<configuration>
					<configurationFile>src/main/resources/generator/generator-config.xml</configurationFile>
					<overwrite>true</overwrite>
					<verbose>true</verbose>
				</configuration>
				<dependencies>
					<dependency>
						<groupId>mysql</groupId>
						<artifactId>mysql-connector-java</artifactId>
						<version>8.0.22</version>
					</dependency>
				</dependencies>
			</plugin>
		</plugins>
	</build>
</project>

新增了MyBatis Generator插件(mybatis-generator-maven-plugin)，其中

参数	描述
configurationFile	XML配置文件所在路径，默认值是${basedir}/src/main/resources/generatorConfig.xml
overwrite	布尔值，默认值是false。如果值为true，那么生成的Java文件会覆盖现有的同名的Java文件
verbose	布尔值，如果值为true，Mybatis generator会将过程信息写入编译日志

另外，Java连接MySql需要驱动包，即mysql-connector-java-8.0.22。

• 然后，添加XML配置文件generator-config.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" defaultModelType="flat">
        <property name="beginningDelimiter" value="`"/>
        <property name="endingDelimiter" value="`"/>

        <!-- 生成的实体类添加toString()方法 -->
        <plugin type="org.mybatis.generator.plugins.ToStringPlugin" />
        <!-- 不生成注释 -->
        <commentGenerator>
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>
        <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/wikidev"
                        userId="wikidev"
                        password="test@123">
        </jdbcConnection>
        <!-- domain类的位置 -->
        <javaModelGenerator targetProject="src\main\java"
                            targetPackage="com.jepcc.wiki.domain"/>
        <!-- mapper xml的位置 -->
        <sqlMapGenerator targetProject="src\main\resources"
                         targetPackage="mapper"/>
        <!-- mapper类的位置 -->
        <javaClientGenerator targetProject="src\main\java"
                             targetPackage="com.jepcc.wiki.mapper"
                             type="XMLMAPPER" />
        <table tableName="demo" domainObjectName="Demo"/>
    </context>
</generatorConfiguration>

可能遇到错误提示：URI is not registered (Settings | Languages & Frameworks | Schemas and DTDs)，URI没有注册，那我们就到（Settings | Languages & Frameworks | Schemas and DTDs）这个地方去完成注册。

• 接着，添加命令mybatis-generator:generate -e，通过执行该命令运行Mybatis Generator生成文件

  • Model实体类文件
    • com.jepcc.wiki.domain.Demo
    • com.jepcc.wiki.domain.DemoExample
  • Mapper接口文件
    • com.jepcc.wiki.mapper.DemoMapper
  • Mapper XML配置文件
    • src/main/resources/mapper/DemoMapper.xml

• 再接着，手动添加DemoService.java和DemoController.java

package com.jepcc.wiki.service;

import com.jepcc.wiki.domain.Demo;
import com.jepcc.wiki.mapper.DemoMapper;
import org.springframework.stereotype.Service;

import javax.annotation.Resource;
import java.util.List;

@Service
public class DemoService {
    @Resource
    private DemoMapper demoMapper;

    public List<Demo> list(){
        return demoMapper.selectByExample(null);
    }
}

package com.jepcc.wiki.controller;

import com.jepcc.wiki.domain.Demo;
import com.jepcc.wiki.service.DemoService;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;
import java.util.List;

@RestController
@RequestMapping("/demo")
public class DemoController {
    @Resource
    private DemoService demoService;
    @GetMapping("/list")
    public List<Demo> list(){
        return demoService.list();
    }
}

请注意，接口/demo/list有两种写法，
第一种：@GetMapping("/demo/list")；
第二种：@RequestMapping("/demo")+@GetMapping("/list")

• 最后，添加测试接口，并调试

GET http://localhost:8080/demo/list
###