《5K入门级项目实战：好来屋在线影院》之第 2 战 —— MyBatis 逆向工程

OK，我们先创建一个项目：haolaiwu-movie，然后介绍 Mybatis 的逆向工程。

1、新建项目，起名：haolaiwu-movie

选择 Maven，Next 

GroupId填入：com.movie      ArtifactId填入：haolaiwu-movie

创建好工程后，在 pom.xml 中添加 mysql 的依赖，完整的 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.movie</groupId>
    <artifactId>haolaiwu-movie</artifactId>
    <version>1.0.0</version>

    <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>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.48</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <!-- mybatis generator 自动生成代码插件 -->
            <plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>1.3.7</version>
                <configuration>
                    <configurationFile>${basedir}/src/main/resources/mybatis-generator.xml</configurationFile>
                    <overwrite>true</overwrite>
                    <verbose>true</verbose>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

然后我们在 src/main/java 目录下，创建几个包 package：config（放配置类）、controller（前端请求类）、database（操作数据库）、entity（实体类）、manage（业务处理层）、util（工具类）。具体操作如下：

1、先创建基础包：com.movie

2、在 movie 包下依次创建上述的包。

 

 

MyBatis 逆向工程

所谓mybatis逆向工程，就是 mybatis 会根据我们设计好的数据表，自动生成 pojo 对象类、mapper.xml、基本的CRUD语句，能缩短我们“重复造轮子”的时间，提高效率。

首先，我们先安装 MySQL 数据库。可以参考我的博客：https://blog.csdn.net/BiandanLoveyou/article/details/84677787

然后我们创建一个数据库，起名：movie

对着数据库连接鼠标右键“新建数据库”

输入数据库名，选择字符集 utf8（如果是互联网项目，优先选择 utf8mb4，可以存放 emoji 表情等特殊符号。）。

然后我们创建一个表，表名：user_account

CREATE TABLE `user_account` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `user_name` varchar(50) DEFAULT NULL COMMENT '用户名',
  `password` varchar(100) DEFAULT NULL COMMENT '密码',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

