spring-boot 速成自定义配置

Posted 2020-09-11 菩提树下的杨过

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了spring-boot 速成自定义配置相关的知识，希望对你有一定的参考价值。

spring-boot 提供了很多默认的配置项，但是开发过程中，总会有一些业务自己的配置项，下面示例了，如何添加一个自定义的配置：

一、写一个自定义配置的类

package com.example.config;
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

/**
 * Created by 菩提树下的杨过 on 2017/4/15.
 */
@Data
@Component
@ConfigurationProperties(prefix = "web.config")
public class WebConfig {
    private String webTitle;
    private String authorName;
    private String authorBlogUrl;
}

注意上面的注解@ConfigurationProperties(prefix = "web.config")，这表示这个类将从属性文件中读取web.config开头的属性值

二、在application.yml中配置属性

spring-boot支持properties及yml格式，不过推荐大家使用新的yml格式，看上去更清晰

web:
  config:
    webTitle: "欢迎使用SpringBoot"
    authorName: "菩提树下的杨过"
    authorBlogUrl: "http://yjmyzz.cnblogs.com/"

三、来一发

为了演示效果，可以弄一个最简单的web应用，先来一个controller

package com.example.controllers;

import com.example.config.WebConfig;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.ui.ModelMap;
import org.springframework.web.bind.annotation.RequestMapping;

@Controller
public class IndexController {

    @Autowired
    WebConfig webConfig;

    @RequestMapping("/")
    String index(ModelMap map) {
        map.addAttribute("title", webConfig.getWebTitle());
        map.addAttribute("name", webConfig.getAuthorName());
        map.addAttribute("blog", webConfig.getAuthorBlogUrl());
        return "index";
    }
}

然后在index.html模板中写点东西(注：本例使用了thymeleaf做为模板引擎)

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <title th:text="${title}"></title>
</head>
<body>
<div>
    <h1 th:text="${name}"/>
    <h1 th:text="${blog}"/>
</div>
</body>
</html>

最后跑起来的运行效果如下：