本文將深入講解如何在 Spring Boot 3.3 中集成 Zipkin 來監控 RESTful API 的性能表現。我們將從 Zipkin 的基本概念出發，介紹它的安裝與配置，并通過前后端代碼示例演示如何實現對 API 調用鏈路的追蹤和性能監控。

什么是 Zipkin？

Zipkin 是一款分布式追蹤系統，最初由 Twitter 開發，專門用于幫助工程師分析和監控微服務架構下服務的通信。它能記錄跨越多個服務之間的調用鏈路，并且詳細地展示調用的耗時和路徑。Zipkin 的核心功能包括：

Zipkin 的工作原理

Zipkin 使用 Span 和 Trace 作為核心概念。每一個 Span 表示一個工作單元，例如一次服務調用或數據庫查詢。Trace 則是一組相關的 Span，它們表示某個請求從開始到結束的整個鏈路。Zipkin 會通過 Zipkin Server 收集并存儲這些 Span，然后在 Web UI 中可視化展示出來，幫助開發者分析性能數據。

Zipkin 的安裝與配置

運行 Zipkin 服務器

Zipkin 可以通過 Docker 運行，也可以直接下載可執行的 .jar 文件來啟動。以下是通過 Docker 安裝 Zipkin 的步驟：

docker run -d -p 9411:9411 openzipkin/zipkin

該命令會在 9411 端口啟動 Zipkin 服務，你可以通過瀏覽器訪問 http://localhost:9411 來查看 Zipkin 的 Web UI。

集成 Zipkin 到 Spring Boot

通過 Spring Cloud Sleuth，可以輕松將 Zipkin 集成到 Spring Boot 應用中。下面的 pom.xml 配置展示了如何添加 Zipkin 相關依賴。

項目依賴配置 (pom.xml)

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
 <modelVersion>4.0.0</modelVersion>
  <parent>
      <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-parent</artifactId>
     <version>3.3.4</version>
        <relativePath/> <!-- lookup parent from repository -->
  </parent>
 <groupId>com.icoderoad</groupId>
    <artifactId>zipkin-restful</artifactId>
 <version>0.0.1-SNAPSHOT</version>
   <name>zipkin-restful</name>
 <description>Demo project for Spring Boot</description>
 
    <properties>
      <java.version>17</java.version>
 </properties>
 <dependencies>
        <!-- Spring Boot Starter Web -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!-- Spring Boot Zipkin -->
         <dependency>
          <groupId>io.micrometer</groupId>
          <artifactId>micrometer-tracing-bridge-brave</artifactId>
        </dependency>
    
        <dependency>
          <groupId>io.zipkin.reporter2</groupId>
          <artifactId>zipkin-reporter-brave</artifactId>
        </dependency>

        <!-- Lombok -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <scope>provided</scope>
        </dependency>

        <!-- Thymeleaf -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-thymeleaf</artifactId>
        </dependency>

        <dependency>
          <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-test</artifactId>
           <scope>test</scope>
     </dependency>
 </dependencies>

   <build>
       <plugins>
         <plugin>
              <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-maven-plugin</artifactId>
           </plugin>
     </plugins>
    </build>

</project>

應用配置 (application.yml)

Zipkin 的服務地址和采樣率等相關配置可以通過 application.yml 文件進行設置。

server:
  port: 8080

spring:
  application:
    name: zipkin-monitoring-demo
  zipkin:
    base-url: http://localhost:9411  # Zipkin 服務器地址
  sleuth:
    sampler:
      probability: 1.0  # 采樣率設置為 1.0 表示采集所有請求

logging:
  level:
    org.springframework.web: DEBUG

讀取配置類（@ConfigurationProperties?配置）

為了更好地管理配置項，我們可以通過 @ConfigurationProperties 注解結合 Lombok 來簡化代碼。以下是自定義 Zipkin 配置類：

package com.icoderoad.zipkin.config;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

import lombok.Data;

@Data
@Component
@ConfigurationProperties(prefix = "spring.zipkin")
public class ZipkinProperties {
    private String baseUrl;
    private Double samplerProbability;
}

