前言

我們知道專案的監控是尤為重要的，但是我們如果用jdk 自帶的jconsole 和jvisualvm 的話會非常繁瑣，且介面不是很友好。之前我們使用了spring boot 專案，但是都沒有對專案有一個很好的監控。在spring 家族中有 spring-boot-admin 可以很好的幫我們起到監控微服務專案的作用。

spring-boot-admin 是一個針對 Spring Boot 的 Actuator 介面進行 UI 美化封裝的監控工具，它可以在列表中瀏覽所有被監控 spring-boot 專案的基本資訊、詳細的 Health 資訊、記憶體資訊、JVM 資訊、垃圾回收資訊、各種配置資訊（比如資料來源、快取列表和命中率）等，還可以直接修改 logger 的 level。

spring-boot-admin 分為服務端和客戶端。服務端是一個單獨的微服務，用來檢視監控的專案的執行情況，客戶端是我們一個個的微服務專案。所以要想讓我們的專案被服務端監控到，就需要將我們的服務註冊到服務端去。

好了，我們來動手試試吧。

admin-server

我們先來搭建spring-boot-admin 的服務端，上面說了服務端是一個單獨的專案。所以我們建立一個新的springboot 專案。建立好後，我們做一下修改。

pom.xml

在pom 檔案中，我們引入 如下依賴

<?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>2.2.2.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.quellanan</groupId>
    <artifactId>springbootadmin</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>springbootadmin</name>
    <description>springbootadmin project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
        <spring-boot-admin.version>2.2.1</spring-boot-admin.version>
    </properties>

    <dependencies>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>de.codecentric</groupId>
            <artifactId>spring-boot-admin-starter-server</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-security</artifactId>
        </dependency>

    </dependencies>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>de.codecentric</groupId>
                <artifactId>spring-boot-admin-dependencies</artifactId>
                <version>${spring-boot-admin.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

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

上面是我整個的pom 檔案，可以看到我引入了web 、admin-starter-server、security。
如果考慮其他的，可以只引用admin-starter-server 就可以實現效果。

啟動類

在我們的啟動類上加入@EnableAdminServer 註解，如果不加的話，專案可以正常啟動，但是看不到任何東西。@EnableAdminServer 註解的作用就是啟動監控。

@SpringBootApplication
@EnableAdminServer
public class SpringbootadminApplication {
    public static void main(String[] args) {
        SpringApplication.run(SpringbootadminApplication.class, args);
    }
}
 

配置 security

這樣配置好之後，就可以啟動專案啦，但是我們這裡先不啟動，因為上一節我們學習了，spring-boot-security .這裡我們將它用起來。
我們前面已經引入了 security ,接下來，我們在application中增加配置

spring.security.user.name=admin
spring.security.user.password=123456

表示這個使用者才能訪問。另外我們建立一個 SecurityConfig 類 繼承 WebSecurityConfigurerAdapter 重寫 configure(HttpSecurity http) 方法。程式碼如下：

@Configuration
public class SecurityConfig extends WebSecurityConfigurerAdapter {
    @Override
    protected void configure(HttpSecurity http) throws Exception {
        SavedRequestAwareAuthenticationSuccessHandler successHandler
                = new SavedRequestAwareAuthenticationSuccessHandler();
        successHandler.setTargetUrlParameter("redirectTo");
        successHandler.setDefaultTargetUrl("/");
        http.authorizeRequests()
                .antMatchers("/assets/**").permitAll()
                .antMatchers("/login").permitAll()
                .anyRequest().authenticated().and()
                .formLogin().loginPage("/login")
                .successHandler(successHandler).and()
                .logout().logoutUrl("/logout").and()
                .httpBasic().and()
                .csrf()
                .csrfTokenRepository(CookieCsrfTokenRepository.withHttpOnlyFalse())
                .ignoringAntMatchers(
                        "/instances",
                        "/actuator/**"
                );
    }
}

現在我們啟動一下專案看看。啟動專案後輸入

http://localhost:8080

會跳轉到 登入介面，進入主頁現在是什麼都沒有的。

admin-client

到此我們服務端的配置就已經可以了，現在我們來配置一下客戶端，我們隨便找一個Springboot 專案，或者自己建立一個新的專案都可以。

pom.xml

我們先在pom 檔案中加入admin-client 依賴，注意這裡的版本需要和server 的版本一致。

        <dependency>
            <groupId>de.codecentric</groupId>
            <artifactId>spring-boot-admin-starter-client</artifactId>
            <version>2.2.1</version>
        </dependency>

application.properties

然後我們在 application.properties 檔案中加入如下配置。

spring.boot.admin.client.url=http://localhost:8080
management.endpoints.web.exposure.include=*
spring.application.name=sdwlzlapp-file
spring.boot.admin.client.username=admin
spring.boot.admin.client.password=123456

spring.boot.admin.client.url 指向我們服務端的專案介面路徑。
management.endpoints.web.exposure.include 表示將所有埠都暴露出來，可以被監控到。
spring.application.name 表示改專案在spring-boot-admin 上的的顯示名稱。
spring.boot.admin.client.username 和password 就是設定的使用者名稱和密碼了，這裡需要注意的是，如果admin-server 中沒有整合 security 的話，不用配置使用者名稱和密碼也可以註冊進去，在服務端可以監控到，但如果admin-server 集成了security，就需要保證client 中配置的使用者名稱和server 中配置的使用者名稱密碼保持一致。

測試

配置了上面這些，就就可以將專案註冊到admin-server 中啦，我們啟動一下專案。

現在還有一個問題，如果我們專案本身就整合的安全框架，比如security ，沒有登入的話不能訪問介面，那這樣的專案怎麼被admin-server 監控到呢？比如就我們上節將的security 的demo ，我們註冊進來，雖然監控到了，但是是一個失敗的狀態。

可以看到，不難發現問題，那就是監控的介面也被專案本身攔截了，所以才導致是失敗的狀態，那要怎麼修改了呢，其實也好處理，將這幾個介面放開就可以了。我們在專案的SecurityConfig 類中configure(HttpSecurity http)加上

程式碼如下：

@Override
    protected void configure(HttpSecurity http) throws Exception {
        http.authorizeRequests()
            .antMatchers("/", "/hello").permitAll()
            .antMatchers( "/actuator/**").permitAll()
            .antMatchers( "/instances").permitAll()
            .anyRequest().authenticated()
            .and()
            .formLogin()
            //.loginPage("/login")
            .permitAll()
            .and()
            .logout()
            .permitAll();
    }

這樣我們重啟專案，就發現可以監控成功了。

番外

到此為止，我們也算是將spring-boot-admin的大致功能演示了下。

程式碼上傳到github：
https://github.com/QuellanAn/springbootadmin

後續加油♡

歡迎大家關注個人公眾號 "程式設計師愛酸奶"

分享各種學習資料，包含java，linux，大資料等。資料包含視訊文件以及原始碼，同時分享本人及投遞的優質技術博文。

如果大家喜歡記得關注和分享喲❤

相關推薦