JoinWrapper (mybatis-plus-join 1.0.0 API)

java.lang.Object
- com.baomidou.mybatisplus.core.conditions.Wrapper<T>
- - com.baomidou.mybatisplus.core.conditions.AbstractWrapper<T,com.baomidou.mybatisplus.core.toolkit.support.SFunction<T,?>,C>
  - - top.xiajibagao.mybatis.plus.join.wrapper.AbstractDynamicResultWrapper<T,R,JoinWrapper<T,R>>
    - - top.xiajibagao.mybatis.plus.join.wrapper.JoinWrapper<T,R>

类型参数:

T - 查询主表实体类型

R - 查询返回实体类型

所有已实现的接口:

com.baomidou.mybatisplus.core.conditions.interfaces.Compare<JoinWrapper<T,R>,com.baomidou.mybatisplus.core.toolkit.support.SFunction<T,?>>, com.baomidou.mybatisplus.core.conditions.interfaces.Func<JoinWrapper<T,R>,com.baomidou.mybatisplus.core.toolkit.support.SFunction<T,?>>, com.baomidou.mybatisplus.core.conditions.interfaces.Join<JoinWrapper<T,R>>, com.baomidou.mybatisplus.core.conditions.interfaces.Nested<JoinWrapper<T,R>,JoinWrapper<T,R>>, com.baomidou.mybatisplus.core.conditions.ISqlSegment, Serializable, ColumnQuery<com.baomidou.mybatisplus.core.toolkit.support.SFunction<?,?>,com.baomidou.mybatisplus.core.toolkit.support.SFunction<T,?>,com.baomidou.mybatisplus.core.toolkit.support.SFunction<R,?>,JoinWrapper<T,R>>, FuncColumnSelect<com.baomidou.mybatisplus.core.toolkit.support.SFunction<?,?>,com.baomidou.mybatisplus.core.toolkit.support.SFunction<T,?>,com.baomidou.mybatisplus.core.toolkit.support.SFunction<R,?>,JoinWrapper<T,R>>, PredicateCompare<JoinWrapper<T,R>,com.baomidou.mybatisplus.core.toolkit.support.SFunction<T,?>>, PredicateFunc<JoinWrapper<T,R>,com.baomidou.mybatisplus.core.toolkit.support.SFunction<T,?>>, TableSegment

直接已知子类:

JoinWrapper.JoinTable, JoinWrapper.LogicTable
```
public class JoinWrapper<T,R>
extends AbstractDynamicResultWrapper<T,R,JoinWrapper<T,R>>
```
支持join的条件构造器

作者:

huangchengxing

另请参阅:

序列化表格

嵌套类概要

嵌套类
限定符和类型	类和说明
`static class`	`JoinWrapper.JoinTable<T,J,R>` 要join的关联表
`static class`	`JoinWrapper.LogicJoinTable<T,R>` 要join的逻辑表
`static class`	`JoinWrapper.LogicTable<T>` 不存在对应数据库表的逻辑表

字段概要

字段
限定符和类型字段和说明

protected List<JoinWrapper.JoinTable<?,?,R>> joinTableList
join的表

protected AtomicInteger joinTableSeq
当前join表数量
- 从类继承的字段 top.xiajibagao.mybatis.plus.join.wrapper.AbstractDynamicResultWrapper
  alisa, isLogic, resultClass, selectColumns, tableInfo, targetClass
- 从类继承的字段 com.baomidou.mybatisplus.core.conditions.AbstractWrapper
  expression, lastSql, paramNameSeq, paramNameValuePairs, sqlComment, sqlFirst, typedThis

字段
限定符和类型	字段和说明
`protected List<JoinWrapper.JoinTable<?,?,R>>`	`joinTableList` join的表
`protected AtomicInteger`	`joinTableSeq` 当前join表数量

构造器概要

构造器
限定符构造器和说明

protected JoinWrapper(@NotNull Class<T> targetClass, @NotNull Class<R> resultClass, boolean isLogic)

