SpringBoot—yml配置多环境（踩坑总结!）

红太狼 2023-09-27 19:41 13阅读 0赞

## 一、实例操作 ##

①、创建对应的application.yml （dev 开发；prod 生产；test 测试）文件

![d4268a1abde24787ad88c145ac480769.png][]

②、在application.yml文件中，放公共的配置部分 （这部分最好还是复制，自己敲位置，空格不对都会报错）

![80e5f8f8648445c9bfd156949475779d.png][]

spring:
      profiles:
        active: @profileActive@

在dev版本：

server:
      port: 9001

在prod版本：

server:
      port: 9003

在test版本：

server:
      port: 9002

③、在pom文件中添加相应的配置: (建议直接复制过去，修改对应需要的依赖即可)

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.2.3.RELEASE</version>
            <relativePath/>
            
        </parent>
        <groupId>com.xiaobai</groupId>
        <artifactId>knowledge</artifactId>
        <version>1.0.0</version>
        <name>knowledge</name>
        <description>knowledge share project for Spring Boot</description>
    
        <properties>
            
            <java.version>1.8</java.version>
        </properties>
    
        <profiles>
            <profile>
                
                <id>dev</id>
                <properties>
                    <profileActive>dev</profileActive>
                </properties>
                
                <activation>
                    <activeByDefault>true</activeByDefault>
                </activation>
            </profile>
            <profile>
                
                <id>test</id>
                <properties>
                    <profileActive>test</profileActive>
                </properties>
            </profile>
            <profile>
                
                <id>prod</id>
                <properties>
                    <profileActive>prod</profileActive>
                </properties>
            </profile>
        </profiles>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-data-rest</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-mail</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-oauth2-resource-server</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-security</artifactId>
            </dependency>
            
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web-services</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-websocket</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.session</groupId>
                <artifactId>spring-session-core</artifactId>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-devtools</artifactId>
                <scope>runtime</scope>
                <optional>true</optional>
            </dependency>
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <scope>runtime</scope>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-configuration-processor</artifactId>
                <optional>true</optional>
            </dependency>
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <optional>true</optional>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
                <exclusions>
                    <exclusion>
                        <groupId>org.junit.vintage</groupId>
                        <artifactId>junit-vintage-engine</artifactId>
                    </exclusion>
                </exclusions>
            </dependency>
            <dependency>
                <groupId>org.springframework.security</groupId>
                <artifactId>spring-security-test</artifactId>
                <scope>test</scope>
            </dependency>
        </dependencies>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
    
            <resources>
                <resource>
                    <directory>src/main/resources</directory>
                    <includes>
                        <include>application-${profileActive}.yml</include>
                        <include>application.yml</include>
                        <include>**/*.xml</include>
                    </includes>
                    <filtering>true</filtering>
                </resource>
                <resource>
                    <directory>src/main/java</directory>
                    <includes>
                        <include>**/*.xml</include>
                    </includes>
                </resource>
            </resources>
    
        </build>
    
    </project>

## 二、注意事项 ##

在yml配置多环境时，需要注意以下几点：（**最省事的方法，就是能复制就复制，yml文件自己大概知道有哪些东西就行了**）

（1）注意yml文件的缩进格式，必须按照正确的缩进方式来书写；

（2）多个环境的yml文件名称必须与application.yml保持一致，只是文件名前面加上环境名称；

（3）可以在yml文件中直接定义变量，也可以使用application.yml中的变量；

（4）使用SpringBoot提供的Profile机制可以方便地在不同的环境中切换。

## 三、对应的日志配置文件修改（不要忘了） ##

设置了三种配置环境，对应要修改的还有日志配置文件，在 Spring Boot框架中，默认使用的就是logback日志管理。

![11d4c30d174547048d458914254f1883.png][]

