Spring Boot 入門之基礎篇（一）

時間  2019-11-08
標籤 spring boot 入門 基礎 欄目 Spring 简体版
原文   原文鏈接

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

1、前言

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

本系列以快速入門爲主，可看成工具小手冊閱讀java

2、環境搭建

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

image

2.1 添加依賴

建立 maven 工程，在 pom.xml 文件中添加以下依賴：github

<!-- 定義公共資源版本 -->
<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 的文件夾。web

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

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

templates：用於存放模板文件。tomcat

目錄結構以下：springboot

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

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

image

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

3、熱部署

當咱們修改文件和建立文件時，都須要從新啓動項目。這樣頻繁的操做很浪費時間，配置熱部署可讓項目自動加載變化的文件，省去的手動操做。

在 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

4、多環境切換

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、配置日誌

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    # 初始化時爲日誌系統註冊一個關閉鉤子

6、打包運行

打包的形式有兩種：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 容器中運行便可。

7、參考資料

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程