快捷導航

springboot配置文件使用方式

更新時間：2024年11月28日 10:19:28 作者：golemon.

文章介紹了將參數(shù)配置在配置文件中的方法,包括使用@Component和@Value注解進行外部配置的屬性注入,以及使用@ConfigurationProperties簡化配置,文章還提供了YAML格式配置文件的語法和特點,并強調(diào)了集中管理和維護配置參數(shù)的重要性

參數(shù)配置化

一些配置信息寫在Java代碼中，如果我們在做項目時每涉及到一個第三方技術(shù)服務(wù)，就將其參數(shù)硬編碼，那么在Java程序中會存在兩個問題：

如果這些參數(shù)發(fā)生變化了，就必須在源程序代碼中改動這些參數(shù)，然后需要重新進行代碼的編譯，將Java代碼編譯成class字節(jié)碼文件再重新運行程序。（比較繁瑣）
如果我們開發(fā)的是一個真實的企業(yè)級項目， Java類可能會有很多，如果將這些參數(shù)分散的定義在各個Java類當中，我們要修改一個參數(shù)值，我們就需要在眾多的Java代碼當中來定位到對應(yīng)的位置，再來修改參數(shù)，修改完畢之后再重新編譯再運行。（參數(shù)配置過于分散，是不方便集中的管理和維護）

為了解決以上分析的問題，我們可以將參數(shù)配置在配置文件中。

如下：

#?????
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/tlias
spring.datasource.username=root
spring.datasource.password=mysql

#??mybatis?????
mybatis.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

#???????? ? ??????????
mybatis.configuration.map-underscore-to-camel-case=true

#配置單個文件最大上傳大小
spring.servlet.multipart.max-file-size=10MB

#配置單個請求最大上傳大小(一次請求可以上傳多個文件)
spring.servlet.multipart.max-request-size=100MB

#自定義的阿里云OSS配置信息
aliyun.oss.endpoint=https://oss-cn-hangzhou.aliyuncs.com
aliyun.oss.accessKeyId=LTAI4GCH1vX6DKqJWxd6nEuW
aliyun.oss.accessKeySecret=yBshYweHOpqDuhCArrVHwIiBKpyqSL
aliyun.oss.bucketName=web-tlias

使用@Component進行注解

使用@Value注解用于外部配置的屬性注入，具體用法為：

@Value("${配置文件中的key}")

@Component
public class AliOSSUtils {

    @Value("${aliyun.oss.endpoint}")
    private String endpoint;
    
    @Value("${aliyun.oss.accessKeyId}")
    private String accessKeyId;
    
    @Value("${aliyun.oss.accessKeySecret}")
    private String accessKeySecret;
    
    @Value("${aliyun.oss.bucketName}")
    private String bucketName;
 	
 	//省略其他代碼...
 }

@Value不是lombok的包，而是spring包內(nèi)。不要導錯包

yml配置格式

SpringBoot提供了多種屬性配置方式：

application.properties：

server.port=8080
server.address=127.0.0.1

application.yml：

server:
	port: 8080
	address: 127.0.0.1

application.yaml：

server:
	port: 8080
	address: 127.0.0.1

XML：

<server>
	<port>8080</port>
	<address>127.0.0.1</address>
</server>

yml 格式的配置文件，后綴名有兩種：

yml （推薦）
yaml

yml格式的數(shù)據(jù)有以下特點：

容易閱讀
容易與腳本語言交互
以數(shù)據(jù)為核心，重數(shù)據(jù)輕格式

yml基本語法

大小寫敏感
數(shù)值前邊必須有空格，作為分隔符
使用縮進表示層級關(guān)系，縮進時，不允許使用Tab鍵，只能用空格（idea中會自動將Tab轉(zhuǎn)換為空格）
縮進的空格數(shù)目不重要，只要相同層級的元素左側(cè)對齊即可
#表示注釋，從這個字符一直到行尾，都會被解析器忽略

yml數(shù)據(jù)格式

對象/map集合：