<?xml version="1.0" encoding="UTF-8"?>
    
    
    
    
    <configuration scan="true" scanPeriod="10 seconds">
    
        <contextName>logback</contextName>
        
        <property name="log.path" value="./logs"/>
        <property name="log_pattern" value="%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level --- [%thread] %logger{50} - %msg%n"/>
        <property name="log_fileNamePattern" value="-%d{yyyy-MM-dd}.%i.log"/>
        <property name="log_maxFileSize" value="100MB"/>
        <property name="log_maxHistory" value="15"/>
    
        
        <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
            
            <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
                <level>INFO</level>
            </filter>
            <encoder charset="UTF-8">
                <pattern>${log_pattern}</pattern>
            </encoder>
        </appender>
    
    
        
    
        
        <appender name="DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            
            <file>${log.path}/log-debug.log</file>
            
            <encoder>
                <pattern>${log_pattern}</pattern>
                <charset>UTF-8</charset> 
            </encoder>
            
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                
                <fileNamePattern>${log.path}/log-debug-${log_fileNamePattern}</fileNamePattern>
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>${log_maxFileSize}</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
                
                <maxHistory>${log_maxHistory}</maxHistory>
            </rollingPolicy>
            
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>debug</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
    
        </appender>
    
        
        <appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            
            <file>${log.path}/log_info.log</file>
            
            <encoder>
                <pattern>${log_pattern}</pattern>
                <charset>UTF-8</charset> 
            </encoder>
            
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                
                <fileNamePattern>${log.path}/log-info-${log_fileNamePattern}</fileNamePattern>
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>${log_maxFileSize}</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
                
                <maxHistory>${log_maxHistory}</maxHistory>
            </rollingPolicy>
            
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>info</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
    
        
        <appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            
            <file>${log.path}/log_warn.log</file>
            
            <encoder>
                <pattern>${log_pattern}</pattern>
                <charset>UTF-8</charset> 
            </encoder>
            
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                
                <fileNamePattern>${log.path}/log-warn-${log_fileNamePattern}</fileNamePattern>
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>${log_maxFileSize}</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
                
                <maxHistory>${log_maxHistory}</maxHistory>
            </rollingPolicy>
            
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>warn</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
    
        
        <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            
            <file>${log.path}/log_error.log</file>
            
            <encoder>
                <pattern>${log_pattern}</pattern>
                <charset>UTF-8</charset> 
            </encoder>
            
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                
                <fileNamePattern>${log.path}/log-error-${log_fileNamePattern}</fileNamePattern>
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>${log_maxFileSize}</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
                
                <maxHistory>${log_maxHistory}</maxHistory>
            </rollingPolicy>
            
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>ERROR</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
    
    
        
        <springProfile name="dev">
            <logger name="com.nmys.view" level="debug"/>
        </springProfile>
    
        <root level="info">
            <appender-ref ref="CONSOLE"/>
            <appender-ref ref="DEBUG_FILE"/>
            <appender-ref ref="INFO_FILE"/>
            <appender-ref ref="WARN_FILE"/>
            <appender-ref ref="ERROR_FILE"/>
        </root>
    
        
        <springProfile name="test">
            <root level="info">
                <appender-ref ref="CONSOLE"/>
                <appender-ref ref="DEBUG_FILE"/>
                <appender-ref ref="INFO_FILE"/>
                <appender-ref ref="ERROR_FILE"/>
                <appender-ref ref="WARN_FILE"/>
            </root>
        </springProfile>
    
        
        <springProfile name="pro">
            <root level="info">
                <appender-ref ref="CONSOLE"/>
                <appender-ref ref="DEBUG_FILE"/>
                <appender-ref ref="INFO_FILE"/>
                <appender-ref ref="ERROR_FILE"/>
                <appender-ref ref="WARN_FILE"/>
            </root>
        </springProfile>
    
    
    </configuration>

[d4268a1abde24787ad88c145ac480769.png]: https://img-blog.csdnimg.cn/d4268a1abde24787ad88c145ac480769.png
[80e5f8f8648445c9bfd156949475779d.png]: https://img-blog.csdnimg.cn/80e5f8f8648445c9bfd156949475779d.png
[11d4c30d174547048d458914254f1883.png]: https://img-blog.csdnimg.cn/11d4c30d174547048d458914254f1883.png