【轉】Spring Boot 入門之配置基礎

原文地址：Spring Boot 入門之基礎篇（一）
博客地址：http://www.extlight.com

一、前言

Spring Boot 是由 Pivotal 團隊提供的全新框架，其設計目的是用來簡化新 Spring 應用的初始搭建以及開發過程。該框架使用了特定的方式來進行配置，從而使開發人員不再需要定義樣板化的配置。

本系列以快速入門爲主，可當作工具小手冊閱讀

二、環境搭建

創建一個 maven 工程，目錄結構如下圖：

2.1 添加依賴

創建 maven 工程，在 pom.xml 文件中添加如下依賴：

<!-- 定義公共資源版本 -->
<parent>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-parent</artifactId>
	<version>1.5.6.RELEASE</version>
	<relativePath /> 
</parent>

<properties>
	<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
	<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
	<java.version>1.8</java.version>
</properties>

<dependencies>
    <!-- 上邊引入 parent，因此 下邊無需指定版本 -->
    <!-- 包含 mvc,aop 等jar資源 -->
	<dependency>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-web</artifactId>
	</dependency>
</dependencies>

<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
        </plugin>
    </plugins>
</build>

2.2 創建目錄和配置文件

創建 src/main/resources 源文件目錄，並在該目錄下創建 application.properties 文件、static 和 templates 的文件夾。

application.properties：用於配置項目運行所需的配置數據。

static：用於存放靜態資源，如：css、js、圖片等。

templates：用於存放模板文件。

目錄結構如下：

2.3 創建啓動類

在 com.light.springboot 包下創建啓動類，如下：

/**
 該註解指定項目爲springboot，由此類當作程序入口
 自動裝配 web 依賴的環境
 
**/
@SpringBootApplication
public class SpringbootApplication {

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

2.4 案例演示

創建 com.light.springboot.controller 包，在該包下創建一個 Controller 類，如下：

@RestController
public class TestController {

	@GetMapping("/helloworld")
	public String helloworld() {
		return "helloworld";
	}
}

在 SpringbootApplication 文件中右鍵 Run as -> Java Application。當看到 “Tomcat started on port(s): 8080 (http)” 字樣說明啓動成功。

打開瀏覽器訪問 http://localhost:8080/helloworld，結果如下：

讀者可以使用 STS 開發工具，裏邊集成了插件，可以直接創建 Spingboot 項目，它會自動生成必要的目錄結構。

三、熱部署

當我們修改文件和創建文件時，都需要重新啓動項目。這樣頻繁的操作很浪費時間，配置熱部署可以讓項目自動加載變化的文件，省去的手動操作。

在 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>

配置好 pom.xml 文件後，我們啓動項目，隨便創建/修改一個文件並保存，會發現控制檯打印 springboot 重新加載文件的信息。

演示圖如下：

四、多環境切換

application.properties 是 springboot 在運行中所需要的配置信息。

當我們在開發階段，使用自己的機器開發，測試的時候需要用的測試服務器測試，上線時使用正式環境的服務器。

這三種環境需要的配置信息都不一樣，當我們切換環境運行項目時，需要手動的修改多出配置信息，非常容易出錯。

爲了解決上述問題，springboot 提供多環境配置的機制，讓開發者非常容易的根據需求而切換不同的配置環境。

在 src/main/resources 目錄下創建三個配置文件:

application-dev.properties：用於開發環境
application-test.properties：用於測試環境
application-prod.properties：用於生產環境

我們可以在這個三個配置文件中設置不同的信息，application.properties 配置公共的信息。

在 application.properties 中配置：

spring.profiles.active=dev

表示激活 application-dev.properties 文件配置， springboot 會加載使用 application.properties 和 application-dev.properties 配置文件的信息。

同理，可將 spring.profiles.active 的值修改成 test 或 prod 達到切換環境的目的。

演示圖如下：

五、配置日誌

5.1 配置 logback（官方推薦使用）

5.1.1 配置日誌文件

spring boot 默認會加載 classpath:logback-spring.xml 或者 classpath:logback-spring.groovy。

如需要自定義文件名稱，在 application.properties 中配置 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.properties 中的 spring.profiles.active 的配置。

即 spring.profiles.active 的值可以看作是日誌配置文件中對應的 springProfile 是否生效的開關。

5.2 配置 log4j2

5.2.1 添加依賴

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

5.2.2 配置日誌文件

spring boot 默認會加載 classpath:log4j2.xml 或者 classpath:log4j2-spring.xml。

如需要自定義文件名稱，在 application.properties 中配置 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-*.properties 中設置，日誌相關的配置：

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。

6.1 打包成可執行的 jar 包

默認情況下，通過 maven 執行 package 命令後，會生成 jar 包，且該 jar 包會內置了 tomcat 容器，因此我們可以通過 java -jar 就可以運行項目，如下圖：

6.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 容器中運行即可。

【轉】Spring Boot 入門之配置基礎

一、前言

二、環境搭建

2.1 添加依賴

2.2 創建目錄和配置文件

2.3 創建啓動類

2.4 案例演示

三、熱部署

四、多環境切換

五、配置日誌

5.1 配置 logback（官方推薦使用）

5.2 配置 log4j2

六、打包運行

6.1 打包成可執行的 jar 包

6.2 打包成部署的 war 包

七、參考資料

AI 畫圖真刺激，手把手教你如何用 ComfyUI 來畫出刺激的圖

公司剛入職了一名 Java 中級開發，短短 4 行代碼居然湊齊了 3 個 bug！我哭了~~

公衆號5月C#/.NET熱文一覽

git 下載大陸鏡像地址

【轉】UAP studio基礎使用技巧

【轉】【Books】史上最全的Java進階書籍推薦

【轉】Spring Boot 官方文檔筆記

【轉】Spring Boot 入門之配置基礎

【轉】Eclipse安裝Maven插件（其他插件同理）

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結