SpringBootAdmin使用

Posted 2020-11-25 一个笨蛋的博客

SpringBootAdmin用来管理和监控SpringBoot应用程序，它利用spring-boot-starter-actuator提供的功能，将各个微服务的状态整合到一起，并提供良好的界面查看支持，并且能够动态的修改实例日志级别。SpringBootAdmin分为server端和client端，server端可查看各个微服务的状态，client端将微服务注册到server端。github源码地址：https://github.com/codecentric/spring-boot-admin

1、服务端基本配置

  1）pom.xml依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
    <groupId>de.codecentric</groupId>
    <artifactId>spring-boot-admin-server</artifactId>
    <version>2.2.1</version>
</dependency>
<dependency>
    <groupId>de.codecentric</groupId>
    <artifactId>spring-boot-admin-server-ui</artifactId>
    <version>2.2.1</version>
</dependency>

  2）application.properties配置

server.port=8001
spring.application.name=admin-server

  3）SpringBoot启动类添加@EnableAdminServer注解

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

2、客户端基本配置

  1）pom.xml依赖

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

  2）application.properties配置

server.port=8002
spring.application.name=admin-client
spring.boot.admin.client.url=http://127.0.0.1:8001
management.endpoints.web.exposure.include=*
management.endpoint.health.show-details=ALWAYS

  3）客户端不需要做任何代码修改

3、查看SpringBootAdmin效果

  1）启动服务端和客户端后，访问http://127.0.0.1:8001，就可以查看所有注册的实例

  2）点击具体实例就可以查看到当前实例的具体运行状态，在该界面可查看应用实例的健康状态、线程、内存使用、GC时间

  3）修改日志级别。点击日志配置，根据包过滤需要修改的类，将level由info调整到debug后，该实例对应的代码就可以输出debug级别的日志了。

 

 

4、启用认证

  SpringBootAdmin的认证系统由spring-security管理。

  1）服务端pom.xml文件增加spring-security依赖，改为：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
    <groupId>de.codecentric</groupId>
    <artifactId>spring-boot-admin-server</artifactId>
    <version>2.2.1</version>
</dependency>
<dependency>
    <groupId>de.codecentric</groupId>
    <artifactId>spring-boot-admin-server-ui</artifactId>
    <version>2.2.1</version>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-security</artifactId>
</dependency>

  2）服务端application.properties增加security用户和密码配置信息，修改为：

server.port=8001
spring.application.name=admin-server
spring.security.user.name=admin
spring.security.user.password=abc123

  3）服务端增加Java代码，配置spring-security

package com.zhi.demo.config;

import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
import org.springframework.security.web.csrf.CookieCsrfTokenRepository;

import de.codecentric.boot.admin.server.config.AdminServerProperties;

/**
 * 配置security验证页面指向SpringBootAdmin提供的UI界面
 * 
 * @author zhi.leaf
 * @since 2020年1月20日17:44:25
 *
 */
@Configuration
public class SecuritySecureConfig extends WebSecurityConfigurerAdapter {

    private final String contextPath;

    public SecuritySecureConfig(AdminServerProperties adminServerProperties) {
        this.contextPath = adminServerProperties.getContextPath();
    }

    @Override
    protected void configure(HttpSecurity http) throws Exception {
        // 跨域设置，SpringBootAdmin客户端通过instances注册，见InstancesController
        http.csrf().csrfTokenRepository(CookieCsrfTokenRepository.withHttpOnlyFalse())
                .ignoringAntMatchers(contextPath + "/instances");

        http.authorizeRequests().antMatchers(contextPath + "/assets/**").permitAll(); // 静态资源
        http.authorizeRequests().anyRequest().authenticated(); // 所有请求必须通过认证

        // 整合spring-boot-admin-server-ui
        http.formLogin().loginPage("/login").permitAll();
        http.logout().logoutUrl("/logout").logoutSuccessUrl("/login");

        // 启用basic认证，SpringBootAdmin客户端使用的是basic认证
        http.httpBasic();
    }
}

  4）客户端application.properties也增加用户和密码信息，和服务端保持一致，改为

server.port=8002
spring.application.name=admin-client
spring.boot.admin.client.url=http://127.0.0.1:8001
spring.boot.admin.client.username=admin
spring.boot.admin.client.password=abc123

  5）重启服务端和客户端后，http://127.0.0.1:8001/，将会出现登录界面

5、通知提醒。SpringBootAdmin提供了多种通知功能，也可以自定义通知提醒。这里我们验证一下邮件通知功能

  1）服务端poxm.xml增加配置

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

  2）增加配置

spring.mail.host=smtp.qq.com
spring.mail.username=[e-mail]
spring.mail.password=xxxx

spring.boot.admin.notify.mail.from=[e-mail]
spring.boot.admin.notify.mail.to=[e-mail]

  3）当客户端实例停掉后，我们会受到如下邮件提醒，邮件模板是可以配置的。