优化注释

gradle.properties

@@ -1,3 +1,3 @@
 signing.keyId=1FD337F9
 signing.password=243194995
-signing.secretKeyRingFile=/Users/hubin/dev/signing.gpg
+signing.secretKeyRingFile=C:/Users/wonde/.m2/signing.gpg

mybatis-plus-core/src/main/java/com/baomidou/mybatisplus/core/conditions/AbstractWrapper.java

@@ -15,40 +15,6 @@
  */
 package com.baomidou.mybatisplus.core.conditions;
 
-import static com.baomidou.mybatisplus.core.enums.SqlKeyword.AND;
-import static com.baomidou.mybatisplus.core.enums.SqlKeyword.ASC;
-import static com.baomidou.mybatisplus.core.enums.SqlKeyword.BETWEEN;
-import static com.baomidou.mybatisplus.core.enums.SqlKeyword.DESC;
-import static com.baomidou.mybatisplus.core.enums.SqlKeyword.EQ;
-import static com.baomidou.mybatisplus.core.enums.SqlKeyword.EXISTS;
-import static com.baomidou.mybatisplus.core.enums.SqlKeyword.GE;
-import static com.baomidou.mybatisplus.core.enums.SqlKeyword.GROUP_BY;
-import static com.baomidou.mybatisplus.core.enums.SqlKeyword.GT;
-import static com.baomidou.mybatisplus.core.enums.SqlKeyword.HAVING;
-import static com.baomidou.mybatisplus.core.enums.SqlKeyword.IN;
-import static com.baomidou.mybatisplus.core.enums.SqlKeyword.IS_NOT_NULL;
-import static com.baomidou.mybatisplus.core.enums.SqlKeyword.IS_NULL;
-import static com.baomidou.mybatisplus.core.enums.SqlKeyword.LE;
-import static com.baomidou.mybatisplus.core.enums.SqlKeyword.LIKE;
-import static com.baomidou.mybatisplus.core.enums.SqlKeyword.LT;
-import static com.baomidou.mybatisplus.core.enums.SqlKeyword.NE;
-import static com.baomidou.mybatisplus.core.enums.SqlKeyword.NOT;
-import static com.baomidou.mybatisplus.core.enums.SqlKeyword.OR;
-import static com.baomidou.mybatisplus.core.enums.SqlKeyword.ORDER_BY;
-import static com.baomidou.mybatisplus.core.enums.WrapperKeyword.APPLY;
-import static com.baomidou.mybatisplus.core.enums.WrapperKeyword.LEFT_BRACKET;
-import static com.baomidou.mybatisplus.core.enums.WrapperKeyword.RIGHT_BRACKET;
-import static java.util.stream.Collectors.joining;
-
-import java.util.Arrays;
-import java.util.Collection;
-import java.util.HashMap;
-import java.util.Map;
-import java.util.Objects;
-import java.util.concurrent.atomic.AtomicInteger;
-import java.util.function.BiPredicate;
-import java.util.function.Function;
-
 import com.baomidou.mybatisplus.core.conditions.interfaces.Compare;
 import com.baomidou.mybatisplus.core.conditions.interfaces.Func;
 import com.baomidou.mybatisplus.core.conditions.interfaces.Join;
@@ -56,14 +22,16 @@ import com.baomidou.mybatisplus.core.conditions.interfaces.Nested;
 import com.baomidou.mybatisplus.core.conditions.segments.MergeSegments;
 import com.baomidou.mybatisplus.core.conditions.segments.NormalSegmentList;
 import com.baomidou.mybatisplus.core.enums.SqlKeyword;
-import com.baomidou.mybatisplus.core.toolkit.ArrayUtils;
-import com.baomidou.mybatisplus.core.toolkit.Assert;
-import com.baomidou.mybatisplus.core.toolkit.CollectionUtils;
-import com.baomidou.mybatisplus.core.toolkit.Constants;
-import com.baomidou.mybatisplus.core.toolkit.SerializationUtils;
-import com.baomidou.mybatisplus.core.toolkit.StringPool;
-import com.baomidou.mybatisplus.core.toolkit.StringUtils;
+import com.baomidou.mybatisplus.core.toolkit.*;
 