构造器
限定符	构造器和说明
`protected`	`JoinWrapper(@NotNull Class<T> targetClass, @NotNull Class<R> resultClass, boolean isLogic)`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`protected <J> JoinWrapper.JoinTable<T,J,R>`	`addJoin(JoinType joinType, Class<J> joinTable)` 添加关联查询
`protected <J> JoinWrapper<T,R>`	`addJoin(JoinType joinType, Class<J> joinTable, Consumer<JoinWrapper.JoinTable<T,J,R>> consumer)` 添加关联查询
`protected JoinWrapper.LogicJoinTable<T,R>`	`addJoin(JoinType joinType, JoinWrapper<?,R> logicTable)` 添加关联查询
`static <T,R> JoinWrapper<T,R>`	`create(@NotNull Class<T> targetClass, @NotNull Class<R> resultClass)` 创建条件构造器
`String`	`getSqlJoin()` 获取“LEFT JOIN xxx a on a.id = b.aid”格式的join语句
`boolean`	`hasJoin()` 是否存在join语句
`protected void`	`initNeed()`
`<J> JoinWrapper.JoinTable<T,J,R>`	`innerJoin(Class<J> joinTable)` 内连接
`<J> JoinWrapper<T,R>`	`innerJoin(Class<J> joinTable, Consumer<JoinWrapper.JoinTable<T,J,R>> consumer)` 内连接
`JoinWrapper.LogicJoinTable<T,R>`	`innerJoin(JoinWrapper<?,R> logicTable)` 内连接
`protected JoinWrapper<T,R>`	`instance()` 获取实例用于or或and的嵌套查询
`<J> JoinWrapper.JoinTable<T,J,R>`	`join(Class<J> joinTable)` 连接
`<J> JoinWrapper<T,R>`	`join(Class<J> joinTable, Consumer<JoinWrapper.JoinTable<T,J,R>> consumer)` 连接
`JoinWrapper.LogicJoinTable<T,R>`	`join(JoinWrapper<?,R> logicTable)` 连接
`<J> JoinWrapper.JoinTable<T,J,R>`	`leftJoin(Class<J> joinTable)` 左连接
`<J> JoinWrapper<T,R>`	`leftJoin(Class<J> joinTable, Consumer<JoinWrapper.JoinTable<T,J,R>> consumer)` 左连接
`JoinWrapper.LogicJoinTable<T,R>`	`leftJoin(JoinWrapper<?,R> logicTable)` 左连接
`<J> JoinWrapper.JoinTable<T,J,R>`	`rightJoin(Class<J> joinTable)` 右连接
`<J> JoinWrapper<T,R>`	`rightJoin(Class<J> joinTable, Consumer<JoinWrapper.JoinTable<T,J,R>> consumer)` 右连接
`JoinWrapper.LogicJoinTable<T,R>`	`rightJoin(JoinWrapper<?,R> logicTable)` 右连接
`void`	`setAlisa(String alisa)` 设置表别名，为连表时保证别名不重复，故不允许修改别名
`protected void`	`setAlisaByJoinSeq()` 设置当前表别名
`JoinWrapper.LogicTable<R>`	`toLogicTable()` 将当前查询转为一张逻辑表

从类继承的方法 top.xiajibagao.mybatis.plus.join.wrapper.AbstractDynamicResultWrapper
columnToString, getSqlSelect, getTable, having, initLogicDelete, limit, limit, nonEmptyOfEntity, notLikeLeft, notLikeRight, select, selectAll, setEntity, setEntityClass, toStringColumn, toTableColumn, where

从类继承的方法 com.baomidou.mybatisplus.core.conditions.AbstractWrapper
addCondition, addNestedCondition, allEq, allEq, and, and, apply, between, clear, clone, columnsToString, comment, doIt, eq, exists, first, formatSql, formatSqlIfNeed, func, ge, getEntity, getEntityClass, getExpression, getParamNameValuePairs, getSqlComment, getSqlFirst, getSqlSegment, groupBy, gt, having, in, inSql, isNotNull, isNull, last, le, like, likeLeft, likeRight, likeValue, lt, ne, nested, not, not, notBetween, notExists, notIn, notInSql, notLike, or, or, orderBy

从类继承的方法 com.baomidou.mybatisplus.core.conditions.Wrapper
getCustomSqlSegment, getSqlSet, getTargetSql, isEmptyOfEntity, isEmptyOfNormal, isEmptyOfWhere, nonEmptyOfNormal, nonEmptyOfWhere

从类继承的方法 java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 top.xiajibagao.mybatis.plus.join.wrapper.interfaces.TableSegment
getAlisa, getTableIfNonAlisa, getTableWithAlisa

