springboot源码分析9-random的使用以及原理

摘要：springboot框架为我们提供了很多的便利，其中有一个非常有意思的功能，那就是可以通过变量的方式来配置一个随机数random，然后使用random随机出各式各样数值。本位重点讲解一下random的使用以及框架内部的实现机制。

1.1. Springboot中random的使用

首先我们定义一个配置类，如下所示：

1 @Component

2 public class Config {

3  @Value("${random.value}")

4  private String value;

5  @Value("${random.int}")

6  private int randomInt;

7  @Value("${random.long}")

8  private long randomLong;

9  @Value("${random.uuid}")

10  private String randomuuid;

11  @Value("${random.int(10)}")

12  private int randomInt1;

13  @Value("${random.int[1024,65536]}")

14  private int randomIntRange;

15 

16  @Override

17  public String toString() {

18  return "Config [value=" + value + ", randomInt=" + randomInt + ", randomLong=" + randomLong + ", randomuuid="

19  + randomuuid + ", randomInt1=" + randomInt1 + ", randomIntRange=" + randomIntRange + "]";

20  }

21 }

上述类中我们配置的与random相关的表达式有：

random.value返回值是string类型；random.int返回值是int类型;random.long返回值是long类型;random.uuid返回值是string类型;random.random.int(10)返回值是int类型;random.int[1024,65536]返回值是int类型。

紧接着，我们书写一个springboot启动类并打印Config类。示例代码如下：

1 @SpringBootApplication

2 public class DemoApplication {

3  public static void main(String[] args) {

4  BainuoSpringApplication springApplication = new BainuoSpringApplication(DemoApplication.class);

5  ConfigurableApplicationContext configurableApplicationContext = springApplication.run(args);

6  Config config = configurableApplicationContext.getBean(Config.class);

7  System.out.println(config.toString());

8  }

9 }

运行上述类，程序的输出如下：

Config [value=d4143e016f2f89527af9290cdc5faf8d, randomInt=-1397177543, randomLong=-5400484272385792469, randomuuid=113b3970-ac05-4a31-8a6c-1145ee55b9f9, randomInt1=2, randomIntRange=36897]

 

1.2. Springboot中random内部实现机制

上述我们讲解了random的各种使用方式，心中不免有个疑惑。Springboot是如何处理这些random的呢？我们又该如何更好的使用呢？正所谓知其然，还要知其所以然。前面的系列文章中，我们详细讲解了环境属性的相关知识点，其中PropertySource类有一个子类RandomValuePropertySource，该类正是处理上文我们使用的random的。我们来快速学习下该类，示例代码如下：

1 public class RandomValuePropertySource extends PropertySource {

2  public static final String RANDOM_PROPERTY_SOURCE_NAME = "random";

3  private static final String PREFIX = "random.";

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

5  public RandomValuePropertySource(String name) {

6  super(name, new Random());

7  }

8  public RandomValuePropertySource() {

9  this(RANDOM_PROPERTY_SOURCE_NAME);

10  }

11  @Override

12 

13  private Object getRandomValue(String type) {

14  if (type.equals("int")) {

15  return getSource().nextInt();

16  }

17  if (type.equals("long")) {

18  return getSource().nextLong();

19  }

20  String range = getRange(type, "int");

21  if (range != null) {

22  return getNextIntInRange(range);

23  }

24  range = getRange(type, "long");

25  if (range != null) {

26  return getNextLongInRange(range);

27  }

28  if (type.equals("uuid")) {

29  return UUID.randomUUID().toString();

30  }

31  return getRandomBytes();

32  }

33 

34  private String getRange(String type, String prefix) {

35  if (type.startsWith(prefix)) {

36  int startIndex = prefix.length() + 1;

37  if (type.length() > startIndex) {

38  return type.substring(startIndex, type.length() - 1);

39  }

40  }

41  return null;

42  }

43 

44  private int getNextIntInRange(String range) {

45  String[] tokens = StringUtils.commaDelimitedListToStringArray(range);

46  int start = Integer.parseInt(tokens[0]);

47  if (tokens.length == 1) {

48  return getSource().nextInt(start);

49  }

50  return start + getSource().nextInt(Integer.parseInt(tokens[1]) - start);

51  }

52 

53  private long getNextLongInRange(String range) {

54  String[] tokens = StringUtils.commaDelimitedListToStringArray(range);

55  if (tokens.length == 1) {

56  return Math.abs(getSource().nextLong() % Long.parseLong(tokens[0]));

57  }

58  long lowerBound = Long.parseLong(tokens[0]);

59  long upperBound = Long.parseLong(tokens[1]) - lowerBound;

60  return lowerBound + Math.abs(getSource().nextLong() % upperBound);

61  }

62 

63  private Object getRandomBytes() {

64  byte[] bytes = new byte[32];

65  getSource().nextBytes(bytes);

66  return DigestUtils.md5DigestAsHex(bytes);

67  }

68 

69  public static void addToEnvironment(ConfigurableEnvironment environment) {

70  environment.getPropertySources().addAfter(

71  StandardEnvironment.SYSTEM_ENVIRONMENT_PROPERTY_SOURCE_NAME,

72  new RandomValuePropertySource(RANDOM_PROPERTY_SOURCE_NAME));

73  logger.trace("RandomValuePropertySource add to Environment");

74  }

75 

76 }

下面重点讲解一下getProperty方法，该方法的处理逻辑非常的简单，首先判断需要获取的变量是否是以random开头的，如果是则开始调用getRandomValue方法进行处理，并截取random.这个字符串。示例代码如下：

1  public Object getProperty(String name) {

2  if (!name.startsWith(PREFIX)) {

3  return null;

4  }

5  return getRandomValue(name.substring(PREFIX.length()));

6  }

比如上文的${random.value}，在这里处理之后，传递给getRandomValue方法的参数值是value；同理${random.int}在这里处理之后，传递给getRandomValue方法的参数值是int。好了，继续看getRandomValue方法吧，该方法内部实现中，会调用类似getSource方法，该方法返回值正式Random实例对象。示例代码如下：

1 public RandomValuePropertySource(String name) {

2  super(name, new Random());

3  }

了解了这些之后，getRandomValue方法的处理逻辑就非常简单了，总结梳理如下：

1. 如果是int则直接调用调用new Random().nextInt()。

2. 如果是long则直接调用调用new Random().nextLong()。

3. 如果是int或者long范围的则首先通过getRange获取到区间，然后还是调用new Random()中的区间随机数生成方法。

4. 如果是uuid则直接调用调用UUID.randomUUID().toString()。

5. 如果没有识别出来，则直接调用getRandomBytes生成一个字符串。

RandomValuePropertySource类的处理非常的简单而且经典，只要用一定的java基础均可以看明白。大家下去一步步debug即可看到起内部处理逻辑。但是这个类是怎么注入到当前springboot运行环境的呢？相信很多人有这样的疑问？这个涉及到了Springboot中的监听器使用，我们后续文章再来展开说明。

---

欢迎关注我的微信公众号，第一时间获得博客更新提醒，以及更多成体系的Java相关原创技术干货。 
扫一扫下方二维码或者长按识别二维码，即可关注。