lhzsdnu d4da321b5c
update docs/zh/apt.md.
Signed-off-by: lhzsdnu <2383376138@qq.com>
2023-04-08 03:11:56 +00:00

2.3 KiB
Raw Blame History

Mybatis-Flex APT 配置

Mybatis-Flex 使用了 APTAnnotation Processing Tool技术在项目编译的时候会自动根据 Entity 类定义的字段帮你生成 "ACCOUNT" 类以及 Entity 对应的 Mapper 类, 通过开发工具构建项目(如下图),或者执行 maven 编译命令: mvn clean package 都可以自动生成。这个原理和 lombok 一致。

关闭 APT 功能

在项目的 resources 目录下添加 mybatis-flex.properties 配置文件,配置内容如下:

processor.enable = false

APT 代码生成路径

默认在 Entity 类所在的 maven 项目的 target/generated-sources/annotations 目录下, 如果 Entity 是 test/java 目录下的测试代码APT 生成的代码则放在 target/generated-test-sources/test-annotations 目录下。

如果我们不想让生成的代码放在这些目录,这可以添加如下配置:

processor.genPath = your-path

genPath 可以是绝对路径,也可以是相对路径,如果填写的是相对路径,那么则是相对 Maven 根模块的目录。

APT 生成的 Tables 类名和包名

默认情况下, APT 生成的类名为 "Tables",而包名为 entity 的包添加上 ".table",假设 Account.java 的包名为 "com.mybatisflex.entity",那么生成的包名则为 "com.mybatisflex.entity.table"。

添加如下配置,自定义生成的类名和包名。

processor.tablesPackage = com.your-package
processor.tablesClassName = your-class-name

APT 生成的 Mapper 包名

默认情况下, APT 生成的 Mapper 类名为 "***Mapper",而包名为 entity 的包添加上 ".mapper",假设 Account.java 的包名为 "com.mybatisflex.entity",那么生成的 Mapper 类为 "com.mybatisflex.mapper.AccountMapper"。

添加如下配置,自定义 Mapper 生成的包名。

processor.mappersPackage = com.your-package

APT 关闭 Mapper 生成

processor.mappersGenerateEnable = false

开发工具无法导入生成的代码?

如下图所示,点击项目目录(注意是项目的根目录),右键 > Maven

  • 1、 先点击 Generate Sources and Update Folders
  • 2、 再点击 Reload project