This commit is contained in:
Looly 2021-10-07 22:36:41 +08:00
parent 75d915716d
commit cff7c1cedd
4 changed files with 498 additions and 59 deletions

View File

@ -3,7 +3,7 @@
------------------------------------------------------------------------------------------------------------- -------------------------------------------------------------------------------------------------------------
# 5.7.14 (2021-09-30) # 5.7.14 (2021-10-07)
### 🐣新特性 ### 🐣新特性
* 【extra 】 修复HttpCookie设置cookies的方法不符合RFC6265规范问题issue#I4B70D@Gitee * 【extra 】 修复HttpCookie设置cookies的方法不符合RFC6265规范问题issue#I4B70D@Gitee
@ -18,6 +18,7 @@
* 【core 】 优化Base64.isBase64方法减少一次多余的判断pr#1860@Github * 【core 】 优化Base64.isBase64方法减少一次多余的判断pr#1860@Github
* 【core 】 优化Base64.isBase64方法减少一次多余的判断pr#1860@Github * 【core 】 优化Base64.isBase64方法减少一次多余的判断pr#1860@Github
* 【cache 】 优化FIFOCache未设置过期策略时无需遍历判断过期对象pr#425@Gitee * 【cache 】 优化FIFOCache未设置过期策略时无需遍历判断过期对象pr#425@Gitee
* 【core 】 增加Opt类pr#426@Gitee
### 🐞Bug修复 ### 🐞Bug修复
* 【http 】 修复HttpCookie设置cookies的方法不符合RFC6265规范问题pr#418@Gitee * 【http 】 修复HttpCookie设置cookies的方法不符合RFC6265规范问题pr#418@Gitee

View File