接下来，在项目的 resources 文件夹下，创建一个 mybatis-generator.xml 文件。

 mybatis-generator.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>

    <!-- 需要额外加载的依赖包，location属性指明加载jar/zip包的全路径。可以复制本地仓库的 jar 包粘贴到项目中 -->
    <classPathEntry location="src/main/resources/mysql-connector-java-5.1.48.jar"/>

    <!--
        context:生成一组对象的环境
        id:必选，上下文id，用于在生成错误时提示
        defaultModelType:指定生成对象的样式
            1，conditional：类似hierarchical；
            2，flat：所有内容（主键，blob）等全部生成在一个对象中；
            3，hierarchical：主键生成一个XXKey对象(key class)，Blob等单独生成一个对象，其他简单属性在一个对象中(record class)
        targetRuntime:
            1，MyBatis3：默认的值，生成基于MyBatis3.x以上版本的内容，包括XXXBySample；
            2，MyBatis3Simple：类似MyBatis3，只是不生成XXXBySample；
        introspectedColumnImpl：类全限定名，用于扩展MBG
    -->
    <context id="mysql" defaultModelType="hierarchical" targetRuntime="MyBatis3Simple">


        <!-- 自动识别数据库关键字，默认false，如果设置为true，根据SqlReservedWords中定义的关键字列表；
            一般保留默认值，遇到数据库关键字（Java关键字），使用columnOverride覆盖
         -->
        <property name="autoDelimitKeywords" value="false"/>
        <!-- 生成的Java文件的编码 -->
        <property name="javaFileEncoding" value="UTF-8"/>
        <!-- 格式化java代码 -->
        <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>
        <!-- 格式化XML代码 -->
        <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/>

        <!-- beginningDelimiter和endingDelimiter：指明数据库的用于标记数据库对象名的符号，比如ORACLE就是双引号，MYSQL默认是`反引号； -->
        <property name="beginningDelimiter" value="`"/>
        <property name="endingDelimiter" value="`"/>
        <property name="useActualColumnNames" value="false"/>

        <!-- 使用这个配置链接数据库 -->
        <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://localhost:3306/movie"
                        userId="root"
                        password="123456">
            <property name="useUnicode" value="true"/>
            <property name="characterEncoding" value="UTF-8"/>
            <property name="serverTimezone" value="UTC"/>
            <!-- 这里面可以设置property属性，每一个property属性都设置到配置的Driver上 -->
        </jdbcConnection>

        <!-- java类型处理器
            用于处理DB中的类型到Java中的类型，默认使用JavaTypeResolverDefaultImpl；
            注意一点，默认会先尝试使用Integer，Long，Short等来对应DECIMAL和 NUMERIC数据类型；
        -->
        <javaTypeResolver type="org.mybatis.generator.internal.types.JavaTypeResolverDefaultImpl">
            <!--
                true：使用BigDecimal对应DECIMAL和 NUMERIC数据类型
                false：默认,
                    scale>0;length>18：使用BigDecimal;
                    scale=0;length[10,18]：使用Long；
                    scale=0;length[5,9]：使用Integer；
                    scale=0;length<5：使用Short；
             -->
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>


        <!-- java模型创建器，是必须要的元素
            负责：1，key类（见context的defaultModelType）；2，java类；3，查询类
            targetPackage：生成的类要放的包，真实的包受enableSubPackages属性控制；
            targetProject：目标项目，指定一个存在的目录下，生成的内容会放到指定目录中，如果目录不存在，MBG不会自动建目录
         -->
        <!-- 根据实际应用修改自动生成实体类文件的路径 -->
        <javaModelGenerator targetPackage="com.movie.entity.template" targetProject="src/main/java">
            <!--  for MyBatis3/MyBatis3Simple
                自动为每一个生成的类创建一个构造方法，构造方法包含了所有的field；而不是使用setter；
             -->
            <property name="constructorBased" value="false"/>

            <!-- 在targetPackage的基础上，根据数据库的schema再生成一层package，最终生成的类放在这个package下，默认为false -->
            <property name="enableSubPackages" value="true"/>

            <!-- for MyBatis3 / MyBatis3Simple
                是否创建一个不可变的类，如果为true，
                那么MBG会创建一个没有setter方法的类，取而代之的是类似constructorBased的类
             -->
            <property name="immutable" value="false"/>

            <!-- 设置是否在getter方法中，对String类型字段调用trim()方法 -->
            <property name="trimStrings" value="false"/>

        </javaModelGenerator>

        <!-- 生成SQL map的XML文件生成器，
            注意，在Mybatis3之后，我们可以使用mapper.xml文件+Mapper接口（或者不用mapper接口），
                或者只使用Mapper接口+Annotation，所以，如果 javaClientGenerator配置中配置了需要生成XML的话，这个元素就必须配置
            targetPackage/targetProject:同javaModelGenerator
         -->
        <!-- 生成的 mapper 文件存放路径 -->
        <sqlMapGenerator targetPackage="mapper.template" targetProject="src/main/resources">
            <!-- 在targetPackage的基础上，根据数据库的schema再生成一层package，最终生成的类放在这个package下，默认为false -->
            <property name="enableSubPackages" value="true"/>
        </sqlMapGenerator>

        <!-- 选择一个table来生成相关文件，可以有一个或多个table，必须要有table元素
            选择的table会生成一下文件：
            1，SQL map文件
            2，生成一个主键类；
            3，一个用户生成动态查询的条件类（selectByExample, deleteByExample），可选；
            4，Mapper接口（可选）
            tableName（必要）：要生成对象的表名；
            注意：大小写敏感问题。

            可选：
            1，domainObjectName：生成的domain类的名字，如果不设置，直接使用表名作为domain类的名字；
            2，enableInsert（默认true）：指定是否生成insert语句；
            3，enableSelectByPrimaryKey（默认true）：指定是否生成按照主键查询对象的语句（就是getById或get）；
            4，enableSelectByExample（默认true）：MyBatis3Simple为false，指定是否生成动态查询语句；
            5，enableUpdateByPrimaryKey（默认true）：指定是否生成按照主键修改对象的语句（即update)；
            6，enableDeleteByPrimaryKey（默认true）：指定是否生成按照主键删除对象的语句（即delete）；
            7，enableDeleteByExample（默认true）：MyBatis3Simple为false，指定是否生成动态删除语句；
            8，enableCountByExample（默认true）：MyBatis3Simple为false，指定是否生成动态查询总条数语句（用于分页的总条数查询）；
            9，enableUpdateByExample（默认true）：MyBatis3Simple为false，指定是否生成动态修改语句（只修改对象中不为空的属性）；
            10，modelType：参考context元素的defaultModelType，相当于覆盖；
         -->

        <table tableName="user_account" domainObjectName="UserAccountEntity">
            <generatedKey column="id" sqlStatement="MySql"/>
        </table>


    </context>
