SpringBoot2.X监控和管理神器：SpringBoot Admin

逃离我推掉我的手 2023-07-24 02:50 31阅读 0赞

# 前言 #

我们在使用SpringBoot的时候，特别的敏捷与方便，开发起来特别的快。比如加入`spring-boot-starter-web`这个启动器，就能开发JavaWeb项目；我们再加入`mybatis-spring-boot-starter`这个启动器，就能使用MyBatis操作数据库。相比之前我们使用SSM，真的省去很多配置，那我们有没有想过，为什么使用SpringBoot就不要配置了？**原因**：通过查看源码知道，每个启动器里面都做了自动配置，MyBatis的自动配置类：**MybatisAutoConfiguration**，SpringMVC自动配置类：**WebMvcAutoConfiguration**，可以在配置文件中覆盖默认配置。  
![在这里插入图片描述][20200409002126635.png]

1.  假设我们不看SpringBoot源码，可能就不知道SpringBoot到底做了哪些自动配置，所以一款SpringBoot开源项目就出来了：SpringBoot Admin。
2.  由于SpringBoot Admin就是将**SpringBoot Actuator**中提供的**endpoint**信息可视化表示，并且可以通过邮件、Telegram、Hipchat等发送告警消息。所以先介绍SpringBoot Actuator。

# SpringBoot Actuator #

由于博文篇幅原因，单独写一篇介绍：SpringBoot Actuator。  
[应用监控之 SpringBoot Actuator 使用及配置][SpringBoot Actuator]

# SpringBoot Admin #

1.  SpringBoot Admin是一个开源社区项目，用于管理和监控SpringBoot应用程序。
2.  SpringBoot应用程序作为**SpringBoot Admin Client**注册在**SpringBoot Admin Server**（通过HTTP） ，展示SpringBoot Admin Client的Actuator端点上的一些图形化监控。

# SpringBoot-Admin工作流程图 #

下图简单描述了SpringBoot-Admin的作用，就是为之前的SpringBoot Actuator提供图形化管理与监控。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDE3NjE2OQ_size_16_color_FFFFFF_t_70]

# SpringBoot-Admin-Server #

我们先搭建SpringBoot-Admin-Server，因为它要时刻监听是否有SpringBoot-Admin-Client注册进来。

1.  引入SpringBoot-Admin-Server启动器依赖。
    
        <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>
            <version>2.1.3</version>
        </dependency>
2.  修改默认端口号。
    
        server:
          port: 9999
3.  在启动类上添加\*\*@EnableAdminServer\*\*注解，表示开启SpringBoot-Admin-Server。启动SpringBoot-Admin-Server项目，之后在浏览器输入：http://localhost:9999。会发现页面一直在转圈，这是因为还没有Client注册进来。
    
        @SpringBootApplication
        @EnableAdminServer
        public class SpringBootAdminServer { 
            public static void main(String[] args) { 
                SpringApplication.run(SpringBootAdminServer.class, args);
            }
        }
    
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDE3NjE2OQ_size_16_color_FFFFFF_t_70 1]

# SpringBoot-Admin-Client #

上面已经搭建完SpringBoot-Admin-Server，接下来就搭建SpringBoot-Admin-Client。

1.  引入SpringBoot-Admin-Client启动器依赖，版本一定要和上面Server的版本一致，不然可能会出现意外的惊喜。
    
        <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.1.3</version>
        </dependency>
2.  在配置文件中，将SpringBoot-Admin-Client注册到SpringBoot-Admin-Server中，以及暴露想要暴露的端点。
    
        server:
          port: 8888
        spring:
          boot:
            admin:
              client:
                url: http://localhost:9999 #SpringBoot Admin Server地址
                instance:
                  name: SpringBoot-Admin-ClientOne #注册上去的服务名称
        management:
          endpoints:
            web:
              exposure:
                include: '*' #暴露所有的Actuator端点
          endpoint:
            health:
              show-details: always
3.  启动SpringBoot-Admin-Client应用，在回到之前访问的路径：http://localhost:9999。从下图看，SpringBoot-Admin-Client已经成功注册到SpringBoot-Admin-Server当中了。  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDE3NjE2OQ_size_16_color_FFFFFF_t_70 2]

# 玩转SpringBoot-Admin #

上面已经搭建好SpringBoot-Admin-Server和SpringBoot-Admin-Client了，上面还说过，SpringBoot-Admin就是将SpringBoot Actuator暴露的端点提供图形化管理与监控，那接下来就开始了解SpringBoot-Admin页面平台。

1.  直接点击列表中的SpringBoot-Admin-Client，就会跳转到该客户端详细页面，里面展示了它暴露的端点。  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDE3NjE2OQ_size_16_color_FFFFFF_t_70 3]
2.  点击左侧的Environment，就会显示当前客户端应用使用的JDK版以及其他信息。  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDE3NjE2OQ_size_16_color_FFFFFF_t_70 4]
3.  点击左侧beans，就会显示所有注册在Spring IOC容器的bean。  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDE3NjE2OQ_size_16_color_FFFFFF_t_70 5]
4.  点击Mappings，就会显示所有的URL映射信息。  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDE3NjE2OQ_size_16_color_FFFFFF_t_70 6]
5.  点击Loggers，就会显示当前客户端应用任意包，任意类所使用的日志级别。里面的日志级别支持点击修改的。  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDE3NjE2OQ_size_16_color_FFFFFF_t_70 7]

# 总结 #

1.  本篇博客重点介绍如何搭建SpringBoot-Admin平台，只是介绍了里面一些功能，其他的功能要靠大家自己搭建去完了。
2.  附上SpringBoot-Admin官方说明文档：[SpringBoot-Admin官方说明文档][SpringBoot-Admin]。
3.  [本篇博客源代码][Link 1]。

[20200409002126635.png]: /images/20230528/af6d5857f82344c28a98d71ac0c2f014.png
[SpringBoot Actuator]: https://blog.csdn.net/weixin_44176169/article/details/105402127
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDE3NjE2OQ_size_16_color_FFFFFF_t_70]: /images/20230528/bb3a2e7f5474407cbe626829f975d0d8.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDE3NjE2OQ_size_16_color_FFFFFF_t_70 1]: /images/20230528/d1af8bbeb5c94d028c1658e1db449d3d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDE3NjE2OQ_size_16_color_FFFFFF_t_70 2]: /images/20230528/bbed8d08ab0c4229954b6be5c6d555b5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDE3NjE2OQ_size_16_color_FFFFFF_t_70 3]: /images/20230528/d334579ee6144abfb78d562bdda64a83.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDE3NjE2OQ_size_16_color_FFFFFF_t_70 4]: /images/20230528/94fe6e23ab4142d599f2f03b64475a90.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDE3NjE2OQ_size_16_color_FFFFFF_t_70 5]: /images/20230528/6b3f9afe74c743c393c1bc08818dcc72.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDE3NjE2OQ_size_16_color_FFFFFF_t_70 6]: /images/20230528/336eac4d1932473f87c8e2608e296280.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDE3NjE2OQ_size_16_color_FFFFFF_t_70 7]: /images/20230528/7acd3aed0a8048789583b5026ad6e424.png
[SpringBoot-Admin]: https://codecentric.github.io/spring-boot-admin/2.2.1/#securing-spring-boot-admin
[Link 1]: https://github.com/ZhengWenQi98/SpringBoot