配置文件 application properties

最新推荐文章于 2024-06-20 20:20:21 发布

苹果就叫不呐呐

最新推荐文章于 2024-06-20 20:20:21 发布

阅读量679

点赞数 9

分类专栏： JavaWeb 文章标签： java web 个人开发职场和发展

本文链接：https://blog.csdn.net/prince0520/article/details/137092197

版权

JavaWeb 专栏收录该内容

1 篇文章 0 订阅

订阅专栏

配置文件 application properties

1 参数交由配置文件集中管理 @Value(“${}”)用于外部配置的属性注入

在之前编写的程序中进行文件上传时，需要调用AliOSSUtils工具类，将文件上传到阿里云OSS对象存储服务当中。而在调用工具类进行文件上传时，需要一些参数：

endpoint //阿里云OSS域名
accessKeyID //用户身份ID
accessKeySecret //用户密钥
bucketName //存储空间的名字

硬编码存在的问题

关于以上的这些阿里云相关配置信息，我们是直接写死在java代码中了(硬编码)，如果在做项目时每涉及到一个第三方技术服务，就将其参数硬编码，那么在Java程序中会存在两个问题：

如果这些参数发生变化了，就必须在源程序代码中改动这些参数，然后需要重新进行代码的编译，将Java代码编译成class字节码文件再重新运行程序。（比较繁琐）
如果开发的是一个真实的企业级项目， Java类可能会有很多，如果将这些参数分散的定义在各个Java类当中，要修改一个参数值，就需要在众多的Java代码当中来定位到对应的位置，再来修改参数，修改完毕之后再重新编译再运行。（参数配置过于分散，是不方便集中的管理和维护）

为了解决以上分析的问题，可以将参数配置在配置文件中。如下：

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

在将阿里云OSS配置参数交给properties配置文件来管理之后，AliOSSUtils工具类就变为以下形式：

@Component
public class AliOSSUtils {
    /*以下4个参数没有指定值（默认值：null）*/
    private String endpoint;
    private String accessKeyId;
    private String accessKeySecret;
    private String bucketName;

    //省略其他代码...
}

而此时如果直接调用AliOSSUtils类当中的upload方法进行文件上传时，这4项参数全部为null，原因是因为并没有给它赋值。

此时需要将配置文件当中所配置的属性值读取出来，并分别赋值给AliOSSUtils工具类当中的各个属性。那应该怎么做呢？

因为application.properties是springboot项目默认的配置文件，所以springboot程序在启动时会默认读取application.properties配置文件，可以使用一个现成的注解：

@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;
 	
 	//省略其他代码...
 }

在这里插入图片描述

2 yml配置文件⭐️

前面一直使用springboot项目创建完毕后自带的application.properties进行属性配置，
在springboot项目中支持多种配置方式：

application.properties

server.port=8080  # 内嵌的tomcat端口号
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

yml 格式的配置文件，后缀名有两种：

yml （推荐）
yaml

(1)常见配置文件格式对比

在这里插入图片描述

可以看到配置同样的数据信息，yml格式的数据有以下特点：

层级结构，容易阅读
容易与脚本语言交互
以数据为核心，重数据轻格式

(2)yml配置文件的基本语法

大小写敏感
数值前边必须有空格，作为分隔符
使用缩进表示层级关系，缩进时，不允许使用Tab键，只能用空格（idea中会自动将Tab转换为空格）
缩进的空格数目不重要，只要相同层级的元素左侧对齐即可
#表示注释，从这个字符一直到行尾，都会被解析器忽略

在这里插入图片描述

(3)yml文件中常见的数据格式

定义对象或Map集合

user:
  name: zhangsan
  age: 18
  password: 123456

定义数组、list或set集合

hobby: 
  - java
  - game
  - sport

熟悉完了yml文件的基本语法后，修改下之前案例中使用的配置文件，变更为application.yml配置方式：

修改application.properties名字为：_application.properties（名字随便更换，只要加载不到即可）
创建新的配置文件： application.yml

原有application.properties文件：

在这里插入图片描述

新建的application.yml文件：

spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/tlias
    username: root
    password: 1234
  servlet:
    multipart:
      max-file-size: 10MB
      max-request-size: 100MB
      
