spring boot中自定义properties文件并获取内容

最近项目中使用到了spring boot，这次带来点关于spring boot中properties文件的使用方法

 

首先你可以定义一个properties文件，如下所示：

// 文件名可以自行定义，这里名为uploaddefine.properties
upload.image[JPG]=.jpg
upload.image[PNG]=.png
upload.office[CSV]=.csv
upload.office[EXCEL]=.excel
upload.text[txt]=.txt
upload.text[epub]=.epub

在这个文件中，我们定义了三个大类，分别为image、office、text

我们的目标是能够让程序自动读取我们定义的文件内容，下面是具体实现。

 

首先，在类上要表明的注解为：

@Configuration
@ConfigurationProperties(prefix = "upload")
@PropertySource("classpath:uploaddefine.properties")
public class UploadDefineConfig {
      omitted......
}

 这样一来就能是程序自动读取我们的配置文件，

@ConfigurationProperties(prefix = "upload")：读取前缀为 upload 的内容

@PropertySource("classpath:uploaddefine.properties")：定义了要读取的properties文件的位置

 

接下来就需要将内容读到我们事先定义好了的集合中了：

public static Map<String, String> image = new HashMap<>();
public static Map<String, String> office = new HashMap<>();
public static Map<String, String> text = new HashMap<>();

//注意需要添加get/set方法，并且这两个方法不能为static 

我们将Map定义为了static是为了方便使用，你也可以使用非静态形式的。

 

请注意，我们将每一个Map对象的名字定义成了properties中prefix之后的名字，只有这样才能够让程序自动将properties文件的内容添加到我们的Map对象之中。

 

此时，我们的自定义properties文件就大功告成了！快点来试一下吧！

我们通过一个http请求来获取这些内容，下面是返回的结果：

{
    "image": {
        "JPG": ".jpg",
        "PNG": ".png"
    },
    "office": {
        "EXCEL": ".excel",
        "CSV": ".csv"
    },
    "text": {
        "txt": ".txt",
        "epub": ".epub"
    }
}

 可以看到我们的内容已经成功的被读取出来了，很简单吧

 

如果你不想用这种K-V形式，而是直接一个List<String>获取所有的值的话，也很简单

只要在properties中这样定义即可：

my.servers[0]=127.0.0.1:8080
my.servers[1]=127.0.0.1:8081
my.servers[2]=127.0.0.1:8082

// 在class文件中，则需要这样
public static List<String> servers = new ArrayList<>();

 

对于中小型的项目，十分推荐spring boot，远离配置地狱

评论

2 楼 thbcd 2017-05-16  

PropertySource注解是Spring框架本来就有的 不关Boot的事 再说既然用了Boot 那为什么不把所有配置都写到application.yml里边呢

1 楼 k88520 2016-11-25  

适用于1.4.0以下的版本