SpringBoot是怎么实现在配置文件的随机数的?

简介: 随机数的使用你是不是经常用到?我们在进行运行`SpringBoot`单元测试时一般不会指定应用程序启动时的`端口号`,可以在`application.properties`文件内配置`server.port`的值为`${random.int(10000)}`,代表了随机使用`0~10000`的端口号。

随机数的使用你是不是经常用到?我们在进行运行SpringBoot单元测试时一般不会指定应用程序启动时的端口号,可以在application.properties文件内配置server.port的值为${random.int(10000)},代表了随机使用0~10000的端口号。

既然这种方式使用这么方便,那你知道${random.int}是通过什么方式实现的吗?

推荐阅读

概述

配置文件方式

在我们分析源码之前,我们先来看看${random.xxx}具体提供了哪几种的随机配置。

int随机数

使用${random.int}方式配置,结果从int的最大值、最小值中间产生,int的最小值为-2147483648,最大值为2147483647,配置如下所示:

server:
  port: ${random.int}

int范围随机数

使用${random.int(10000)}方式配置,这种方式我们可以指定随机数的最大值,当然不能超过2147483647,配置如下所示:

server:
  port: ${random.int(10000)}
注意事项: ${random.int(10000)}随机数的值将会在 0~10000之间产生,配置的 最大值必须为正整数

如果需要指定随机数的最小值,可以使用${random.int[100,200]}方式配置,这样只会从100~200之间产生随机数(包括最小值,不包括最大值)。

long随机数

使用${random.long}方式配置,结果会从long的最大值、最小值中间产生,long的最小值为-9223372036854775808,最大值为9223372036854775807,配置方式如下所示:

config:
  longValue: ${random.long}

long范围随机数

使用${random.long(10000)}方式配置,我们可以指定0~9223372036854775807之间的任意数值作为随机的最大上限,配置方式如下所示:

config:
  maxLongValue: ${random.long(102400)}
如果需要指定最小值,可以使用 ${random.long[1024,2048]}方式配置,这样只会从 1024~2048中产生随机数(包括最小值,不包括最大值)。

uuid随机数

uuid因为它的唯一性,应该是我们平时开发中比较常用到的。

SpringBoot也为我们考虑到了这一点,我们只需要使用${random.uuid}就可以获得一个随机的uuid字符串,配置方式如下所示:

config:
  uuid: ${random.uuid}

@Value方式

如果在我们在编码中需要用到随机数的生成,${random}是支持注入使用的,主要还是因为它的实现继承自PropertySource

我们可以在Spring IOC所管理的类内直接使用@Value注解进行注入使用,如下所示:

/**
 * 随机生成uuid字符串
 */
@Value("${random.uuid}")
private String uuid;
/**
 * 随机生成0~1000的正整数
 */
@Value("${random.int(1000)}")
private int maxInt;
/**
 * 随机生成0~102400的long类型数值
 */
@Value("${random.long(102400)}")
private long maxLong;

源码解析

我们之所以可以这么方便的使用随机数,都归功于SpringBoot为我们提供了一个名为RandomValuePropertySourcePropertySource实现类,该实现类位于org.springframework.boot.env包内,该类部分源码如下所示:

/**
 * {@link PropertySource} that returns a random value for any property that starts with
 * {@literal "random."}. Where the "unqualified property name" is the portion of the
 * requested property name beyond the "random." prefix, this {@link PropertySource}
 * ...
 */
public class RandomValuePropertySource extends PropertySource<Random> {

  private static final String PREFIX = "random.";

  private static final Log logger = LogFactory.getLog(RandomValuePropertySource.class);

  @Override
  public Object getProperty(String name) {
    // 仅处理random.开头的配置
    if (!name.startsWith(PREFIX)) {
      return null;
    }
    if (logger.isTraceEnabled()) {
      logger.trace("Generating random property for '" + name + "'");
    }
    // 获取数据数,将random.后的内容作为类型参数传递到getRandomValue方法
    return getRandomValue(name.substring(PREFIX.length()));
  }
  
  private Object getRandomValue(String type) {
    // 处理random.int类型的随机数
    if (type.equals("int")) {
      return getSource().nextInt();
    }
    // 处理random.long类型的随机数
    if (type.equals("long")) {
      return getSource().nextLong();
    }
    // 处理random.int(100)类型的随机数
    String range = getRange(type, "int");
    if (range != null) {
      // 生成有范围的int类型随机数
      return getNextIntInRange(range);
    }
    // 处理random.long(1024)类型的随机数
    range = getRange(type, "long");
    if (range != null) {
      // 生成有范围的long类型随机数
      return getNextLongInRange(range);
    }
    // 处理random.uuid类型的随机数
    if (type.equals("uuid")) {
      // 生成随机的uuid返回
      return UUID.randomUUID().toString();
    }
    // 默认返回随机字节
    return getRandomBytes();
  }