mybatis:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
    map-underscore-to-camel-case: true
	
aliyun:
  oss:
    endpoint: https://oss-cn-hangzhou.aliyuncs.com
    accessKeyId: LTAI4GCH1vX6DKqJWxd6nEuW
    accessKeySecret: yBshYweHOpqDuhCArrVHwIiBKpyqSL
    bucketName: web-397

3 @ConfigurationProperties注解用于完成属性注入

——直接将配置文件中配置项的值自动的注入到Bean对象的属性中

在application.properties或者application.yml中配置了阿里云OSS的四项参数之后，如果java程序中需要这四项参数数据，我们直接通过@Value注解来进行注入。但是如果说需要注入的属性较多，写起来就会比较繁琐。

在Spring中提供了一种简化方式，可以🔴直接将配置文件中配置项的值自动的注入到对象的属性中。

需要创建一个实现类，且实体类中的属性名和配置文件当中key的名字必须要一致

比如配置文件当中叫endpoint，实体类当中的属性也得叫endpoint，
另外实体类当中的属性还需要提供 getter / setter方法：@Data
需要将实体类交给Spring的IOC容器管理，成为IOC容器当中的bean对象：@Conponent
在实体类上添加@ConfigurationProperties注解，并通过perfect属性来指定配置参数项的前缀

在这里插入图片描述

实体类：AliOSSProperties

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

/*阿里云OSS相关配置*/
/**
 * 程序在运行时，会自动将yml配置文件中4个配置项对应的值 自动注入到创建的Bean对象的4个属性中来
 * 在其他的程序中，如果我们想要获取到这四个属性值，直接注入这个Bean对象，调用get方法就行
 */
@Data
@Component！！！！！！！！！！！！！！！！！！！！！！！！！！！
@ConfigurationProperties(prefix = "aliyun.oss") //prefix：指定前缀
public class AliOSSProperties {   
    private String endpoint; //区域    
    private String accessKeyId ;//身份ID    
    private String accessKeySecret ;//身份密钥    
    private String bucketName;//存储空间
}

AliOSSUtils工具类：

import com.aliyun.oss.OSS;
import com.aliyun.oss.OSSClientBuilder;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import org.springframework.web.multipart.MultipartFile;
import java.io.IOException;
import java.io.InputStream;
import java.util.UUID;

@Component //当前类对象由Spring创建和管理
public class AliOSSUtils {

    //注入配置参数的实体类对象！！！！！！！！！！！！！！！！！
    @Autowired
    private AliOSSProperties aliOSSProperties;
   
    
    /**
     * 实现上传图片到OSS
     */
   public String upload(MultipartFile file) throws IOException {

        // 获取阿里云oss参数！！！！！！！！！！！！！！！！！！！！！！！！！！！
        String endpoint = aliOSSProperties.getEndpoint();
        String accessKeyId = aliOSSProperties.getAccessKeyId();
        String accessKeySecret = aliOSSProperties.getAccessKeySecret();
        String bucketName = aliOSSProperties.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("//")[0] + "//" + bucketName + "." + endpoint.split("//")[1] + "/" + fileName;
        // 关闭ossClient
        ossClient.shutdown();
        return url;// 把上传到oss的路径返回
    }

}

在这里插入图片描述

警告提示是告知我们还需要引入一个依赖：

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

当在pom.xml文件当中配置了这项依赖之后，重新启动服务，大家就会看到在properties或者是yml配置文件当中，就会提示阿里云 OSS 相关的配置项。所以这项依赖它的作用就是会自动的识别被@Configuration Properties注解标识的bean对象。

@ConfigurationProperties 和@Value区别

相同点：都是用来注入外部配置的属性的。

不同点：

@Value注解只能一个一个的进行外部属性的注入。
@ConfigurationProperties可以批量的将外部的属性配置注入到bean对象的属性中。

如果要注入的属性非常的多，并且还想做到复用，就可以定义这么一个bean对象。通过 configuration properties 批量的将外部的属性配置直接注入到 bin 对象的属性当中。在其他的类当中，要想获取到注入进来的属性，直接注入 bin 对象，然后调用 get 方法，就可以获取到对应的属性值了