Spring Boot 提供了運行時的應用監控和管理功能，我們可以通過http、JMX進行操作。

全部章節傳送門：
Spring Boot學習筆記（一）：Spring Boot 入門基礎
Spring Boot學習筆記（二）：Spring Boot 運行原理
Spring Boot學習筆記（三）：Spring Boot Web開發
Spring Boot學習筆記（四）：Spring Boot 數據訪問
Spring Boot學習筆記（五）：Spring Boot 企業級開發
Spring Boot學習筆記（六）：Spring Boot 應用監控

常見端點介紹

Spring Boot 2.0提供的常用端點如下所示。

配置端點

默認情況下，所有的端點都是打開的，除了 shutdown 端點。可以通過 management.endpoint.<id>.enabled的值設置為true或者false。

例如，想要打開 shutdown 端點，可以在application.properties中配置：

management.endpoint.shutdown.enabled=true

默認情況下，所有的端點都可以通過JMX查看，而只有health端點和info端點可以通過HTTP查看。我們可以通過配置進行修改。

management.endpoints.web.exposure.include=health,info 
management.endpoints.web.exposure.exclude=
management.endpoints.jmx.exposure.include=*
management.endpoints.jmx.exposure.exclude=

查看端點

創建 Spring Boot 項目，添加 Actuator、Web和HATEOAS依賴。

<?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 http://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>2.1.3.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.wyk</groupId>
    <artifactId>actuatordemo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>actuatordemo</name>
    <description>Demo project for Spring Boot Actustor</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-hateoas</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</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.properties中添加配置信息。

# 開啟所有端點允許HTTP查看
management.endpoints.web.exposure.include=*
# 顯示詳細健康信息
management.endpoint.health.show-details=always

然后運行程序，即可查看端點信息。

登錄 http://localhost:8080/actuator 。

actuator端點查看.png

登錄 http://localhost:8080/actuator/health 查看端點信息。

health端點查看.png

除了shutdown端點需要POST方式查看，其他端點均可直接查看。

還可以通過JMX對應用進行管理和監控。在控制臺輸入 jconsole即可進入JMX。

然后選擇我們的程序進入界面，然后在MBean標簽的org.springframework.boot域下可以對程序進行監控和管理。

jmx界面.png

自定義端點

自定義端點需要使用如下注釋。

• @Endpoint 是構建 rest 的唯一路徑。不同請求的操作，調用時缺少必需參數，或者使用無法轉換為所需類型的參數，則不會調用操作方法，響應狀態將為400（錯誤請求）
• @ReadOperation = GET 響應狀態為 200 如果沒有返回值響應 404（資源未找到）。

• @WriteOperation = POST 響應狀態為 200 如果沒有返回值響應 204（無響應內容）
• @DeleteOperation = DELETE 響應狀態為 200 如果沒有返回值響應 204（無響應內容）

依舊使用上面的工程，添加一個實體類。

package com.wyk.actuatordemo;

import org.springframework.boot.actuate.endpoint.annotation.Endpoint;
import org.springframework.boot.actuate.endpoint.annotation.ReadOperation;
import org.springframework.boot.actuate.endpoint.annotation.WriteOperation;
import org.springframework.stereotype.Component;

@Endpoint(id="status")
@Component
public class StatusEndpoint {
    private String status;

    @ReadOperation
    public String getStatus() {
        return status;
    }

    @WriteOperation
    public void setStatus(String status) {
        this.status = status;
    }
}

然后修改運行類。

package com.wyk.actuatordemo;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@SpringBootApplication
@RestController
public class ActuatordemoApplication {

    @Autowired
    StatusEndpoint statusEndpoint;

    public static void main(String[] args) {
        SpringApplication.run(ActuatordemoApplication.class, args);
    }

    @RequestMapping("/change")
    public String changeStatus(String status) {
        //StatusEndpoint statusEndpoint = new StatusEndpoint();
        statusEndpoint.setStatus(status);
        return "OK";
    }
}

運行程序，打開 http://localhost:8080/actuator/status， 這時候會報404，是因為status沒有值。

自定義端點狀態1.png

再打開一個窗口，輸入 http://localhost:8080/change?status=123 ， 這時候再打開 http://localhost:8080/actuator/status ，就可以看到了。

自定義端點狀態2.png

自定義 HealthIndicator

Health 信息是從 AppliciationContext 中所有的 HealthIndicator 的 Bean 中收集的， Spring 內置的HealthIndicator 如下所示。

要實現自己的 HealthIndicator 只需要實現 HealthIndicator 類。

package com.wyk.actuatordemo;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.actuate.health.Health;
import org.springframework.boot.actuate.health.HealthIndicator;

public class StatusHealth implements HealthIndicator {
    @Autowired
    StatusEndpoint statusEndpoint;

    @Override
    public Health health() {
        String status = statusEndpoint.getStatus();

        if(status == null || !status.equals("123")) {
            return Health.down().withDetail("Error", "Not Running").build();
        }
        return  Health.up().build();


    }
}

運行程序，打開 http://localhost:8080/actuator/health 查看。

自定義health.png