@ -24,11 +24,11 @@
*/ */
package cn.hutool.core.bean; package cn.hutool.core.bean;
import cn.hutool.core.lang.func.VoidFunc0;
import cn.hutool.core.util.StrUtil; import cn.hutool.core.util.StrUtil;
import java.util.NoSuchElementException; import java.util.NoSuchElementException;
import java.util.Objects; import java.util.Objects;
import java.util.Optional;
import java.util.function.Consumer; import java.util.function.Consumer;
import java.util.function.Function; import java.util.function.Function;
import java.util.function.Predicate; import java.util.function.Predicate;
@ -36,14 +36,17 @@ import java.util.function.Supplier;
import java.util.stream.Stream; import java.util.stream.Stream;
/** /**
* 复制jdk16中的Optional以及自己进行了一点调整和新增比jdk8中的Optional多了几个实用的函数 * 复制jdk16中的Optional以及自己进行了一点调整和新增比jdk8中的Optional多了几个实用的函数<br>
* 详细见https://gitee.com/dromara/hutool/pulls/426
* *
* @author VampireAchao * @author VampireAchao
* @see java.util.Optional * @see java.util.Optional
* @deprecated 请使用 {@link cn.hutool.core.lang.Opt}
*/ */
public final class OptionalBean<T> { @Deprecated
public class OptionalBean<T> {
/** /**
* 一个空的{@code Opt} * 一个空的{@code OptionalBean}
*/ */
private static final OptionalBean<?> EMPTY = new OptionalBean<>(null); private static final OptionalBean<?> EMPTY = new OptionalBean<>(null);
@ -53,7 +56,7 @@ public final class OptionalBean<T> {
private final T value; private final T value;
/** /**
* {@code Opt}的构造函数 * {@code OptionalBean}的构造函数
* *
* @param value 包裹里的元素 * @param value 包裹里的元素
*/ */
@ -62,7 +65,7 @@ public final class OptionalBean<T> {
} }
/** /**
* 返回一个空的{@code Opt} * 返回一个空的{@code OptionalBean}
*/ */
public static <T> OptionalBean<T> empty() { public static <T> OptionalBean<T> empty() {
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")
@ -71,11 +74,11 @@ public final class OptionalBean<T> {
} }
/** /**
* 返回一个包裹里元素不可能为空的{@code Opt} * 返回一个包裹里元素不可能为空的{@code OptionalBean}
* *
* @param value 包裹里的元素 * @param value 包裹里的元素
* @param <T> 包裹里元素的类型 * @param <T> 包裹里元素的类型
* @return 一个包裹里元素不可能为空的 {@code Opt} * @return 一个包裹里元素不可能为空的 {@code OptionalBean}
* @throws NullPointerException 如果传入的元素为空抛出 {@code NPE} * @throws NullPointerException 如果传入的元素为空抛出 {@code NPE}
*/ */
public static <T> OptionalBean<T> of(T value) { public static <T> OptionalBean<T> of(T value) {
@ -83,11 +86,11 @@ public final class OptionalBean<T> {
} }
/** /**
* 返回一个包裹里元素可能为空的{@code Opt} * 返回一个包裹里元素可能为空的{@code OptionalBean}
* *
* @param value 传入需要包裹的元素 * @param value 传入需要包裹的元素
* @param <T> 包裹里元素的类型 * @param <T> 包裹里元素的类型
* @return 一个包裹里元素可能为空的 {@code Opt} * @return 一个包裹里元素可能为空的 {@code OptionalBean}
*/ */
public static <T> OptionalBean<T> ofNullable(T value) { public static <T> OptionalBean<T> ofNullable(T value) {
return value == null ? empty() return value == null ? empty()
@ -95,18 +98,18 @@ public final class OptionalBean<T> {
} }
/** /**
* 返回一个包裹里元素可能为空的{@code Opt}额外判断了空字符串的情况 * 返回一个包裹里元素可能为空的{@code OptionalBean}额外判断了空字符串的情况
* *
* @param value 传入需要包裹的元素 * @param value 传入需要包裹的元素
* @param <T> 包裹里元素的类型 * @param <T> 包裹里元素的类型
* @return 一个包裹里元素可能为空或者为空字符串的 {@code Opt} * @return 一个包裹里元素可能为空或者为空字符串的 {@code OptionalBean}
*/ */
public static <T> OptionalBean<T> ofBlankAble(T value) { public static <T> OptionalBean<T> ofBlankAble(T value) {
return StrUtil.isBlankIfStr(value) ? empty() : new OptionalBean<>(value); return StrUtil.isBlankIfStr(value) ? empty() : new OptionalBean<>(value);
} }
/** /**
* 返回包裹里的元素取不到则为{@code null}注意此处和{@link Optional#get()}不同的一点是本方法并不会抛出{@code NoSuchElementException} * 返回包裹里的元素取不到则为{@code null}注意此处和{@link java.util.Optional#get()}不同的一点是本方法并不会抛出{@code NoSuchElementException}
* 如果元素为空则返回{@code null}如果需要一个绝对不能为{@code null}的值则使用{@link #orElseThrow()} * 如果元素为空则返回{@code null}如果需要一个绝对不能为{@code null}的值则使用{@link #orElseThrow()}
* *
* @return 包裹里的元素有可能为{@code null} * @return 包裹里的元素有可能为{@code null}
@ -131,7 +134,7 @@ public final class OptionalBean<T> {
* 判断包裹里元素的值是否不存在不存在为 {@code true}否则为{@code false} * 判断包裹里元素的值是否不存在不存在为 {@code true}否则为{@code false}
* *
* @return 包裹里元素的值不存在 则为 {@code true}否则为{@code false} * @return 包裹里元素的值不存在 则为 {@code true}否则为{@code false}
* @since 11 这是jdk11{@link Optional}中的新函数 * @since 11 这是jdk11{@link java.util.Optional}中的新函数
*/ */
public boolean isEmpty() { public boolean isEmpty() {
return value == null; return value == null;
@ -144,7 +147,7 @@ public final class OptionalBean<T> {
* @throws NullPointerException 如果包裹里的值存在但你传入的操作为{@code null}时抛出 * @throws NullPointerException 如果包裹里的值存在但你传入的操作为{@code null}时抛出
* @apiNote 例如如果值存在就打印结果 * @apiNote 例如如果值存在就打印结果
* <pre>{@code * <pre>{@code
* Opt.ofNullable("Hello Hutool!").ifPresent(System.out::println); * Opt.ofNullable("Hello Hutool!").ifPresent(Console::log);
* }</pre> * }</pre>
*/ */
public void ifPresent(Consumer<? super T> action) { public void ifPresent(Consumer<? super T> action) {
@ -155,32 +158,32 @@ public final class OptionalBean<T> {
/** /**
* 如果包裹里的值存在就执行传入的值存在时的操作({@link Consumer#accept}) * 如果包裹里的值存在就执行传入的值存在时的操作({@link Consumer#accept})
* 否则执行传入的值不存在时的操作({@link Runnable}中的{@link Runnable#run}) * 否则执行传入的值不存在时的操作({@link VoidFunc0}中的{@link VoidFunc0#call()})
* *
* @param action 包裹里的值存在时的操作 * @param action 包裹里的值存在时的操作
* @param emptyAction 包裹里的值不存在时的操作 * @param emptyAction 包裹里的值不存在时的操作
* @throws NullPointerException 如果包裹里的值存在时执行的操作为 {@code null}, 或者包裹里的值不存在时的操作为 {@code null}则抛出{@code NPE} * @throws NullPointerException 如果包裹里的值存在时执行的操作为 {@code null}, 或者包裹里的值不存在时的操作为 {@code null}则抛出{@code NPE}
* @apiNote 例如值存在就打印对应的值不存在则用{@code System.err.println}打印另一句字符串 * @apiNote 例如值存在就打印对应的值不存在则用{@code Console.error}打印另一句字符串
* <pre>{@code * <pre>{@code
* Opt.ofNullable("Hello Hutool!").ifPresentOrElse(System.out::println, () -> System.err.println("Ops!Something is wrong!")); * Opt.ofNullable("Hello Hutool!").ifPresentOrElse(Console::log, () -> Console.error("Ops!Something is wrong!"));
* }</pre> * }</pre>
* @since 9 这是jdk9{@link Optional}中的新函数 * @since 9 这是jdk9{@link java.util.Optional}中的新函数
*/ */
public void ifPresentOrElse(Consumer<? super T> action, Runnable emptyAction) { public void ifPresentOrElse(Consumer<? super T> action, VoidFunc0 emptyAction) {
if (value != null) { if (value != null) {
action.accept(value); action.accept(value);
} else { } else {
emptyAction.run(); emptyAction.callWithRuntimeException();
} }
} }
/** /**
* 判断包裹里的值存在并且与给定的条件是否满足 ({@link Predicate#test}执行结果是否为true) * 判断包裹里的值存在并且与给定的条件是否满足 ({@link Predicate#test}执行结果是否为true)
* 如果满足条件则返回本身 * 如果满足条件则返回本身
* 不满足条件或者元素本身为空时返回一个返回一个空的{@code Opt} * 不满足条件或者元素本身为空时返回一个返回一个空的{@code OptionalBean}
* *
* @param predicate 给定的条件 * @param predicate 给定的条件
* @return 如果满足条件则返回本身, 不满足条件或者元素本身为空时返回一个返回一个空的{@code Opt} * @return 如果满足条件则返回本身, 不满足条件或者元素本身为空时返回一个返回一个空的{@code OptionalBean}
* @throws NullPointerException 如果给定的条件为 {@code null}抛出{@code NPE} * @throws NullPointerException 如果给定的条件为 {@code null}抛出{@code NPE}
*/ */
public OptionalBean<T> filter(Predicate<? super T> predicate) { public OptionalBean<T> filter(Predicate<? super T> predicate) {
@ -193,13 +196,13 @@ public final class OptionalBean<T> {
} }
/** /**
* 如果包裹里的值存在就执行传入的操作({@link Function#apply})并返回一个包裹了该操作返回值的{@code Opt} * 如果包裹里的值存在就执行传入的操作({@link Function#apply})并返回一个包裹了该操作返回值的{@code OptionalBean}
* 如果不存在返回一个空的{@code Opt} * 如果不存在返回一个空的{@code OptionalBean}
* *
* @param mapper 值存在时执行的操作 * @param mapper 值存在时执行的操作
* @param <U> 操作返回值的类型 * @param <U> 操作返回值的类型
* @return 如果包裹里的值存在就执行传入的操作({@link Function#apply})并返回一个包裹了该操作返回值的{@code Opt} * @return 如果包裹里的值存在就执行传入的操作({@link Function#apply})并返回一个包裹了该操作返回值的{@code OptionalBean}
* 如果不存在返回一个空的{@code Opt} * 如果不存在返回一个空的{@code OptionalBean}
* @throws NullPointerException 如果给定的操作为 {@code null}抛出 {@code NPE} * @throws NullPointerException 如果给定的操作为 {@code null}抛出 {@code NPE}
*/ */
public <U> OptionalBean<U> map(Function<? super T, ? extends U> mapper) { public <U> OptionalBean<U> map(Function<? super T, ? extends U> mapper) {
@ -213,13 +216,13 @@ public final class OptionalBean<T> {
/** /**
* 如果包裹里的值存在就执行传入的操作({@link Function#apply})并返回该操作返回值 * 如果包裹里的值存在就执行传入的操作({@link Function#apply})并返回该操作返回值
* 如果不存在返回一个空的{@code Opt} * 如果不存在返回一个空的{@code OptionalBean}
* {@link OptionalBean#map}的区别为 传入的操作返回值必须为 {@link OptionalBean} * {@link OptionalBean#map}的区别为 传入的操作返回值必须为 OptionalBean
* *
* @param mapper 值存在时执行的操作 * @param mapper 值存在时执行的操作
* @param <U> 操作返回值的类型 * @param <U> 操作返回值的类型
* @return 如果包裹里的值存在就执行传入的操作({@link Function#apply})并返回该操作返回值 * @return 如果包裹里的值存在就执行传入的操作({@link Function#apply})并返回该操作返回值
* 如果不存在返回一个空的{@code Opt} * 如果不存在返回一个空的{@code OptionalBean}
* @throws NullPointerException 如果给定的操作为 {@code null}或者给定的操作执行结果为 {@code null}抛出 {@code NPE} * @throws NullPointerException 如果给定的操作为 {@code null}或者给定的操作执行结果为 {@code null}抛出 {@code NPE}
*/ */
public <U> OptionalBean<U> flatMap(Function<? super T, ? extends OptionalBean<? extends U>> mapper) { public <U> OptionalBean<U> flatMap(Function<? super T, ? extends OptionalBean<? extends U>> mapper) {
@ -235,7 +238,7 @@ public final class OptionalBean<T> {
/** /**
* 如果包裹里元素的值存在就执行对应的操作并返回本身 * 如果包裹里元素的值存在就执行对应的操作并返回本身
* 如果不存在返回一个空的{@code Opt} * 如果不存在返回一个空的{@code OptionalBean}
* *
* @param action 值存在时执行的操作 * @param action 值存在时执行的操作
* @throws NullPointerException 如果值存在并且传入的操作为 {@code null} * @throws NullPointerException 如果值存在并且传入的操作为 {@code null}
@ -252,11 +255,11 @@ public final class OptionalBean<T> {
} }
/** /**
* 如果包裹里元素的值存在就返回本身如果不存在则使用传入的操作执行后获得的 {@code Opt} * 如果包裹里元素的值存在就返回本身如果不存在则使用传入的操作执行后获得的 {@code OptionalBean}
* *
* @return 如果包裹里元素的值存在就返回本身如果不存在则使用传入的函数执行后获得的 {@code Opt} * @return 如果包裹里元素的值存在就返回本身如果不存在则使用传入的函数执行后获得的 {@code OptionalBean}
* @throws NullPointerException 如果传入的操作为空或者传入的操作执行后返回值为空则抛出 {@code NPE} * @throws NullPointerException 如果传入的操作为空或者传入的操作执行后返回值为空则抛出 {@code NPE}
* @since 9 这是jdk9{@link Optional}中的新函数 * @since 9 这是jdk9{@link java.util.Optional}中的新函数
*/ */
public OptionalBean<T> or(Supplier<? extends OptionalBean<? extends T>> supplier) { public OptionalBean<T> or(Supplier<? extends OptionalBean<? extends T>> supplier) {
Objects.requireNonNull(supplier); Objects.requireNonNull(supplier);
@ -274,12 +277,12 @@ public final class OptionalBean<T> {
* 否则返回一个空元素的 {@link Stream} * 否则返回一个空元素的 {@link Stream}
* *
* @return 返回一个包含该元素的 {@link Stream}或空的 {@link Stream} * @return 返回一个包含该元素的 {@link Stream}或空的 {@link Stream}
* @apiNote 该方法能将 {@link OptionalBean} 中的元素传递给 {@link Stream} * @apiNote 该方法能将 OptionalBean 中的元素传递给 {@link Stream}
* <pre>{@code * <pre>{@code
* Stream<Opt<T>> os = .. * Stream<Opt<T>> os = ..
* Stream<T> s = os.flatMap(Opt::stream) * Stream<T> s = os.flatMap(Opt::stream)
* }</pre> * }</pre>
* @since 9 这是jdk9{@link Optional}中的新函数 * @since 9 这是jdk9{@link java.util.Optional}中的新函数
*/ */
public Stream<T> stream() { public Stream<T> stream() {
if (isEmpty()) { if (isEmpty()) {
@ -315,7 +318,7 @@ public final class OptionalBean<T> {
* *
* @return 返回一个不为 {@code null} 的包裹里的值 * @return 返回一个不为 {@code null} 的包裹里的值
* @throws NoSuchElementException 如果包裹里的值不存在则抛出该异常 * @throws NoSuchElementException 如果包裹里的值不存在则抛出该异常
* @since 10 这是jdk10{@link Optional}中的新函数 * @since 10 这是jdk10{@link java.util.Optional}中的新函数
*/ */
public T orElseThrow() { public T orElseThrow() {
if (value == null) { if (value == null) {
@ -366,16 +369,16 @@ public final class OptionalBean<T> {
} }
/** /**
* 判断传入参数是否与 {@code Opt}相等 * 判断传入参数是否与 {@code OptionalBean}相等
* 在以下情况下返回true * 在以下情况下返回true
* <ul> * <ul>
* <li>它也是一个 {@code Opt} 并且 * <li>它也是一个 {@code OptionalBean} 并且
* <li>它们包裹住的元素都为空 或者 * <li>它们包裹住的元素都为空 或者
* <li>它们包裹住的元素之间相互 {@code equals()} * <li>它们包裹住的元素之间相互 {@code equals()}
* </ul> * </ul>
* *
* @param obj 一个要用来判断是否相等的参数 * @param obj 一个要用来判断是否相等的参数
* @return 如果传入的参数也是一个 {@code Opt}并且它们包裹住的元素都为空 * @return 如果传入的参数也是一个 {@code OptionalBean}并且它们包裹住的元素都为空
* 或者它们包裹住的元素之间相互 {@code equals()} 就返回{@code true} * 或者它们包裹住的元素之间相互 {@code equals()} 就返回{@code true}
* 否则返回 {@code false} * 否则返回 {@code false}
*/ */

View File

@ -0,0 +1,417 @@
/*
* Copyright (c) 2012, 2020, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package cn.hutool.core.lang;
import cn.hutool.core.lang.func.VoidFunc0;
import cn.hutool.core.util.StrUtil;
import java.util.NoSuchElementException;
import java.util.Objects;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.function.Predicate;
import java.util.function.Supplier;
import java.util.stream.Stream;
/**
* 复制jdk16中的Optional以及自己进行了一点调整和新增比jdk8中的Optional多了几个实用的函数<br>
* 详细见https://gitee.com/dromara/hutool/pulls/426
*
* @author VampireAchao
* @see java.util.Optional
*/
public class Opt<T> {
/**
* 一个空的{@code Opt}
*/
private static final Opt<?> EMPTY = new Opt<>(null);
/**
* 包裹里实际的元素
*/
private final T value;
/**
* {@code Opt}的构造函数
*
* @param value 包裹里的元素
*/
private Opt(T value) {
this.value = value;
}
/**
* 返回一个空的{@code Opt}
*/
public static <T> Opt<T> empty() {
@SuppressWarnings("unchecked")
Opt<T> t = (Opt<T>) EMPTY;
return t;
}
/**
* 返回一个包裹里元素不可能为空的{@code Opt}
*
* @param value 包裹里的元素
* @param <T> 包裹里元素的类型
* @return 一个包裹里元素不可能为空的 {@code Opt}
* @throws NullPointerException 如果传入的元素为空抛出 {@code NPE}
*/
public static <T> Opt<T> of(T value) {
return new Opt<>(Objects.requireNonNull(value));
}
/**
* 返回一个包裹里元素可能为空的{@code Opt}
*
* @param value 传入需要包裹的元素
* @param <T> 包裹里元素的类型
* @return 一个包裹里元素可能为空的 {@code Opt}
*/
public static <T> Opt<T> ofNullable(T value) {
return value == null ? empty()
: new Opt<>(value);
}
/**
* 返回一个包裹里元素可能为空的{@code Opt}额外判断了空字符串的情况
*
* @param value 传入需要包裹的元素
* @param <T> 包裹里元素的类型
* @return 一个包裹里元素可能为空或者为空字符串的 {@code Opt}
*/
public static <T> Opt<T> ofBlankAble(T value) {
return StrUtil.isBlankIfStr(value) ? empty() : new Opt<>(value);
}
/**
* 返回包裹里的元素取不到则为{@code null}注意此处和{@link java.util.Optional#get()}不同的一点是本方法并不会抛出{@code NoSuchElementException}
* 如果元素为空则返回{@code null}如果需要一个绝对不能为{@code null}的值则使用{@link #orElseThrow()}
*
* @return 包裹里的元素有可能为{@code null}
* @apiNote 如果需要一个绝对不能为 {@code null}的值则使用{@link #orElseThrow()}
* 做此处修改的原因是有时候我们确实需要返回一个null给前端并且这样的时候并不少见
* 而使用 {@code .orElse(null)}需要写整整12个字符{@code .get()}就只需要6个啦
*/
public T get() {
return value;
}
/**
* 判断包裹里元素的值是否存在存在为 {@code true}否则为{@code false}
*
* @return 包裹里元素的值存在为 {@code true}否则为{@code false}
*/
public boolean isPresent() {
return value != null;
}
/**
* 判断包裹里元素的值是否不存在不存在为 {@code true}否则为{@code false}
*
* @return 包裹里元素的值不存在 则为 {@code true}否则为{@code false}
* @since 11 这是jdk11{@link java.util.Optional}中的新函数
*/
public boolean isEmpty() {
return value == null;
}
/**
* 如果包裹里的值存在就执行传入的操作({@link Consumer#accept})
*
* @param action 你想要执行的操作
* @throws NullPointerException 如果包裹里的值存在但你传入的操作为{@code null}时抛出
* @apiNote 例如如果值存在就打印结果
* <pre>{@code
* Opt.ofNullable("Hello Hutool!").ifPresent(Console::log);
* }</pre>
*/
public void ifPresent(Consumer<? super T> action) {
if (value != null) {
action.accept(value);
}
}
/**
* 如果包裹里的值存在就执行传入的值存在时的操作({@link Consumer#accept})
* 否则执行传入的值不存在时的操作({@link VoidFunc0}中的{@link VoidFunc0#call()})
*
* @param action 包裹里的值存在时的操作
* @param emptyAction 包裹里的值不存在时的操作
* @throws NullPointerException 如果包裹里的值存在时执行的操作为 {@code null}, 或者包裹里的值不存在时的操作为 {@code null}则抛出{@code NPE}
* @apiNote 例如值存在就打印对应的值不存在则用{@code Console.error}打印另一句字符串
* <pre>{@code
* Opt.ofNullable("Hello Hutool!").ifPresentOrElse(Console::log, () -> Console.error("Ops!Something is wrong!"));
* }</pre>
* @since 9 这是jdk9{@link java.util.Optional}中的新函数
*/
public void ifPresentOrElse(Consumer<? super T> action, VoidFunc0 emptyAction) {
if (value != null) {
action.accept(value);
} else {
emptyAction.callWithRuntimeException();
}
}
/**
* 判断包裹里的值存在并且与给定的条件是否满足 ({@link Predicate#test}执行结果是否为true)
* 如果满足条件则返回本身
* 不满足条件或者元素本身为空时返回一个返回一个空的{@code Opt}
*
* @param predicate 给定的条件
* @return 如果满足条件则返回本身, 不满足条件或者元素本身为空时返回一个返回一个空的{@code Opt}
* @throws NullPointerException 如果给定的条件为 {@code null}抛出{@code NPE}
*/
public Opt<T> filter(Predicate<? super T> predicate) {
Objects.requireNonNull(predicate);
if (isEmpty()) {
return this;
} else {
return predicate.test(value) ? this : empty();
}
}
/**
* 如果包裹里的值存在就执行传入的操作({@link Function#apply})并返回一个包裹了该操作返回值的{@code Opt}
* 如果不存在返回一个空的{@code Opt}
*
* @param mapper 值存在时执行的操作
* @param <U> 操作返回值的类型
* @return 如果包裹里的值存在就执行传入的操作({@link Function#apply})并返回一个包裹了该操作返回值的{@code Opt}
* 如果不存在返回一个空的{@code Opt}
* @throws NullPointerException 如果给定的操作为 {@code null}抛出 {@code NPE}
*/
public <U> Opt<U> map(Function<? super T, ? extends U> mapper) {
Objects.requireNonNull(mapper);
if (isEmpty()) {
return empty();
} else {
return Opt.ofNullable(mapper.apply(value));
}
}
/**
* 如果包裹里的值存在就执行传入的操作({@link Function#apply})并返回该操作返回值
* 如果不存在返回一个空的{@code Opt}
* {@link Opt#map}的区别为 传入的操作返回值必须为 Opt
*
* @param mapper 值存在时执行的操作
* @param <U> 操作返回值的类型
* @return 如果包裹里的值存在就执行传入的操作({@link Function#apply})并返回该操作返回值
* 如果不存在返回一个空的{@code Opt}
* @throws NullPointerException 如果给定的操作为 {@code null}或者给定的操作执行结果为 {@code null}抛出 {@code NPE}
*/
public <U> Opt<U> flatMap(Function<? super T, ? extends Opt<? extends U>> mapper) {
Objects.requireNonNull(mapper);
if (isEmpty()) {
return empty();
} else {
@SuppressWarnings("unchecked")
Opt<U> r = (Opt<U>) mapper.apply(value);
return Objects.requireNonNull(r);
}
}
/**
* 如果包裹里元素的值存在就执行对应的操作并返回本身
* 如果不存在返回一个空的{@code Opt}
*
* @param action 值存在时执行的操作
* @throws NullPointerException 如果值存在并且传入的操作为 {@code null}
* @apiNote 属于 {@link #ifPresent}的链式拓展
* @author VampireAchao
*/
public Opt<T> peek(Consumer<T> action) {
Objects.requireNonNull(action);
if (isEmpty()) {
return Opt.empty();
}
action.accept(value);
return this;
}
/**
* 如果包裹里元素的值存在就返回本身如果不存在则使用传入的操作执行后获得的 {@code Opt}
*
* @return 如果包裹里元素的值存在就返回本身如果不存在则使用传入的函数执行后获得的 {@code Opt}
* @throws NullPointerException 如果传入的操作为空或者传入的操作执行后返回值为空则抛出 {@code NPE}
* @since 9 这是jdk9{@link java.util.Optional}中的新函数
*/
public Opt<T> or(Supplier<? extends Opt<? extends T>> supplier) {
Objects.requireNonNull(supplier);
if (isPresent()) {
return this;
} else {
@SuppressWarnings("unchecked")
Opt<T> r = (Opt<T>) supplier.get();
return Objects.requireNonNull(r);
}
}
/**
* 如果包裹里元素的值存在就返回一个包含该元素的 {@link Stream},
* 否则返回一个空元素的 {@link Stream}
*
* @return 返回一个包含该元素的 {@link Stream}或空的 {@link Stream}
* @apiNote 该方法能将 Opt 中的元素传递给 {@link Stream}
* <pre>{@code
* Stream<Opt<T>> os = ..
* Stream<T> s = os.flatMap(Opt::stream)
* }</pre>
* @since 9 这是jdk9{@link java.util.Optional}中的新函数
*/
public Stream<T> stream() {
if (isEmpty()) {
return Stream.empty();
} else {
return Stream.of(value);
}
}
/**
* 如果包裹里元素的值存在则返回该值否则返回传入的{@code other}
*
* @param other 元素为空时返回的值有可能为 {@code null}.
* @return 如果包裹里元素的值存在则返回该值否则返回传入的{@code other}
*/
public T orElse(T other) {
return value != null ? value : other;
}
/**
* 如果包裹里元素的值存在则返回该值否则返回传入的操作执行后的返回值
*
* @param supplier 值不存在时需要执行的操作返回一个类型与 包裹里元素类型 相同的元素
* @return 如果包裹里元素的值存在则返回该值否则返回传入的操作执行后的返回值
* @throws NullPointerException 如果之不存在并且传入的操作为空则抛出 {@code NPE}
*/
public T orElseGet(Supplier<? extends T> supplier) {
return value != null ? value : supplier.get();
}
/**
* 如果包裹里的值存在则返回该值否则抛出 {@code NoSuchElementException}
*
* @return 返回一个不为 {@code null} 的包裹里的值
* @throws NoSuchElementException 如果包裹里的值不存在则抛出该异常
* @since 10 这是jdk10{@link java.util.Optional}中的新函数
*/
public T orElseThrow() {
if (value == null) {
throw new NoSuchElementException("No value present");
}
return value;
}
/**
* 如果包裹里的值存在则返回该值否则执行传入的操作获取异常类型的返回值并抛出
*
* @param <X> 异常类型
* @param exceptionSupplier 值不存在时执行的操作返回值继承 {@link Throwable}
* @return 包裹里不能为空的值
* @throws X 如果值不存在
* @throws NullPointerException 如果值不存在并且 传入的操作为 {@code null}或者操作执行后的返回值为{@code null}
* @apiNote 往往是一个包含无参构造器的异常 例如传入{@code IllegalStateException::new}
*/
public <X extends Throwable> T orElseThrow(Supplier<? extends X> exceptionSupplier) throws X {
if (value != null) {
return value;
} else {
throw exceptionSupplier.get();
}
}
/**
* 如果包裹里的值存在则返回该值否则执行传入的操作获取异常类型的返回值并抛出
*
* @param <X> 异常类型
* @param exceptionFunction 值不存在时执行的操作返回值继承 {@link Throwable}
* @param message 作为传入操作执行时的参数一般作为异常自定义提示语
* @return 包裹里不能为空的值
* @throws X 如果值不存在
* @throws NullPointerException 如果值不存在并且 传入的操作为 {@code null}或者操作执行后的返回值为{@code null}
* @apiNote 往往是一个包含 自定义消息 构造器的异常 例如
* <pre>{@code
* Opt.ofNullable(null).orElseThrow(IllegalStateException::new, "Ops!Something is wrong!");
* }</pre>
* @author VampireAchao
*/
public <X extends Throwable> T orElseThrow(Function<String, ? extends X> exceptionFunction, String message) throws X {
if (value != null) {
return value;
} else {
throw exceptionFunction.apply(message);
}
}
/**
* 判断传入参数是否与 {@code Opt}相等
* 在以下情况下返回true
* <ul>
* <li>它也是一个 {@code Opt} 并且
* <li>它们包裹住的元素都为空 或者
* <li>它们包裹住的元素之间相互 {@code equals()}
* </ul>
*
* @param obj 一个要用来判断是否相等的参数
* @return 如果传入的参数也是一个 {@code Opt}并且它们包裹住的元素都为空
* 或者它们包裹住的元素之间相互 {@code equals()} 就返回{@code true}
* 否则返回 {@code false}
*/
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (!(obj instanceof Opt)) {
return false;
}
Opt<?> other = (Opt<?>) obj;
return Objects.equals(value, other.value);
}
/**
* 如果包裹内元素为空则返回0否则返回元素的 {@code hashcode}
*
* @return 如果包裹内元素为空则返回0否则返回元素的 {@code hashcode}
*/
@Override
public int hashCode() {
return Objects.hashCode(value);
}
/**
* 返回包裹内元素调用{@code toString()}的结果不存在则返回{@code null}
* return 包裹内元素调用{@code toString()}的结果不存在则返回{@code null}
*/
@Override
public String toString() {
return value != null
? value.toString()
: null;
}
}

View File

@ -1,22 +1,26 @@
package cn.hutool.core.bean; package cn.hutool.core.lang;
import lombok.AllArgsConstructor;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;
import lombok.NoArgsConstructor; import lombok.NoArgsConstructor;
import org.junit.Assert; import org.junit.Assert;
import org.junit.Ignore;
import org.junit.Test; import org.junit.Test;
import java.util.NoSuchElementException;
/** /**
* {@link OptionalBean}的单元测试 * {@link Opt}的单元测试
* *
* @author VampireAchao * @author VampireAchao
*/ */
public class OptionalBeanTest { public class OptTest {
@Test @Test
public void ofBlankAbleTest() { public void ofBlankAbleTest() {
// ofBlankAble相对于ofNullable考虑了字符串为空串的情况 // ofBlankAble相对于ofNullable考虑了字符串为空串的情况
String hutool = OptionalBean.ofBlankAble("").orElse("hutool"); String hutool = Opt.ofBlankAble("").orElse("hutool");
Assert.assertEquals("hutool", hutool); Assert.assertEquals("hutool", hutool);
} }
@ -24,7 +28,7 @@ public class OptionalBeanTest {
public void getTest() { public void getTest() {
// 和原版Optional有区别的是get不会抛出NoSuchElementException // 和原版Optional有区别的是get不会抛出NoSuchElementException
// 如果想使用原版Optional中的get这样获取一个一定不为空的值则应该使用orElseThrow // 如果想使用原版Optional中的get这样获取一个一定不为空的值则应该使用orElseThrow
Object opt = OptionalBean.ofNullable(null).get(); Object opt = Opt.ofNullable(null).get();
Assert.assertNull(opt); Assert.assertNull(opt);
} }
@ -32,28 +36,30 @@ public class OptionalBeanTest {
public void isEmptyTest() { public void isEmptyTest() {
// 这是jdk11 Optional中的新函数直接照搬了过来 // 这是jdk11 Optional中的新函数直接照搬了过来
// 判断包裹内元素是否为空注意并没有判断空字符串的情况 // 判断包裹内元素是否为空注意并没有判断空字符串的情况
boolean isEmpty = OptionalBean.empty().isEmpty(); boolean isEmpty = Opt.empty().isEmpty();
Assert.assertTrue(isEmpty); Assert.assertTrue(isEmpty);
} }
@Test @Test
@Ignore
public void ifPresentOrElseTest() { public void ifPresentOrElseTest() {
// 这是jdk9中的新函数直接照搬了过来 // 这是jdk9中的新函数直接照搬了过来
// 存在就打印对应的值不存在则用{@code System.err.println}打印另一句字符串 // 存在就打印对应的值不存在则用{@code System.err.println}打印另一句字符串
OptionalBean.ofNullable("Hello Hutool!").ifPresentOrElse(System.out::println, () -> System.err.println("Ops!Something is wrong!")); Opt.ofNullable("Hello Hutool!").ifPresentOrElse(Console::log, () -> Console.error("Ops!Something is wrong!"));
OptionalBean.empty().ifPresentOrElse(System.out::println, () -> System.err.println("Ops!Something is wrong!"));
Opt.empty().ifPresentOrElse(Console::log, () -> Console.error("Ops!Something is wrong!"));
} }
@Test @Test
public void peekTest() { public void peekTest() {
User user = new User(); User user = new User();
// 相当于ifPresent的链式调用 // 相当于ifPresent的链式调用
OptionalBean.ofNullable("hutool").peek(user::setUsername).peek(user::setNickname); Opt.ofNullable("hutool").peek(user::setUsername).peek(user::setNickname);
Assert.assertEquals("hutool", user.getNickname()); Assert.assertEquals("hutool", user.getNickname());
Assert.assertEquals("hutool", user.getUsername()); Assert.assertEquals("hutool", user.getUsername());
// 注意传入的lambda中对包裹内的元素执行赋值操作并不会影响到原来的元素 // 注意传入的lambda中对包裹内的元素执行赋值操作并不会影响到原来的元素
String name = OptionalBean.ofNullable("hutool").peek(username -> username = "123").peek(username -> username = "456").get(); String name = Opt.ofNullable("hutool").peek(username -> username = "123").peek(username -> username = "456").get();
Assert.assertEquals("hutool", name); Assert.assertEquals("hutool", name);
} }
@ -61,30 +67,42 @@ public class OptionalBeanTest {
public void orTest() { public void orTest() {
// 这是jdk9 Optional中的新函数直接照搬了过来 // 这是jdk9 Optional中的新函数直接照搬了过来
// 给一个替代的Opt // 给一个替代的Opt
String str = OptionalBean.<String>ofNullable(null).or(() -> OptionalBean.ofNullable("Hello hutool!")).map(String::toUpperCase).orElseThrow(); String str = Opt.<String>ofNullable(null).or(() -> Opt.ofNullable("Hello hutool!")).map(String::toUpperCase).orElseThrow();
Assert.assertEquals("HELLO HUTOOL!", str); Assert.assertEquals("HELLO HUTOOL!", str);
User user = User.builder().username("hutool").build(); User user = User.builder().username("hutool").build();
OptionalBean<User> userOptionalBean = OptionalBean.of(user); Opt<User> userOpt = Opt.of(user);
// 获取昵称获取不到则获取用户名 // 获取昵称获取不到则获取用户名
String name = userOptionalBean.map(User::getNickname).or(() -> userOptionalBean.map(User::getUsername)).get(); String name = userOpt.map(User::getNickname).or(() -> userOpt.map(User::getUsername)).get();
Assert.assertEquals("hutool", name); Assert.assertEquals("hutool", name);
} }
@Test @Test(expected = NoSuchElementException.class)
public void orElseThrowTest() { public void orElseThrowTest() {
// 获取一个不可能为空的值否则抛出NoSuchElementException异常 // 获取一个不可能为空的值否则抛出NoSuchElementException异常
Object obj = OptionalBean.ofNullable(null).orElseThrow(); Object obj = Opt.ofNullable(null).orElseThrow();
Assert.assertNull(obj);
}
@Test(expected = IllegalStateException.class)
public void orElseThrowTest2() {
// 获取一个不可能为空的值否则抛出自定义异常 // 获取一个不可能为空的值否则抛出自定义异常
Object assignException = OptionalBean.ofNullable(null).orElseThrow(IllegalStateException::new); Object assignException = Opt.ofNullable(null).orElseThrow(IllegalStateException::new);
Assert.assertNull(assignException);
}
@Test(expected = IllegalStateException.class)
public void orElseThrowTest3() {
// 获取一个不可能为空的值否则抛出带自定义消息的自定义异常 // 获取一个不可能为空的值否则抛出带自定义消息的自定义异常
Object exceptionWithMessage = OptionalBean.empty().orElseThrow(IllegalStateException::new, "Ops!Something is wrong!"); Object exceptionWithMessage = Opt.empty().orElseThrow(IllegalStateException::new, "Ops!Something is wrong!");
Assert.assertNull(exceptionWithMessage);
} }
@Data @Data
@Builder @Builder
@NoArgsConstructor @NoArgsConstructor
private static class User { @AllArgsConstructor
static class User {
private String username; private String username;
private String nickname; private String nickname;
} }