Spring Boot Admin 快速入门详解

1、介绍

官网地址

spring boot admin 是开源社区孵化的项目，用于对 spring boot 应用的管理和监控。spring boot admin 分为服务端(spring-boot-admin-server)和客户端(spring-boot-admin-client)，服务端和客户端之间采用 http 通讯方式实现数据交互；单体项目中需要整合 spring-boot-admin-client 才能让应用被监控。在 springcloud 项目中，spring-boot-admin-server 是直接从注册中心抓取应用信息，不需要每个微服务应用整合 spring-boot-admin-client 就可以实现应用的管理和监控。

2、服务端搭建

2.1 引入依赖

注意：版本要和 spring boot 版本对应，例如我的 spring boot 是 2.3.7.release，那么 spring boot admin 对应的版本就是 2.3.x。

<!-- spring boot admin 服务端依赖 -->
<dependency>
    <groupid>de.codecentric</groupid>
    <artifactid>spring-boot-admin-starter-server</artifactid>
    <version>2.3.1</version>
</dependency>

2.2 添加注解

给启动类添加一个注解：@enableadminserver

@enableadminserver
@springbootapplication(exclude = {datasourceautoconfiguration.class})
public class serverapplication {
     public static void main(string[] args) {
        springapplication.run(serverapplication.class, args);
    }
}

2.3 进行测试

访问项目的端口号即可！

例如我配置的端口号是 9000，那么直接访问 http://localhost:9000/ 即可！

2.4 测试结果

3、客户端搭建

3.1 引入依赖

注意：版本要和 spring boot 版本对应，例如我的 spring boot 是 2.3.7.release，那么 spring boot admin 对应的版本就是 2.3.x。

<!-- spring boot admin 客户端依赖 -->
<dependency>
    <groupid>de.codecentric</groupid>
    <artifactid>spring-boot-admin-starter-client</artifactid>
    <version>2.3.1</version>
</dependency>

3.2 编写配置

编写 application.yml 文件：

spring:
  application:
    name: client
  boot:
    admin:
      client:
        # 配置 admin server（服务端的名字）
        url: http://localhost:9000
server:
  port: 9001
 # 开放端点用于 springboot admin 的监控
management:
  endpoints:
    web:
      exposure:
        include: '*'
logging:
  file:
    # 配置生成日志文件名称
    name: admin-client.log

3.3 进行测试

启动项目，然后访问服务端的 web 管理界面：

4、安全性

这个 spring boot admin 的管理后台不用账号密码就能直接访问，一点都不安全，因此要给它加上登录的功能。

参考 spring boot admin 的官方文档，我们可以在 admin-server 端添加 spring security 相关依赖及就可以实现需要登录后才能访问网页管理面板。

官网文档地址

4.1 添加依赖

在服务端添加 spring security 依赖：

<dependency>
    <groupid>org.springframework.boot</groupid>
    <artifactid>spring-boot-starter-security</artifactid>
</dependency>

4.2 编写配置

编写 application.yml 文件，编写用户名密码：

server:
  port: 9000
spring:
  application:
    name: server
  security:
    user:
      name: admin
      password: admin

4.3 编写配置类

编写 spring security 的配置类：

@configuration
public class securityconfig extends websecurityconfigureradapter {
    private final string admincontextpath;
     public securityconfig(adminserverproperties adminserverproperties) {
        this.admincontextpath = adminserverproperties.getcontextpath();
    }
     @override
    protected void configure(httpsecurity http) throws exception {
        savedrequestawareauthenticationsuccesshandler successhandler = new 		savedrequestawareauthenticationsuccesshandler();
        successhandler.settargeturlparameter("redirectto");
        successhandler.setdefaulttargeturl(admincontextpath + "/");
        http.authorizerequests()
                // 1. 配置所有静态资源和登录页可以公开访问（匿名访问）
                .antmatchers(admincontextpath + "/assets/**").permitall()
                .antmatchers(admincontextpath + "/login").permitall()
                .anyrequest().authenticated()
                .and()
                // 2. 配置登录和登出路径
                .formlogin().loginpage(admincontextpath + "/login").successhandler(successhandler).and()
                .logout().logouturl(admincontextpath + "/logout").and()
                // 3. 开启 http basic 支持，客户端注册时需要使用
                .httpbasic().and()
                .csrf()
                // 4. 开启基于 cookie 的 csrf 保护
                .csrftokenrepository(cookiecsrftokenrepository.withhttponlyfalse())
                // 5. 忽略这些路径的 csrf 保护以便客户端注册
                .ignoringantmatchers(
                        admincontextpath + "/instances",
                        admincontextpath + "/actuator/**"
                );
    }
}

4.4 修改客户端配置

修改客户端的 application.yml 配置文件，添加用户名密码：

这里不添加用户名和密码的话，是连不上服务端的：

spring:
  application:
    name: client
  boot:
    admin:
      client:
        # 配置 admin server（服务端的名字）
        url: http://localhost:9000
        # 配置用户名
        username: admin
        # 配置密码
        password: admin

4.5 进行测试

重启客户端和服务端项目

访问效果为：

总结

本篇文章就到这里了，希望能够给你带来帮助，也希望您能够多多关注的更多内容！