springboot配置文件使用方式

 更新时间:2024年11月28日 10:19:28   作者:golemon.  
文章介绍了将参数配置在配置文件中的方法,包括使用@Component和@Value注解进行外部配置的属性注入,以及使用@ConfigurationProperties简化配置,文章还提供了YAML格式配置文件的语法和特点,并强调了集中管理和维护配置参数的重要性

参数配置化

一些配置信息写在Java代码中,如果我们在做项目时每涉及到一个第三方技术服务,就将其参数硬编码,那么在Java程序中会存在两个问题:

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

为了解决以上分析的问题,我们可以将参数配置在配置文件中。

如下:

#?????
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包内。不要导错包

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格式的数据有以下特点:

  • 容易阅读
  • 容易与脚本语言交互
  • 以数据为核心,重数据轻格式

yml基本语法

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

yml数据格式

对象/map集合

user:
	name: Tom
	age: 20
	address: beijing

数组/List/Set

hobby:
	- Java
	- C
	- Python

@ConfigurationProperties

Spring提供的简化方式套路:

1.需要创建一个实现类,且实体类中的属性名和配置文件当中key的名字必须要一致。比如:配置文件当中叫endpoints,实体类当中的属性也得叫endpoints,另外实体类当中的属性还需要提供 getter / setter方法

2.需要将实体类交给Spring的IOC容器管理,成为IOC容器当中的bean对象

3.在实体类上添加@ConfigurationProperties注解,并通过perfect属性来指定配置参数项的前缀

  • 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("//")[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对象。

Value和ConfigurationProperties区别

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

不同点:

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

总结

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • Spring Security前后端分离接入保姆级教程

    Spring Security前后端分离接入保姆级教程

    文章详细介绍了如何基于角色权限模型与数据权限控制,使用SpringSecurity实现一个小型摄影作品管理系统的前后端分离认证鉴权流程,从基础接入到权限扩展和数据权限控制,每一步都提供了自定义类、代码、注释和逻辑说明,感兴趣的朋友跟随小编一起看看吧
    2025-11-11
  • struts2.3.24+spring4.1.6+hibernate4.3.11+mysql5.5.25开发环境搭建图文教程

    struts2.3.24+spring4.1.6+hibernate4.3.11+mysql5.5.25开发环境搭建图文

    这篇文章主要介绍了struts2.3.24+spring4.1.6+hibernate4.3.11+mysql5.5.25开发环境搭建图文教程,感兴趣的小伙伴们可以参考一下
    2016-06-06
  • 基于Java和FFmpeg实现视频压缩和剪辑功能

    基于Java和FFmpeg实现视频压缩和剪辑功能

    在视频处理开发中,压缩和剪辑是常见的需求,本文将介绍如何使用 Java 结合 FFmpeg 实现视频压缩和剪辑功能,同时去除数据库操作,仅专注于视频处理,需要的朋友可以参考下
    2025-08-08
  • 在springboot中如何给mybatis加拦截器

    在springboot中如何给mybatis加拦截器

    这篇文章主要介绍了在springboot中如何给mybatis加拦截器,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-08-08
  • Java的IO模型、Netty原理解析

    Java的IO模型、Netty原理解析

    Java的I/O是以流的方式进行数据输入输出的,Java的类库涉及很多领域的IO内容:标准的输入输出,文件的操作、网络上的数据传输流、字符串流、对象流等,这篇文章主要介绍了Java的IO模型、Netty原理详解,需要的朋友可以参考下
    2025-03-03
  • 通过实例学习Either 树和模式匹配

    通过实例学习Either 树和模式匹配

    这篇文章主要介绍了通过实例学习Either 树和模式匹配,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,,需要的朋友可以参考下
    2019-06-06
  • java swing实现贪吃蛇双人游戏

    java swing实现贪吃蛇双人游戏

    这篇文章主要为大家详细介绍了java swing实现贪吃蛇双人小游戏,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-01-01
  • 线程池中execute与submit的区别说明

    线程池中execute与submit的区别说明

    这篇文章主要介绍了线程池execute与submit的区别说明,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-03-03
  • IDEA2022搭建Spring Cloud多模块项目的详细过程

    IDEA2022搭建Spring Cloud多模块项目的详细过程

    这篇文章主要介绍了IDEA2022搭建Spring Cloud多模块项目,网上有很多教程父模块都是通过maven的方式创建的,然后子模块是通过Spring Initalizr方式创建,这种方式父模块无法管理子模块的依赖仲裁,需要每个子模块自行管理,就失去了父模块的用处了
    2022-10-10
  • 浅谈Spring Data JPA与MyBatisPlus的比较

    浅谈Spring Data JPA与MyBatisPlus的比较

    本文主要介绍了浅谈Spring Data JPA 与 MyBatisPlus的比较
    2024-08-08

最新评论