从数据库生成实体类

一、为什么需要从数据库生成实体类

在软件开发过程中，尤其是涉及到数据持久化操作时，实体类起着至关重要的作用，从数据库生成实体类主要有以下几个重要意义：

1、提高开发效率

减少手动编码错误：手动编写实体类时，很容易因为疏忽而出现属性名拼写错误、数据类型不匹配等问题，在处理一个包含大量字段的数据库表时，如员工信息表（包含员工编号、姓名、性别、入职日期、部门编号等多个字段），若手动编写实体类，一旦不小心将“employee_id”写成了“employe_id”，在后续的数据访问和操作中就会导致各种难以察觉的错误，而通过从数据库自动生成实体类，可以极大地避免这类低级错误，确保属性名与数据库表中的列名准确对应。

快速搭建基本框架：对于复杂的业务系统，其涉及的数据库表众多且结构复杂，从数据库生成实体类能够快速地为每个表创建对应的实体类文件，为开发者提供了一个基本的代码框架，开发者可以在这个框架的基础上，根据业务逻辑进一步添加方法、注解等，而无需从零开始构建整个实体类体系，从而节省了大量的时间和精力。

2、保证数据一致性

同步数据库结构变化：在项目的开发和维护过程中，数据库的结构可能会因为业务需求的变化而进行调整，如新增或删除列、修改数据类型等，如果手动维护实体类，很可能会忘记更新相应的实体类，导致实体类与数据库表的结构不一致，而使用从数据库生成实体类的工具，当数据库结构发生变化时，只需重新生成实体类，就能保证实体类始终与最新的数据库结构保持一致，从而确保数据在不同层次（数据库层和应用程序层）之间的准确传输和处理。

统一数据访问方式：实体类作为数据库表在应用程序中的映射，定义了对数据库中数据的操作方式，从数据库生成实体类可以确保所有对数据库数据的访问都通过这些统一的实体类进行，避免了直接使用 SQL 语句操作数据库可能带来的数据不一致问题，在一个多用户并发访问的系统中，如果不同模块直接使用各自的 SQL 语句去操作数据库，可能会导致某个数据项被部分更新、读取到脏数据等情况，而通过实体类的封装和方法调用，可以按照既定的规则和顺序对数据进行操作，保证数据的一致性和完整性。

3、便于维护和扩展

集中管理数据相关逻辑：将所有与数据库表相关的属性和操作封装在实体类中，使得数据的逻辑更加清晰和集中，当需要对某个数据库表相关的业务逻辑进行修改或扩展时，只需要在对应的实体类中进行操作即可，而不需要在整个项目中到处查找和修改涉及该表的代码，若要为员工信息表添加一个新的业务功能，如计算员工的工龄并根据工龄给予相应的活动，只需在员工实体类中添加一个计算工龄的方法以及相关的活动计算逻辑，而不会影响到其他模块的代码。

方便与其他层交互：在分层架构的应用程序中（如表现层、业务逻辑层、数据访问层），实体类作为数据传输的载体，在各层之间起到了桥梁的作用，从数据库生成的实体类具有明确的属性和结构，方便在不同层之间传递数据，在表现层获取用户输入的员工信息后，可以将这些信息封装成员工实体类对象，然后传递给业务逻辑层进行处理，业务逻辑层处理完毕后再将结果以实体类对象的形式返回给表现层进行展示，这种基于实体类的数据传输方式使得各层之间的耦合度降低，提高了代码的可维护性和可扩展性。

二、如何从数据库生成实体类

（一）使用 MyBatis Generator

1、配置环境

需要确保项目中已经引入了 MyBatis Generator 的相关依赖，在 Maven 项目中，可以在pom.xml 文件中添加如下依赖：

<dependency>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-core</artifactId>
    <version>1.4.0</version>
</dependency>

还需要配置数据库连接驱动等相关依赖，以便 MyBatis Generator 能够连接到数据库，对于 MySQL 数据库，需要添加 MySQL 驱动的依赖：

<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.23</version>
</dependency>

2、创建配置文件

MyBatis Generator 需要一个配置文件来指定数据库连接信息、生成的实体类相关信息以及其他一些参数，以下是一个示例配置文件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>
    <context id="DB2Tables" targetRuntime="MyBatis3">
        <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/yourdatabase"
                        userId="yourusername"
                        password="yourpassword"/>
        <javaModelGenerator targetPackage="com.example.model" targetProject="src/main/java"/>
        <sqlMapGenerator targetPackage="com.example.mapper" targetProject="src/main/resources"/>
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.example.mapper" targetProject="src/main/java"/>
        <table tableName="employee" domainObjectName="Employee"/>
    </context>
