2. 程式人生 > >Spring Boot 入門之基礎篇（一）

Spring Boot 入門之基礎篇（一）

阿新 • • 發佈：2018-12-25

一、前言

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

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

二、環境搭建

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

image

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：用於存放模板檔案。

目錄結構如下：

image

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)” 字樣說明啟動成功。

image

讀者可以使用 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 重新載入檔案的資訊。

演示圖如下：

image

四、多環境切換

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 達到切換環境的目的。

演示圖如下：

image

五、配置日誌

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 就可以執行專案，如下圖：

image

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 入門之基礎篇（一）

一、前言 Spring Boot 是由 Pivotal 團隊提供的全新框架，其設計目的是用來簡化新 Spring 應用的初始搭建以及開發過程。該框架使用了特定的方式來進行配置，從而使開發人員不再需要定義樣板化的配置。 本系列以快速入門為主，可當作工具小手冊閱讀

Spring Boot 學習之基礎篇（一）

該系列並非完全原創，官方文件、作者Spring Boot 是由 Pivotal 團隊提供的全新框架，其設計目的是用來簡化新 Spring 應用的初始搭建以及開發過程。該框架使用了特定的方式來進行配置，從而使開發人員不再需要定義樣板化的配置。一、環境搭建建立一個Maven專案，

Spring Boot 入門之 Web 篇（二）

一、前言 上一篇《Spring Boot 入門之基礎篇（一）》介紹了 Spring Boot 的環境搭建以及專案啟動打包等基礎內容，本篇繼續深入介紹 Spring Boot 與 Web 開發相關的知識。 二、整合模板引擎 由於 jsp 不被 SpringBoot 推薦使用，所以模板引擎主

Java多執行緒之基礎篇（一）

一、併發和並行 1.1 概念 1.2 比較 1.3 程序和執行緒 二、基礎概念 2.1 執

Spring Boot 學習之 Web 篇（二）

該系列並非完全原創，官方文件、作者一、前言上一篇《Spring Boot 入門之基礎篇（一）》介紹了 Spring Boot 的環境搭建以及專案啟動打包等基礎內容，本篇繼續深入介紹 Spring Boot 與 Web 開發相關的知識。二、整合模板引擎由於 jsp 不被 Spr

Spring Boot學習入門之Hello World（一）

1.通過Spring Initializr（地址：http://start.spring.io/）生成Spring Boot專案結構 2.匯入Spring Boot專案 pom.xml內容： 3.編寫RESTful API 4.啟動Spring Boot應用 三

nodejs之elasticsearch使用：基礎篇（一）

nodejs之elasticsearch使用：基礎篇（一） 前言 程式碼 前言 本節只是嘗試使用nodejs中的elasticsearch模組實現elasticsearch在node環境下的基本增刪改查。 具體方法詳情

Spring Boot 官方文件學習（一）入門及使用

轉載：http://www.cnblogs.com/larryzeal/p/5799195.html 目錄：  一、內建Servlet Container： Name Servlet Version Java Version Tomcat 8 3.1

微控制器入門基礎篇（一）：Keil基本操作

Keil基本操作     文/阿丘  2018/3/28一、概述    工欲善其事必先利其器。Keil uVersion 4.0（後文簡稱為Keil 4.0）是微控制器程式開發的整合開發環境（IDE），集成了C編譯器、巨集彙編、聯結器、庫管理和一個功能強大的模擬偵錯程式。 

Spring+SpringMVC+MyBatis+easyUI整合基礎篇（一）專案簡述及技術選型介紹

萌芽階段 很久之前就開始打算整理一下自己的技術部落格了，由於各種原因(藉口總是可以找到的)，實在抽不出時間所以計劃一直處於擱置狀態，一直只是心底的一顆小萌芽，日復一日的悠悠歲月如同手中緊抓的沙子，無聲無息的流失，不過這顆小生命也在我渴望與期待的澆灌下不斷的長大。

JAVA工程師成神之路--基礎篇（一）目錄

在網上看到一篇文章“java成神之路”，按照上面的要求大幹一番，看看能不能成神。 具體指標 一、基礎篇 1-1 JVM     1.1.1  JAVA記憶體           1.1.1.1  JAVA記憶體模型           1.1.1.2 JAVA記憶體管理  

C#系列之基礎知識點（一）

命名規則 系列 字符 註釋 編輯器 小數類型 智能 規則 解釋 知識點一：VS啟動方法 第一種：雙擊圖標 第二種：window+R——調出cmd，輸入devenu properties 屬性的意思 知識點二:後綴名解釋 .sln 解決方案文件：包含整個解決方案的信息 .

Python 之 基礎知識（一）

post 練習 初學 查看 http 變量 規則 style python程序 首先，對於初學者在一個項目中設置多個程序可以執行，是非常方便的，可以方便對不同知識點的練習和測試 對於商業項目而言，通常在一個項目中，只有一個可以執行的Python程序 一、註釋 為了提高可讀性

Zabbix3.4之安裝篇（一）

entos agent roo zabb com serve arc centos 7 mysql- 實驗環境：Centos 71.下載zabbix yum 文件 [root@xiaopeng /]# cd /etc/yum.repos.d/ [root@xiaop

Zabbix 3.4之 安裝篇（一）

systemctl 防火墻 sql數據庫 x86_64 mage system 啟動 輸入密碼 shang 實驗環境：Centos 7```1.下載zabbix yum 文件[root@xiaopeng /]# cd /etc/yum.repos.d/[root@x

淺析 rand7生成rand10 方法 之 思想篇（一）

同余 one a + b 個數 height 意義 UC ogr edi 【問題描寫敘述】 rand7是一個能生成1-7的隨機數。要求利用rand7生成1-10的隨

構建NetCore應用框架之實戰篇（一）：什麽是框架，如何設計一個框架

net 希望 dmi 清晰 構建 組織 評估 系統開發 概念 一、系列簡述 本篇起，將通過一系列文章，去描述如何構建一個應用開發框架，並以作者開發的框架為例，逐個點展開分析，如何從零開始，構建自己的開發框架。 本系列文章的目的，是帶領有一編程經驗的人，通過動手，初步完成

網絡基礎篇（一）

分時 osi模型 郵件 高層 不用 電子設備 2msl 基於 三種 OSI模型的七層結構 1、物理層： 二進傳輸 為啟動、維護以及關閉物理鏈路定義了電氣規範、機械規範、過程規範、和功能規範。 2、數據鏈路層： 訪問介質： 定義如何格式化數據以便進行傳輸以及如何控制對網絡的訪

嵌入式linux學習之基礎知識（一） linux檔案許可權

linux 檔案許可權相關 Linux使用者分為： 擁有者、組群（Group）、其他（Other） linux檔案的許可權總共有10位，如 -rwxrwxr-x ,分為4段。 第一段 佔1位 表示檔案的型別 - ：表示普通檔案 d ：表示資料夾、目錄 l ：表示連結檔案，類似window

spring boot 整合thyemleaf基本使用（一）

thyemleaf基本使用 ：首先引入依賴thyemleaf <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-star