SpringBoot+Mybatis反向工程全过程

目录

一、前言

二、正文开始

1、总体项目结构

2、数据库mybatis_generator_demo1数据的sql

3、创建一个SpringBoot+Maven项目,再创建一个Module

4、创建SpringBoot的启动类

5、在项目的pom文件或者模块的pom文件里导入依赖。

项目pom文件依赖代码:

模块的pom文件内容

6、在模块的Java下创建包,com.generator.start,创建文件的注释配置类:CommentGenrator类。拿来用就好了。

7、在包下com.generator.start包下创建,反向工程的生成器类Generator,这个类需要导入生成器的配置文件。

8、在resources下导入以下文件

(1)项目的application.yml文件。

(2)然后是generator.properties文件,反向工程配置文件里的数据源引用的是该文件中设置的相应的数据。修改为自己数据源信息就好。

(3)generatorConfig.xml文件,是反向工程最重要的配置文件。在这里我们只需要修改其中的部分的配置信息即可。

9、执行结果


一、前言

一不小心,忘记SpringBoot版的Mybatis反向工程要怎么搭建和配置了,为了避免以后还会忘记,记录下来,也希望可以帮助到小伙伴儿们

二、正文开始

1、总体项目结构

 

2、数据库mybatis_generator_demo1数据的sql

这是Navicat导出的sql脚本的内容,复制需要的内容去运行就可以了

/*
Navicat MySQL Data Transfer

Source Server         : mysql
Source Server Version : 50621
Source Host           : localhost:3306
Source Database       : mybatis_generator_demo1

Target Server Type    : MYSQL
Target Server Version : 50621
File Encoding         : 65001

Date: 2021-07-19 21:49:09
*/

SET FOREIGN_KEY_CHECKS=0;

-- ----------------------------
-- Table structure for book
-- ----------------------------
DROP TABLE IF EXISTS `book`;
CREATE TABLE `book` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `name` varchar(25) NOT NULL,
  `author` varchar(64) NOT NULL,
  `page_number` int(7) DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

3、创建一个SpringBoot+Maven项目,再创建一个Module

我项目取名为mybatis_generator,见名知其意,模块取名为module_one。我一开始直接在项目下开始了导入依赖,粘贴进生成器类,resources下的所有需要的文件,然后执行生成器类的时候,一直生成不了文件,报错:The specified target project directory mybatis_generator\src\main\java does。不明白什么原因,解决办法是,pom文件的依赖不用更换就在项目的pom文件里就好,但是其它的文件,需要放在新建的模块中才行

4、创建SpringBoot的启动类

这个没什么解释的,必须创建的,

package com.generator.start;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

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

5、在项目的pom文件或者模块的pom文件里导入依赖。

因为我是先在项目pom文件导入,所以展示下我两个pom文件的内容:

项目pom文件依赖代码:

<?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>org.example</groupId>
    <artifactId>mybatis_generator</artifactId>
    <packaging>pom</packaging>
    <version>1.0-SNAPSHOT</version>
    <modules>
        <module>module_one</module>
    </modules>

    <parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.2.6.RELEASE</version>
    <relativePath/> <!-- lookup parent from repository -->
</parent>

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

<dependencies>

    <dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-starter</artifactId>
        <version>1.3.2</version>
    </dependency>

    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <scope>runtime</scope>
    </dependency>

    <!--集成druid连接池-->
    <dependency>
        <groupId>com.alibaba</groupId>
        <artifactId>druid-spring-boot-starter</artifactId>
        <version>1.1.10</version>
    </dependency>

    <!-- MyBatis 生成器 -->
    <dependency>
        <groupId>org.mybatis.generator</groupId>
        <artifactId>mybatis-generator-core</artifactId>
        <version>1.3.7</version>
    </dependency>

</dependencies>

<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
        </plugin>
    </plugins>
</build>



</project>

模块的pom文件内容

在我创建模块的时候,idea自动创建的,没有任何改动。

<?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">
    <parent>
        <artifactId>mybatis_generator</artifactId>
        <groupId>org.example</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>module_one</artifactId>