</generatorConfiguration>

在上面的配置文件中：

jdbcConnection 元素用于配置数据库连接信息，包括驱动类、连接 URL、用户名和密码等，需要根据实际情况修改这些值，使其能够正确连接到目标数据库。

javaModelGenerator 元素指定了生成的实体类的包名和存放位置，这里设置目标包名为com.example.model，目标项目路径为src/main/java，意味着生成的实体类文件将放在src/main/java/com/example/model 目录下。

sqlMapGenerator 元素用于配置生成的 SQL 映射文件（Mapper 接口文件）的包名和存放位置，同样设置了包名为com.example.mapper，存放路径为src/main/resources。

javaClientGenerator 元素指定了客户端代码（这里是 XML 映射文件）的生成方式和相关信息。

table 元素指定了要生成实体类的数据库表名（这里是employee 表）以及对应的实体类名称（Employee），可以根据需要添加多个table 元素来为不同的表生成实体类。

3、运行生成器

在配置好上述文件后，可以通过命令行或者集成开发环境（IDE）来运行 MyBatis Generator 生成实体类和其他相关文件，在命令行中，进入 MyBatis Generator 的lib 目录（假设解压后的 MyBatis Generator 文件在libs 目录下），然后执行以下命令：

java org.mybatis.generator.api.MyBatisGenerator -config generatorConfig.xml -overwrite

-config 参数指定了配置文件的路径，-overwrite 参数表示如果目标文件已存在则覆盖，运行该命令后，MyBatis Generator 会根据配置文件中的信息连接到数据库，读取指定的表结构，并生成相应的实体类、Mapper 接口和 XML 映射文件等。

（二）使用 JPA（Java Persistence API）工具

1、配置持久化单元

在使用 JPA 从数据库生成实体类时，首先需要在项目中配置持久化单元，在 Java EE 项目中，通常在persistence.xml 文件中进行配置，以下是一个示例persistence.xml 文件：

<persistence xmlns="http://xmlns.jcp.org/xml/ns/persistence" version="2.2">
    <persistence-unit name="examplePU">
        <provider>org.hibernate.jpa.HibernatePersistenceProvider</provider>
        <class>com.example.model.Employee</class>
        <properties>
            <property name="javax.persistence.jdbc.driver" value="com.mysql.cj.jdbc.Driver"/>
            <property name="javax.persistence.jdbc.url" value="jdbc:mysql://localhost:3306/yourdatabase"/>
            <property name="javax.persistence.jdbc.user" value="yourusername"/>
            <property name="javax.persistence.jdbc.password" value="yourpassword"/>
            <property name="hibernate.dialect" value="org.hibernate.dialect.MySQLDialect"/>
    </persistence-unit>
</persistence>

在上面的配置中：

<provider> 元素指定了 JPA 提供者，这里使用的是 Hibernate 作为 JPA 实现。

<class> 元素用于指定持久化类（即要生成实体类的类），这里先手动添加了一个Employee 类作为示例，后续可以通过工具自动发现和添加其他类。

<properties> 元素配置了数据库连接相关的属性，包括驱动类、连接 URL、用户名、密码以及数据库方言等，需要根据实际情况修改这些值以连接到正确的数据库。

2、使用反向工程工具

JPA 提供了一些反向工程工具，可以帮助开发者从现有的数据库结构生成实体类和其他元数据，Hibernate Tools 是一个常用的 JPA 反向工程工具，以下是使用 Hibernate Tools 的一般步骤：

打开 Hibernate Tools 插件（如果是在 Eclipse 等 IDE 中使用）。

配置数据库连接信息，使其能够连接到目标数据库，这与前面配置 JPA 持久化单元中的数据库连接信息类似，但这里是在 Hibernate Tools 的工具界面中进行设置。

选择要生成实体类的数据库模式（Schema）和表，可以通过工具提供的界面浏览数据库中的模式和表结构，并勾选需要生成实体类的表。

设置生成选项，如实体类的包名、存放路径、是否生成注释等，可以指定实体类所在的包名为com.example.model，存放路径为项目的src/main/java 目录，并选择生成 JPA 注释以便在编译时进行验证和代码提示。

