快捷導(dǎo)航

Springboot集成magic-api的詳細過程

更新時間：2023年06月13日 08:59:46 作者：有一只柴犬

這篇文章主要介紹了Springboot集成magic-api的相關(guān)知識，本文結(jié)合實例代碼給大家介紹的非常詳細，對大家的學(xué)習或工作具有一定的參考借鑒價值,需要的朋友可以參考下

1、前言

今天項目中遇到一個問題，springboot后端項目經(jīng)常使用log4j輸出日志，同時會配置相應(yīng)日志級別。但是由于開發(fā)過程中不經(jīng)意間都會log.info("xxxx")來打印日志，而線上級別也會控制在info級別。正常不會有什么問題，但是今天有個超長報文傳輸，恰好日志在控制臺輸出了這段報文用作跟蹤。而log并沒有開啟緩存以及并行寫入，導(dǎo)致IO阻塞，程序無法正常響應(yīng)。

通常情況下，這種問題的解決措施為：

直接重啟程序
使用arths動態(tài)調(diào)整日志級別

arths是個好工具，很適合用于線上排障，應(yīng)對該場景也可以直接動態(tài)調(diào)整log級別，而不需要重啟服務(wù)器。那么今天再介紹另一個可以動態(tài)調(diào)整日志級別的工具，magic-api。magic-api

2、springboot集成magic-api

2.1、添加maven依賴

<dependency>    
    <groupId>org.ssssssss</groupId>    
    <artifactId>magic-api-spring-boot-starter</artifactId>    
    <version>2.1.0</version>
</dependency>

其他springboot的相關(guān)依賴就不贅述了。

2.2、application.yml配置

magic-api:
  web: /magic/web    # magic-api控制臺訪問地址
  resource:          # magic-api數(shù)據(jù)存儲信息配置
    location: workspace/magic/data      # location表示使用本地文件存儲，存儲路徑為工作目錄workspace/magic/data下
    datasource:        # datasource表示數(shù)據(jù)源存儲，這里指定使用的數(shù)據(jù)源， datasource和location選擇一個

2.3、編寫測試接口

@Slf4j
@RestController
@RequestMapping("test")
public class TestController {
    @GetMapping("index")
    public String index(){
        //  trace 級別日志        
        LOGGER.trace("-------trace------");
        //  debug 級別日志        
        LOGGER.debug("-------debug------");
        //  info 級別日志        
        LOGGER.info("-------info------");
        //  warn 級別日志        
        LOGGER.warn("-------warn------");
        //  error 級別日志        
        LOGGER.error("-------error------");
        return "ok";
    }
}

2.4、啟動程序，訪問接口

當看到控制臺輸出如下信息，就是已經(jīng)啟動成功了。

訪問接口：http://localhost:8083/test/index?？梢钥吹饺罩敬蛴。?/p>

由于默認日志級別是info，所以看到info以上級別的輸出。

2.5、magic-api腳本

打開magic-api控制臺：http://192.168.0.109:8083/magic/web/index.html

左側(cè)菜單欄選擇接口，接著空白處右鍵創(chuàng)建分組：

創(chuàng)建完分組后，創(chuàng)建接口：

創(chuàng)建后，在return "Hello magic-api"編輯框內(nèi)使用如下腳本：

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import ch.qos.logback.classic.Level;
import ch.qos.logback.classic.LoggerContext;
var levelName = "debug";
var packageName = "com.xxx";
LoggerFactory.getILoggerFactory().getLogger(packageName).setLevel(Level.toLevel(levelName));
return "OK";

由于springboot中使用了lombok，使用了默認的logback，所以這里的impor實現(xiàn)類需要找對。不然沒有效果。