</project>

6、在模块的Java下创建包,com.generator.start,创建文件的注释配置类:CommentGenrator类。拿来用就好了。

package com.generator.start;

import org.mybatis.generator.api.IntrospectedColumn;
import org.mybatis.generator.api.IntrospectedTable;
import org.mybatis.generator.api.dom.java.Field;
import org.mybatis.generator.internal.DefaultCommentGenerator;
import org.mybatis.generator.internal.util.StringUtility;

import java.util.Properties;

/**
 * 自定义注释生成器
 * Created by macro on 2018/4/26.
 */
public class CommentGenerator extends DefaultCommentGenerator {
    private boolean addRemarkComments = false;

    /**
     * 设置用户配置的参数
     */
    @Override
    public void addConfigurationProperties(Properties properties) {
        super.addConfigurationProperties(properties);
        this.addRemarkComments = StringUtility.isTrue(properties.getProperty("addRemarkComments"));
    }

    /**
     * 给字段添加注释
     */
    @Override
    public void addFieldComment(Field field, IntrospectedTable introspectedTable,
                                IntrospectedColumn introspectedColumn) {
        String remarks = introspectedColumn.getRemarks();
        //根据参数和备注信息判断是否添加备注信息
        if (addRemarkComments && StringUtility.stringHasValue(remarks)) {
            addFieldJavaDoc(field, remarks);
        }
    }

    /**
     * 给model的字段添加注释
     */
    private void addFieldJavaDoc(Field field, String remarks) {
        //文档注释开始
        field.addJavaDocLine("/**");
        //获取数据库字段的备注信息
        String[] remarkLines = remarks.split(System.getProperty("line.separator"));
        for (String remarkLine : remarkLines) {
            field.addJavaDocLine(" * " + remarkLine);
        }
        addJavadocTag(field, false);
        field.addJavaDocLine(" */");
    }

}

7、在包下com.generator.start包下创建,反向工程的生成器类Generator,这个类需要导入生成器的配置文件。

package com.generator.start;

import org.mybatis.generator.api.MyBatisGenerator;
import org.mybatis.generator.config.Configuration;
import org.mybatis.generator.config.xml.ConfigurationParser;
import org.mybatis.generator.internal.DefaultShellCallback;

import java.io.InputStream;
import java.util.ArrayList;
import java.util.List;

/**
 * 用于生产MBG的代码
 * Created by macro on 2018/4/26.
 */
public class Generator {
    public static void main(String[] args) throws Exception {
        //MBG 执行过程中的警告信息
        List<String> warnings = new ArrayList<String>();
        //当生成的代码重复时,覆盖原代码
        boolean overwrite = true;
        //读取我们的 MBG 配置文件
        InputStream is = Generator.class.getResourceAsStream("/generatorConfig.xml");
        ConfigurationParser cp = new ConfigurationParser(warnings);
        Configuration config = cp.parseConfiguration(is);
        is.close();

        DefaultShellCallback callback = new DefaultShellCallback(overwrite);
        //创建 MBG
        MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
        //执行生成代码
        myBatisGenerator.generate(null);
        //输出警告信息
        for (String warning : warnings) {
            System.out.println(warning);
        }

        System.out.println("创建完成");
    }
}

8、在resources下导入以下文件

(1)项目的application.yml文件。

这里不知道干啥用的,好像没什么用啊。有大佬知道还请不腻赐教,我只知道怎么使用。

server:
  port: 8096

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mybatis_generator_demo1?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai
    username: root
    password: root
pagehelper:
  helper-dialect: mysql
  reasonable: true

(2)然后是generator.properties文件,反向工程配置文件里的数据源引用的是该文件中设置的相应的数据。修改为自己数据源信息就好。

jdbc.driverClass=com.mysql.jdbc.Driver
jdbc.connectionURL=jdbc:mysql://localhost:3306/mybatis_generator_demo1?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai
jdbc.userId=root
jdbc.password=root