</generatorConfiguration>

说明：

1、这里会使用到 mysql 的驱动 jar 包，放在当前路径下，我们在 pom.xml 里已经下载了该 jar 包，只需要从本地仓库复制出来，粘贴到 resources 目录下，与 mybatis-generator.xml 文件同一级即可。

先找到我们本地仓库的路径（即 repository 目录下）， 找到刚才下载的 mysql 的 jar 包。

粘贴到 IDEA 中

 

2、数据库连接信息配置，根据自己的实际配置信息修改：

<jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://localhost:3306/movie"
                        userId="root"
                        password="123456">

3、Mybatis 逆向生成的实体存放路径，可以根据实际需要配置。没有目录 mybatis 会自动生成目录。

4、Mybatis 逆向生成的 mapper 文件存放路径，可以根据实际需要配置。没有目录 mybatis 会自动生成目录。

5、tableName 是我们数据库实际的表名，domainObjectName 是生成对应的实体的名字。如果不设置，默认使用表名。

6、xml 配置报红色：URI is not registered (Settings | Languages & Frameworks | Schemas and DTDs)

URI 是“统一资源定位符”的意思，字面意思是没有被注册。可以按照字面提示信息在 Settings ——》Languages & Frameworks ——》Schemas and DTDs 下配置，把告警的 URI 复制，添加到 Ignored 忽略列表即可：

 

OK，万事具备，只欠东风。我们现在就可以使用 Mybatis 的逆向工程了。找到 IDEA 右边的  Maven Projects ——》Plugins ——》mybatis-generator——》mybatis-generator:generate。双击运行即可。

这时候，在控制台出现信息：BUILD SUCCESS。说明我们成功了（如果没成功，请根据实际报错排查）。

[INFO] Scanning for projects...
[INFO] 
[INFO] ----------------------< com.movie:haolaiwu-movie >----------------------
[INFO] Building haolaiwu-movie 1.0.0
[INFO] --------------------------------[ jar ]---------------------------------
[INFO] 
[INFO] --- mybatis-generator-maven-plugin:1.3.7:generate (default-cli) @ haolaiwu-movie ---
[INFO] Connecting to the Database
[INFO] Introspecting table user_account
[INFO] Generating Record class for table user_account
[INFO] Generating SQL Map for table user_account
[INFO] Saving file UserAccountEntityMapper.xml
[INFO] Saving file UserAccountEntity.java
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 0.778 s
[INFO] Finished at: 2019-11-04T23:18:17+08:00
[INFO] ------------------------------------------------------------------------

这时候去看下我们配置的路径，已经有实体 UserAccountEntity 和 UserAccountEntityMapper.xml 文件生成：

这时候，我们把实体 UserAccountEntity 和 UserAccountEntityMapper.xml 文件放到它们相对应的位置。

UserAccountEntity 剪切到 entity 包下。UserAccountEntityMapper.xml 文件放到 mapper 目录下。

在 UserAccountEntityMapper.xml 文件我们看到有个 URI 警告，使用刚才说的方法去掉警告。

还看到 mybatis 自动帮我们创建了基本的 CRUD 的代码，我们也可以设置不让 mybatis 自动生成，只需在 mybatis-generator.xml 的配置文件里，针对某个 table 单独设置。参照如下代码：

<table tableName="user_account" domainObjectName="UserAccountEntity" enableCountByExample="false"
               enableUpdateByExample="false"
               enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false">
            <generatedKey column="id" sqlStatement="MySql"/>
        </table>

OK，Mybatis 的逆向工程讲述到这，可以做收藏，以后项目用得着。