java 对对象操作

Posted 2022-11-26 IT的鱼

/*
 * Copyright (c) Huawei Technologies Co., Ltd. 2021-2021. All rights reserved.
 */

package com.huawei.it.util.util;

import com.huawei.it.jalor5.core.exception.ApplicationException;
import com.huawei.it.util.excetion.BizApplicationException;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.concurrent.atomic.AtomicReference;
import java.util.function.Predicate;

/**
 * 功能描述：对象操作工具类
 *
 * @author YaoJiang-wx1047757
 * @since 2021-06-28
 */
public class ObjectUtils 
    /**
     * 功能描述：获取一个需要不为Null的对象
     * 如果传入的对象为Null，则通过Supplier生成自定义的对象
     *
     * @author YaoJiang-wx1047757
     * @since 2021-06-28
     * @param obj 期望不为Null的对象
     * @param supplier 自定义对象生产者
     * @return T 用户预期范围内的对象
     * @throws ApplicationException 自定义对象生成过程中可能抛出异常
     */
    public static <T> T requireNotNull(T obj, Supplier<T> supplier) throws ApplicationException 
        return obj == null ? supplier.get() : obj;
    

    /**
     * 功能描述：获取一个需要不为Null的对象
     * 如果传入的对象为Null，则抛出异常
     *
     * @author YaoJiang-wx1047757
     * @since 2021-06-29
     * @param obj 期望不为Null的对象
     * @param errorMsg 如果为Null时抛出的异常信息
     * @return T 用户期望得到的非Null对象
     * @throws ApplicationException 传入对象为Null时抛出该异常
     */
    public static <T> T requireNotNull(T obj, String errorMsg) throws ApplicationException 
        return requireNotNull(obj, () -> 
            throw new BizApplicationException(errorMsg);
        );
    

    /**
     * 功能描述：获取一个需要不为Null且不为空的字符串
     * 如果传入的字符串为Null或者为空，则通过Supplier生成自定义的对象
     *
     * @author YaoJiang-wx1047757
     * @since 2021-06-28
     * @param str 期望不为Null且不为空的字符串
     * @param supplier 自定义字符串生产者
     * @return java.lang.String 用户预期范围内的字符串
     * @throws ApplicationException 自定义对象生成过程中可能抛出异常
     */
    public static String requireNotEmpty(String str, Supplier<String> supplier) throws ApplicationException 
        return str == null || "".equals(str) ? supplier.get() : str;
    

    /**
     * 功能描述：获取一个需要不为Null且不为空的字符串
     * 如果传入的字符串为Null或者为空，则抛出异常
     *
     * @author YaoJiang-wx1047757
     * @since 2021-06-29
     * @param str 期望不为Null且不为空的字符串
     * @param errorMsg 当字符串为Null或为空时抛出的异常信息
     * @return java.lang.String 用户期望得到的非Null且非空字符串
     * @throws ApplicationException 传入的字符串为Null或为空时抛出的异常
     */
    public static String requireNotEmpty(String str, String errorMsg) throws ApplicationException 
        return requireNotEmpty(str, () -> 
            throw new BizApplicationException(errorMsg);
        );
    

    /**
     * 功能描述：获取一个不为Null且不为空的集合
     * 如果传入的集合为Null或者为空，则通过Supplier生成自定义的对象
     *
     * @author YaoJiang-wx1047757
     * @since 2021-06-28
     * @param collection 期望不为Null且不为空的集合
     * @param supplier 自定义集合生产者
     * @return C 用户预期范围内的集合
     * @throws ApplicationException 自定义对象生成过程中可能抛出异常
     */
    public static <T extends Collection> T requireNotEmpty(
            T collection, Supplier<T> supplier) throws ApplicationException 
        return collection == null || collection.isEmpty() ? supplier.get() : collection;
    

    /**
     * 功能描述：获取一个不为Null且不为空的集合
     * 如果传入的集合为Null或者为空，则抛出异常
     *
     * @author YaoJiang-wx1047757
     * @since 2021-06-29
     * @param collection 期望不为Null且不为空的集合
     * @param errorMsg 集合为Null或者为空时抛出的异常
     * @return T 用户期望得到的非Null且非空的集合
     * @throws ApplicationException 传入的集合为Null或者为空时抛出的异常
     */
    public static <T extends Collection> T requireNotEmpty(T collection, String errorMsg) throws ApplicationException 
        return requireNotEmpty(collection, () -> 
            throw new BizApplicationException(errorMsg);
        );
    

    /**
     * 功能描述：如果传入的对象不为Null，则调用传入的函数执行处理
     *
     * @author YaoJiang-wx1047757
     * @since 2021-06-29
     * @param obj 执行非Null判断的对象
     * @param consumer 传入对象非Null时的后续逻辑
     * @throws ApplicationException 执行后续逻辑时可能抛出该异常
     */
    public static <T> void ifPresent(T obj, Consumer<T> consumer) throws ApplicationException 
        boolean condition = obj != null;
        ifTrue(condition, obj, consumer);
    

    /**
     * 功能描述：如果传入的字符串不为Null且不为空，则调用传入的函数执行处理
     *
     * @author YaoJiang-wx1047757
     * @since 2021-06-29
     * @param str 执行非Null且非空判断的字符串
     * @param consumer 传入字符串非Null且非空时的后续逻辑
     * @throws ApplicationException 执行后续逻辑时可能抛出该异常
     */
    public static void ifPresent(String str, Consumer<String> consumer) throws ApplicationException 
        boolean condition = str != null && !"".equals(str);
        ifTrue(condition, str, consumer);
    

    /**
     * 功能描述：如果传入的集合不为Null且不为空，则调用传入的函数执行处理
     *
     * @author YaoJiang-wx1047757
     * @since 2021-06-29
     * @param collection 执行非Null且非空判断的集合
     * @param consumer 传入集合非Null且非空时的后续逻辑
     * @throws ApplicationException 执行后续逻辑时可能抛出该异常
     */
    public static <E, T extends Collection<E>> void ifPresent(
            T collection, Consumer<T> consumer) throws ApplicationException 
        boolean condition = collection != null && !collection.isEmpty();
        ifTrue(condition, collection, consumer);
    

    /**
     * 功能描述：获取传入集合的第一个元素，如果传入的集合为Null或为空则返回Null
     *
     * @author YaoJiang-wx1047757
     * @since 2021-06-29
     * @param collection 需要获取第一个元素的集合
     * @return E 集合的第一个元素或Null
     * @throws ApplicationException 获取第一个元素的过程中可能抛出异常
     */
    public static <E, T extends Collection<E>> E findFirst(T collection) throws ApplicationException 
        AtomicReference<E> item = new AtomicReference<>();
        boolean condition = collection != null && !collection.isEmpty();
        ifTrue(condition, collection, collect -> item.set(collect.iterator().next()));
        return item.get();
    

    /**
     * 功能描述：获取传入集合的第一个元素，如果传入的集合为Null或为空则抛出异常
     *
     * @author YaoJiang-wx1047757
     * @since 2021-06-29
     * @param collection 需要获取第一个元素的集合
     * @param errorMsg 集合为Null或为空时抛出的异常信息
     * @return E 集合的第一个元素（非Null）
     * @throws ApplicationException 集合为Null或者为空时抛出异常
     */
    public static <E, T extends Collection<E>> E findFirst(
            T collection, String errorMsg) throws ApplicationException 
        return requireNotEmpty(collection, errorMsg).iterator().next();
    

    /**
     * 功能描述：在传入的集合中获取符合条件的元素列表
     *
     * @author YaoJiang-wx1047757
     * @since 2021-06-29
     * @param collection 需要执行过滤操作的集合
     * @param predicate 过滤条件
     * @return java.util.List<E> 过滤后得到的元素列表
     * @throws ApplicationException 数据筛选过程可能抛出异常
     */
    public static <E, T extends Collection<E>> List<E> find(
            T collection, Predicate<E> predicate) throws ApplicationException 
        List<E> resultList = new ArrayList<>();
        ifPresent(collection, collect -> 
            for (E next : collect) 
                ifTrue(predicate.test(next), next, resultList::add);
            
        );
        return resultList;
    

    /**
     * 功能描述：如果指定的条件成立，则调用传入的函数执行处理
     *
     * @author YaoJiang-wx1047757
     * @since 2021-06-29
     * @param condition 条件
     * @param obj 对象消费者的入参
     * @param consumer 条件成立时的后续逻辑
     * @throws ApplicationException 执行后续逻辑时可能抛出异常
     */
    private static <T> void ifTrue(boolean condition, T obj, Consumer<T> consumer) throws ApplicationException 
        if (condition) 
            consumer.consume(obj);
        
    

    /**
     * 功能描述：对象提供者接口
     *
     * @author YaoJiang-wx1047757
     * @since 2021-06-28
     */
    public interface Supplier<T> 
        /**
         * 功能描述：获取指定的对象，方法内部自定义对象获取逻辑
         *
         * @author YaoJiang-wx1047757
         * @since 2021-06-28
         * @return T 返回用户期望的对象
         * @throws ApplicationException 获取对象的过程中可抛出该异常
         */
        T get() throws ApplicationException;
    

    /**
     * 功能描述：对象消费者接口
     *
     * @author YaoJiang-wx1047757
     * @since 2021-06-29
     */
    public interface Consumer<T> 
        /**
         * 功能描述：对传入的对象进行相应处理
         *
         * @author YaoJiang-wx1047757
         * @since 2021-06-29
         * @param obj 需要进行处理的对象
         * @throws ApplicationException 对象处理过程中可能抛出该异常
         */
        void consume(T obj) throws ApplicationException;