跳到主要內容

SpringBoot基本配置詳解

SpringBoot項目有一些基本的配置，比如啟動圖案（banner），比如默認配置文件application.properties，以及相關的默認配置項。


示例項目代碼在：


一、啟動圖案banner


編寫banner.txt放入resources文件夾下，然後啟動項目即可修改默認圖案。


關於banner的生成，可以去一些專門的網站。


比如：https://www.bootschool.net/ascii



二、配置文件application


2.1 application.properties/yml


resources下通常會默認生成一個application.properties文件，這個文件包含了SpringBoot項目的全局配置文件。裏面的配置項通常是這樣的：


server.port=8080

在這個文件里我們可以添加框架支持的配置項，比如項目端口號、JDBC連接的數據源、日誌級別等等。


現在比較流行的是將properties文件改為yml文件。yml文件的格式yaml是這樣的：


server:
     port: 8080

yml和properties的作用是一樣的。而yml的好處是顯而易見的——更易寫易讀。


屬性之間互相調用使用${name}：


eknown:
     email: eknown@163.com
     uri: http://www.eknown.cn
     title: 'hello, link to ${eknown.uri} or email to ${eknown.email}'

鏈接：


2.2 多環境配置文件


通常開發一個應用會有多個環境，常見如dev/prod，也會有test，甚至其他一些自定義的環境，SpringBoot支持配置文件的靈活切換。


定義新配置文件需要遵循以下格式：application-{profile}.properties 或者application-{profile}.yml


比如現在有dev和prod兩個環境，我需要在application.yml文件之外新建兩個文件：




  1. application-dev.yml

    server:
        port: 8080

  2. application-prod.yml

    server:
       port: 8081



然後在application.yml中通過application.profiles.active={profile}指明啟用那個配置：


application:
     profiles:
       active: dev

除了在application.yml中指定配置文件外，還可以通過啟動命令指定：java -jar xxx.jar --spring.profiles.active=dev


2.2 自定義配置項並獲取它


主要介紹兩種方式，獲取單個配置項和獲取多個配置項。


舉例：


eknown:
     email: eknown@163.com
     uri: http://www.eknown.cn

2.2.1 使用@Value註解獲取單個配置項


@Value("${eknown.email}")
 private String email;
 
 @Value("${eknown.uri}")
 private String url;

注意：使用@Value註解的時候，所在類必須被Spring容器管理，也就是被@Component、@Controller、@Service等註解定義的類。


2.2.2 獲取多個配置項


第一種，定義一個bean類，通過@Value獲取多個配置項：


@Component
 public class MyConfigBean {
   
 }

然後我們通過get方法來獲取這些值：


@RestController
 public class BasicAction {
   
   @Autowired
   private MyConfigBean myConfigBean;
 
 }

第二種，使用註解@ConfigurationProperties：


@Component
 @ConfigurationProperties(perfix="eknown")
 public class MyConfigBean {
 
   private String email;
   private String uri;
 }

這裏只需要通過prefix指定前綴即可，後面的值自動匹配。


這裏我們還使用了@Component註解來讓spring容器管理這個MyConfigBean。


此外，我們可以不需要引入@Component，轉而在Application啟動類上加上@EnableConfigurationProperties({MyConfigBean.class})來啟動這個配置。


注意：我們這裡是從主配置文件，也就是SpringBoot默認的application-profile文件中獲取配置數據的。


而從自定義的配置文件，比如test.yml這種形式中獲取配置項時，情況是有點不大一樣的。


三、自定義配置文件


上面介紹的配置文件都是springboot默認的application開頭的文件。如果要自定義一個配置文件呢，比如test.yml或test.properties，怎麼獲取其中的配置項呢？


使用@PageResource註解即可。


首先我們來看一下讀取自定義的properties文件里的內容：


test.properties


hello.time=2019.11.19
 hello.name=eknown

定義Configuration類：


@Configuration
 @PropertySource("classpath:test.properties")
 //@PropertySource("classpath:test.yml") // 注意，yml文件不能直接這樣寫，會讀不出數據
 @ConfigurationProperties(prefix = "hello")
 public class TestConfiguration {
     private String name;
     private String time;
 
     // hide get and set methods
 }

測試一下：


@RestController
 @RequestMapping(value = "test")
 public class TestAction {
 
     @Autowired
     private TestConfiguration testConfiguration;
 
     @GetMapping(value = "config")
     public String test() {
         return testConfiguration.getName() + "<br/>" + testConfiguration.getTime();
     }
 }


如果將properties文件換成yml文件呢？


我們嘗試一下，發現：



讀不出數據？


分析一下@PropertySource註解，發現其使用的PropertySourceFactory是DefaultPropertySourceFactory.


這個類的源碼如下：


