Spring Boot(二):简单的初始配置

一、热部署

当我们修改文件和创建文件时,都需要重新启动项目。这样频繁的操作很浪费时间,配置热部署可以让项目自动加载变化的文件,省去的手动操作。

在 pom.xml 文件中添加如下配置:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-devtools</artifactId>
    <optional>true</optional>
    <scope>true</scope>
</dependency>
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <!-- 没有该配置,devtools 不生效 -->
                    <fork>true</fork>
                </configuration>
            </plugin>
        </plugins>
    </build>

还有一点不能忘记,就是 按住ctrl + shift + alt + /,选择Registry,勾上 Compiler autoMake allow when app running
如图:


1.png
企业微信截图_15555740019421.png

二、配置文件更改以及多环境切换

application.properties 是 springboot 在运行中所需要的配置信息。
新建springboot项目时默认的配置文件就是application.properties,我们把application.properties删除新建application.yml
原因:
实质上跟properties是差不多的,但是yml文件的好处,天然的树状结构,一目了然,还有官方给的很多demo,都是用yml文件配置的;
注意点:

1,原有的key,例如spring.jpa.properties.hibernate.dialect,按“.”分割,
如:

server.port=8080,

都变成树状的配置,
如

server:
  port: 8080

2,key后面的冒号,后面一定要跟一个空格
3,把原有的application.properties删掉。然后一定要执行一下 maven -X clean install
4,如果你的项目中存在 application.properties 文件,那么 application.yml 文件就只是一个摆设,(应该是默认的优先级)

当我们在开发阶段,使用自己的机器开发,测试的时候需要用的测试服务器测试,上线时使用正式环境的服务器。
这三种环境需要的配置信息都不一样,当我们切换环境运行项目时,需要手动的修改多出配置信息,非常容易出错。
为了解决上述问题,springboot 提供多环境配置的机制,让开发者非常容易的根据需求而切换不同的配置环境。
在 src/main/resources 目录下创建三个配置文件:

application-dev.yml:用于开发环境
application-test.yml:用于测试环境
application-prod.yml:用于生产环境
我们可以在这个三个配置文件中设置不同的信息,application.yml 配置公共的信息。

在 application.yml 中配置:
spring.profiles.active: dev
表示激活 application-dev.yml 文件配置, springboot 会加载使用 application.yml 和 application-dev.yml 配置文件的信息。

同理,可将 spring.profiles.active 的值修改成 test 或 prod 达到切换环境的目的。

三、配置日志

3.1 配置 logback(官方推荐使用)
3.1.1 配置日志文件

spring boot 默认会加载 classpath:logback-spring.xml 或者 classpath:logback-spring.groovy。

如需要自定义文件名称,在 application.yml 中配置 logging.config 选项即可。

在 src/main/resources 下创建 logback-spring.xml 文件,内容如下:

    <?xml version="1.0" encoding="UTF-8"?>
    <configuration>
        <!-- 文件输出格式 -->
        <property name="PATTERN" value="%-12(%d{yyyy-MM-dd HH:mm:ss.SSS}) |-%-5level [%thread] %c [%L] -| %msg%n" />
        <!-- test文件路径 -->
        <property name="TEST_FILE_PATH" value="d:/test.log" />
        <!-- pro文件路径 -->
        <property name="PRO_FILE_PATH" value="/opt/test/log" />
        
        <!-- 开发环境 -->
        <springProfile name="dev">
            <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
                <encoder>
                    <pattern>${PATTERN}</pattern>
                </encoder>
            </appender>
            <logger name="com.light.springboot" level="debug" />
            <root level="info">
                <appender-ref ref="CONSOLE" />
            </root>
        </springProfile>
        
        <!-- 测试环境 -->
        <springProfile name="test">
            <!-- 每天产生一个文件 -->
            <appender name="TEST-FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
                <!-- 文件路径 -->
                <file>${TEST_FILE_PATH}</file>
                <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                    <!-- 文件名称 -->
                    <fileNamePattern>${TEST_FILE_PATH}/info.%d{yyyy-MM-dd}.log</fileNamePattern>
                    <!-- 文件最大保存历史数量 -->
                    <MaxHistory>100</MaxHistory>
                </rollingPolicy>
                <layout class="ch.qos.logback.classic.PatternLayout">
                    <pattern>${PATTERN}</pattern>
                </layout>
            </appender>
            <root level="info">
                <appender-ref ref="TEST-FILE" />
            </root>
        </springProfile>
        
        <!-- 生产环境 -->
        <springProfile name="prod">
            <appender name="PROD_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
                <file>${PRO_FILE_PATH}</file>
                <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                    <fileNamePattern>${PRO_FILE_PATH}/warn.%d{yyyy-MM-dd}.log</fileNamePattern>
                    <MaxHistory>100</MaxHistory>
                </rollingPolicy>
                <layout class="ch.qos.logback.classic.PatternLayout">
                    <pattern>${PATTERN}</pattern>
                </layout>
            </appender>
            <root level="warn">
                <appender-ref ref="PROD_FILE" />
            </root>
        </springProfile>
    </configuration>