从接口继承的方法 com.baomidou.mybatisplus.core.conditions.ISqlSegment
getSqlSegment

从接口继承的方法 top.xiajibagao.mybatis.plus.join.wrapper.interfaces.PredicateCompare
between, betweenIfAllNotNull, eq, eqIfNotNull, ge, geIfNotNull, gt, gtIfNotNull, le, leIfNotNull, like, likeIfNotBank, likeLeft, likeLeftIfNotBank, likeRight, likeRightIfNotBank, lt, ltIfNotNull, ne, neIfNotNull, notBetween, notBetweenIfAllNotNull, notLike, notLikeIfNotBank, notLikeLeftIfNotBank, notLikeRightIfNotBank

从接口继承的方法 com.baomidou.mybatisplus.core.conditions.interfaces.Compare
allEq, allEq, allEq, allEq, allEq, allEq, between, between, eq, eq, ge, ge, gt, gt, le, le, like, like, likeLeft, likeLeft, likeRight, likeRight, lt, lt, ne, ne, notBetween, notBetween, notLike, notLike

从接口继承的方法 top.xiajibagao.mybatis.plus.join.wrapper.interfaces.PredicateFunc
eqIfNotEmpty, in, notIn, notInIfNotEmpty

从接口继承的方法 com.baomidou.mybatisplus.core.conditions.interfaces.Func
func, func, groupBy, groupBy, groupBy, having, having, in, in, in, in, inSql, inSql, isNotNull, isNotNull, isNull, isNull, notIn, notIn, notIn, notIn, notInSql, notInSql, orderBy, orderByAsc, orderByAsc, orderByAsc, orderByDesc, orderByDesc, orderByDesc

从接口继承的方法 top.xiajibagao.mybatis.plus.join.wrapper.interfaces.FuncColumnSelect
abs, avg, caseByCondition, caseByValue, concat, count, count, currentDate, currentTime, currentTimestamp, dateFormat, day, div, format, ifNull, ifNull, lower, max, min, month, mul, now, plus, rand, replace, sub, sum, upper, year

从接口继承的方法 top.xiajibagao.mybatis.plus.join.wrapper.interfaces.ColumnQuery
having, having, select, select, select, toTableColumn, where, where

从接口继承的方法 com.baomidou.mybatisplus.core.conditions.interfaces.Nested
and, nested, not, or

从接口继承的方法 com.baomidou.mybatisplus.core.conditions.interfaces.Join
apply, comment, exists, first, last, notExists, or

- 字段详细资料
  - joinTableSeq
```
protected AtomicInteger joinTableSeq
```
    当前join表数量
  - joinTableList
```
protected List<JoinWrapper.JoinTable<?,?,R>> joinTableList
```
    join的表
- 构造器详细资料
  - JoinWrapper
```
protected JoinWrapper(@NotNull
                      @NotNull Class<T> targetClass,
                      @NotNull
                      @NotNull Class<R> resultClass,
                      boolean isLogic)
```
- 方法详细资料
  - hasJoin
```
public boolean hasJoin()
```
    是否存在join语句
    
    返回:
    
    boolean
  - create
```
public static <T,R> JoinWrapper<T,R> create(@NotNull
                                            @NotNull Class<T> targetClass,
                                            @NotNull
                                            @NotNull Class<R> resultClass)
```
    创建条件构造器
    
    参数:
    
    targetClass - 查询主表类型
    
    resultClass - 返回类型
    
    返回:
    
    com.xiajibagao.top.mybatis.plus.concatSegment.wrapper.JoinMapper
  - setAlisa
```
public void setAlisa(String alisa)
              throws UnsupportedOperationException
```
    设置表别名，为连表时保证别名不重复，故不允许修改别名
    
    参数:
    
    alisa - 表别名
    
    抛出:
    
    UnsupportedOperationException - 调用时抛出
  - setAlisaByJoinSeq
```
protected void setAlisaByJoinSeq()
```
    设置当前表别名
  - getSqlJoin
```
public String getSqlJoin()
```
    获取“LEFT JOIN xxx a on a.id = b.aid”格式的join语句
    
    返回:
    
    java.lang.String
  - join
