Springboot 之 自定义配置文件及读取配置文件

时间：2025-02-13 22:51:18

本文章来自【知识林】

读取核心配置文件

核心配置文件是指在resources根目录下的或配置文件，读取这两个配置文件的方法有两种，都比较简单。

核心配置文件内容如下：

=9090

=Hello World Springboot!
  • 使用@Value方式（常用）：
@RestController
public class WebController {

    @Value("${}")
    private String msg;

    @RequestMapping(value = "index", method = )
    public String index() {
        return "The Way 1 : " +msg;
    }
}

注意：在@Value的${}中包含的是核心配置文件中的键名。在Controller类上加@RestController表示将此类中的所有视图都以JSON方式显示，类似于在视图方法上加@ResponseBody。

访问：http://localhost:9090/index 时将得到The Way 1 : Hello World Springboot!

  • 使用Environment方式
@RestController
public class WebController {

    @Autowired
    private Environment env;

    @RequestMapping(value = "index2", method = )
    public String index2() {

        return "The Way 2 : " + ("");
    }
}

注意：这种方式是依赖注入Evnironment来完成，在创建的成员变量private Environment env上加上@Autowired注解即可完成依赖注入，然后使用("键名")即可读取出对应的值。

访问：http://localhost:9090/index2 时将得到The Way 2 : Hello World Springboot!

读取自定义配置文件

为了不破坏核心文件的原生态，但又需要有自定义的配置信息存在，一般情况下会选择自定义配置文件来放这些自定义信息，这里在resources/config目录下创建配置文件

resources/config/内容如下：

=zslin
=V 1.0
=393156105@
创建管理配置的实体类：
@ConfigurationProperties(locations = "classpath:config/", prefix = "web")
@Component
public class MyWebConfig {

    private String name;

    private String version;

    private String author;

    public String getAuthor() {
        return author;
    }

    public String getName() {
        return name;
    }

    public String getVersion() {
        return version;
    }

    public void setAuthor(String author) {
        this.author = author;
    }

    public void setName(String name) {
        this.name = name;
    }

    public void setVersion(String version) {
        this.version = version;
    }
}

注意：

  • 在@ConfigurationProperties注释中有两个属性：

    • locations：指定配置文件的所在位置
    • prefix：指定配置文件中键名称的前缀（我这里配置文件中所有键名都是以web.开头）

  • 使用@Component是让该类能够在其他地方被依赖使用，即使用@Autowired注释来创建实例。

创建测试Controller
@RestController
@RequestMapping(value = "config")
public class ConfigController {

    @Autowired
    private MyWebConfig myWebConfig;

    @RequestMapping(value = "index", method = )
    public String index() {
        return "webName: "+()+", webVersion: "+
                ()+", webAuthor: "+();
    }
}

注意：由于在MyWebConfig类上加了注释@Component，所以可以直接在这里使用@Autowired来创建其实例对象。

访问：http://localhost:9090/config/index 时将得到webName: zslin, webVersion: V 1.0, webAuthor: 393156105@

示例代码：/zsl131/spring-boot-test/tree/master/study02

本文章来自【知识林】

相关文章