MyBatis Generator 超详细配置 | 您所在的位置:网站首页 › mysqldbconfiG配置 › MyBatis Generator 超详细配置 |
想快速开始,请直接拉到最后,看整体配置。 MyBatis Generator 是 MyBatis 提供的一个代码生成工具。可以帮我们生成 表对应的持久化对象(po)、操作数据库的接口(dao)、CRUD sql的xml(mapper)。 MyBatis Generator 是一个独立工具,你可以下载它的jar包来运行、也可以在 Ant 和 maven 运行。 使用环境我是在 maven 中配置并使用的。这篇文章也是基于 maven 环境来讲解。 既然使用了 MyBatis Generator ,那么你的项目一定使用了 MyBatis, 并且一定使用了某一种数据库,并且这些依赖应该已经在 maven 中配置好了。 例如 接下来需要在 pom 中引入 MyBatis Generator 插件 引入 MyBatis Generator 插件在 pom 的根节点下添加以下配置 org.mybatis.generator mybatis-generator-maven-plugin 1.3.7 配置 MyBatis Generator 插件光引入 MyBatis Generator 插件还不行,还得配置 MyBatis Generator插件 配置 MyBatis Generator config 文件路径MyBatis Generator 插件需要根据一个 MyBatis Generator config 文件,来具体运行 配置如下,版本我用的是目前最新的版本 1.3.7 org.mybatis.generator mybatis-generator-maven-plugin 1.3.7 src/main/resources/mybatis-generator-config.xml注意,这个路径是你的配置文件相对于该 pom 文件的路径 至于这个文件该怎么配置我们待会在 允许覆盖生成的文件有时候我们的数据库表添加了新字段,需要重新生成对应的文件。常规做法是手动删除旧文件,然后在用 MyBatis Generator 生成新文件。当然你也可以选择让 MyBatis Generator 覆盖旧文件,省下手动删除的步骤。 配置如下 org.mybatis.generator mybatis-generator-maven-plugin 1.3.7 src/main/resources/mybatis-generator-config.xml true值得注意的是,MyBatis Generator 只会覆盖旧的 po、dao、而 *mapper.xml 不会覆盖,而是追加,这样做的目的是防止用户自己写的 sql 语句一不小心都被 MyBatis Generator 给覆盖了 添加数据库驱动依赖MyBatis Generator 需要链接数据库,肯定是需要对应数据库驱动的依赖的。 如下,给 MyBatis Generator 添加数据库驱动依赖 org.mybatis.generator mybatis-generator-maven-plugin 1.3.7 src/main/resources/mybatis-generator-config.xml true mysql mysql-connector-java 8.0.17我用的数据库是 mysql ,其他数据库同理。注意数据库驱动的版本号,不同的版本对应的 MyBatis Generator 配置有些许不同,之后会讲。 大部分情况下,我们的项目中已经配置过了对应数据库的JDBC驱动,如下 现在在插件中又配置一次,感觉有些冗余,maven 提供了 includeCompileDependencies 属性,让我们在插件中引用 dependencies 的依赖,这样就不需要重复配置了。 配置如下 org.mybatis.generator mybatis-generator-maven-plugin 1.3.7 src/main/resources/mybatis-generator-config.xml true true一般配置了 includeCompileDependencies 后就不需要配置其他依赖了,因为 includeCompileDependencies 会将当前 pom 的 dependencies 中所以 Compile 期的依赖全部添加到生成器的类路径中。 但有的人不想配置 includeCompileDependencies ,或者想在MyBatis Generator插件中使用另一个版本的依赖,就可以配置 dependencies 如图 另外,我看到网上大部分文章都会配置 mybatis-generator-core 这个依赖,但是 MyBatis Generator 官网的案例中都没有提到说要配置这个依赖,我没有配置,并且可以正常使用 MyBatis Generator MyBatis Generator 插件启动后,会根据你在 pom 中配置都路径找到该配置文件。 这个配置文件才是详细都配置 MyBatis Generator 生成代码的各种细节。 其中最重要的就是 context ,你的配置文件至少得包含一个context MyBatis Generator config 是可以引入外部配置文件的,如下,路径为相对于当前配置文件的路径 代码如下,注意是配置在 下 配置文件中的内容如下 注意是配置在 下 id : 随便填,保证多个 context id 不重复就行 defaultModelType : 可以不填,默认值 conditional,flat表示一张表对应一个po targetRuntime :可以不填,默认值 MyBatis3,常用的还有 MyBatis3Simple,这个配置会影响生成的 dao 和 mapper.xml的内容targetRuntime = MyBatis3,生成的 dao 和 mapper.xml 如下 targetRuntime = MyBatis3Simple,生成的 dao 和 mapper.xml 如下,接口会少很多,只包含最最常用的 context 节点就讲完了,唯一需要注意的就是targetRuntime的值,该配置成什么看个人喜好 context的子元素上一节只是配置了 context 节点, context 里面还有子元素需要配置。 context的子元素必须按照以下给出的个数、顺序配置。(是的,没错 MyBatis Generator 对配置的循序还有要求) property (0..N) plugin (0..N) commentGenerator (0 or 1) jdbcConnection (需要connectionFactory 或 jdbcConnection) javaTypeResolver (0 or 1) javaModelGenerator (至少1个) sqlMapGenerator (0 or 1) javaClientGenerator (0 or 1) table (1..N) plugin配置一个插件,例如 这个插件给生成的Java模型对象增加了equals和hashCode方法 commentGeneratorcommentGenerator 用来配置生成的注释。默认是生成注释的,并且会生成时间戳,如下 如果你不想保留时间戳,需要如下配置 默认生成的注释是不会有 db 表中字段的注释,如果你想知道每个字段在数据库中的含义(前提是数据库中对应表的字段你添加了注释),可以如下配置 但说实话,MyBatis Generator 生成注释无用信息太多了,所以我一般都选择不生成注释 jdbcConnectionMyBatis Generator 需要链接数据库,所以需要配置 jdbcConnection,具体如下 ${}里面是外部配置文件中的"name" 你也可以写死,那就不需要配置了 这里面值得注意的是,因为我用的 mysql-connector-java 版本是 8.0.17,如果配置这一项,会找不到对应的数据库,官网对此的解释是 具体原因参考这篇文章 MyBatis Generator踩坑与自救 javaTypeResolverjavaTypeResolver 是配置 JDBC 与 java 的类型转换规则,或者你也可以不用配置,使用它默认的转换规则。 就算配置也只能配置 bigDecimal 类型和时间类型的转换 javaModelGenerator配置 po 生成的包路径和项目路径,如下 生成出来的 set 方法如下 时,可能会在 po 目录下在创建一个 “数据库名” 的文件夹,生成的 po 会放在该文件夹下,也就是说会多一层目录,用的上的可以配置 sqlMapGenerator配置 Mapper.xml 文件的生成目录 配置 XxxMapper.java 文件的生成目录 type="XMLMAPPER" 会将接口的实现放在 mapper.xml中,也推荐这样配置。也可以设置 type 为其他值,比如 type="ANNOTATEDMAPPER",接口的实现通过注解写在接口上面,如图 如果采用这种方式,不会生成 mapper.xml 也不用配置 ,但是采用注解来实现接口应对简单查询还好,如果是复杂查询并不如xml方便,所以还是建议将type配置成XMLMAPPER table一个 table 对应一张表,如果想同时生成多张表,需要配置多个 table 其中 domainObjectName 不配置时,它会按照帕斯卡命名法将表名转换成类名 enableXXXByExample 默认为true,但只有在targetRuntime="MyBatis3"时才生效 生效时,会在po下多生成一个 XxxExample.java 的文件,如下 当 targetRuntime="MyBatis3Simple"时,enableXXXByExample 不管为true、还是false 都不生效 整体配置 pom 整体配置 org.mybatis.generator mybatis-generator-maven-plugin 1.3.7 src/main/resources/mybatis-generator-config.xml true mysql mysql-connector-java 8.0.17MyBatis Generator Config 引用的外部配置文件内容如下 # mysql spring.datasource.driverClassName=com.mysql.cj.jdbc.Driver spring.datasource.url=jdbc:mysql://localhost:3306/boot?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=Asia/Shanghai spring.datasource.username=root spring.datasource.password=123456配置好后,双击 maven 中的 MyBatis Generator 运行 MyBatis Generator 官网 |
CopyRight 2018-2019 实验室设备网 版权所有 |