// @since 3.1 public abstract class CommandLinePropertySource<T> extends EnumerablePropertySource<T> { // 命令行选项参数 public static final String COMMAND_LINE_PROPERTY_SOURCE_NAME = "commandLineArgs"; // 非选项参数 的名称 public static final String DEFAULT_NON_OPTION_ARGS_PROPERTY_NAME = "nonOptionArgs"; private String nonOptionArgsPropertyName = DEFAULT_NON_OPTION_ARGS_PROPERTY_NAME; // 可以看到若调用者没有指定 会使用这个默认值的~ public CommandLinePropertySource(T source) { super(COMMAND_LINE_PROPERTY_SOURCE_NAME, source); } ... // containsOption和getNonOptionArgs都是抽象方法 @Override public final boolean containsProperty(String name) { // 若你是的name是`nonOptionArgs` 那就是非选项参数中不为空 就是true if (this.nonOptionArgsPropertyName.equals(name)) { return !this.getNonOptionArgs().isEmpty(); } return this.containsOption(name); } @Override @Nullable public final String getProperty(String name) { if (this.nonOptionArgsPropertyName.equals(name)) { Collection<String> nonOptionArguments = this.getNonOptionArgs(); if (nonOptionArguments.isEmpty()) { return null; } else { // 显然非选项参数是多个 最终逗号分隔后再返回 return StringUtils.collectionToCommaDelimitedString(nonOptionArguments); } } // 选项参数使用getOptionValues 若它是一个集合，那就用逗号分隔后再返回 Collection<String> optionValues = this.getOptionValues(name); if (optionValues == null) { return null; } else { return StringUtils.collectionToCommaDelimitedString(optionValues); } } protected abstract boolean containsOption(String name); @Nullable protected abstract List<String> getOptionValues(String name); protected abstract List<String> getNonOptionArgs(); }
选项参数：能够通过如上--server.port=9090这种方式传入的，可以传入多个值或者列表等
非选项参数：我们在命令行传递除了vm参数的所以其它参数。比如我上面写成--server.port=9090 fsx最终的结果如下（非选项参数是个List装载的）
SimpleCommandLinePropertySource
它是我们最为常用的一个属性源之一，source类型为CommandLineArgs：Spring内部使用的一个类。CommandLineArgs内部维护着Map<String, List<String>> optionArgs和List<String> nonOptionArgs来表示整个命令行消息
我们构造使用它只需要把命令行的String[]数组扔进来即可，非常的方便。
public class SimpleCommandLinePropertySource extends CommandLinePropertySource<CommandLineArgs> { // SimpleCommandLineArgsParser解析这个数组。 // 注意：它识别的是--而不是-D public SimpleCommandLinePropertySource(String... args) { super(new SimpleCommandLineArgsParser().parse(args)); } public SimpleCommandLinePropertySource(String name, String[] args) { super(name, new SimpleCommandLineArgsParser().parse(args)); } // 可见最终的source类型是CommandLineArgs类型~~~ // 下面实现最终都委托给CommandLineArgs去处理~ @Override public String[] getPropertyNames() { return StringUtils.toStringArray(this.source.getOptionNames()); } @Override protected boolean containsOption(String name) { return this.source.containsOption(name); } @Override @Nullable protected List<String> getOptionValues(String name) { return this.source.getOptionValues(name); } @Override protected List<String> getNonOptionArgs() { return this.source.getNonOptionArgs(); } }
JOptCommandLinePropertySource
基于JOpt Simple的属性源实现，JOpt Simple是一个解析命令行选项参数的第三方库。它能够自定义格式、从文件中解析等高级操作，处略~
SpringBoot扩展的PropertySource
此处讲到了PropertySource，所以把SpringBoot对它的扩展也一并说说。SpringBoot主要扩展了两个属性源RandomValuePropertySource和AnnotationsPropertySource
RandomValuePropertySource
随机属性源，系统中用到随机数的地方使用它配置非常非常好使，如下：
my.secret=${random.value} my.number=${random.int} my.bignumber=${random.long} my.number.less.than.ten=${random.int(10)} my.number.in.range=${random.int[1024,65536]}
书写配置文件的时候也能得到如下提示：
public class RandomValuePropertySource extends PropertySource<Random> { ... private static final String PREFIX = "random."; // 必须以random.打头 ... private Object getRandomValue(String type) { if (type.equals("int")) { return getSource().nextInt(); } if (type.equals("long")) { return getSource().nextLong(); } String range = getRange(type, "int"); if (range != null) { return getNextIntInRange(range); } range = getRange(type, "long"); if (range != null) { return getNextLongInRange(range); } if (type.equals("uuid")) { return UUID.randomUUID().toString(); } return getRandomBytes(); } ... }
给出一个示例如下：
@Slf4j public class Main { public static void main(String[] args) { // 自定义的一个随机值属性源,起名叫做 myRandom RandomValuePropertySource random = new RandomValuePropertySource("myRandom"); // 随机生成一个整数 log.info("random int:{}", random.getProperty("random.int")); // 随机生成一个整数，指定上边界，不大于等于1 log.info("random int(1):{}", random.getProperty("random.int(1)")); // 随机生成一个整数，指定上边界，不大于等于5 log.info("random int(5):{}", random.getProperty("random.int(5)")); // 随机生成一个整数，使用区间[0,1),前闭后开=>只能是1 // 注意区间的表示法：使用()包围,2个字符 log.info("random int(0,1):{}", random.getProperty("random.int(0,1)")); // 随机生成一个整数，使用区间[1,3),前闭后开=>只能是1或者2 // 注意区间的表示法：使用空格包围,2个字符，前后各一个空格 log.info("random int(1,3):{}", random.getProperty("random.int 1,3 ")); // 随机生成一个整数，使用区间[3,4),前闭后开=>只能是3 // 注意区间的表示法：使用汉字包围,2个字符，前后各一个汉字自负 log.info("random int(3,4):{}", random.getProperty("random.int底3,4顶")); // 随机生成一个整数，使用区间[5,6),前闭后开=>只能是5 // 注意区间的表示法：使用英文字母包围,2个字符，前后各一个英文字母 log.info("random int(5,6):{}", random.getProperty("random.intL5,6U")); // 随机生成一个整数，使用区间[5,6),前闭后开=>只能是5 // 注意区间的表示法：使用数字包围,2个字符，前一个数字5，后一个数字6 log.info("random int(5,6):{}", random.getProperty("random.int55,66")); // 随机生成一个长整数 log.info("random long:{}", random.getProperty("random.long")); // 随机生成一个整数，使用区间[100,101),前闭后开=>只能是100 log.info("random long(100,101):{}", random.getProperty("random.long(100,101)")); // 随机生成一个 uuid log.info("random uuid:{}", random.getProperty("random.uuid")); } }
打印结果：
17:31:56.629 [main] INFO com.fsx.boot1demo1.maintest.Main - random int:-1019461798 17:31:56.648 [main] INFO com.fsx.boot1demo1.maintest.Main - random int(1):0 17:31:56.648 [main] INFO com.fsx.boot1demo1.maintest.Main - random int(5):0 17:31:56.651 [main] INFO com.fsx.boot1demo1.maintest.Main - random int(0,1):0 17:31:56.651 [main] INFO com.fsx.boot1demo1.maintest.Main - random int(1,3):1 17:31:56.651 [main] INFO com.fsx.boot1demo1.maintest.Main - random int(3,4):3 17:31:56.651 [main] INFO com.fsx.boot1demo1.maintest.Main - random int(5,6):5 17:31:56.651 [main] INFO com.fsx.boot1demo1.maintest.Main - random int(5,6):5 17:31:56.652 [main] INFO com.fsx.boot1demo1.maintest.Main - random long:-7444646397347920224 17:31:56.653 [main] INFO com.fsx.boot1demo1.maintest.Main - random long(100,101):100 17:31:57.035 [main] INFO com.fsx.boot1demo1.maintest.Main - random uuid:77d0c3e1-ae05-41e3-ba8d-6c168c1b9a3c
AnnotationsPropertySource
关于这个注解属性源，它需要结合@PropertyMapping一起使用，稍微稍微复杂点，这个我把它放在SpringBoot章节中进行详细讲解~
PropertySources
从命名中就可以看出，它是PropertySource的一个复数形式，但是它是接口而不是抽象类。
它如同一个容器可以包含一个或者多个PropertySource（姑且可粗暴的把它理解成一个Collection）
public interface PropertySources extends Iterable<PropertySource<?>> { // @since 5.1 注意这个default方法是5.1后才有的 方便遍历和流式操作 default Stream<PropertySource<?>> stream() { return StreamSupport.stream(spliterator(), false); } // 注意这个name指的是PropertySource的name属性~ boolean contains(String name); // 根据name找到一个PropertySource~~~没找到返回null @Nullable PropertySource<?> get(String name); }
Spring仅为我们提供一个实现类：MutablePropertySources