  private String getRange(String type, String prefix) {
    if (type.startsWith(prefix)) {
      int startIndex = prefix.length() + 1;
      if (type.length() > startIndex) {
        return type.substring(startIndex, type.length() - 1);
      }
    }
    return null;
  }

  private int getNextIntInRange(String range) {
    String[] tokens = StringUtils.commaDelimitedListToStringArray(range);
    int start = Integer.parseInt(tokens[0]);
    if (tokens.length == 1) {
      return getSource().nextInt(start);
    }
    return start + getSource().nextInt(Integer.parseInt(tokens[1]) - start);
  }

  private long getNextLongInRange(String range) {
    String[] tokens = StringUtils.commaDelimitedListToStringArray(range);
    if (tokens.length == 1) {
      return Math.abs(getSource().nextLong() % Long.parseLong(tokens[0]));
    }
    long lowerBound = Long.parseLong(tokens[0]);
    long upperBound = Long.parseLong(tokens[1]) - lowerBound;
    return lowerBound + Math.abs(getSource().nextLong() % upperBound);
  }
}

当我们使用${random.xxx}这种方式获取随机数时,无论是配置文件方式还是@Value方式都会通过org.springframework.boot.env.RandomValuePropertySource#getProperty方法来获取对应类型的随机数。

注意事项: RandomValuePropertySource在继承 PropertySource时泛型类型为 Randomjava.util.Random类内包含了全部的随机生成逻辑,该类由 java提供,有兴趣可以研究下源码。

总结

SpringBoot内的配置都是通过ConfigurablePropertyResolver属性配置解析器来获取的,而该类的实例化在AbstractEnvironment内,我们通过AbstractEnvironment#getProperty(java.lang.String)方法可以获取由多个PropertySource实现类提供的属性配置。

相关文章
|
运维 Java 程序员
SpringBoot配置文件优先级
其实上述4种文件是提供给你了4种配置文件书写的位置,功能都是一样的,都是做配置的。总体上来说,4种配置文件如果都存在的话,有一个优先级的问题,说白了就是加入4个文件我都有,里面都有一样的配置,谁生效的问题。两个配置文件共存,因为config目录中的配置加载优先级比你的高,所以配置项如果和级别4里面的内容相同就覆盖了,这样是不是很简单?场景A:你作为一个开发者,你做程序的时候为了方便自己写代码,配置的数据库肯定是连接你自己本机的,咱们使用4这个级别,也就是之前一直用的application.yml。...
237 0
|
Java Nacos Spring
《SpringBoot系列二》:配置文件加载优先级(含服务注册中心nacos)
《SpringBoot系列二》:配置文件加载优先级(含服务注册中心nacos)
1495 0
《SpringBoot系列二》:配置文件加载优先级(含服务注册中心nacos)
|
JSON Java 数据格式
【SpringBoot】配置文件的加载与属性值的绑定
【SpringBoot】配置文件的加载与属性值的绑定
【SpringBoot】配置文件的加载与属性值的绑定
|
监控 安全 Java
《SpringBoot启动流程三》:两万+字图文带你debug源码分析SpringApplication准备阶段(含配置文件加载时机、日志系统初始化时机)
《SpringBoot启动流程三》:两万+字图文带你debug源码分析SpringApplication准备阶段(含配置文件加载时机、日志系统初始化时机)
317 0
《SpringBoot启动流程三》:两万+字图文带你debug源码分析SpringApplication准备阶段(含配置文件加载时机、日志系统初始化时机)
|
Java Spring
《SpringBoot系列四》:@Value注解从配置文件中读取数组/集合(@Value设置默认值)
《SpringBoot系列四》:@Value注解从配置文件中读取数组/集合(@Value设置默认值)
2497 0
《SpringBoot系列四》:@Value注解从配置文件中读取数组/集合(@Value设置默认值)
|
JSON 前端开发 Java
《SpringBoot系列一》:yaml配置文件各种数据类型使用姿势(含@EnableConfigurationProperties、@ConfigurationProperties)
《SpringBoot系列一》:yaml配置文件各种数据类型使用姿势(含@EnableConfigurationProperties、@ConfigurationProperties)
1270 0
《SpringBoot系列一》:yaml配置文件各种数据类型使用姿势(含@EnableConfigurationProperties、@ConfigurationProperties)
|
Java 测试技术 数据库连接
springboot原理实战(6)--配置文件注入集合,动态注入,切换profile环境
springboot原理实战(6)--配置文件注入集合,动态注入,切换profile环境
362 0
springboot原理实战(6)--配置文件注入集合,动态注入,切换profile环境
|
Java 关系型数据库 MySQL
springboot原理实战(5)-配置文件操作
springboot原理实战(5)-配置文件操作
228 0
springboot原理实战(5)-配置文件操作
|
XML Java 应用服务中间件
SpringBoot项目知识点,配置文件
SpringBoot项目知识点,配置文件
113 0
SpringBoot项目知识点,配置文件
|
Java
SpringBoot配置文件application
SpringBoot配置文件application
93 2
下一篇
无影云桌面