使用IntelliJ IDEA構(gòu)建Spring Boot項目示例

我們介紹新建Spring Boot項目的流程, 主要內(nèi)容包含

  • 創(chuàng)建項目
  • 配置日志環(huán)境
  • 使用配置文件
  • 多環(huán)境下的配置文件
  • 寫一個demo服務
  • 打包和部署

1. 創(chuàng)建項目

  1. 打開IntelliJ IDEA, 選擇菜單File->New->Project.

  2. 輸入組織名稱(Group)和項目名稱(Artifact).


  3. 添加依賴包. 添加Web: Web即可. 我們建議添加一個插件Core: Lombok. 它可以在編譯的時候自動生成模版代碼(例如Getter和Setter).

    image.png

  4. 按照提示一路Next就能完成項目的創(chuàng)建. 項目文件夾的結(jié)構(gòu)如下圖所示.


    image.png

  5. 打開DemoSpringBootApplication.java, 然后點擊編輯器中的三角形圖標即可啟動服務. 至此項目創(chuàng)建完畢.

    image.png

2. 配日志環(huán)境

我們使用SLF4j + Log4j2, 其中SLF4j是一個日志框架, 而Log4j2是日志框架的一種實現(xiàn). 更多信息讀者可以自行參考其他教程.

  1. 在pom.xml文件中添加如下依賴. 
    <!-- 日志依賴: SLF4j + Log4j2 -->
    <!-- SLF4j核心包 -->
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-api</artifactId>
    </dependency>
    <!-- SLF4j橋接Log4j2 -->
    <dependency>
        <groupId>org.apache.logging.log4j</groupId>
        <artifactId>log4j-slf4j-impl</artifactId>
        <version>2.11.2</version>
    </dependency>
    <!-- Log4j2核心包 -->
    <dependency>
        <groupId>org.apache.logging.log4j</groupId>
        <artifactId>log4j-api</artifactId>
        <version>2.11.2</version>
    </dependency>
    <dependency>
        <groupId>org.apache.logging.log4j</groupId>
        <artifactId>log4j-core</artifactId>
        <version>2.11.2</version>
    </dependency>
  2. 在指定的位置添加execlusion, 目的是過濾Springboot自帶的日志依賴. 
        <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
        <!-- 去掉springboot自帶的日志依賴 -->
        <exclusions>
            <exclusion>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-logging</artifactId>
            </exclusion>
        </exclusions>
    </dependency>
  3. 添加Log4j2的配置文件log4j2.xml到resources文件夾下. 關(guān)于Log4j2如何配置, 可以自行參考網(wǎng)上教程.
    下面的配置文件設置了3個日志輸出:
    • 控制臺 日志等級:INFO
    • 文件(logs/info.log) 日志等級: INFO
    • 文件(logs/error.log) 日志等級: ERROR
    <?xml version="1.0" encoding="UTF-8"?>
<!--日志級別以及優(yōu)先級排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
<Configuration>
    <Appenders>
        <!-- 控制臺的配置 -->
        <Console name="Console" target="SYSTEM_OUT">
            <!--輸出日志的格式-->
            <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%5p] - %l - %m%n"/>
        </Console>
        <!-- 輸出文件的配置 - INFO -->
        <RollingFile name="RollingFileInfo" fileName="./logs/info.log"
                     filePattern="./logs/info-%d{yyyyMMdd}.log">
            <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%5p] - %l - %m%n" charset="UTF-8"/>
            <!--輸出level及以上級別的信息 -->
            <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
            <Policies>
                <!-- 日志文件的滾動時間間隔: 1天(單位取決于filePattern定義的粒度) -->
                <TimeBasedTriggeringPolicy interval="1" modulate="false"/>
                <!-- 單個日志文件最大size -->
                <SizeBasedTriggeringPolicy size="50 MB"/>
            </Policies>
        </RollingFile>
        <!-- 輸出文件的配置 - ERROR -->
        <RollingFile name="RollingFileError" fileName="./logs/error.log"
                     filePattern="./logs/error-%d{yyyyMMdd}.log">
            <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%5p] - %l - %m%n" charset="UTF-8"/>
                <!--輸出level及以上級別的信息 -->
            <ThresholdFilter level="ERROR" onMatch="ACCEPT" onMismatch="DENY"/>
            <Policies>
                <!-- 日志文件的滾動時間間隔: 1天(單位取決于filePattern定義的粒度) -->
                <TimeBasedTriggeringPolicy interval="1" modulate="true"/>
                <!-- 單個日志文件最大size -->
                <SizeBasedTriggeringPolicy size="50 MB"/>
            </Policies>
        </RollingFile>
    </Appenders>
    <Loggers>
        <!--過濾掉框架的日志信息 -->
        <Logger name="org.springframework" level="WARN" />
        <Logger name="org.hibernate" level="WARN" />
        <Root level="INFO">
            <AppenderRef ref="Console"/>
            <AppenderRef ref="RollingFileInfo"/>
            <AppenderRef ref="RollingFileError"/>
        </Root>
    </Loggers>