修改 RESTful API 示例

為了更好地展示 Zipkin 的追蹤功能，我們將創建一個返回 JSON 數據的 API，并展示它如何通過 Zipkin 進行監控。

package com.icoderoad.zipkin.controller;

import java.util.HashMap;
import java.util.Map;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class ApiController {

    @GetMapping("/api/test")
    public Map<String, String> testApi() {
        // 模擬業務邏輯
        Map<String, String> response = new HashMap<>();
        response.put("message", "API 調用成功！");
        response.put("status", "200 OK");
        return response;
    }
}

前端頁面展示 (Thymeleaf + jQuery + Bootstrap)

在前端，我們將使用 jQuery 調用 RESTful API 并展示返回的 JSON 數據。前端使用 Bootstrap 進行頁面美化，jQuery 來處理 API 請求。

在 src/main/resources/templates 目錄下創建 index.html 文件：

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>API 性能監控</title>
    <link  rel="stylesheet">
    <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.5.1/jquery.min.js"></script>
    <script src="https://maxcdn.bootstrapcdn.com/bootstrap/4.5.2/js/bootstrap.min.js"></script>
</head>
<body>
    <div class="container">
        <h1>Spring Boot 3 Zipkin 監控示例</h1>
        <button id="testApiBtn" class="btn btn-primary">調用 API</button>
        <div id="apiResponse" class="mt-3"></div>
    </div>

    <script>
        $(document).ready(function(){
            $('#testApiBtn').click(function(){
                $.ajax({
                    url: '/api/test',
                    type: 'GET',
                    dataType: 'json',
                    success: function(response) {
                        $('#apiResponse').html('<pre>' + JSON.stringify(response, null, 2) + '</pre>');
                    },
                    error: function() {
                        $('#apiResponse').html('<div class="alert alert-danger">API 調用失敗！</div>');
                    }
                });
            });
        });
    </script>
</body>
</html>

效果展示與分析

啟動 Spring Boot 應用并調用 /api/test 接口后，Zipkin 會記錄 API 調用鏈路信息。你可以通過訪問 http://localhost:9411/zipkin 查看追蹤數據。

Zipkin 追蹤示例：

  1. 服務調用的耗時：展示每個 API 請求在服務器端和中間件的響應時間。
  2. 調用鏈路分析：展示微服務架構下的調用順序，幫助開發者了解請求的具體流向。
  3. 性能瓶頸定位：通過分析每個 Span 的耗時，快速找出系統中性能較差的環節。

Zipkin 提供了直觀的 Web UI，可以方便地分析調用鏈路，定位性能問題。

總結

通過本文的演示，我們成功地將 Zipkin 集成到了 Spring Boot 3 項目中，監控 RESTful API 的性能表現。Zipkin 作為一款強大的分布式追蹤工具，能夠在微服務架構下幫助開發者快速定位系統瓶頸，優化服務性能。結合 Spring Cloud Sleuth 的使用，Zipkin 可以無縫集成到微服務項目中，實現對全鏈路調用的追蹤。

未來我們可以進一步擴展 Zipkin 的使用場景，例如與 Kafka、RabbitMQ 等消息隊列集成，實現更復雜的追蹤方案。

通過這些實踐，開發者可以更好地管理微服務架構，快速定位并解決系統性能瓶頸，從而提升系統的穩定性和用戶體驗。

文章轉自微信公眾號@路條編程

上一篇：

使用Spring Boot創建Restful API指南

下一篇：

Spring Boot 2.X 實戰--RESTful API 全局異常處理
#你可能也喜歡這些API文章!

我們有何不同？

API服務商零注冊

多API并行試用

數據驅動選型，提升決策效率

查看全部API→
??

熱門場景實測，選對API

#AI文本生成大模型API

對比大模型API的內容創意新穎性、情感共鳴力、商業轉化潛力

25個渠道
一鍵對比試用API 限時免費

#AI深度推理大模型API

對比大模型API的邏輯推理準確性、分析深度、可視化建議合理性

10個渠道
一鍵對比試用API 限時免費