idea中配置自动生成model mapper sql 代码

idea中配置自动生成model mapper sql 代码

创建maven项目

步骤省略。

配置pom.xml

文件中增加如下内容:

<plugin>
  <groupId>org.mybatis.generator</groupId>
  <artifactId>mybatis-generator-maven-plugin</artifactId>
  <version>1.3.2</version>
  <configuration>
    <verbose>true</verbose>
    <!-- 代表mybatis generator生成的内容不要覆盖已有的内容 -->
    <overwrite>false</overwrite>
  </configuration>
  <dependencies>
    <dependency>
      <groupId>mysql</groupId>
      <artifactId>mysql-connector-java</artifactId>
      <version>${mysql.version}</version>
    </dependency>
  </dependencies>
</plugin>

安装mysql数据库(或者其他)

步骤省略。

配置generatorConfig.xml

项目路径:一般放在resources下,具体在内容中配置;
内容(参照官方文档:http://www.mybatis.org/generator/configreference/xmlconfig.html):

<?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" defaultModelType="hierarchical" targetRuntime="MyBatis3Simple">

        <!-- 自动识别数据库关键字,默认false,如果设置为true,根据SqlReservedWords中定义的关键字列表;
         一般保留默认值,遇到数据库关键字(Java关键字),使用columnOverride覆盖 -->
        <property name="autoDelimitKeywords" value="false"/>
        <!-- 生成的Java文件的编码 -->
        <property name="javaFileEncoding" value="UTF-8"/>

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

        <!-- 注释生成器 -->
        <commentGenerator>
            <property name="suppressDate" value="true"/>
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>

        <!-- 必须要有的,使用这个配置链接数据库 @TODO:是否可以扩展 -->
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/testdb?serverTimezone=UTC" userId="root" password="root">
            <!-- 这里面可以设置property属性,每一个property属性都设置到配置的Driver上 -->
        </jdbcConnection>

        <!-- java模型创建器,是必须要的元素 负责:1,key类(见context的defaultModelType);2,java类;3,查询类
            targetPackage:生成的类要放的包,真实的包受enableSubPackages属性控制; targetProject:目标项目,指定一个存在的目录下,生成的内容会放到指定目录中,如果目录不存在,MBG不会自动建目录 -->
        <javaModelGenerator targetPackage="com.zjq.model" targetProject="src/main/java">
            <!-- for MyBatis3/MyBatis3Simple 自动为每一个生成的类创建一个构造方法,构造方法包含了所有的field;而不是使用setter; -->
            <property name="constructorBased" value="false"/>
            <!-- for MyBatis3 / MyBatis3Simple 是否创建一个不可变的类,如果为true, 那么MBG会创建一个没有setter方法的类,取而代之的是类似constructorBased的类 -->
            <property name="immutable" value="false"/>
        </javaModelGenerator>


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

        <!-- 对于mybatis来说,即生成Mapper接口,注意,如果没有配置该元素,那么默认不会生成Mapper接口 targetPackage/targetProject:同javaModelGenerator
            type:选择怎么生成mapper接口(在MyBatis3/MyBatis3Simple下):
            1,ANNOTATEDMAPPER:会生成使用Mapper接口+Annotation的方式创建(SQL生成在annotation中),不会生成对应的XML;
            2,MIXEDMAPPER:使用混合配置,会生成Mapper接口,并适当添加合适的Annotation,但是XML会生成在XML中;
            3,XMLMAPPER:会生成Mapper接口,接口完全依赖XML;
            注意,如果context是MyBatis3Simple:只支持ANNOTATEDMAPPER和XMLMAPPER -->
        <javaClientGenerator targetPackage="com.zjq.mapper"
                             type="XMLMAPPER" targetProject="src/main/java">
            <!-- 在targetPackage的基础上,根据数据库的schema再生成一层package,最终生成的类放在这个package下,默认为false -->
            <property name="" value="true"/>

            <!-- 可以为所有生成的接口添加一个父接口,但是MBG只负责生成,不负责检查 <property name="rootInterface"
                value=""/> -->
        </javaClientGenerator>

        <table tableName="t_role" delimitIdentifiers="true">
            <!-- 参考 javaModelGenerator 的 constructorBased属性 -->
            <property name="constructorBased" value="false"/>
            <generatedKey column="id" sqlStatement="JDBC"/>
        </table>

    </context>

</generatorConfiguration>

运行MyBatis Generator

配置maven启动:
1.
这里写图片描述
2.mybatis-generator:generate -e
这里写图片描述
3.执行完第2步骤,右键菜单中就会有此选项(需要安装maven helper插件);点击运行后,就会生成3个文件;
这里写图片描述

这里写图片描述

<think>我们正在讨论如何在IntelliJ IDEA自动生成MyBatismapper.xml文件。根据用户的问题,他想要一个配置或插件来实现这个功能。 已知的引用信息提到: 引用[1]介绍了MyBatis配置文件,包括config.xml和Mapper.xml,并说明了Mapper.xml的作用是自定义SQL语句,实现POJO与SQL的映射。 引用[2]提供了在IDEA配置mapper.xml模板的方法,这样在创建新的mapper.xml文件时可以使用预定义的模板。 但是,用户的需求不仅仅是模板,而是自动生成mapper.xml文件代码,这意味着他可能希望根据数据库表或其他信息自动生成CRUD操作的SQL映射。 在MyBatis生态中,有一个著名的代码生成工具叫做MyBatis Generator(简称MBG),它可以自动生成Mapper接口、Mapper.xml文件以及实体类。 因此,我们可以建议用户使用MyBatis Generator,并说明如何在IDEA配置它。 步骤: 1. 添加MyBatis Generator插件依赖(Maven或Gradle) 2. 创建并配置generatorConfig.xml文件 3. 运行MyBatis Generator 另外,IDEA本身也有插件可以辅助生成,比如“Free MyBatis Plugin”或“MyBatisCodeHelper-Pro”(后者是付费的),这些插件可以在IDEA的插件市场找到。 考虑到用户可能希望使用免费的工具,我们将重点介绍MyBatis Generator和Free MyBatis Plugin。 下面我们详细说明两种方法: 方法一:使用MyBatis Generator(MBG)自动生成代码 方法二:使用IDEA插件(如Free MyBatis Plugin)辅助生成 注意:用户问题中提到的引用[2]是关于模板的,我们可以将其作为基础模板,然后结合代码生成工具来生成具体的SQL映射。 由于用户要求自动生成,我们优先推荐MyBatis Generator,因为它是官方提供的。 详细步骤: 方法一:使用MyBatis Generator(MBG) 1. 在项目中添加MyBatis Generator的Maven插件(假设项目是Maven项目) 在pom.xml中添加: <build> <plugins> <plugin> <groupId>org.mybatis.generator</groupId> <artifactId>mybatis-generator-maven-plugin</artifactId> <version>1.4.0</version> <!-- 使用最新版本 --> <configuration> <configurationFile>src/main/resources/generatorConfig.xml</configurationFile> <overwrite>true</overwrite> </configuration> <dependencies> <!-- 如果使用MySQL,需要添加数据库驱动 --> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>8.0.23</version> <!-- 根据实际情况选择版本 --> </dependency> </dependencies> </plugin> </plugins> </build> 2. 在src/main/resources目录下创建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> <!-- 数据库驱动路径,如果已经在Maven中配置了依赖,这里可以指定classPathEntry,但通常Maven项目不需要,因为插件依赖已经包含 --> <!-- <classPathEntry location="/path/to/mysql-connector-java-8.0.23.jar" /> --> <context id="DB2Tables" targetRuntime="MyBatis3"> <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver" connectionURL="jdbc:mysql://localhost:3306/your_database" userId="your_username" password="your_password"> </jdbcConnection> <javaTypeResolver> <property name="forceBigDecimals" value="false"/> </javaTypeResolver> <!-- 生成实体类的位置 --> <javaModelGenerator targetPackage="com.example.model" targetProject="src/main/java"> <property name="enableSubPackages" value="true"/> <property name="trimStrings" value="true"/> </javaModelGenerator> <!-- 生成Mapper.xml文件的位置 --> <sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources"> <property name="enableSubPackages" value="true"/> </sqlMapGenerator> <!-- 生成Mapper接口的位置 --> <javaClientGenerator type="XMLMAPPER" targetPackage="com.example.mapper" targetProject="src/main/java"> <property name="enableSubPackages" value="true"/> </javaClientGenerator> <!-- 指定要生成的表 --> <table tableName="your_table" domainObjectName="YourModel"/> </context> </generatorConfiguration> 3. 运行Maven命令:mvn mybatis-generator:generate 或者通过IDEA的Maven工具窗口运行该插件的generate目标。 方法二:使用IDEA插件(Free MyBatis Plugin) 1. 在IDEA中安装插件:File -> Settings -> Plugins,搜索“Free MyBatis Plugin”并安装。 2. 重启IDEA。 3. 使用该插件可以: - 在Mapper接口的方法上按Alt+Enter,可以生成对应的SQL标签(在mapper.xml中) - 在mapper.xml中,可以快速跳转到Mapper接口的方法 - 提供一些代码模板和检测功能 4. 但是注意,这个插件并不能像MBG那样根据数据库表自动生成整个CRUD代码,它主要是辅助开发,减少手动编写的工作量。 因此,如果用户需要从数据库表直接生成完整的mapper.xml文件,推荐使用方法一(MBG)。如果用户只是希望在编写过程中有一些辅助,那么可以使用插件。 另外,用户之前提到的引用[2]中的模板,可以用于创建新的mapper.xml文件时的初始模板。我们可以配置IDEA的文件模板,这样在创建mapper.xml时自动生成基础结构。 配置IDEAmapper.xml模板: 1. File -> Settings -> Editor -> File and Code Templates 2. 点击“+”号,新建一个模板,命名为“MyBatis Mapper.xml” 3. 在内容区域填入引用[2]提供的模板内容: <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd"> <mapper namespace=""> </mapper> 4. 这样,在创建新的mapper.xml文件时,可以选择这个模板。 综上所述,我们可以结合使用MyBatis Generator来自动生成基础CRUD操作的mapper.xml,然后使用IDEA的模板来创建新的mapper.xml文件(当需要手动添加一些SQL时),同时使用Free MyBatis Plugin插件提高开发效率。 最后,我们根据用户的问题,直接回答如何在IDEA自动生成mapper.xml文件,重点推荐MyBatis Generator。 注意:在配置generatorConfig.xml时,需要用户根据自己的数据库和项目结构修改配置生成的相关问题: 1. MyBatis Generator支持哪些数据库? 2. 如何配置MyBatis Generator以生成不同风格的代码(例如,使用注解而不是XML)? 3. Free MyBatis Plugin还有哪些实用功能?</think>在 IntelliJ IDEA自动生成 MyBatis 的 `mapper.xml` 文件,可通过以下两种主流方案实现: --- ### 方案一:使用 MyBatis Generator (官方代码生成器) #### 配置步骤: 1. **添加 Maven 依赖** 在 `pom.xml` 中配置 MyBatis Generator 插件: ```xml <build> <plugins> <plugin> <groupId>org.mybatis.generator</groupId> <artifactId>mybatis-generator-maven-plugin</artifactId> <version>1.4.2</version> <dependencies> <!-- 数据库驱动(以 MySQL 为例)--> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>8.0.33</version> </dependency> </dependencies> <configuration> <configurationFile>src/main/resources/generatorConfig.xml</configurationFile> <!-- 配置文件路径 --> <overwrite>true</overwrite> </configuration> </plugin> </plugins> </build> ``` 2. **创建配置文件 `generatorConfig.xml`** 在 `src/main/resources` 目录下创建文件,内容示例: ```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/your_db" userId="root" password="123456"> </jdbcConnection> <!-- 实体类生成位置 --> <javaModelGenerator targetPackage="com.example.model" targetProject="src/main/java"/> <!-- Mapper.xml 生成位置 --> <sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources"/> <!-- Mapper 接口生成位置 --> <javaClientGenerator type="XMLMAPPER" targetPackage="com.example.mapper" targetProject="src/main/java"/> <!-- 指定要生成的表 --> <table tableName="user"/> <!-- 替换为你的表名 --> </context> </generatorConfiguration> ``` 3. **运行生成器** - 通过 IDEA 的 Maven 工具栏: `Plugins > mybatis-generator > mybatis-generator:generate` - 或命令行执行: ```bash mvn mybatis-generator:generate ``` **输出结果**:自动生成实体类、Mapper 接口和 `mapper.xml` 文件(含基础 CRUD SQL)。 --- ### 方案二:使用 IDEA 插件(推荐) #### 插件推荐: 1. **Free MyBatis Plugin**(免费) - 功能:XML 与接口互跳、SQL 补全、自动生成 CRUD 语句。 - 安装: `Settings > Plugins > Marketplace` → 搜索 "Free MyBatis Plugin" → 安装并重启 IDEA。 2. **MyBatisCodeHelper-Pro**(付费,功能强大) - 功能:自动生成 CRUD、批量插入、动态条件查询等复杂 SQL。 - 安装:同上,搜索 "MyBatisCodeHelper-Pro"。 #### 使用示例(Free MyBatis Plugin): 1. **创建 Mapper 接口** ```java public interface UserMapper { User selectById(Long id); // 方法名按需定义 } ``` 2. **自动生成 XML** - 在接口方法名上按 `Alt + Enter` → 选择 `Generate MyBatis SQL` → 选择 XML 文件位置。 - 插件自动生成对应 SQL 模板: ```xml <select id="selectById" resultType="User"> SELECT * FROM user WHERE id = #{id} </select> ``` --- ### 配置 XML 模板(可选) 按引用[^2]配置通用模板,避免手动编写头信息: 1. `Settings > Editor > File and Code Templates` 2. 点击 `+` 新建模板,命名 `MyBatis Mapper.xml` 3. 粘贴模板内容: ```xml <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd"> <mapper namespace="${NAMESPACE}"> </mapper> ``` 4. 创建新 XML 文件时选择此模板。 --- ### 对比总结 | **方案** | **优点** | **适用场景** | |------------------------|----------------------------------|--------------------------| | MyBatis Generator | 全自动生成所有基础 SQL | 新建项目需快速生成大量 CRUD | | Free MyBatis Plugin | 轻量级,与 IDEA 深度集成 | 日常开发中逐步添加 SQL 语句 | | MyBatisCodeHelper-Pro | 智能生成复杂 SQL,高效 | 企业级项目,追求开发效率 | ---
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值