+import java.util.*;
+import java.util.concurrent.atomic.AtomicInteger;
+import java.util.function.BiPredicate;
+import java.util.function.Function;
+
+import static com.baomidou.mybatisplus.core.enums.SqlKeyword.*;
+import static com.baomidou.mybatisplus.core.enums.WrapperKeyword.*;
+import static java.util.stream.Collectors.joining;
 
 /**
  * <p>
@@ -327,9 +295,8 @@ public abstract class AbstractWrapper<T, R, This extends AbstractWrapper<T, R, T
     }
 
     /**
-     * <p>
      * 内部自用
-     * </p>
+     * <p>
      * NOT 关键词
      */
     protected This not(boolean condition) {
@@ -337,9 +304,8 @@ public abstract class AbstractWrapper<T, R, This extends AbstractWrapper<T, R, T
     }
 
     /**
-     * <p>
      * 内部自用
-     * </p>
+     * <p>
      * 拼接 AND
      */
     protected This and(boolean condition) {
@@ -347,9 +313,7 @@ public abstract class AbstractWrapper<T, R, This extends AbstractWrapper<T, R, T
     }
 
     /**
-     * <p>
      * 普通查询条件
-     * </p>
      *
      * @param condition  是否执行
      * @param column     属性
@@ -361,9 +325,7 @@ public abstract class AbstractWrapper<T, R, This extends AbstractWrapper<T, R, T
     }
 
     /**
-     * <p>
      * 多重嵌套查询条件
-     * </p>
      *
      * @param condition 查询条件值
      */