user:
	name: Tom
	age: 20
	address: beijing

數(shù)組/List/Set

hobby:
	- Java
	- C
	- Python

@ConfigurationProperties

Spring提供的簡化方式套路：

1.需要創(chuàng)建一個實現(xiàn)類，且實體類中的屬性名和配置文件當中key的名字必須要一致。比如：配置文件當中叫endpoints，實體類當中的屬性也得叫endpoints，另外實體類當中的屬性還需要提供 getter / setter方法

2.需要將實體類交給Spring的IOC容器管理，成為IOC容器當中的bean對象

3.在實體類上添加@ConfigurationProperties注解，并通過perfect屬性來指定配置參數(shù)項的前綴

AliOSSUtilsProperties.java：

package com.intelligent_learning_aid_system.utils;

import lombok.Data;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

@Data
@Component
@ConfigurationProperties(prefix = "aliyun.oss")
public class AliOSSUtilsProperties {
    private String endpoint;

    private String accessKeyId;

    private String accessKeySecret;

    private String bucketName;
}

AliOSSUtils.java：

package com.intelligent_learning_aid_system.utils;

import com.aliyun.oss.OSS;
import com.aliyun.oss.OSSClientBuilder;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
import org.springframework.web.multipart.MultipartFile;

import java.io.IOException;
import java.io.InputStream;
import java.util.UUID;

/**
 * 阿里云 OSS 工具類
 */
@Component
public class AliOSSUtils {
    @Autowired
    private AliOSSUtilsProperties aliOSSUtilsProperties;

    public String upload(MultipartFile file) throws IOException {
        // 獲取配置文件中的值
        String endpoint = aliOSSUtilsProperties.getEndpoint();
        String accessKeyId = aliOSSUtilsProperties.getAccessKeyId();
        String accessKeySecret = aliOSSUtilsProperties.getAccessKeySecret();
        String bucketName = aliOSSUtilsProperties.getBucketName();


        // 獲取上傳文件的  輸入流
        InputStream inputStream = file.getInputStream();

        // 避免文件覆蓋
        String originalFilename = file.getOriginalFilename();
        String fileName = UUID.randomUUID().toString() + originalFilename.substring(originalFilename.lastIndexOf("."));

        // 上傳到OSS
        OSS ossClient = new OSSClientBuilder().build(endpoint, accessKeyId, accessKeySecret);
        ossClient.putObject(bucketName, fileName, inputStream);

        //文件訪問路徑
        String url = endpoint.split("http://")[0] + "http://" + bucketName + "." + endpoint.split("http://")[1] + "/" + fileName;

        // 關(guān)閉ossClient
        ossClient.shutdown();
        return url;// 把上傳到oss的路徑返回
    }

}

這個警告提示是告知我們還需要引入一個依賴：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
</dependency>

當我們在pom.xml文件當中配置了這項依賴之后，我們重新啟動服務(wù)，大家就會看到在properties或者是yml配置文件當中，就會提示阿里云 OSS 相關(guān)的配置項。

所以這項依賴它的作用就是會自動的識別被@Configuration Properties注解標識的bean對象。

Value和ConfigurationProperties區(qū)別

相同點：都是用來注入外部配置的屬性的。

不同點：

@Value注解只能一個一個的進行外部屬性的注入。
@ConfigurationProperties可以批量的將外部的屬性配置注入到bean對象的屬性中。

總結(jié)

以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。

您可能感興趣的文章:

最新国产好看的视频,伊人天堂AV在线,国产Aaaaaa视频,蜜臀视频在线观看一区,人妻av色图,密臀久久久精品影片,青青视频免费观看毛片,久草在线观看视,国产三级精品色情在线

springboot配置文件使用方式

目錄

參數(shù)配置化

yml配置格式

yml基本語法

yml數(shù)據(jù)格式

@ConfigurationProperties

Value和ConfigurationProperties區(qū)別

總結(jié)

相關(guān)文章

最新評論

大家感興趣的內(nèi)容

最近更新的內(nèi)容

常用在線小工具