springboot+mybatis+mysql 通过 generator 配置文件生成代码

本贴最后更新于 2006 天前,其中的信息可能已经时移俗易
第一次写文章!有写错的地方请指出!
此篇文章主要是这两天自己搭springboot时用到generator生成相应的entity,dao以及xml文件的总结。
一、通过https://start.spring.io/生成相应的demo文件

imagepng
注意选择 web、mysql、mybatis 三个模块,能够在 pom 中生成相应的配置文件。

二、将文件下载下来后导入到 idea 中,并在 src.main.java 目录下增加放 entity(实体类)、dao(mapper 接口)的 package,在 resources 下增加放 mapper.xml 的 directory,以及增加一个文件夹放 generate 的配置文件的 directory。具体目录结构如下图

imagepng
三、在 pom.xml 中增加 generate 的配置信息
1、在 dependencies 中添加以下内容

<!--mybatis 自动生成插件-->  
<dependency\>  
   <groupId\>org.mybatis.generator</groupId\>  
   <artifactId\>mybatis-generator-core</artifactId\>  
   <version\>1.3.5</version\>  
</dependency\>  

2、在 plugins 中添加以下内容

<!-- (1)  mybatis generator 自动生成代码插件 -->  
<plugin\>  
   <groupId\>org.mybatis.generator</groupId\>  
   <artifactId\>mybatis-generator-maven-plugin</artifactId\>  
   <version\>1.3.2</version\>  
   <executions\>  
      <execution\>  
         <id\>Generate MyBatis Artifacts</id\>  
         <phase\>deploy</phase\>  
         <goals\>  
            <goal\>generate</goal\>  
         </goals\>  
      </execution\>  
   </executions\>  
   <configuration\>  
      <!-- generator 工具配置文件的位置 -->  
  <configurationFile\>src/main/resources/mybatis-generator/generatorConfig.xml</configurationFile\>  
      <verbose\>true</verbose\>  
      <overwrite\>true</overwrite\>  
   </configuration\>  
   <dependencies\>  
      <dependency\>  
         <groupId\>mysql</groupId\>  
         <artifactId\>mysql-connector-java</artifactId\>  
         <scope\>runtime</scope\>  
         <version\>${mysql.version}</version\>  
      </dependency\>  
   </dependencies\>  
</plugin\>