@@ -377,13 +339,11 @@ public abstract class AbstractWrapper<T, R, This extends AbstractWrapper<T, R, T
     protected abstract This instance(AtomicInteger paramNameSeq, Map<String, Object> paramNameValuePairs);
 
     /**
-     * <p>
      * 格式化SQL
-     * </p>
      *
      * @param sqlStr SQL语句部分
      * @param params 参数集
-     * @return this
+     * @return sql
      */
     protected final String formatSql(String sqlStr, Object... params) {
         return formatSqlIfNeed(true, sqlStr, params);
@@ -405,7 +365,7 @@ public abstract class AbstractWrapper<T, R, This extends AbstractWrapper<T, R, T
      * @param need   是否需要格式化
      * @param sqlStr SQL语句部分
      * @param params 参数集
-     * @return this
+     * @return sql
      */
     protected final String formatSqlIfNeed(boolean need, String sqlStr, Object... params) {
         if (!need || StringUtils.isEmpty(sqlStr)) {
@@ -423,9 +383,7 @@ public abstract class AbstractWrapper<T, R, This extends AbstractWrapper<T, R, T
     }
 
     /**
-     * <p>
      * 获取in表达式 包含括号
-     * </p>
      *
      * @param value 集合
      */
@@ -444,12 +402,11 @@ public abstract class AbstractWrapper<T, R, This extends AbstractWrapper<T, R, T
     }
 
     /**
-     * <p>
      * 对sql片段进行组装
-     * </p>
      *
      * @param condition   是否执行
      * @param sqlSegments sql片段数组
+     * @return children
      */
     protected This doIt(boolean condition, ISqlSegment... sqlSegments) {
         if (condition) {
@@ -495,8 +452,8 @@ public abstract class AbstractWrapper<T, R, This extends AbstractWrapper<T, R, T
     /**
      * 拼接`WHERE`至SQL前
      *
-     * @param sql
-     * @return
+     * @param sql sql
+     * @return 带 where 的 sql
      */
     private String concatWhere(String sql) {
         return Constants.WHERE + " " + sql;
@@ -513,9 +470,7 @@ public abstract class AbstractWrapper<T, R, This extends AbstractWrapper<T, R, T
     }
 
     /**
-     * <p>
      * 多字段转换为逗号 "," 分割字符串
-     * </p>
      *
      * @param columns 多字段
      */

mybatis-plus-core/src/main/java/com/baomidou/mybatisplus/core/conditions/interfaces/Compare.java

@@ -49,7 +49,8 @@ public interface Compare<This, R> extends Serializable {
      *
      * @param condition   执行条件
      * @param params      map 类型的参数, key 是字段名, value 是字段值
-     * @param null2IsNull 是否参数为 null 自动执行 isNull 方法, false 则忽略这个字段
+     * @param null2IsNull 是否参数为 null 自动执行 isNull 方法, false 则忽略这个字段\
+     * @return children
      */
     <V> This allEq(boolean condition, Map<R, V> params, boolean null2IsNull);
 
@@ -74,6 +75,7 @@ public interface Compare<This, R> extends Serializable {
      * @param filter      返回 true 来允许字段传入比对条件中
      * @param params      map 类型的参数, key 是字段名, value 是字段值
      * @param null2IsNull 是否参数为 null 自动执行 isNull 方法, false 则忽略这个字段
+     * @return children
      */
     <V> This allEq(boolean condition, BiPredicate<R, V> filter, Map<R, V> params, boolean null2IsNull);
 
@@ -88,6 +90,9 @@ public interface Compare<This, R> extends Serializable {
      * 等于 =
      *
      * @param condition 执行条件
+     * @param column    字段
+     * @param val       值
+     * @return children
      */
     This eq(boolean condition, R column, Object val);
 
@@ -102,6 +107,9 @@ public interface Compare<This, R> extends Serializable {
      * 不等于 <>
      *
      * @param condition 执行条件
+     * @param column    字段
+     * @param val       值
+     * @return children
      */
     This ne(boolean condition, R column, Object val);
 
@@ -116,6 +124,9 @@ public interface Compare<This, R> extends Serializable {
      * 大于 >
      *
      * @param condition 执行条件
+     * @param column    字段
+     * @param val       值
+     * @return children
      */
     This gt(boolean condition, R column, Object val);
 
@@ -130,6 +141,9 @@ public interface Compare<This, R> extends Serializable {
      * 大于等于 >=
      *
      * @param condition 执行条件
+     * @param column    字段
+     * @param val       值
+     * @return children
      */
     This ge(boolean condition, R column, Object val);
 
@@ -144,6 +158,9 @@ public interface Compare<This, R> extends Serializable {
      * 小于 <
      *
      * @param condition 执行条件
+     * @param column    字段
+     * @param val       值
+     * @return children
      */
     This lt(boolean condition, R column, Object val);
 
@@ -158,6 +175,9 @@ public interface Compare<This, R> extends Serializable {
      * 小于等于 <=
      *
      * @param condition 执行条件
+     * @param column    字段
+     * @param val       值
+     * @return children
      */
     This le(boolean condition, R column, Object val);
 
@@ -172,6 +192,10 @@ public interface Compare<This, R> extends Serializable {
      * BETWEEN 值1 AND 值2
      *
      * @param condition 执行条件
+     * @param column    字段
+     * @param val1      值1
+     * @param val2      值2
+     * @return children
      */
     This between(boolean condition, R column, Object val1, Object val2);
 
@@ -186,6 +210,10 @@ public interface Compare<This, R> extends Serializable {
      * NOT BETWEEN 值1 AND 值2
      *
      * @param condition 执行条件
+     * @param column    字段
+     * @param val1      值1
+     * @param val2      值2
+     * @return children
      */
     This notBetween(boolean condition, R column, Object val1, Object val2);
 
@@ -200,6 +228,9 @@ public interface Compare<This, R> extends Serializable {
      * LIKE '%值%'
      *
      * @param condition 执行条件
+     * @param column    字段
+     * @param val       值
+     * @return children
      */
     This like(boolean condition, R column, Object val);
 
@@ -214,6 +245,9 @@ public interface Compare<This, R> extends Serializable {
      * NOT LIKE '%值%'
      *
      * @param condition 执行条件
+     * @param column    字段
+     * @param val       值
+     * @return children
      */
     This notLike(boolean condition, R column, Object val);
 
@@ -228,6 +262,9 @@ public interface Compare<This, R> extends Serializable {
      * LIKE '%值'
      *
      * @param condition 执行条件
+     * @param column    字段
+     * @param val       值
+     * @return children
      */
     This likeLeft(boolean condition, R column, Object val);
 
@@ -242,6 +279,9 @@ public interface Compare<This, R> extends Serializable {
      * LIKE '值%'
      *
      * @param condition 执行条件
+     * @param column    字段
+     * @param val       值
+     * @return children
      */
     This likeRight(boolean condition, R column, Object val);
 }

mybatis-plus-core/src/main/java/com/baomidou/mybatisplus/core/conditions/interfaces/Func.java

@@ -49,6 +49,7 @@ public interface Func<This, R> extends Serializable {
      *
      * @param condition 执行条件
      * @param column    字段
+     * @return children
      */
     This isNull(boolean condition, R column);
 
@@ -65,6 +66,7 @@ public interface Func<This, R> extends Serializable {
      *
      * @param condition 执行条件
      * @param column    字段
+     * @return children
      */
     This isNotNull(boolean condition, R column);
 
@@ -91,6 +93,7 @@ public interface Func<This, R> extends Serializable {
      * @param condition 执行条件
      * @param column    字段
      * @param coll      数据集合
+     * @return children
      */
     default This inOrThrow(boolean condition, R column, Collection<?> coll) {
         Assert.notEmpty(coll, "coll could not be empty!");
@@ -106,6 +109,7 @@ public interface Func<This, R> extends Serializable {
      * @param condition 执行条件
      * @param column    字段
      * @param coll      数据集合
+     * @return children
      */
     This in(boolean condition, R column, Collection<?> coll);
 
@@ -125,6 +129,7 @@ public interface Func<This, R> extends Serializable {
      * @param condition 执行条件
      * @param column    字段
      * @param values    数据数组
+     * @return children
      */
     default This inOrThrow(boolean condition, R column, Object... values) {
         Assert.notEmpty(values, "values could not be empty!");
@@ -147,6 +152,7 @@ public interface Func<This, R> extends Serializable {
      * @param condition 执行条件
      * @param column    字段
      * @param values    数据数组
+     * @return children
      */
     default This in(boolean condition, R column, Object... values) {
         return in(condition, column, Arrays.stream(Optional.ofNullable(values).orElseGet(() -> new Object[]{}))
@@ -176,6 +182,7 @@ public interface Func<This, R> extends Serializable {
      * @param condition 执行条件
      * @param column    字段
      * @param coll      数据集合
+     * @return children
      */
     default This notInOrThrow(boolean condition, R column, Collection<?> coll) {
         Assert.notEmpty(coll, "coll could not be empty!");
@@ -189,6 +196,7 @@ public interface Func<This, R> extends Serializable {
      * @param condition 执行条件
      * @param column    字段
      * @param coll      数据集合
+     * @return children
      */
     This notIn(boolean condition, R column, Collection<?> coll);
 
@@ -215,6 +223,7 @@ public interface Func<This, R> extends Serializable {
      * @param condition 执行条件
      * @param column    字段
      * @param values    数据数组
+     * @return children
      */
     default This notInOrThrow(boolean condition, R column, Object... values) {
         Assert.notEmpty(values, "values could not be empty!");
@@ -228,6 +237,7 @@ public interface Func<This, R> extends Serializable {
      * @param condition 执行条件
      * @param column    字段
      * @param values    数据数组
+     * @return children
      */
     default This notIn(boolean condition, R column, Object... values) {
         return notIn(condition, column, Arrays.stream(Optional.ofNullable(values).orElseGet(() -> new Object[]{}))
@@ -250,6 +260,7 @@ public interface Func<This, R> extends Serializable {
      * @param condition 执行条件
      * @param column    字段
      * @param inValue   sql语句
+     * @return children
      */
     This inSql(boolean condition, R column, String inValue);
 
@@ -269,6 +280,7 @@ public interface Func<This, R> extends Serializable {
      * @param condition 执行条件
      * @param column    字段
      * @param inValue   sql语句 ---> 1,2,3,4,5,6 或者 select id from table where id < 3
+     * @return children
      */
     This notInSql(boolean condition, R column, String inValue);
 
@@ -285,6 +297,7 @@ public interface Func<This, R> extends Serializable {
      *
      * @param condition 执行条件
      * @param columns   字段数组
+     * @return children
      */
     This groupBy(boolean condition, R... columns);
 
@@ -301,6 +314,7 @@ public interface Func<This, R> extends Serializable {
      *
      * @param condition 执行条件
      * @param columns   字段数组
+     * @return children
      */
     default This orderByAsc(boolean condition, R... columns) {
         return orderBy(condition, true, columns);
@@ -319,6 +333,7 @@ public interface Func<This, R> extends Serializable {
      *
      * @param condition 执行条件
      * @param columns   字段数组
+     * @return children
      */
     default This orderByDesc(boolean condition, R... columns) {
         return orderBy(condition, false, columns);
@@ -331,6 +346,7 @@ public interface Func<This, R> extends Serializable {
      * @param condition 执行条件
      * @param isAsc     是否是 ASC 排序
      * @param columns   字段数组
+     * @return children
      */
     This orderBy(boolean condition, boolean isAsc, R... columns);
 
@@ -349,6 +365,7 @@ public interface Func<This, R> extends Serializable {
      * @param condition 执行条件
      * @param sqlHaving sql 语句
      * @param params    参数数组
+     * @return children
      */
     This having(boolean condition, String sqlHaving, Object... params);
 }

mybatis-plus-core/src/main/java/com/baomidou/mybatisplus/core/conditions/interfaces/Join.java

@@ -39,6 +39,7 @@ public interface Join<This> extends Serializable {
      * 拼接 OR
      *
      * @param condition 执行条件
+     * @return children
      */
     This or(boolean condition);
 
@@ -57,6 +58,7 @@ public interface Join<This> extends Serializable {
      * 例3: apply("date_format(dateColumn,'%Y-%m-%d') = {0}", LocalDate.now())
      *
      * @param condition 执行条件
+     * @return children
      */
     This apply(boolean condition, String applySql, Object... value);
 
@@ -74,6 +76,7 @@ public interface Join<This> extends Serializable {
      *
      * @param condition 执行条件
      * @param lastSql   sql语句
+     * @return children
      */
     This last(boolean condition, String lastSql);
 
@@ -91,6 +94,7 @@ public interface Join<This> extends Serializable {
      *
      * @param condition 执行条件
      * @param existsSql sql语句
+     * @return children
      */
     This exists(boolean condition, String existsSql);
 
@@ -108,6 +112,7 @@ public interface Join<This> extends Serializable {
      *
      * @param condition    执行条件
      * @param notExistsSql sql语句
+     * @return children
      */
     This notExists(boolean condition, String notExistsSql);
 }

mybatis-plus-core/src/main/java/com/baomidou/mybatisplus/core/conditions/interfaces/Nested.java

@@ -42,6 +42,7 @@ public interface Nested<This> extends Serializable {
      *
      * @param condition 执行条件
      * @param func      函数
+     * @return children
      */
     This and(boolean condition, Function<This, This> func);
 
@@ -58,6 +59,7 @@ public interface Nested<This> extends Serializable {
      *
      * @param condition 执行条件
      * @param func      函数
+     * @return children
      */
     This or(boolean condition, Function<This, This> func);
 
@@ -74,6 +76,7 @@ public interface Nested<This> extends Serializable {
      *
      * @param condition 执行条件
      * @param func      函数
+     * @return children
      */
     This nested(boolean condition, Function<This, This> func);
 }

mybatis-plus-core/src/main/java/com/baomidou/mybatisplus/core/conditions/query/Query.java

@@ -53,7 +53,7 @@ public interface Query<This, T, R> extends Serializable {
      * </p>
      *
      * @param predicate 过滤方式
-     * @return this
+     * @return children
      */
     This select(Class<T> entityClass, Predicate<TableFieldInfo> predicate);