```
public JoinWrapper.LogicJoinTable<T,R> join(JoinWrapper<?,R> logicTable)
```
    连接
    
    参数:
    
    logicTable - 待连接的逻辑表
    
    返回:
    
    com.xiajibagao.top.mybatis.plus.concatSegment.wrapper.JoinWrapper.JoinTable
  - join
```
public <J> JoinWrapper.JoinTable<T,J,R> join(Class<J> joinTable)
```
    连接
    
    参数:
    
    joinTable - 待连接的表
    
    返回:
    
    com.xiajibagao.top.mybatis.plus.concatSegment.wrapper.JoinWrapper.JoinTable
  - join
```
public <J> JoinWrapper<T,R> join(Class<J> joinTable,
                                 Consumer<JoinWrapper.JoinTable<T,J,R>> consumer)
```
    连接
    
    参数:
    
    joinTable - 待连接的表
    
    consumer - 操作
    
    返回:
    
    com.xiajibagao.top.mybatis.plus.concatSegment.wrapper.JoinWrapper
  - innerJoin
```
public JoinWrapper.LogicJoinTable<T,R> innerJoin(JoinWrapper<?,R> logicTable)
```
    内连接
    
    参数:
    
    logicTable - 待连接的逻辑表
    
    返回:
    
    com.xiajibagao.top.mybatis.plus.concatSegment.wrapper.JoinWrapper.JoinTable
  - innerJoin
```
public <J> JoinWrapper.JoinTable<T,J,R> innerJoin(Class<J> joinTable)
```
    内连接
    
    参数:
    
    joinTable - 待连接的表
    
    返回:
    
    com.xiajibagao.top.mybatis.plus.concatSegment.wrapper.JoinWrapper.JoinTable
  - innerJoin
```
public <J> JoinWrapper<T,R> innerJoin(Class<J> joinTable,
                                      Consumer<JoinWrapper.JoinTable<T,J,R>> consumer)
```
    内连接
    
    参数:
    
    joinTable - 待连接的表
    
    consumer - 操作
    
    返回:
    
    com.xiajibagao.top.mybatis.plus.concatSegment.wrapper.JoinWrapper
  - rightJoin
```
public JoinWrapper.LogicJoinTable<T,R> rightJoin(JoinWrapper<?,R> logicTable)
```
    右连接
    
    参数:
    
    logicTable - 待连接的逻辑表
    
    返回:
    
    com.xiajibagao.top.mybatis.plus.concatSegment.wrapper.JoinWrapper.JoinTable
  - rightJoin
```
public <J> JoinWrapper.JoinTable<T,J,R> rightJoin(Class<J> joinTable)
```
    右连接
    
    参数:
    
    joinTable - 待连接的表
    
    返回:
    
    com.xiajibagao.top.mybatis.plus.concatSegment.wrapper.JoinWrapper.JoinTable
  - rightJoin
```
public <J> JoinWrapper<T,R> rightJoin(Class<J> joinTable,
                                      Consumer<JoinWrapper.JoinTable<T,J,R>> consumer)
```
    右连接
    
    参数:
    
    joinTable - 待连接的表
    
    consumer - 操作
    
    返回:
    
    com.xiajibagao.top.mybatis.plus.concatSegment.wrapper.JoinWrapper
  - leftJoin
```
public JoinWrapper.LogicJoinTable<T,R> leftJoin(JoinWrapper<?,R> logicTable)
```
    左连接
    
    参数:
    
    logicTable - 待连接的逻辑表
    
    返回:
    
    com.xiajibagao.top.mybatis.plus.concatSegment.wrapper.JoinWrapper.JoinTable
  - leftJoin
```
public <J> JoinWrapper.JoinTable<T,J,R> leftJoin(Class<J> joinTable)
```
    左连接
    
    参数:
    
    joinTable - 待连接的表
    
    返回:
    
    com.xiajibagao.top.mybatis.plus.concatSegment.wrapper.JoinWrapper.JoinTable
  - leftJoin
```
public <J> JoinWrapper<T,R> leftJoin(Class<J> joinTable,
                                     Consumer<JoinWrapper.JoinTable<T,J,R>> consumer)
```
    左连接
    
    参数:
    
    joinTable - 待连接的表
    
    consumer - 操作
    
    返回:
    
    com.xiajibagao.top.mybatis.plus.concatSegment.wrapper.JoinWrapper
  - addJoin