</Configuration>
  4. 測試日志環(huán)境: 添加注解@Slf4j可直接使用log變量.
    DemoSpringBootApplicationTests.java 
    @Slf4j
@RunWith(SpringRunner.class)
@SpringBootTest
public class DemoSpringBootApplicationTests {
    @Test
    public void testLogger() {
        log.info("Logger is OK");
        log.error("Logger is OK");
    }
}
    我們能看到如下的日志信息: 
    2019-05-10 10:54:18.096 [ INFO] - com.example.demospringboot.DemoSpringBootApplicationTests.testLogger(DemoSpringBootApplicationTests.java:20) - Logger is OK  
2019-05-10 10:54:18.097 [ERROR] - com.example.demospringboot.DemoSpringBootApplicationTests.testLogger(DemoSpringBootApplicationTests.java:21) - Logger is OK

3. 使用配置文件

我們可以在application.properties文件中添加自定義配置, 例如

myConfig.foo=foo-foo
myConfig.bar=bar-bar

在代碼中讀取配置的方法如下. 新建一個配置類(名字任意):
MyConfig.java

@Data
@Component
public class MyConfig {
    @Value("${myConfig.foo}")
    private String foo;
    @Value("${myConfig.bar}")
    private String bar;
}

注解說明

  • @Data 為類提供讀寫方法, 此外還提供了 equals(), hashCode(), toString() 方法.
  • @Component Spring Boot為類提供管理功能, 可以自動生成對象.
  • @Value (lombok) 讀取配置文件中定義的字段.

注意 由于我們使用Spring Boot框架來加載配置文件, 因此不能直接通過new MyConfig()這樣的操作來初始化對象, 否則無法讀取配置. 正確的使用方式應該是使用注解@Autowired, 由框架來幫助我們初始化對象.

MyConfigTest.java

@RunWith(SpringRunner.class)
@SpringBootTest
public class MyConfigTest {

    @Autowired
    private MyConfig myConfig;

    @Test
    public void test() {
        System.out.println("myConfig.foo = " + myConfig.getFoo());
        System.out.println("myConfig.bar = " + myConfig.getBar());
    }
}

運行上面的測試代碼, 結(jié)果如下.

myConfig.foo = foo-foo
myConfig.bar = bar-bar

4. 多環(huán)境下的配置文件

實際的項目開發(fā)可能會有多套環(huán)境, 分別采用不同的配置. 為了方便打包和部署, 我們可以按照application-[xxx].properties的格式命名, 其中[xxx]代表環(huán)境名稱. 示例如下:

  • 開發(fā)環(huán)境: application-dev.properties
  • 測試環(huán)境: application-test.properties
  • 線上環(huán)境: application-online.properties

然后在application.properties中設置當前環(huán)境的名稱.

# 設置當前環(huán)境為開發(fā)環(huán)境
spring.profiles.active=dev

Spring Boot的默認配置可以參考 Common application properties.

5. 寫一個demo服務

我們實現(xiàn)如下功能: 當用戶訪問 http://localhost:8080/config時返回配置文件的內(nèi)容. 實現(xiàn)代碼如下.

Controller.java

@RestController
public class Controller {

    // 配置類
    private MyConfig myConfig;

    @Autowired
    public Controller(MyConfig myConfig) {
        this.myConfig = myConfig;
    }

    // 以把配置文件的內(nèi)容以JSON格式返回
    @RequestMapping(value = "/config", method = RequestMethod.GET)
    public String getConfig() {
        return new Gson().toJson(myConfig);
    }

}

說明: Gson類把對象轉(zhuǎn)換成JSON字符串, 可以在pom.xml中添加如下依賴.

<!-- 處理JSON -->
<dependency>
    <groupId>com.google.code.gson</groupId>
    <artifactId>gson</artifactId>
    <version>2.8.5</version>
</dependency>

6. 打包和部署

  1. 點擊工具欄Edit Configurations菜單


  2. 點"+"(加號)新建Maven配置


    image.png
  3. 命令行輸入: clean package, 然后確定
    image.png
  4. 運行上一步建立的maven配置, IDE會在target文件夾下生成demo-spring-boot-0.0.1-SNAPSHOT.jar.
    注意 如果想跳過單元測試, 可以在pom.xml的plugins節(jié)點中添加如下依賴: 
    <plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-surefire-plugin</artifactId>
    <configuration>
        <skip>true</skip>
    </configuration>
</plugin>
  5. 進入target文件夾, 然后運行java -jar demo-spring-boot-0.0.1-SNAPSHOT.jar即可啟動服務. 在瀏覽器訪問http://localhost:8080/config可以測試結(jié)果.

7. 完整的示例代碼

https://github.com/xianqiu/demo-spring-boot

公眾號：生活研究生（mo_hulage）
最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點，簡書系信息發(fā)布平臺，僅提供信息存儲服務。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容