SpringBoot(三) – Slf4j+logback 日誌，非同步請求，定時任務
- 2022 年 10 月 14 日
- 筆記
- springboot
1、Slf4j+logback 日誌
SpringBoot框架的默認日誌實現：slf4j + logback；
默認日誌級別：info，對應了實際生產環境日誌級別；
1.1 日誌級別
# 常見的日誌框架中，日誌級別都包含五種,優先順序從低到高：
trace < debug < info < warn < error
#日誌輸出規則是:
自動設置的日誌級及更高級別，進行日誌輸出;
比如當前日誌級別是info,那麼日誌輸出的級別包含:info，warn,error,凡是業務的這三個級別，都會輸出到日誌文件
1.1.1 trace 日誌級別
trace 日誌級別，了解，實際開發中，幾乎不會使用此級別；(配置文件指定為 trace 級別才會輸出)；
logger.trace("------------ trace 日誌級別，了解，實際開發中，幾乎不會使用此級別 ------------------");
1.1.2 debug 日誌級別
- debug 日誌級別，掌握，實際開發中，此日誌級別作為調試日誌使用，是線上調試問題定位的有效手段;
- 強調：線上一般默認是不開debug日誌，因此日誌級別記錄的日誌極為詳情，會產生大量的日誌內容及文件;
- 發現線上問題，不好定位時，臨時開啟debug;
logger.debug("------------ {} 日誌級別，{}，實際開發中，此日誌級別作為調試日誌使用，是線上調試問題定位的有效手段 ------------------","debug","掌握");
1.1.3 info 日誌級別
info 日誌級別，掌握，實際開發中，此日誌級別是核心業務環境日誌，不需要記錄特別詳細，一般都是介面 入和出，方便版本上線查看業務是否正常使用;
logger.info("------------ {} 日誌級別，{}，實際開發中，此日誌級別時核心業務環境日誌，不需要記錄特別詳細 ------------","info","掌握");
1.1.4 warn 日誌級別
warn 日誌級別，掌握，實際開發中,此日誌級別是業務警告日誌，警告日誌不一定是錯誤，可能業務異常流程，或者數據錯誤判斷;
logger.warn("------------ {} 日誌級別，{}，實際開發中,此日誌級別時業務警告日誌 ------------","warn","掌握");
1.1.5 error 日誌級別
error 日誌級別，掌握，實際開發中,此日誌級別是核心業務錯誤，凡是系統中出現了異常或者程式錯誤，都必須使用error日誌，級別最高，確保必須輸出，可以有效的記錄線上業務的錯誤;
logger.error("------------ {} 日誌級別，{}，實際開發中,此日誌級別是核心業務錯誤 ------------","error","掌握");
1.2 日誌使用
1.2.1 創建日誌對象
//創建日誌對象
Logger logger = LoggerFactory.getLogger(getClass());
logger.trace("");
logger.debug("");
logger.info("");
logger.warn("");
logger.error("");
1.2.2 @Slf4j 註解
@Slf4j
public class ChargeResultNotifySchedule{
log.trace("");
log.debug("");
log.info("");
log.warn("");
log.error("");
}
1.3 配置文件配置日誌 資訊
1.3.1 測試默認日誌級別
1.3.1.1 直接運行測試類
1.3.1.2 測試類增加 @RunWith(SpringRunner.class) 註解
測試類增加 @RunWith(SpringRunner.class) 註解 運行的是SpringBoot項目測試，會讀取到配置文件；
1.3.2 修改配置文件資訊
1.3.2.1 修改默認日誌級別為 debug
# 默認日誌級別為 info ，更改默認日誌級別debug
logging:
level:
com:
kgc:
sbt: debug
1.4 指定日誌輸出
1.4.1 指定日誌輸出到指定文件
- 默認日誌只輸出到控制台；
- 指定輸出到指定文件，默認會載入到根路徑下；
- 所有的日誌，都是追加記錄，不會執行覆蓋；
logging:
file: kh96-logging.log
日誌輸出到根目錄下的指定文件名下：
1.4.2 指定日誌輸入到指定目錄下
不指定文件名，SpringBoot中的logback會由默認的日誌名spring.log；
logging:
path: D:/KEGONGCHANG/DaiMa/IDEA/KH96/SpringBoot/SpringBoot/TempFile/kh96-logging2
默認名：
輸出文件：
1.4.3 指定輸出格式
# 了解 %d日期，%thread 執行緒名稱，%-5leavel 日誌級別 %logger{50} 日誌類路徑 %msg 日誌內容
logging:
pattern:
console: "%d{yyyy-MM-dd HH:mm:ss} +++ [%thread] +++ %-5level +++ %logger{100} +++ %msg%n"
file: "%d{yyyy-MM-dd HH:mm:ss} +++ [%thread] +++ %-5level +++ %logger{100} +++ %msg%n
1.4.4 指定輸入格式文件
網上由很多；
<?xml version="1.0" encoding="UTF-8"?>
<!--
scan：配置文件發生改變，是否被重新載入，默認值為true。
scanPeriod：設置監測配置文件是否有修改的時間間隔，當scan為true時，此屬性生效。默認的時間間隔為1分鐘。
debug：是否列印出logback內部日誌資訊，實時查看logback運行狀態。默認值為false。
-->
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<!-- 日誌的根目錄，可以自動創建log目錄，一般公司都是統一的日誌目錄，不能亂寫 -->
<property name="LOG_HOME" value="D:/KEGONGCHANG/DaiMa/IDEA/KH96/SpringBoot/SpringBoot/TempFile/log" />
<!-- 日誌文件名稱 -->
<property name="appName" value="log-sbt-kh96"/>
<!-- 控制台輸出 -->
<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
<!--
日誌輸出格式：
%d{日期時間格式}，
%thread：執行緒名，
%-5level：級別從左顯示5個字元寬度
%logger{60} 表示logger名字最長60個字元，否則按照句點分割。
%msg：記錄的日誌消息，
%n是換行符
-->
<layout class="ch.qos.logback.classic.PatternLayout">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{60} - %msg%n</pattern>
</layout>
</appender>
<!-- 滾動文件記錄，先將日誌記錄到指定文件，當符合某個條件時，將日誌記錄到其他文件 -->
<appender name="appLogAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 指定伺服器記錄日誌文件的名稱 -->
<file>${LOG_HOME}/${appName}.log</file>
<!--
當發生滾動時，決定 RollingFileAppender 的行為，涉及文件移動和重命名
TimeBasedRollingPolicy： 最常用的滾動策略，它根據時間來制定滾動策略，既負責滾動也負責觸發滾動。
-->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--
滾動時產生的文件的存放位置及文件名稱 %d{yyyy-MM-dd}：按天進行日誌滾動
%i：當文件大小超過maxFileSize時，按照i進行文件滾動
-->
<fileNamePattern>${LOG_HOME}/${appName}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
<!--
可選節點，控制保留的歸檔文件的最大數量，超出數量就刪除舊文件。假設設置每天滾動，
且maxHistory是30，則只保存最近30天的文件，刪除之前的舊文件。注意，刪除舊文件時，
那些為了歸檔而創建的目錄也會被刪除。
-->
<MaxHistory>30</MaxHistory>
<!--
當日誌文件超過maxFileSize指定的大小是，根據上面提到的%i進行日誌文件滾動 注意此處配置SizeBasedTriggeringPolicy是無法實現按文件大小進行滾動的，必須配置timeBasedFileNamingAndTriggeringPolicy
-->
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>30MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<!-- 日誌輸出格式： -->
<layout class="ch.qos.logback.classic.PatternLayout">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{60} : %line ] - %msg%n</pattern>
</layout>
</appender>
<!--
logger主要用於存放日誌對象，也可以定義日誌類型、級別
name：表示匹配的logger類型前綴，也就是包的前半部分
level：要記錄的日誌級別，包括 TRACE < DEBUG < INFO < WARN < ERROR
additivity：作用在於當前logger配置是否使用 rootLogger配置的appender進行輸出，即此logger的列印資訊是否向上級傳遞
false：表示只用當前logger的appender-ref
true：表示當前logger的appender-ref和rootLogger的appender-ref都有效
-->
<!-- 此種沒有指定自己的appender-ref，所以直接使用root標籤的配置 -->
<logger name="com.kgc.sbt" level="debug" />
<logger name="org.springframework" level="debug"/>
<!--
root與logger是父子關係，沒有特別定義則默認為root，任何一個類只會和一個logger對應，
要麼是定義的logger，要麼是root，判斷的關鍵在於找到這個logger，然後判斷這個logger的appender和level。
-->
<root level="debug">
<appender-ref ref="stdout" />
<appender-ref ref="appLogAppender" />
</root>
</configuration>
2、非同步請求
2.1 非同步請求處理實現類
@Service
@Slf4j
public class ChargeServiceImpl implements ChargeService{
@Override
@Async
//開啟非同步執行緒註解,如果是同一個類中的其他方法，添加此非同步處理註解，非同步是不生效的
//使用的是Spring內置的執行緒池
public void executesAsynCharge(String chargeTel, Double chargeMoney) {
try {
TimeUnit.MILLISECONDS.sleep(2000);
}catch (Exception e){
e.printStackTrace();
}
log.info("********* 非同步渠道 充值成功，充值手機號：{}，充值金額：{} ************",chargeTel,chargeMoney);
}
}
2.2 主啟動類
主啟動類上必須增加@EnableAsync 註解，開啟非同步處理功能；
@SpringBootApplication
@EnableAsync //開啟非同步處理功能
public class Springboot03AsyztimerApplication {
public static void main(String[] args) {
SpringApplication.run(Springboot03AsyzyimerApplication.class, args);
}
}
2.3 請求調用非同步處理方法
@RestController
@Slf4j
public class ChargeController {
@Autowired
ChargeService chargeService;
@GetMapping("/asyncCharge")
public String asyncCharge(@RequestParam("chargeTel") String chargeTel,@RequestParam("chargeMoney") Double chargeMoney){
log.info("------ 開始充值，充值手機號：{}，充值金額：{} 開始調用充值渠道充值 --------- ",chargeTel,chargeMoney);
// log startTimeMillis = System.currentTimeMillis(); //舊的獲取當前時間毫秒數
long startTimeMillis = Instant.now().toEpochMilli();
//調用充值渠道 非同步 充值
chargeService.executesAsynCharge(chargeTel,chargeMoney);
long finishTimeMillis = Instant.now().toEpochMilli();
log.info("------ 結束充值，充值手機號：{}，充值金額：{} ，充值總耗時:{}-----------",chargeTel,chargeMoney,finishTimeMillis-startTimeMillis);
return String.format("%s充值%s成功！",chargeTel,chargeMoney);
}
}
3、定時任務
3.1 場景
非同步充值結果，定時批量回調訂單；
public void chargeResultNotifyMethodOne(){
//模擬從資料庫獲取5筆需要回調的充值訂單，進行批量回調結果
List<String> chargeOrderList = Arrays.asList("KH001","KH002","KH003","KH004","KH005");
//循環處理需要回調的5筆訂單
log.info("---------- 開始 執行批量回調充值結果------------");
chargeOrderList.forEach(chargeOrderNo->{
log.info("***** 充值訂單：{}，回調重接成功！ ******");
try{
TimeUnit.MILLISECONDS.sleep(100);
}catch (Exception e){
e.printStackTrace();
}
log.info("---------- 結束 執行批量回調充值結果 ------------");
});
}
3.2 註解
3.2.1 @Scheduled(fixedDelay = 5 * 1000)
fixedDelay :計時規則： 從上一次執行結束 開始計時 到 下一次定時任務開始 ,不關心前一次定時任務耗時多久;
3.2.2 @Scheduled(fixedRate = 5 * 1000)
fixedRate: 計時規則：從上一次定時任務執行開始 開始計時 到 下一次定時任務開始，如果上一次定時任務 超過定時，上一次執行完後，下一次立即執行;
3.2.3 @Scheduled(cron = “*/5 * * * * ?”)
cron表達式：既可以是實現循環時間間隔，執行定時任務，也可以執行某個時刻的定時任務，通過指定表達式實現的，靈活度是三種最高的
1)循環定時： 每次執行的定時任務時間點，是由cron表達是決定的，其實都是預置好的；比如5秒，5秒執行一次定時
2)定點定時：在指定的某個時刻，執行一次定時任務
秒 分 時 日 月 周
@Scheduled(cron = "*/5 * * * * ?")
3.2.4 @EnableScheduling
@SpringBootApplication
@EnableScheduling //開啟定時任務功能
public class Springboot03AsyztimerApplication {
public static void main(String[] args) {
SpringApplication.run(Springboot03AsyzyimerApplication.class, args);
}
}
