SpringBoot3基礎(chǔ)用法
一、背景
最近在一個(gè)輕量級(jí)的服務(wù)中,嘗試了最新的技術(shù)和工具選型;
即SpringBoot3,JDK17,IDEA2023,Navicat16,雖然新的技術(shù)和工具都更加強(qiáng)大和高效,但是適應(yīng)采坑的過(guò)程總是枯燥的;
【環(huán)境一覽】
圖片
首先框架主體從SpringBoot2升級(jí)到SpringBoot3,Java基礎(chǔ)環(huán)境從JDK8升級(jí)到JDK17;
技術(shù)升級(jí)都到這步了,自然連帶著工具都升級(jí)到最新版本了,涉及到的其他組件,也會(huì)選擇與當(dāng)前框架適應(yīng)的版本;
至于為何使用JDK17,因?yàn)槭荢pringBoot3的最低依賴,也和官方的維護(hù)周期有關(guān);
圖片
實(shí)際上如果JDK21已經(jīng)發(fā)布的話,個(gè)人更傾于這個(gè)版本,要是沒(méi)有合適的嘗試機(jī)會(huì),繼續(xù)使用JDK8也問(wèn)題不大;
另外開(kāi)發(fā)工具IDEA2021.2版本才開(kāi)始支持JDK17,所以如果版本過(guò)低的話也需要升級(jí),至于Navicat16純屬跟風(fēng)操作;
二、環(huán)境搭建
1、工程結(jié)構(gòu)
在工程結(jié)構(gòu)上沒(méi)有什么變化,通過(guò)maven組件構(gòu)建項(xiàng)目,對(duì)于入門案例來(lái)說(shuō),注意框架依賴,啟動(dòng)類,配置文件即可;
圖片
2、框架依賴
在該工程中只是SpringBoot3框架的簡(jiǎn)單測(cè)試,所以只引入web依賴就足夠;
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<version>${spring-boot.version}</version>
</dependency>
</dependencies>
至于Spring框架和其他組件的依賴,順著web依賴追溯即可,核心的依賴和版本都可以找到;
圖片
3、環(huán)境配置
入門案例,在這里只簡(jiǎn)單的配置服務(wù)器和應(yīng)用名稱;
server:
port: 8082 # 端口號(hào)
tomcat: # Tomcat組件
uri-encoding: UTF-8 # URI編碼
spring:
application:
name: boot-base
三、入門案例
1、測(cè)試接口
提供一個(gè)簡(jiǎn)單的Get請(qǐng)求接口,使用了部分JDK新版的語(yǔ)法,如果拋出異常會(huì)統(tǒng)一處理;
@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("參數(shù)ID錯(cuò)誤");
}
var dataMap = new HashMap<String,String>();
dataMap.put("id",id);
dataMap.put("boot","base");
return dataMap ;
}
}
2、全局異常
基于注解RestControllerAdvice和ExceptionHandler統(tǒng)一異常處理;
@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文件中,簡(jiǎn)單的添加日志配置內(nèi)容,然后從日志文件或者控制臺(tái)輸出查看相關(guān)信息;
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() ;
}
}
四、打包運(yùn)行
打包代碼工程中的m1-01-boot-base子模塊,以及其相關(guān)的依賴;
mvn clean -pl m1-01-boot-base -am -Dmaven.test.skip=true package
運(yùn)行m1-01-boot-base.jar服務(wù),并指定相應(yīng)的端口號(hào)為8080,然后測(cè)試其中相關(guān)接口查看日志即可;
java -jar m1-01-boot-base.jar --server.port=8080
五、參考源碼
文檔倉(cāng)庫(kù):
https://gitee.com/cicadasmile/butte-java-note
源碼倉(cāng)庫(kù):
https://gitee.com/cicadasmile/butte-spring-parent