三、在数据库中新建表 sys_user,
1、在 resources 下 mybatis_generator 下新建 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\>  
    <!--执行generator插件生成文件的命令: call mvn mybatis-generator:generate -e -->  
 <!-- 引入配置文件 -->  <properties resource\="mybatis-generator/mybatisGeneratorinit.properties"/>  
    <!-- 一个数据库一个context -->  
 <!--defaultModelType="flat" 大数据字段,不分表 -->  <context id\="MysqlTables" targetRuntime\="MyBatis3Simple" defaultModelType\="flat"\>  
        <!-- 自动识别数据库关键字,默认false,如果设置为true,根据SqlReservedWords中定义的关键字列表;  
 一般保留默认值,遇到数据库关键字(Java关键字),使用columnOverride覆盖 -->  <property name\="autoDelimitKeywords" value\="true" />  
        <!-- 生成的Java文件的编码 -->  
  <property name\="javaFileEncoding" value\="utf-8" />  
        <!-- beginningDelimiter和endingDelimiter:指明数据库的用于标记数据库对象名的符号,比如ORACLE就是双引号,MYSQL默认是\`反引号; -->  
  <property name\="beginningDelimiter" value\="\`" />  
        <property name\="endingDelimiter" value\="\`" />  
  
        <!-- 格式化java代码 -->  
  <property name\="javaFormatter" value\="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>  
        <!-- 格式化XML代码 -->  
  <property name\="xmlFormatter" value\="org.mybatis.generator.api.dom.DefaultXmlFormatter"/>  
        <plugin type\="org.mybatis.generator.plugins.SerializablePlugin" />  
  
        <plugin type\="org.mybatis.generator.plugins.ToStringPlugin" />  
  
        <!-- 注释 -->  
  <commentGenerator \>  
            <property name\="suppressAllComments" value\="false"/><!-- 是否取消注释 -->  
  <property name\="suppressDate" value\="true" /> <!-- 是否生成注释代时间戳-->  
  </commentGenerator\>  
  
        <!-- jdbc连接 -->  
  <jdbcConnection driverClass\="${jdbc\_driver}" connectionURL\="${jdbc\_url}" userId\="${jdbc\_user}" password\="${jdbc\_password}" />  
        <!-- 类型转换 -->  
  <javaTypeResolver\>  
            <!-- 是否使用bigDecimal, false可自动转化以下类型(Long, Integer, Short, etc.) -->  
  <property name\="forceBigDecimals" value\="false"/>  
        </javaTypeResolver\>  
  
        <!-- 生成实体类地址 -->  
  <javaModelGenerator targetPackage\="com.zhyq.admin.entity" targetProject\="${project}" \>  
            <property name\="enableSubPackages" value\="false"/>  
            <property name\="trimStrings" value\="true"/>  
        </javaModelGenerator\>  
        <!-- 生成mapxml文件 -->  
  <sqlMapGenerator targetPackage\="mapper" targetProject\="${resources}" \>  
            <property name\="enableSubPackages" value\="false" />  
        </sqlMapGenerator\>  
        <!-- 生成mapxml对应client,也就是接口dao -->  
  <javaClientGenerator targetPackage\="com.zhyq.admin.dao" targetProject\="${project}" type\="XMLMAPPER" \>  
            <property name\="enableSubPackages" value\="false" />  
        </javaClientGenerator\>  
        <!-- table可以有多个,每个数据库中的表都可以写一个table,tableName表示要匹配的数据库表,也可以在tableName属性中通过使用%通配符来匹配所有数据库表,只有匹配的表才会自动生成文件 -->  
  <table tableName\="sys\_user" enableCountByExample\="true" enableUpdateByExample\="true" enableDeleteByExample\="true" enableSelectByExample\="true" selectByExampleQueryId\="true"\>  
            <property name\="useActualColumnNames" value\="false" />  
            <!-- 数据库表主键 -->  
  <generatedKey column\="id" sqlStatement\="Mysql" identity\="true" />  
        </table\>  
    </context\>  
</generatorConfiguration\>

注意:配置文件中需要注意需要生成哪个表的相应代码需要进行配置,最好生成一次后进行注释,如果未注释,会将上次生成的代码覆盖!(具体配置详情都在配置文件中有注释)

imagepng

2、在 resources 下 mybatis_generator 下新建 mybatisGeneratorinit.properties 文件,并在里面加入以下内容,该内容主要是为 generator.xml 中提供相应的配置信息

#Mybatis Generator configuration  
#dao类和实体类的位置  
project \=src/main/java  
#mapper文件的位置  
resources\=src/main/resources  
#根据数据库中的表生成对应的pojo类、dao、mapper  
jdbc\_driver \=com.mysql.jdbc.Driver  
jdbc\_url\=jdbc:mysql://localhost:3306/generator
jdbc\_user\=root  
jdbc\_password\=123

四、在 application.yml 中增加 mybatis 的配置信息

mybatis:  
 mapper-locations: mapper/\*\*Mapper.xml  
  configuration:  
 map-underscore-to-camel-case: true

------------------------------------------到此配置信息结束---------------------------------------------------
五、通过 idea 生成相应的代码,配置 generator.xml 作为 maven 启动项,按照以下图片步骤可以看到在右侧 maven 多了一个启动项。完成后点击启动项则生成了相应的代码。

imagepng

imagepng

imagepng

注:mybatis-generator:generate -e -e 为了在生成过程中输出日志
生成结果如下

imagepng

简单写一个 get 请求通过 postman 进行调试返回结果信息,成功将数据库表数据查出来!

imagepng

  • Spring

    Spring 是一个开源框架,是于 2003 年兴起的一个轻量级的 Java 开发框架,由 Rod Johnson 在其著作《Expert One-On-One J2EE Development and Design》中阐述的部分理念和原型衍生而来。它是为了解决企业应用开发的复杂性而创建的。框架的主要优势之一就是其分层架构,分层架构允许使用者选择使用哪一个组件,同时为 JavaEE 应用程序开发提供集成的框架。

    938 引用 • 1456 回帖 • 163 关注
  • MySQL

    MySQL 是一个关系型数据库管理系统,由瑞典 MySQL AB 公司开发,目前属于 Oracle 公司。MySQL 是最流行的关系型数据库管理系统之一。

    673 引用 • 535 回帖
  • MyBatis

    MyBatis 本是 Apache 软件基金会 的一个开源项目 iBatis,2010 年这个项目由 Apache 软件基金会迁移到了 google code,并且改名为 MyBatis ,2013 年 11 月再次迁移到了 GitHub。

    170 引用 • 414 回帖 • 430 关注

相关帖子

欢迎来到这里!

我们正在构建一个小众社区,大家在这里相互信任,以平等 • 自由 • 奔放的价值观进行分享交流。最终,希望大家能够找到与自己志同道合的伙伴,共同成长。

注册 关于
请输入回帖内容 ...

推荐标签 标签

  • IDEA

    IDEA 全称 IntelliJ IDEA,是一款 Java 语言开发的集成环境,在业界被公认为最好的 Java 开发工具之一。IDEA 是 JetBrains 公司的产品,这家公司总部位于捷克共和国的首都布拉格,开发人员以严谨著称的东欧程序员为主。

    180 引用 • 400 回帖
  • 倾城之链
    23 引用 • 66 回帖 • 93 关注
  • 钉钉

    钉钉,专为中国企业打造的免费沟通协同多端平台, 阿里巴巴出品。

    15 引用 • 67 回帖 • 381 关注
  • 友情链接

    确认过眼神后的灵魂连接,站在链在!

    24 引用 • 373 回帖 • 7 关注
  • V2Ray
    1 引用 • 15 回帖
  • CloudFoundry

    Cloud Foundry 是 VMware 推出的业界第一个开源 PaaS 云平台,它支持多种框架、语言、运行时环境、云平台及应用服务,使开发人员能够在几秒钟内进行应用程序的部署和扩展,无需担心任何基础架构的问题。

    5 引用 • 18 回帖 • 151 关注
  • Kubernetes

    Kubernetes 是 Google 开源的一个容器编排引擎,它支持自动化部署、大规模可伸缩、应用容器化管理。

    108 引用 • 54 回帖
  • 国际化

    i18n(其来源是英文单词 internationalization 的首末字符 i 和 n,18 为中间的字符数)是“国际化”的简称。对程序来说,国际化是指在不修改代码的情况下,能根据不同语言及地区显示相应的界面。

    7 引用 • 26 回帖 • 1 关注
  • Windows

    Microsoft Windows 是美国微软公司研发的一套操作系统,它问世于 1985 年,起初仅仅是 Microsoft-DOS 模拟环境,后续的系统版本由于微软不断的更新升级,不但易用,也慢慢的成为家家户户人们最喜爱的操作系统。

    215 引用 • 462 回帖
  • Pipe

    Pipe 是一款小而美的开源博客平台。Pipe 有着非常活跃的社区,可将文章作为帖子推送到社区,来自社区的回帖将作为博客评论进行联动(具体细节请浏览 B3log 构思 - 分布式社区网络)。

    这是一种全新的网络社区体验,让热爱记录和分享的你不再感到孤单!

    131 引用 • 1114 回帖 • 153 关注
  • 程序员

    程序员是从事程序开发、程序维护的专业人员。

    529 引用 • 3527 回帖
  • IPFS

    IPFS(InterPlanetary File System,星际文件系统)是永久的、去中心化保存和共享文件的方法,这是一种内容可寻址、版本化、点对点超媒体的分布式协议。请浏览 IPFS 入门笔记了解更多细节。

    20 引用 • 245 回帖 • 232 关注
  • 区块链

    区块链是分布式数据存储、点对点传输、共识机制、加密算法等计算机技术的新型应用模式。所谓共识机制是区块链系统中实现不同节点之间建立信任、获取权益的数学算法 。

    91 引用 • 751 回帖 • 5 关注
  • Electron

    Electron 基于 Chromium 和 Node.js,让你可以使用 HTML、CSS 和 JavaScript 构建应用。它是一个由 GitHub 及众多贡献者组成的活跃社区共同维护的开源项目,兼容 Mac、Windows 和 Linux,它构建的应用可在这三个操作系统上面运行。

    15 引用 • 136 回帖 • 1 关注
  • Redis

    Redis 是一个开源的使用 ANSI C 语言编写、支持网络、可基于内存亦可持久化的日志型、Key-Value 数据库,并提供多种语言的 API。从 2010 年 3 月 15 日起,Redis 的开发工作由 VMware 主持。从 2013 年 5 月开始,Redis 的开发由 Pivotal 赞助。

    284 引用 • 247 回帖 • 212 关注
  • 七牛云

    七牛云是国内领先的企业级公有云服务商,致力于打造以数据为核心的场景化 PaaS 服务。围绕富媒体场景,七牛先后推出了对象存储,融合 CDN 加速,数据通用处理,内容反垃圾服务,以及直播云服务等。

    25 引用 • 215 回帖 • 160 关注
  • 996
    13 引用 • 200 回帖 • 9 关注
  • Flume

    Flume 是一套分布式的、可靠的,可用于有效地收集、聚合和搬运大量日志数据的服务架构。

    9 引用 • 6 回帖 • 594 关注
  • 黑曜石

    黑曜石是一款强大的知识库工具,支持本地 Markdown 文件编辑,支持双向链接和关系图。

    A second brain, for you, forever.

    9 引用 • 83 回帖 • 1 关注
  • Bug

    Bug 本意是指臭虫、缺陷、损坏、犯贫、窃听器、小虫等。现在人们把在程序中一些缺陷或问题统称为 bug(漏洞)。

    76 引用 • 1738 回帖 • 3 关注
  • 音乐

    你听到信仰的声音了么?

    58 引用 • 507 回帖 • 1 关注
  • Solidity

    Solidity 是一种智能合约高级语言,运行在 [以太坊] 虚拟机(EVM)之上。它的语法接近于 JavaScript,是一种面向对象的语言。

    3 引用 • 18 回帖 • 347 关注
  • FlowUs

    FlowUs.息流 个人及团队的新一代生产力工具。

    让复杂的信息管理更轻松、自由、充满创意。

    1 引用 • 2 关注
  • 创业

    你比 99% 的人都优秀么?

    82 引用 • 1397 回帖 • 1 关注
  • Gzip

    gzip (GNU zip)是 GNU 自由软件的文件压缩程序。我们在 Linux 中经常会用到后缀为 .gz 的文件,它们就是 Gzip 格式的。现今已经成为互联网上使用非常普遍的一种数据压缩格式,或者说一种文件格式。

    9 引用 • 12 回帖 • 106 关注
  • Bootstrap

    Bootstrap 是 Twitter 推出的一个用于前端开发的开源工具包。它由 Twitter 的设计师 Mark Otto 和 Jacob Thornton 合作开发,是一个 CSS / HTML 框架。

    18 引用 • 33 回帖 • 682 关注
  • 服务

    提供一个服务绝不仅仅是简单的把硬件和软件累加在一起,它包括了服务的可靠性、服务的标准化、以及对服务的监控、维护、技术支持等。

    41 引用 • 24 回帖