spring-boot 速成(4) 自定義配置 - yjmyzz－IT工程師數位筆記本

文章出處

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>

最后跑起來的運行效果如下：