点击“生成”按钮，Hibernate Tools 将根据所选的表结构和配置信息生成相应的实体类文件，这些实体类文件将包含表的字段信息、JPA 注解以及基本的方法骨架（如 getter、setter 方法等）。

三、从数据库生成实体类的注意事项

（一）数据库兼容性

1、不同数据库的差异

不同的数据库管理系统（DBMS）在数据类型、约束机制、默认值处理等方面存在一定的差异，这可能会影响实体类的生成和使用，MySQL 中的TINYINT 类型在某些情况下可能会被映射为 Java 中的Boolean 类型，而在 SQL Server 中可能会被映射为Byte 类型，在生成实体类时，需要了解所使用的 DBMS 的特性，并根据具体情况进行适当的调整和配置。

2、特殊数据类型的处理

一些特殊的数据类型可能需要特殊的处理才能正确地生成实体类，对于数据库中的BLOB（二进制大对象）和CLOB（字符大对象）类型，在生成实体类时可能需要使用特定的注解或处理方法来确保数据的读写正常，又如，对于具有自增长属性的字段（如 MySQL 中的AUTO_INCREMENT），在实体类中需要正确标注其自增长属性，以便在使用 ORM 框架时能够正确地处理数据的插入和更新操作。

（二）命名规范

1、表名与类名的转换

在从数据库生成实体类时，通常会将数据库表名转换为 Java 类名，会将表名中的单词转换为驼峰式命名法（Camel Case），并将首字母大写作为类名的首字母，数据库表employee_info 会被转换为 Java 类EmployeeInfo，在实际开发中，可能会根据业务需求或团队的命名规范对类名进行调整，如果表名较长或者包含一些特殊字符，可能会采用缩写或更具描述性的类名。

2、字段名与属性名的转换

同样，数据库表字段名也会被转换为实体类的属性名，一般情况下，会将字段名中的下划线风格转换为驼峰式命名法，字段名employee_name 会被转换为属性名employeeName，需要注意的是，如果字段名是数据库中的关键字或者是保留字，可能需要在属性名中进行特殊处理，以避免与 Java 语言的关键字冲突，如果字段名是order（在 SQL 中是关键字），可以将其属性名改为orderNumber 或其他合适的名称。

（三）版本控制与协作

1、多人协作时的冲突解决

在团队开发环境中，可能会有多个开发人员同时对数据库和实体类进行修改，这可能导致在生成实体类时出现版本冲突的问题，一个开发人员修改了数据库表结构并重新生成了实体类，而另一个开发人员在不知情的情况下也对同一个表结构的实体类进行了手动修改，为了避免这种情况，建议建立良好的版本控制机制，如使用 Git 等版本控制系统对代码进行管理，在生成实体类之前，先更新本地代码库，确保获取到最新的数据库表结构和相关配置文件，如果发现有冲突，及时与团队成员沟通并协商解决。

2、与现有代码的整合

当从数据库生成新的实体类后，需要将其与项目中的现有代码进行整合，这可能涉及到修改业务逻辑代码、持久层代码以及相关的配置文件等，在进行整合时，需要注意保持代码的一致性和可维护性，如果项目中已经存在一些对旧实体类的引用和操作，需要检查这些代码是否适用于新的实体类，并根据需要进行修改和调整，还需要考虑新实体类与其他模块或服务之间的依赖关系和交互情况，确保整个系统的正常运行。

FAQs

1. 从数据库生成实体类时，是否可以自定义字段类型映射？

答：是的，可以使用自定义的类型映射，在使用 MyBatis Generator 时，可以通过配置文件中的typeHandler 元素来指定自定义的类型处理器，从而实现特定字段类型到 Java 类型的自定义映射，在使用 JPA 时，也可以通过在实体类中使用@Column 注解的columnDefinition 属性来指定数据库字段的具体类型定义。

2. 如果数据库表结构发生了变化，如何更新已生成的实体类？

答：如果数据库表结构发生了变化，需要重新运行相应的实体类生成工具来更新实体类，如果使用 MyBatis Generator，可以在修改配置文件中的数据库连接信息和表结构信息后，再次运行生成器命令来重新生成实体类，如果使用 JPA 工具，可以在持久化单元配置中更新数据库连接信息，并重新执行反向工程操作来更新实体类，在更新实体类后，还需要检查和更新与这些实体类相关的业务逻辑代码和其他配置文件。