doc: 更新方法名称。

This commit is contained in:
Suomm 2023-07-22 21:08:31 +08:00
parent 2424edc373
commit 7cbdfe0aa4

View File

@ -3,10 +3,10 @@
`QueryWrapperChain.java` 是一个对 `QueryWrapper` 进行链式调用封装的一个类,在 Service 中, `QueryWrapperChain.java` 是一个对 `QueryWrapper` 进行链式调用封装的一个类,在 Service 中,
我们可以调用 `service.queryChain()` 获得该实例。 我们可以调用 `service.queryChain()` 获得该实例。
例如,查询文章列表代码如下: 例如,查询文章列表代码如下:
```java ```java
@SpringBootTest @SpringBootTest
class ArticleServiceTest { class ArticleServiceTest {
@ -19,28 +19,29 @@ class ArticleServiceTest {
.select(ARTICLE.ALL_COLUMNS) .select(ARTICLE.ALL_COLUMNS)
.from(ARTICLE) .from(ARTICLE)
.where(ARTICLE.ID.ge(100)) .where(ARTICLE.ID.ge(100))
.getList(); .list();
} }
} }
``` ```
若不是在 Service 中,我们也可以通过 `QueryWrapperChain.create` 方法,自己创建一个 `QueryWrapperChain` 实例,代码如下: 若不是在 Service 中,我们也可以通过 `QueryWrapperChain.create` 方法,自己创建一个 `QueryWrapperChain` 实例,代码如下:
```java ```java
List<Article> articles = QueryWrapperChain.create(mapper) List<Article> articles=QueryWrapperChain.create(mapper)
.select(ARTICLE.ALL_COLUMNS) .select(ARTICLE.ALL_COLUMNS)
.from(ARTICLE) .from(ARTICLE)
.where(ARTICLE.ID.ge(100)) .where(ARTICLE.ID.ge(100))
.getList(); .list();
``` ```
## QueryWrapperChain 的方法 ## QueryWrapperChain 的方法
- getOne():获取一条数据 - one():获取一条数据
- getList():获取多条数据 - list():获取多条数据
- getPage():分页查询 - page():分页查询
- getObj():当 SQL 查询只返回 1 列数据的时候,且只有 1 条数据时,可以使用此方法 - obj():当 SQL 查询只返回 1 列数据的时候,且只有 1 条数据时,可以使用此方法
- getObjList():当 SQL 查询只返回 1 列数据的时候,可以使用此方法 - objList():当 SQL 查询只返回 1 列数据的时候,可以使用此方法
- remove():删除数据 - remove():删除数据
- update(entity):更新数据 - update(entity):更新数据
- count():查询数据条数 - count():查询数据条数
@ -48,49 +49,39 @@ List<Article> articles = QueryWrapperChain.create(mapper)
## 扩展方法 ## 扩展方法
### `getOne()` 系列方法 ### `one()` 系列方法
- getOne():获取一条数据 - one():获取一条数据
- getOneAs(asType):查询数据,并直接转换为 vo、dto 等 - oneAs(asType):查询数据,并直接转换为 vo、dto 等
- getOneWithRelations查询一条数据及其关联数据 - oneWithRelations查询一条数据及其关联数据
- getOneWithRelationsAs查询一条数据及其关联数据并直接转换为 vo、dto 等 - oneWithRelationsAs查询一条数据及其关联数据并直接转换为 vo、dto 等
- getOneOpt返回 Optional 类型,获取一条数据 - oneOpt返回 Optional 类型,获取一条数据
- getOneAsOpt(asType):返回 Optional 类型,查询数据,并直接转换为 vo、dto 等 - oneAsOpt(asType):返回 Optional 类型,查询数据,并直接转换为 vo、dto 等
- getOneWithRelationsOpt返回 Optional 类型,查询一条数据及其关联数据 - oneWithRelationsOpt返回 Optional 类型,查询一条数据及其关联数据
- getOneWithRelationsAsOpt返回 Optional 类型,查询一条数据及其关联数据,并直接转换为 vo、dto 等 - oneWithRelationsAsOpt返回 Optional 类型,查询一条数据及其关联数据,并直接转换为 vo、dto 等
### `list()` 系列方法
### `getList()` 系列方法 - list():查询数据列表
- listWithRelations():查询数据列表极其关联数据
- getList():查询数据列表 - listAs():查询数据列表,并直接转换为 vo、dto 等
- getListWithRelations():查询数据列表极其关联数据 - listWithRelationsAs():查询数据列表,及其关联数据,并直接转换为 vo、dto 等
- getListAs():查询数据列表,并直接转换为 vo、dto 等
- getListWithRelationsAs():查询数据列表,及其关联数据,并直接转换为 vo、dto 等
### `getPage()` 系列方法
- getPage(page):分页查询数据列表
- getPageWithRelations(page):分页查询数据列表极其关联数据
- getPageAs(page):分页查询数据列表,并直接转换为 vo、dto 等
- getPageWithRelationsAs(page):分页查询数据列表,及其关联数据,并直接转换为 vo、dto 等
### `getObj()` 系列方法
- getObj():查询第一列,且第一条数据
- getObjAs(asType):查询第一列,且第一条数据并转换为指定类型,比如 Long, String 等
- getObjOpt():返回 Optional 类型,查询第一列,且第一条数据
- getObjAsOpt(asType):返回 Optional 类型,查询第一列,且第一条数据并转换为指定类型,比如 Long, String 等
### `getObjList()` 系列方法
- getObjList():查询第一列
- getObjListAs(asType):查询第一列,并转换为指定类型,比如 Long, String 等
- getObjListOpt():返回 Optional 类型,查询第一列
- getObjListAsOpt(asType):返回 Optional 类型,查询第一列,并转换为指定类型,比如 Long, String 等
### `page()` 系列方法
- page(page):分页查询数据列表
- pageWithRelations(page):分页查询数据列表极其关联数据
- pageAs(page):分页查询数据列表,并直接转换为 vo、dto 等
- pageWithRelationsAs(page):分页查询数据列表,及其关联数据,并直接转换为 vo、dto 等
### `obj()` 系列方法
- obj():查询第一列,且第一条数据
- objAs(asType):查询第一列,且第一条数据并转换为指定类型,比如 Long, String 等
- objOpt():返回 Optional 类型,查询第一列,且第一条数据
- objAsOpt(asType):返回 Optional 类型,查询第一列,且第一条数据并转换为指定类型,比如 Long, String 等
### `objList()` 系列方法
- objList():查询第一列
- objListAs(asType):查询第一列,并转换为指定类型,比如 Long, String 等