public class DefaultPropertySourceFactory implements PropertySourceFactory {
     public DefaultPropertySourceFactory() {
     }
 
     public PropertySource<?> createPropertySource(@Nullable String name, EncodedResource resource) throws IOException {
         return name != null ? new ResourcePropertySource(name, resource) : new ResourcePropertySource(resource);
     }
 }

這個類只能處理properties文件，無法處理yml文件。所以我們需要自定義一個YmlSourceFactory。


public class YamlSourceFactory extends DefaultPropertySourceFactory {
 
     @Override
     public PropertySource<?> createPropertySource(String name, EncodedResource resource) throws IOException {
         return new YamlPropertySourceLoader().load(resource.getResource().getFilename()
                 , resource.getResource()).get(0);
     }
 }

然後定義test.yml文件的config類：


@Configuration
 @PropertySource(value = "classpath:test.yml", encoding = "utf-8", factory = YamlSourceFactory.class)
 @ConfigurationProperties(prefix = "yml.hello")
 public class TestYamlConfiguration {
     private String name;
     private String time;
 
     // hide get and set methods
 }

注：為了區分test.properties和test.yml，這裏的test.yml中的屬性以yml.hello開頭。


編寫一下測試：


    @Autowired
     private TestYamlConfiguration ymlConfiguration;
 
     @GetMapping(value = "yml")
     public String testYml() {
         return "yml config: <br/>" + ymlConfiguration.getName() + "<br/>" + ymlConfiguration.getTime();
     }

訪問：



四、補充@ConfigurationProperties


網上一些資料中，為配合使用@ConfigurationProperties，還使用了@EnableConfigurationProperties註解。


經過測試發現：




  1. 從SpringBoot默認配置文件讀取配置信息，使用@ConfigurationProperties + @Component/@Configuration，或者@ConfigurationProperties + 在啟動類添加@EnableConfigurationProperties({class})。這兩種方式都能解決問題


  2. 從非默認配置文件讀取配置信息，需要利用@PropertySource註解。同樣兩種方式：

    2.1 @PropertySource + @ConfigurationProperties + @Component/@Configuration

    2.2 @PropertySource + @ConfigurationProperties + @Component/@Configuration + @EnableConfigurationProperties，第二種方式存在一個問題，即還是必須要使用@Component註解，如果不使用，則會導致讀取配置信息為null，但程序不會報錯；而如果採用了，則會導致bean類的set方法被執行兩次（也就是生成了兩個同樣類型的bean類）。這種方式不建議！



本站聲明:網站內容來源於博客園,如有侵權,請聯繫我們,我們將及時處理
【其他文章推薦】

※為什麼 USB CONNECTOR 是電子產業重要的元件?



※網頁設計一頭霧水??該從何著手呢? 找到專業技術的網頁設計公司，幫您輕鬆架站!



※想要讓你的商品成為最夯、最多人討論的話題?網頁設計公司讓你強力曝光



※想知道最厲害的台北網頁設計公司推薦、台中網頁設計公司推薦專業設計師"嚨底家"!!



※專營大陸快遞台灣服務



※台灣快遞大陸的貨運公司有哪些呢?



Orignal From: SpringBoot基本配置詳解

留言

張貼留言

這個網誌中的熱門文章

強強聯手!攜手打造雲林縣Web3.0 領地方品牌進軍元宇宙

中華電信攜手國內最大Potato Media Web3.0社群共享平台，及品牌醫生果俐文創三方結合，透過經濟部「CBMP智慧雲遊跨域串連計畫」，協助品牌數位轉型，帶動品牌體驗情境、新商業模組升級與行動支付應用，第一站選在雲林縣當地原生消費品牌，打造社群消費循環，探索近期最夯的元宇宙新玩法。 Potato Media執行長顏宏霖表示，在CBMP計畫協助下，加上站內Web3.0資源，將快速協助雲林縣當地品牌升級轉型，幫助店家創造品牌價值，包含黑矸仔醬油、四代目麥芽酥、玉津烘焙坊、禪屋米胖工坊、YuDS沐耳飲、莫蒂精品巧克力、維野納複合式餐飲、頂雲咖啡、媽祖埔豆腐張、玉山碾米廠等，另外嘉義市麥麵、名香茗茶也等不及跨縣市加入，結合Potato Media站內活動，打造雲林專屬限定NFT道具與頭框，發行雲林扭蛋，體驗全新元宇宙新世界。 左起雲林縣計畫處處長李明岳、果俐文創執行長-陳郁涵、雲林縣議員周秀月、中華電信雲林營運處總經理張肇家、Potato Media執行長顏宏霖、LINE禮物代表睿鼎數位、12CMTaiwan行銷總監楊涵柔。(圖/由Potato Media提供) 此次Potato Media平台合作內容是店家會員註冊活動：首次註冊可得100積分 + 一顆扭蛋，店家推薦文章介紹，可領取店家消費優惠券，站內扭蛋禮物抽獎活動，獎項豐富：雲林限定禮品、雲林意象限定NFT道具與頭框，雲林幣扭一下APP政令大聲公獎勵活動，另外各種雲林美食伴手禮、住宿旅遊的店家，都可以使用行動支付或上LINE禮物平台實際體驗消費。 推薦評價好的 iphone維修 中心 擁有專業的維修技術團隊，同時聘請資深iphone手機維修專家，現場說明手機問題，快速修理，沒修好不收錢 產品缺大量曝光嗎?你需要的是一流 包裝設計 窩窩觸角包含自媒體、自有平台及其他國家營銷業務等，多角化經營並具有國際觀的永續理念。 雲林縣副縣長謝淑亞強調，此次計畫和Potato Media 合作，Potato Media 是一個在 2021 年 4 月正式發布的「區塊鏈 Web3.0 共享社群平台」，創作者和使用者都可以透過互動的機制，例如對文章點讚、留言與轉發分享，來獲取相對應比例的加密貨幣CFO（Potato Media 平台上的原生加密貨幣），跟Facebook、Instagram、YouTu...
張貼留言
閱讀完整內容

