修复FieldsComparator比较结果不正确问题

CHANGELOG.md

@@ -2,7 +2,7 @@
 # 🚀Changelog
 
 -------------------------------------------------------------------------------------------------------------
-# 5.8.22(2023-08-13)
+# 5.8.22(2023-08-15)
 
 ### 🐣新特性
 * 【core  】      NumberUtil.nullToZero增加重载（issue#I7PPD2@Gitee）
@@ -18,6 +18,7 @@
 * 【db    】      修复SqlUtil.formatSql 格式化的sql换行异常（pr#3247@Github）
 * 【core  】      修复DateUtil.parse 给定一个时间解析错误问题（issue#I7QI6R@Gitee）
 * 【core  】      去除默认的ACCEPT_LANGUAGE（issue#3258@Github）
+* 【core  】      修复FieldsComparator比较结果不正确问题（issue#3259@Github）
 
 -------------------------------------------------------------------------------------------------------------
 # 5.8.21(2023-07-29)

hutool-core/src/main/java/cn/hutool/core/comparator/FieldComparator.java

@@ -33,19 +33,21 @@ public class FieldComparator<T> extends FuncComparator<T> {
 	 * @param field 字段
 	 */
 	public FieldComparator(Field field) {
-		this(true, field);
+		this(true, true, field);
 	}
 
 	/**
 	 * 构造
 	 *
 	 * @param nullGreater 是否{@code null}在后
+	 * @param compareSelf 在字段值相同情况下，是否比较对象本身。
+	 *                    如果此项为{@code false}，字段值比较后为0会导致对象被认为相同，可能导致被去重。
 	 * @param field       字段
 	 */
-	public FieldComparator(boolean nullGreater, Field field) {
-		super(nullGreater, (bean) ->
-				(Comparable<?>) ReflectUtil.getFieldValue(bean,
-						Assert.notNull(field, "Field must be not null!")));
+	public FieldComparator(boolean nullGreater, boolean compareSelf, Field field) {
+		super(nullGreater, compareSelf, (bean) ->
+			(Comparable<?>) ReflectUtil.getFieldValue(bean,
+				Assert.notNull(field, "Field must be not null!")));
 	}
 
 	/**

hutool-core/src/main/java/cn/hutool/core/comparator/FieldsComparator.java

@@ -38,7 +38,8 @@ public class FieldsComparator<T> extends NullComparator<T> {
 			for (String fieldName : fieldNames) {
 				field = ClassUtil.getDeclaredField(beanClass, fieldName);
 				Assert.notNull(field, "Field [{}] not found in Class [{}]", fieldName, beanClass.getName());
-				final int compare = new FieldComparator<>(field).compare(a, b);
+				// issue#3259，多个字段比较时，允许字段值重复
+				final int compare = new FieldComparator<>(true, false, field).compare(a, b);
 				if (0 != compare) {
 					return compare;
 				}

hutool-core/src/main/java/cn/hutool/core/comparator/FuncComparator.java

@@ -13,16 +13,31 @@ import java.util.function.Function;
 public class FuncComparator<T> extends NullComparator<T> {
 	private static final long serialVersionUID = 1L;
 
+	private final boolean compareSelf;
 	private final Function<T, Comparable<?>> func;
 
 	/**
 	 * 构造
 	 *
 	 * @param nullGreater 是否{@code null}在后
-	 * @param func        比较项获取函数
+	 * @param func        比较项获取函数，此函数根据传入的一个对象，生成对应的可比较对象，然后根据这个返回值比较
 	 */
 	public FuncComparator(boolean nullGreater, Function<T, Comparable<?>> func) {
+		this(nullGreater, true, func);
+	}
+
+	/**
+	 * 构造
+	 *
+	 * @param nullGreater 是否{@code null}在后
+	 * @param compareSelf 在字段值相同情况下，是否比较对象本身。
+	 *                       如果此项为{@code false}，字段值比较后为0会导致对象被认为相同，可能导致被去重。
+	 * @param func        比较项获取函数，此函数根据传入的一个对象，生成对应的可比较对象，然后根据这个返回值比较
+	 * @since 5.8.22
+	 */
+	public FuncComparator(boolean nullGreater, boolean compareSelf, Function<T, Comparable<?>> func) {
 		super(nullGreater, null);
+		this.compareSelf = compareSelf;
 		this.func = func;
 	}
 
@@ -43,7 +58,7 @@ public class FuncComparator<T> extends NullComparator<T> {
 	/**
 	 * 对象及对应比较的值的综合比较<br>
 	 * 考虑到如果对象对应的比较值相同，如对象的字段值相同，则返回相同结果，此时在TreeMap等容器比较去重时会去重。<br>
-	 * 因此需要比较下对象本身以避免去重
+	 * 因此当{@link #compareSelf}为{@code true}时需要比较下对象本身以避免去重
 	 *
 	 * @param o1 对象1
 	 * @param o2 对象2
@@ -54,7 +69,7 @@ public class FuncComparator<T> extends NullComparator<T> {
 	@SuppressWarnings({"rawtypes", "unchecked"})
 	private int compare(T o1, T o2, Comparable v1, Comparable v2) {
 		int result = ObjectUtil.compare(v1, v2, this.nullGreater);
-		if (0 == result) {
+		if (compareSelf && 0 == result) {
 			//避免TreeSet / TreeMap 过滤掉排序字段相同但是对象不相同的情况
 			result = CompareUtil.compare(o1, o2, this.nullGreater);
 		}

hutool-core/src/test/java/cn/hutool/core/comparator/Issue3259Test.java

@@ -0,0 +1,56 @@
+/*
+ * Copyright (c) 2023 looly(loolly@aliyun.com)
+ * Hutool is licensed under Mulan PSL v2.
+ * You can use this software according to the terms and conditions of the Mulan PSL v2.
+ * You may obtain a copy of Mulan PSL v2 at:
+ *          http://license.coscl.org.cn/MulanPSL2
+ * THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
+ * EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
+ * MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
+ * See the Mulan PSL v2 for more details.
+ */
+
+package cn.hutool.core.comparator;
+
+import cn.hutool.core.collection.CollUtil;
+import cn.hutool.core.collection.ListUtil;
+import cn.hutool.core.util.RandomUtil;
+import lombok.AllArgsConstructor;
+import lombok.ToString;
+import org.junit.Assert;
+import org.junit.Ignore;
+import org.junit.Test;
+
+import java.util.ArrayList;
+import java.util.List;
+
+public class Issue3259Test {
+
+	@Test
+	public void fieldsComparatorTest() {
+		Model x = new Model(1, 1);
+		Model y = new Model(1, RandomUtil.randomInt(2, 100));
+
+		Assert.assertTrue(new FieldsComparator<>(Model.class, "a", "b").compare(x, y) < 0);
+	}
+
+	@Test
+	@Ignore
+	public void sortTest() {
+		for(int i = 2; i < 5; i++) {
+			Model x = new Model(1, 1);
+			Model y = new Model(1, i);
+
+			List<Model> all = ListUtil.of(x, y);
+			all = CollUtil.sort(new ArrayList<>(all), new FieldsComparator<>(Model.class, "a", "b"));
+			System.out.println(all);
+		}
+	}
+
+	@AllArgsConstructor
+	@ToString
+	public static class Model {
+		public int a;
+		public int b;
+	}
+}