com.github.hugh.util.RandomUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of toolbox Show documentation
The newest version!
package com.github.hugh.util;


import com.github.hugh.exception.ToolboxException;

import java.security.NoSuchAlgorithmException;
import java.security.SecureRandom;
import java.util.List;
import java.util.Random;
import java.util.concurrent.ThreadLocalRandom;

/**
 * 随机工具类
 *
 * @author hugh
 * @since 1.0.4
 */
public class RandomUtils {
    private RandomUtils() {
    }

    /**
     * 用于随机选的数字
     */
    private static final String BASE_NUMBER = "0123456789";

    /**
     * 用于随机选的字符
     */
    private static final String BASE_CHAR = "abcdefghijklmnopqrstuvwxyz";

    /**
     * 用于随机选的字符和数字
     */
    private static final String BASE_CHAR_NUMBER = BASE_CHAR + BASE_NUMBER;

    /**
     * 获取随机数生成器对象

     * ThreadLocalRandom是JDK 7之后提供并发产生随机数，能够解决多个线程发生的竞争争夺。
     *
     * @return {@link ThreadLocalRandom}
     */
    public static ThreadLocalRandom getRandom() {
        return ThreadLocalRandom.current();
    }

    /**
     * 获取{@link SecureRandom}，类提供加密的强随机数生成器 (RNG)
     *
     * @return {@link SecureRandom}
     */
    public static SecureRandom getSecureRandom() {
        try {
            return SecureRandom.getInstance("SHA1PRNG");
        } catch (NoSuchAlgorithmException e) {
            throw new ToolboxException(e);
        }
    }

    /**
     * 获取随机数产生器
     *
     * @param isSecure 是否为强随机数生成器 (RNG)
     * @return {@link Random}
     * @see #getSecureRandom()
     * @see #getRandom()
     */
    public static Random getRandom(boolean isSecure) {
        return isSecure ? getSecureRandom() : getRandom();
    }

    /**
     * 随机的字符
     *
     * @param length 长度
     * @return 随机的数字
     */
    public static String randomChar(final int length) {
        return randomString(BASE_CHAR, length);
    }

    /**
     * 随机一个字符串的数字
     * 该方法返回为字符串类型数字
     * 注：当长度为2时、会产生01这种长度的数字字符串
     *
     * @param length 长度
     * @return String 随机的数字
     */
    public static String randomNumber(final int length) {
        return randomString(BASE_NUMBER, length);
    }

    /**
     * 根据需要的数字长度来生成随机数
     * 由于{@link RandomUtils#randomNumber} 会生成补0的两位随机数 例：04,但该方法只会生成对应长度的int数
     * 注：该方法内部生成随机数时,如果首字母为0在转换为int时会自动忽略,导致返回的int长度与传参不一致,
     * 所以在循环结束后,判断首字符是否为0，是0则进行递归调用直至达到对应长度的随机数
     *
     * @param length 随机数长度
     * @return int 随机数
     */
    public static int number(int length) {
        var stringBuilder = new StringBuilder();
        for (var i = 0; i < length; i++) {
            var number = ThreadLocalRandom.current().nextInt(10);//随机生成0-9的数字
            stringBuilder.append(number);
        }
        return stringBuilder.charAt(0) == '0' ? number(length) : Integer.parseInt(stringBuilder.toString());
    }

    /**
     * 随机指定长度的字符串
     * 结果包含字符和数字
     *
     * @param length 长度
     * @return String 随机的字符串
     */
    public static String randomString(final int length) {
        return randomString(BASE_CHAR_NUMBER, length);
    }

    /**
     * 获得一个随机的字符串
     *
     * @param baseString 随机字符选取的样本
     * @param length     字符串的长度
     * @return 随机字符串
     */
    public static String randomString(String baseString, int length) {
        final var stringBuilder = new StringBuilder();
        if (length < 1) {
            length = 1;
        }
        int baseLength = baseString.length();
        for (var i = 0; i < length; i++) {
            var number = ThreadLocalRandom.current().nextInt(baseLength);
            stringBuilder.append(baseString.charAt(number));
        }
        return stringBuilder.toString();
    }

    /**
     * 随机选择列表中的一个元素
     *
     * @param list 列表
     * @param   泛型
     * @return 结果
     */
    public static  T random(final List list) {
        if (ListUtils.isEmpty(list)) {
            return null;
        }
        final int size = list.size();
        final Random random = ThreadLocalRandom.current();
        var index = random.nextInt(size);
        return list.get(index);
    }
}