其中,springProfile 标签的 name 属性对应 application.yml 中的 spring.profiles.active 的配置。

即 spring.profiles.active 的值可以看作是日志配置文件中对应的 springProfile 是否生效的开关。

3.2 配置 log4j2
3.2.1 添加依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>

3.2.2 配置日志文件

spring boot 默认会加载 classpath:log4j2.xml 或者 classpath:log4j2-spring.xml。

如需要自定义文件名称,在 application.yml 中配置 logging.config 选项即可。

log4j2.xml 文件内容如下:

    <?xml version="1.0" encoding="utf-8"?>
    <configuration>
        <properties>
            <!-- 文件输出格式 -->
            <property name="PATTERN">%d{yyyy-MM-dd HH:mm:ss.SSS} |-%-5level [%thread] %c [%L] -| %msg%n</property>
        </properties>
        <appenders>
            <Console name="CONSOLE" target="system_out">
                <PatternLayout pattern="${PATTERN}" />
            </Console>
        </appenders>
        <loggers>
            <logger name="com.light.springboot" level="debug" />
            <root level="info">
                <appenderref ref="CONSOLE" />
            </root>
        </loggers>
    </configuration>

log4j2 不能像 logback 那样在一个文件中设置多个环境的配置数据,只能命名 3 个不同名的日志文件,分别在 application-dev,application-test 和 application-prod 中配置 logging.config 选项。

除了在日志配置文件中设置参数之外,还可以在 application-*.yml 中设置,日志相关的配置:

    logging.config                    # 日志配置文件路径,如 classpath:logback-spring.xml
    logging.exception-conversion-word # 记录异常时使用的转换词
    logging.file                      # 记录日志的文件名称,如:test.log
    logging.level.*                   # 日志映射,如:logging.level.root=WARN,logging.level.org.springframework.web=DEBUG
    logging.path                      # 记录日志的文件路径,如:d:/
    logging.pattern.console           # 向控制台输出的日志格式,只支持默认的 logback 设置。
    logging.pattern.file              # 向记录日志文件输出的日志格式,只支持默认的 logback 设置。
    logging.pattern.level             # 用于呈现日志级别的格式,只支持默认的 logback 设置。
    logging.register-shutdown-hook    # 初始化时为日志系统注册一个关闭钩子

四、打包运行

打包的形式有两种:jar 和 war。
4.1 打包成可执行的 jar 包

默认情况下,通过 maven 执行 package 命令后,会生成 jar 包,且该 jar 包会内置了 tomcat 容器,因此我们可以通过 java -jar 就可以运行项目
4.2 打包成部署的 war 包

让 SpringbootApplication 类继承 SpringBootServletInitializer 并重写 configure 方法,如下:

    @SpringBootApplication
    public class SpringbootApplication extends SpringBootServletInitializer {

        @Override
        protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
            return application.sources(SpringbootApplication.class);
        }

        public static void main(String[] args) {
            SpringApplication.run(SpringbootApplication.class, args);
        }
    }

修改 pom.xml 文件,将 jar 改成 war,如下:

    <packaging>war</packaging>

打包成功后,将 war 包部署到 tomcat 容器中运行即可。

©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

相关阅读更多精彩内容

友情链接更多精彩内容