代码自动生成器
一、新建maven
工程,pom.xml
文件导入依赖,如下:
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.3.2.RELEASE</version>
</parent>
<dependencies>
<!--spring-boot-starter-web-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<version>2.3.2.RELEASE</version>
</dependency>
<!-- lombok -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.22</version>
<scope>provided</scope>
</dependency>
<!-- 单元测试 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<version>2.5.5</version>
<scope>test</scope>
</dependency>
<!--Mybatis-Plus 注意版本-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.4.1</version>
</dependency>
<!--数据库连接驱动 连接配置修改时间-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.21</version>
<!--直接在运行时所需要的包,而非在编译时等时候需要的包,这样指定后,编译就不会通过,会找不到@MapperScan注释-->
<!--<scope>runtime</scope>-->
</dependency>
<!--spring-boot-starter-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
</dependency>
<!--log4j 安全版本-->
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-core</artifactId>
<version>2.15.0</version>
</dependency>
<!--mybatis-spring-boot-starter-->
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>2.2.0</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<excludes>
<exclude>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</exclude>
</excludes>
</configuration>
</plugin>
<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.4.0</version>
<!--Mybtis 代码生成器配置文件-->
<configuration>
<configurationFile>src/main/resources/mybatis-generator-config.xml</configurationFile>
<!--允许覆盖生成的文件-->
<overwrite>true</overwrite>
<!-- 将当前 pom 中的依赖项添加到生成器路径中-->
<!-- <includeCompileDependencies>true</includeCompileDependencies> -->
</configuration>
<dependencies>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.21</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
二、在resources
下新建mybatis-generator-config.xml
配置文件,配置如下:
注意:该配置文件并非是一成不变的,文件最后的table
标签部分按需修改,如需生成多个实体类,依次修改后运行即可,已生成的代码不受影响。
<?xml version="1.0" encoding="UTF-8" ?>
<!--mybatis的代码生成器相关配置-->
<!DOCTYPE generatorConfiguration
PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
"http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
<generatorConfiguration>
<!-- 引入配置文件 -->
<properties resource="generator.properties"/>
<!-- 一个数据库一个context,context的子元素必须按照它给出的顺序
property*,plugin*,commentGenerator?,jdbcConnection,javaTypeResolver?,
javaModelGenerator,sqlMapGenerator?,javaClientGenerator?,table+
-->
<context id="myContext" targetRuntime="MyBatis3Simple" defaultModelType="flat">
<!-- 设置生成文件的编码-->
<property name="javaFileEncoding" value="UTF-8"/>
<!-- 这个插件给生成的Java模型对象增加了equals和hashCode方法 -->
<plugin type="org.mybatis.generator.plugins.EqualsHashCodePlugin"/>
<!-- 增加 toString 方法-->
<plugin type="org.mybatis.generator.plugins.ToStringPlugin"/>
<!-- 生成序列化方法-->
<plugin type="org.mybatis.generator.plugins.SerializablePlugin"/>
<!-- 注释 -->
<commentGenerator>
<!-- 是否生成注释 true: 否: false: 是 -->
<property name="suppressAllComments" value="true"/>
<!-- 是否去除时间戳 true:是 : false:否 -->
<property name="suppressDate" value="true"/>
<!-- 是否添加数据库表中字段的注释 true:是 : false:否,只有当suppressAllComments 为 false 时才能生效 -->
<property name="addRemarkComments" value="true"/>
</commentGenerator>
<!-- jdbc连接 -->
<jdbcConnection driverClass="${jdbc.driver-class-name}"
connectionURL="${jdbc.url}"
userId="${jdbc.username}"
password="${jdbc.password}">
<!--高版本的 mysql-connector-java 需要设置 nullCatalogMeansCurrent=true-->
<property name="nullCatalogMeansCurrent" value="true"/>
</jdbcConnection>
<!-- 类型转换 -->
<javaTypeResolver>
<!--是否使用bigDecimal,默认false。
false,把JDBC DECIMAL 和 NUMERIC 类型解析为 Integer
true,把JDBC DECIMAL 和 NUMERIC 类型解析为java.math.BigDecimal-->
<property name="forceBigDecimals" value="true"/>
<!--默认 false
false,将所有 JDBC 的时间类型解析为 java.util.Date
true,将 JDBC 的时间类型按如下规则解析
DATE -> java.time.LocalDate
TIME -> java.time.LocalTime
TIMESTAMP -> java.time.LocalDateTime
TIME_WITH_TIMEZONE -> java.time.OffsetTime
TIMESTAMP_WITH_TIMEZONE -> java.time.OffsetDateTime
-->
<property name="useJSR310Types" value="false"/>
</javaTypeResolver>
<!-- 生成实体类地址 -->
<javaModelGenerator targetPackage="com.gwm.pojo" targetProject="src/main/java">
<!-- 是否让 schema 作为包的后缀,默认为false -->
<property name="enableSubPackages" value="false"/>
<!-- 是否针对string类型的字段在set方法中进行修剪,默认false -->
<property name="trimStrings" value="true"/>
</javaModelGenerator>
<!-- 生成Mapper.xml文件 -->
<sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources">
</sqlMapGenerator>
<!-- 生成 XxxMapper.java 接口-->
<javaClientGenerator targetPackage="com.gwm.mapper" targetProject="src/main/java" type="XMLMAPPER">
</javaClientGenerator>
<!-- schema为数据库名,oracle需要配置,mysql不需要配置。
tableName为对应的数据库表名
domainObjectName 是要生成的实体类名(可以不指定,默认按帕斯卡命名法将表名转换成类名)
enableXXXByExample 默认为 true, 为 true 会生成一个对应Example帮助类,帮助你进行条件查询,不想要可以设为false
-->
<table schema="" tableName="people" domainObjectName="People"
enableCountByExample="false" enableDeleteByExample="false" enableSelectByExample="false"
enableUpdateByExample="false" selectByExampleQueryId="false">
<!--是否使用实际列名,默认为false-->
<property name="useActualColumnNames" value="false"/>
</table>
</context>
</generatorConfiguration>
mybatis-generator-config.xml
配置文件报错处理方法
http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd 此行报错
原因:dtd外部资源文件没有引入
解决方法一:
左边有红色小灯泡,点击Fetch external resource
(获取外部资源)即可解决
解决方法二:
1、在浏览器中输入 http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd
,自动下载该资源文件,将文件保存到一个单独文件夹,注意文件夹名字不要使用中文(例如使用 dtd
即可);
2、打开 idea
,File
–>Setting
–>搜索dtd
–>在Schemas and DTDs
里新建,(idea版本不同,设置步骤略有差异)
在URI中填入http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd
File中填入在在自己电脑中保存dtd
资源文件的地址
因idea
版本不同,出现如下界面,在设置中搜索dtd
后,直接点击加号添加即可
三、对数据库进行配置
在resources
下新建generator.properties
文件,配置如下:
jdbc.driver-class-name=com.mysql.cj.jdbc.Driver
jdbc.url=jdbc:mysql://127.0.0.1:3306/test?allowMultiQueries=true&serverTimezone=Asia/Shanghai
jdbc.username=你自己的数据库用户名
jdbc.password=你自己的数据库密码
四、按步骤双击运行即可
创建自定义maven骨架
一、创建一个的maven工程,自己定义各个包和配置文件,pom.xml
引入常用的依赖
二、配置archetype
骨架插件
<build>
<plugins>
<!--骨架生成插件-->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-archetype-plugin</artifactId>
<version>3.0.0</version>
</plugin>
</plugins>
</build>
三、执行创建骨架命令
依次执行以下三个命令
archetype:create-from-project
install
archetype:crawl
1、执行 archetype:create-from-project
一定是项目的所在路径下执行命令,如下:
执行完后,在 target 文件夹下,生成骨架模板,如下
2、执行 install
将路径更改为骨架所在路径,执行命令
执行完后,在本地仓库中可以找到已创建好的骨架模板,maven-metadata-local.xml
文件中记录着骨架的信息
3、执行 archetype:crawl
全局命令,直接执行即可
执行完后在本地maven仓库下生成 archetype-catalog.xml
文件,内容是自定义骨架的信息
四、使用自定义骨架
新建maven
项目,首次使用需要添加自定义骨架,操作如下,将maven-metadata-local.xml
信息对应填写即可,填写完成点击OK,在骨架列表中可找到自定义骨架,选择后继续下一步,即可生成带有自定义骨架的项目
删除自定义骨架
在个人电脑中全局搜索 UserArchetypes.xml
文件,若要删除某一个自定义骨架,打开该文件,找到想要删除的骨架信息,直接删除即可,若要删除全部自定义骨架,直接将该文件删除即可。