要上網站行銷農產品，得經過市政府抽驗農藥殘留，檢驗合格才能上網行銷

台北網站設計      網頁設計公司     網站設計公司 食安五環為「源頭控管」、「重建生產管理履歷」、「提高查驗能力」、「加重生產者、廠商的責任」及「鼓勵、創造監督平臺」五大要環，除推動政府與市民消費者共同監督食品安全，更要從農場到餐桌，鏈結農村產業線，以網路社群為媒介，建立嘉義市農村網頁平台。活動現場介紹「農抵嘉」產銷網頁平台的內容，包含在地人文地產景，將景觀、產業、生態及文化等資訊整合、展現，更推廣在地農村農友優質、安全的農產品。要上「農抵嘉」網站行銷農產品，得經過市政府抽驗農藥殘留，檢驗合格才能上網行銷自己的農產品，嘉義市農友可以多利用，也提供店家採購管道。 「尚安心，農抵嘉」，透過「農抵嘉」產銷網頁平台，鏈結農村產業線並促進地產地消，從源頭管理食安，讓政府管理、民間參與，透過食安小教育，讓小朋友接觸農作物，與生產者互動，產生共鳴，一同攜手維護嘉義市的食安。記者會中也展示紅瓦厝社區所做的紅瓦窯烤，並有其他下埤花生等農產品，透過農場職人使「農特產品不只是農產品」，民眾可登入「農抵嘉」網頁http://chiayirural.com/index.asp瞭解更進一步的訊息。 網動廣告 參考資料:蕃新聞https://n.yam.com/Article/20171226529712 Orignal From: 要上網站行銷農產品，得經過市政府抽驗農藥殘留，檢驗合格才能上網行銷
張貼留言
閱讀完整內容

IEA：疫情衝擊能源需求 但再生能源呈創紀錄成長_台中搬家公司

※ 台中搬家公司 教你幾個打包小技巧,輕鬆整理裝箱! 還在煩惱搬家費用要多少哪？台中大展搬家線上試算搬家費用，從此不再擔心「物品怎麼計費」、「多少車才能裝完」 摘錄自2020年11月10日中央社報導 國際能源總署（IEA）報告今天（10日）指出，武漢肺炎（COVID-19）疫情可能衝擊能源需求，但電力部門再生能源繼續以創紀錄速度成長。 IEA執行董事比羅爾（Fatih Birol）表示：「在2025年，再生能源將成為全球最大發電來源，預計將提供1/3的全球電力，終結煤炭50年來作為最大電力供應來源的地位。」 ※推薦 台中搬家公司 優質服務,可到府估價 台中搬鋼琴,台中金庫搬運,中部廢棄物處理,南投縣搬家公司,好幫手搬家,西屯區搬家 IEA關於再生能源的年度報告估計，儘管受到疫情干擾，今年的再生能源新發電容量可望創紀錄，達將近200GW（GW為十億瓦）。 能源轉型 國際新聞 再生能源 疫情看氣候與能源 本站聲明:網站內容來源環境資訊中心https://e-info.org.tw/,如有侵權,請聯繫我們,我們將及時處理 ※ 台中搬家公司 教你幾個打包小技巧,輕鬆整理裝箱! 還在煩惱搬家費用要多少哪？台中大展搬家線上試算搬家費用，從此不再擔心「物品怎麼計費」、「多少車才能裝完」 Orignal From: IEA：疫情衝擊能源需求 但再生能源呈創紀錄成長_台中搬家公司
張貼留言
閱讀完整內容