(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">

<generatorConfiguration>
    <properties resource="generator.properties"/>
    <context id="MySqlContext" targetRuntime="MyBatis3" defaultModelType="flat">
        <property name="beginningDelimiter" value="`"/>
        <property name="endingDelimiter" value="`"/>
        <property name="javaFileEncoding" value="UTF-8"/>
        <!-- 为模型生成序列化方法-->
        <plugin type="org.mybatis.generator.plugins.SerializablePlugin"/>
        <!-- 为生成的Java模型创建一个toString方法 -->
        <plugin type="org.mybatis.generator.plugins.ToStringPlugin"/>
        <!--生成mapper.xml时覆盖原文件-->
        <plugin type="org.mybatis.generator.plugins.UnmergeableXmlMappersPlugin" />
        <commentGenerator type="com.generator.start.CommentGenerator">
            <!-- 是否去除自动生成的注释 true:是 : false:否 -->
            <property name="suppressAllComments" value="true"/>
            <property name="suppressDate" value="true"/>
            <property name="addRemarkComments" value="true"/>
        </commentGenerator>

        <jdbcConnection driverClass="${jdbc.driverClass}"
                        connectionURL="${jdbc.connectionURL}"
                        userId="${jdbc.userId}"
                        password="${jdbc.password}">
            <!--解决mysql驱动升级到8.0后不生成指定数据库代码的问题-->
            <property name="nullCatalogMeansCurrent" value="true" />
        </jdbcConnection>

        <javaModelGenerator targetPackage="com.demo1.book.pojo" targetProject="module_one\src\main\java"/>

        <sqlMapGenerator targetPackage="com.demo1.book.mapper" targetProject="module_one\src\main\resources"/>

        <javaClientGenerator type="XMLMAPPER" targetPackage="com.demo1.book.mapper"
                             targetProject="module_one\src\main\java"/>
        <table tableName="book"/>

    </context>
</generatorConfiguration>

需要配置的信息:

配置注释生成配置类的地址

配置 pojo、Java下的mapper接口和resources下的mapper.xml文件所在位置和模块

 

9、执行结果

生成了需要的pojo文件、mapper接口和.xml文件。控制台的信息输出如下图所示: 

完。 

  • 0
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
创建一个基于Spring Boot和MyBatis项目,可以按照以下步骤进行: 1. 首先,打开IDE(集成开发环境),例如Eclipse或IntelliJ IDEA,并创建一个新的Maven项目。 2. 在项目的pom.xml文件,添加Spring Boot和MyBatis的相关依赖项。这些依赖项包括spring-boot-starter-web、mybatis-spring-boot-starter和mysql-connector-java等。 3. 创建一个名为"application.properties"(如果使用YAML格式,则使用"application.yml")的配置文件,并在其配置数据库连接、端口等相关信息。 4. 在src/main/java目录下创建一个Spring Boot的启动类,例如Application.java。在此类上使用@SpringBootApplication注解,表示这是一个Spring Boot应用程序的入口点。 5. 创建一个包(例如com.example.demo)用于存放项目的代码。在该包创建相关的类和接口。 6. 创建一个数据访问对象(Data Access Object,简称DAO)的接口,例如UserDao.java。可以使用注解(例如@Mapper)来标记该接口,并定义数据访问相关的方法。 7. 在resources目录下创建一个包(例如mapper)用于存放MyBatis的映射文件。在该包创建一个与DAO接口相对应的XML文件,例如UserMapper.xml。在XML文件配置SQL语句和参数映射等。 8. 创建一个服务类,例如UserService.java,在该类调用DAO接口的方法,并进行业务逻辑的处理。 9. 创建一个控制器类,例如UserController.java,在该类定义路由和请求处理方法,接收客户端的请求并调用相应的服务类进行处理。 10. 运行项目,可以使用集成开发环境提供的工具或者命令行执行mvn命令来启动项目。 11. 在浏览器或者其他HTTP客户端发送请求,访问控制器类定义的路由,并查看结果。 通过以上步骤,你可以创建一个基于Spring Boot和MyBatis项目,并实现数据库的访问和基本的业务逻辑。当然,你可以根据具体的需求和项目要求对以上步骤进行调整和扩展。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值