SpringBoot3基礎案例：環境搭建，入門案例，日志組件，全局異常處理，工程打包，服務啟動關閉；

技術和工具「!喜新厭舊」

一、背景

最近在一個輕量級的服務中，嘗試了最新的技術和工具選型；

即SpringBoot3，JDK17，IDEA2023，Navicat16，雖然新的技術和工具都更加強大和高效，但是適應采坑的過程總是枯燥的；

【環境一覽】

首先框架主體從SpringBoot2升級到SpringBoot3，Java基礎環境從JDK8升級到JDK17；

技術升級都到這步了，自然連帶著工具都升級到最新版本了，涉及到的其他組件，也會選擇與當前框架適應的版本；

至于為何使用JDK17，因為是SpringBoot3的最低依賴，也和官方的維護周期有關；

實際上如果JDK21已經發布的話，個人更傾于這個版本，要是沒有合適的嘗試機會，繼續使用JDK8也問題不大；

另外開發工具IDEA2021.2版本才開始支持JDK17，所以如果版本過低的話也需要升級，至于Navicat16純屬跟風操作；

二、環境搭建

1、工程結構

在工程結構上沒有什么變化，通過maven組件構建項目，對于入門案例來說，注意框架依賴，啟動類，配置文件即可；

2、框架依賴

在該工程中只是SpringBoot3框架的簡單測試，所以只引入web依賴就足夠；

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
        <version>${spring-boot.version}</version>
    </dependency>
</dependencies>

至于Spring框架和其他組件的依賴，順著web依賴追溯即可，核心的依賴和版本都可以找到；

3、環境配置

入門案例，在這里只簡單的配置服務器和應用名稱；

server:
  port: 8082                # 端口號
  tomcat:                   # Tomcat組件
    uri-encoding: UTF-8     # URI編碼

spring:
  application:
    name: boot-base

三、入門案例

1、測試接口

提供一個簡單的Get請求接口，使用了部分JDK新版的語法，如果拋出異常會統一處理；

@RestController
public class BootBaseWeb {

    @GetMapping("/boot/base/{id}")
    public Map<String,String> getInfo (@PathVariable String id){
        if (id.isBlank() || "0".equals(id)){
            throw new RuntimeException("參數ID錯誤");
        }
        var dataMap = new HashMap<String,String>();
        dataMap.put("id",id);
        dataMap.put("boot","base");
        return dataMap ;
    }
}

2、全局異常

基于注解RestControllerAdvice和ExceptionHandler統一異常處理；

@RestControllerAdvice
public class HandlerExe {

    @ExceptionHandler(value = Exception.class)
    public Map<String,String> handler02 (HttpServletRequest request, Exception e){
        var errorMap = new HashMap<String,String>() ;
        errorMap.put("code","500");
        errorMap.put("url",request.getRequestURL().toString());
        errorMap.put("msg",e.getMessage());
        return errorMap ;
    }
}

3、日志打印

3.1 日志配置

在application.yml文件中，簡單的添加日志配置內容，然后從日志文件或者控制臺輸出查看相關信息；

logging:
  level:
    root: info
  file:
    path: ./
    name: logs/${spring.application.name}.log
  pattern:
    console: "%d{yyyy-MM-dd HH:mm:ss} %contextName [%thread] %-5level %logger- %msg%n"
    file: "%d{yyyy-MM-dd HH:mm:ss} %contextName [%thread] %-5level %logger- %msg%n"
  logback:
    rolling-policy:
      max-history: 7
      max-file-size: 10MB
      total-size-cap: 50MB

3.2 日志打印

雖然采用的是logback組件，但是使用slf4j的API即可；

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

@RestController
public class BootLogWeb {

    private static final Logger LOGGER = LoggerFactory.getLogger(BootBaseWeb.class);

    @GetMapping("/boot/print/log")
    public String printLog (HttpServletRequest request){
        LOGGER.info("remote-host:{}",request.getRemoteHost());
        LOGGER.info("request-uri:{}",request.getRequestURI());
        return request.getServerName() ;
    }
}

四、打包運行

打包代碼工程中的m1-01-boot-base子模塊，以及其相關的依賴；

mvn clean -pl m1-01-boot-base -am -Dmaven.test.skip=true package

運行m1-01-boot-base.jar服務，并指定相應的端口號為8080，然后測試其中相關接口查看日志即可；

java -jar m1-01-boot-base.jar --server.port=8080

五、參考源碼

文檔倉庫：
https://gitee.com/cicadasmile/butte-java-note

源碼倉庫：
https://gitee.com/cicadasmile/butte-spring-parent