Java最强持久层框架MyBatis-Generator-用法详解（上）XML配置详解3. <generatorConfiguration>的子元素

MBG全部指代MyBatis Generator：

• MyBatis Generator 1.3.4 扩展，可以设置 Mapper（Dao）后缀
• 运行MyBatis Generator
• 有4种运行MBG的方法，具体请看文档 运行 MyBatis Generator
• MBG下载地址: http://repo1.maven.org/maven2/org/mybatis/generator/mybatis-generator-core/

XML配置详解

在MBG中，最主要也最重要的就是XML配置文件，因此本文主要就是XML配置

这里按照配置的顺序对配置逐个讲解，更细的内容可以配合中文文档参照。

1. 配置文件头

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

2. 根节点

<generatorConfiguration>

generatorConfiguration

节点没有任何属性，直接写节点即可，如下：

<generatorConfiguration>
    <!-- 具体配置内容 -->
</generatorConfiguration>  

      

3.

<generatorConfiguration>

的子元素

从这段开始，就是配置的主要内容，这些配置都是

generatorConfiguration

元素的子元素（有严格顺序）

1. <properties>

   (0个或1个)

2. <classPathEntry>

   (0个或多个)

3. <context>

   (1个或多个)

3.1

<properties>

元素

这个元素用来指定外部的属性元素，不是必须的元素。

元素用于指定一个需要在配置中解析使用的外部属性文件，引入属性文件后，可以在配置中使用 ${property}这种形式的引用，通过这种方式引用属性文件中的属性值。 对于后面需要配置的jdbc信息和targetProject属性会很有用

这个属性可以通过resource或者url来指定属性文件的位置，这两个属性只能使用其中一个来指定，同时出现会报错

resource

：指定classpath下的属性文件，使用类似

com/myproject/generatorConfig.properties

这样的属性值。

url

：可以指定文件系统上的特定位置，例如

file:///C:/myfolder/generatorConfig.properties

3.2

<classPathEntry>

这个元素可以0或多个，不受限制。

最常见的用法是通过这个属性指定驱动的路径，例如：

<classPathEntry location="E:\mysql\mysql-connector-java-5.1.29.jar"/>

注意，classPathEntry只在下面这两种情况下才有效

• 当加载 JDBC 驱动内省数据库时
• 当加载根类中的 JavaModelGenerator 检查重写的方法时

**因此，**如果你需要加载其他用途的jar包，classPathEntry起不到作用，不能这么写，解决的办法就是将你用的jar包添加到类路径中，在IDE中运行的时候，添加jar包比较容易。当从命令行执行的时候，需要用java -cp xx.jar,xx2.jar xxxMainClass这种方式在-cp后面指定来使用(注意-jar会导致-cp无效)。

3.3

<context>

在MBG的配置中，至少需要有一个<context>元素。

<context>元素用于指定生成一组对象的环境。例如指定要连接的数据库，要生成对象的类型和要处理的数据库中的表。运行MBG的时候还可以指定要运行的<context>

该元素只有一个必选属性id，用来唯一确定一个<context>元素，该id属性可以在运行MBG时使用

此外还有几个可选属性

defaultModelType

这个属性很重要，这个属性定义了MBG如何生成实体类

这个属性有以下可选值：

• conditional

  :这是默认值,这个模型和下面的

  hierarchical

  类似，除了如果那个单独的类将只包含一个字段，将不会生成一个单独的类。 因此,如果一个表的主键只有一个字段,那么不会为该字段生成单独的实体类,会将该字段合并到基本实体类中。

• flat

  :该模型为每一张表只生成一个实体类。这个实体类包含表中的所有字段。这种模型最简单，推荐使用。

• hierarchical

  :如果表有主键,那么该模型会产生一个单独的主键实体类,如果表还有BLOB字段， 则会为表生成一个包含所有BLOB字段的单独的实体类,然后为所有其他的字段生成一个单独的实体类。 MBG会在所有生成的实体类之间维护一个继承关系。

• targetRuntime

  :此属性用于指定生成的代码的运行时环境。该属性支持以下可选值：

• MyBatis3

  :这是默认值

• MyBatis3Simple

• Ibatis2Java2

• Ibatis2Java5 一般情况下使用默认值即可，有关这些值的具体作用以及区别请查看中文文档的详细内容。

• introspectedColumnImpl:该参数可以指定扩展org.mybatis.generator.api.IntrospectedColumn该类的实现类。该属性的作用可以查看扩展MyBatis Generator。

  ​

一般情况下，我们使用如下的配置即可：

如果你希望不生成和Example查询有关的内容，那么可以按照如下进行配置:

使用MyBatis3Simple可以避免在后面的<table>中逐个进行配置（后面会提到）

MBG配置中的其他几个元素，基本上都是<context>的子元素，这些子元素（有严格的配置顺序）包括：

• <property>

• <plugin>

• <commentGenerator>

• <jdbcConnection>

  (1个)

• <javaTypeResolver>

• <javaModelGenerator>

• <sqlMapGenerator>

• <javaClientGenerator>

• <table>

其中

<property>

属性比较特殊，后面讲解的时候都会和父元素一起进行讲解。在讲解

<property>

属性前，我们先看看什么是分隔符？。

这里通过一个例子说明。假设在Mysql数据库中有一个表名为user info，你没有看错，中间是一个空格，这种情况下如果写出select * from user info这样的语句，肯定是要报错的，在Mysql中的时候我们一般会写成如下的样子:

select * from user info

这里的使用的**反单引号()**就是**分隔符**，**分隔符**可以用于**表名**或者**列名**。 下面继续看`支持的属性：

• autoDelimitKeywords

• beginningDelimiter

• endingDelimiter

• javaFileEncoding

• javaFormatter

• xmlFormatter

由于这些属性比较重要，这里一一讲解。

首先是autoDelimitKeywords，当表名或者字段名为SQL关键字的时候，可以设置该属性为true，MBG会自动给表名或字段名添加分隔符。

然后这里继续上面的例子来讲beginningDelimiter和endingDelimiter属性。

由于beginningDelimiter和endingDelimiter的默认值为双引号(")，在Mysql中不能这么写，所以还要将这两个默认值改为**反单引号()**，配置如下： <property name="beginningDelimiter" value=""/>

属性javaFileEncoding设置要使用的Java文件的编码，默认使用当前平台的编码，只有当生产的编码需要特殊指定时才需要使用，一般用不到。

最后两个javaFormatter和xmlFormatter属性可能会很有用，如果你想使用模板来定制生成的java文件和xml文件的样式，你可以通过指定这两个属性的值来实现。

接下来分节对其他的子元素逐个进行介绍。