```
protected JoinWrapper.LogicJoinTable<T,R> addJoin(JoinType joinType,
                                                  JoinWrapper<?,R> logicTable)
```
    添加关联查询
    
    参数:
    
    joinType - 连接类型
    
    logicTable - 要关联查询的逻辑表
    
    返回:
    
    com.xiajibagao.top.mybatis.plus.concatSegment.wrapper.JoinMapper.JoinTable
  - addJoin
```
protected <J> JoinWrapper.JoinTable<T,J,R> addJoin(JoinType joinType,
                                                   Class<J> joinTable)
```
    添加关联查询
    
    参数:
    
    joinType - 连接类型
    
    joinTable - 连接表类型
    
    返回:
    
    com.xiajibagao.top.mybatis.plus.concatSegment.wrapper.JoinMapper.JoinTable
  - addJoin
```
protected <J> JoinWrapper<T,R> addJoin(JoinType joinType,
                                       Class<J> joinTable,
                                       Consumer<JoinWrapper.JoinTable<T,J,R>> consumer)
```
    添加关联查询
    
    参数:
    
    joinType - 连接类型
    
    joinTable - 连接表类型
    
    consumer - 操作
    
    返回:
    
    com.xiajibagao.top.mybatis.plus.concatSegment.wrapper.JoinMapper
  - instance
```
protected JoinWrapper<T,R> instance()
```
    获取实例用于or或and的嵌套查询
    
    指定者:
    
    instance 在类中 com.baomidou.mybatisplus.core.conditions.AbstractWrapper<T,com.baomidou.mybatisplus.core.toolkit.support.SFunction<T,?>,JoinWrapper<T,R>>
    
    返回:
    
    com.xiajibagao.top.mybatis.plus.concatSegment.wrapper.JoinMapper
  - initNeed
```
protected void initNeed()
```
    覆盖:
    
    initNeed 在类中 AbstractDynamicResultWrapper<T,R,JoinWrapper<T,R>>
  - toLogicTable
```
public JoinWrapper.LogicTable<R> toLogicTable()
```
    将当前查询转为一张逻辑表
    
    返回:
    
    com.xiajibagao.top.mybatis.plus.concatSegment.wrapper.JoinWrapper.LogicTable

类 JoinWrapper<T,R>

嵌套类概要

字段概要

从类继承的字段 top.xiajibagao.mybatis.plus.join.wrapper.AbstractDynamicResultWrapper

从类继承的字段 com.baomidou.mybatisplus.core.conditions.AbstractWrapper

构造器概要

方法概要

从类继承的方法 top.xiajibagao.mybatis.plus.join.wrapper.AbstractDynamicResultWrapper

从类继承的方法 com.baomidou.mybatisplus.core.conditions.AbstractWrapper

从类继承的方法 com.baomidou.mybatisplus.core.conditions.Wrapper

从类继承的方法 java.lang.Object

从接口继承的方法 top.xiajibagao.mybatis.plus.join.wrapper.interfaces.TableSegment

从接口继承的方法 com.baomidou.mybatisplus.core.conditions.ISqlSegment

从接口继承的方法 top.xiajibagao.mybatis.plus.join.wrapper.interfaces.PredicateCompare

从接口继承的方法 com.baomidou.mybatisplus.core.conditions.interfaces.Compare

从接口继承的方法 top.xiajibagao.mybatis.plus.join.wrapper.interfaces.PredicateFunc

从接口继承的方法 com.baomidou.mybatisplus.core.conditions.interfaces.Func

从接口继承的方法 top.xiajibagao.mybatis.plus.join.wrapper.interfaces.FuncColumnSelect

从接口继承的方法 top.xiajibagao.mybatis.plus.join.wrapper.interfaces.ColumnQuery

从接口继承的方法 com.baomidou.mybatisplus.core.conditions.interfaces.Nested

从接口继承的方法 com.baomidou.mybatisplus.core.conditions.interfaces.Join

字段详细资料

joinTableSeq

joinTableList

构造器详细资料

JoinWrapper

方法详细资料

hasJoin

create

setAlisa

setAlisaByJoinSeq

getSqlJoin

join

join

join

innerJoin

innerJoin

innerJoin

rightJoin

rightJoin

rightJoin

leftJoin

leftJoin

leftJoin

addJoin

addJoin

addJoin

instance

initNeed

toLogicTable