mirror of
https://gitee.com/mybatis-flex/mybatis-flex.git
synced 2025-12-06 16:48:24 +08:00
update docs
This commit is contained in:
parent
0d037f0c4b
commit
fcf8df3fa3
@ -1,6 +1,6 @@
|
|||||||
# Mybatis-Flex APT 配置
|
# Mybatis-Flex APT 配置
|
||||||
|
|
||||||
Mybatis-Flex 使用了 APT(Annotation Processing Tool)技术,在项目编译的时候,会自动根据 Entity 类定义的字段帮你生成 "ACCOUNT" 类,
|
Mybatis-Flex 使用了 APT(Annotation Processing Tool)技术,在项目编译的时候,会自动根据 Entity 类定义的字段帮你生成 "ACCOUNT" 类以及 Entity 对应的 Mapper 类,
|
||||||
通过开发工具构建项目(如下图),或者执行 maven 编译命令: `mvn clean package` 都可以自动生成。这个原理和 lombok 一致。
|
通过开发工具构建项目(如下图),或者执行 maven 编译命令: `mvn clean package` 都可以自动生成。这个原理和 lombok 一致。
|
||||||
|
|
||||||

|

|
||||||
@ -30,7 +30,7 @@ processer.genPath = your-path
|
|||||||
genPath 可以是绝对路径,也可以是相对路径,如果填写的是相对路径,那么则是相对 Maven 根模块的目录。
|
genPath 可以是绝对路径,也可以是相对路径,如果填写的是相对路径,那么则是相对 Maven 根模块的目录。
|
||||||
|
|
||||||
|
|
||||||
## APT 生成的类名和包名
|
## APT 生成的 Tables 类名和包名
|
||||||
|
|
||||||
默认情况下, APT 生成的类名为 "Tables",而包名为 entity 的包添加上 ".table",假设 Account.java
|
默认情况下, APT 生成的类名为 "Tables",而包名为 entity 的包添加上 ".table",假设 Account.java
|
||||||
的包名为 "com.mybatisflex.entity",那么生成的包名则为 "com.mybatisflex.entity.table"。
|
的包名为 "com.mybatisflex.entity",那么生成的包名则为 "com.mybatisflex.entity.table"。
|
||||||
@ -38,6 +38,23 @@ genPath 可以是绝对路径,也可以是相对路径,如果填写的是相
|
|||||||
添加如下配置,自定义生成的类名和包名。
|
添加如下配置,自定义生成的类名和包名。
|
||||||
|
|
||||||
```properties
|
```properties
|
||||||
processer.package = com.your-package
|
processer.tablesPackage = com.your-package
|
||||||
processer.className = your-class-name
|
processer.tablesClassName = your-class-name
|
||||||
|
```
|
||||||
|
|
||||||
|
## APT 生成的 Mapper 包名
|
||||||
|
|
||||||
|
默认情况下, APT 生成的 Mapper 类名为 "***Mapper",而包名为 entity 的包添加上 ".mapper",假设 Account.java
|
||||||
|
的包名为 "com.mybatisflex.entity",那么生成的 Mapper 类为 "com.mybatisflex.mapper.AccountMapper"。
|
||||||
|
|
||||||
|
添加如下配置,自定义 Mapper 生成的包名。
|
||||||
|
|
||||||
|
```properties
|
||||||
|
processer.mappersPackage = com.your-package
|
||||||
|
```
|
||||||
|
|
||||||
|
## APT 关闭 Mapper 生成
|
||||||
|
|
||||||
|
```properties
|
||||||
|
processer.mappersGenerateEnable = false
|
||||||
```
|
```
|
||||||
17
readme_zh.md
17
readme_zh.md
@ -34,7 +34,7 @@
|
|||||||
|
|
||||||
## hello world(原生)
|
## hello world(原生)
|
||||||
|
|
||||||
**第一步:编写 Entity 实体类**
|
**第 1 步:编写 Entity 实体类**
|
||||||
|
|
||||||
```java
|
```java
|
||||||
|
|
||||||
@ -51,15 +51,8 @@ public class Account {
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
**第二步,编写 Mapper 类,并继承 BaseMapper**
|
|
||||||
|
|
||||||
```java
|
**第 2 步:开始查询数据**
|
||||||
public interface AccountMapper extends BaseMapper<Account> {
|
|
||||||
//只需定义 Mapper 接口即可,可以无任何内容。
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
**第三步:开始查询数据**
|
|
||||||
|
|
||||||
示例 1:查询 1 条数据
|
示例 1:查询 1 条数据
|
||||||
|
|
||||||
@ -87,6 +80,8 @@ class HelloWorld {
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
> 以上的 `AccountMapper.class` 为 Mybatis-Flex 自动通过 APT 生成,无需手动编码。也手动编写 AccountMapper,关闭自动生成功能,更多查看 APT 文档。
|
||||||
|
|
||||||
示例2:查询列表
|
示例2:查询列表
|
||||||
|
|
||||||
```java
|
```java
|
||||||
@ -396,8 +391,8 @@ QueryWrapper queryWrapper = QueryWrapper.create()
|
|||||||
|
|
||||||
**疑问 2:如何通过实体类 Account.java 生成 QueryWrapper 所需要的 "ACCOUNT" 类 ?**
|
**疑问 2:如何通过实体类 Account.java 生成 QueryWrapper 所需要的 "ACCOUNT" 类 ?**
|
||||||
|
|
||||||
答:Mybatis-Flex 使用了 APT(Annotation Processing Tool)技术,在项目编译的时候,会自动根据 Entity 类定义的字段帮你生成 "ACCOUNT" 类, 通过开发工具构建项目(如下图),或者执行
|
答:Mybatis-Flex 使用了 APT(Annotation Processing Tool)技术,在项目编译的时候,会自动根据 Entity 类定义的字段帮你生成 "ACCOUNT" 类以及 Entity 对应的 Mapper 类,
|
||||||
maven 编译命令: `mvn clean package` 都可以自动生成。这个原理和 lombok 一致。
|
通过开发工具构建项目(如下图),或者执行 maven 编译命令: `mvn clean package` 都可以自动生成。这个原理和 lombok 一致。
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user