spring-boot-admin笔记

╰+哭是因爲堅強的太久メ 2024-03-23 23:25 134阅读 0赞

spring-boot-admin笔记

  1. 本篇教程是基于springboot 2.3.8.RELEASE版本
  2. 和spring-boot-admin-dependencies 2.3.0版本

搭建spring-boot-admin的server端app

pom配置

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5.     <modelVersion>4.0.0</modelVersion>
  6.     <name>dftjk</name>
  7.     <description>Demo project for Spring Boot</description>
  10.     <groupId>cn.mt</groupId>
  11.     <artifactId>dftjk</artifactId>
  12.     <version>1.0-SNAPSHOT</version>
  14.     <properties>
  15.         <java.version>1.8</java.version>
  16.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  17.         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
  18.         <spring-boot.version>2.3.8.RELEASE</spring-boot.version>
  20.     </properties>
  22.     <dependencies>
  24.         <dependency>
  25.             <groupId>org.springframework.boot</groupId>
  26.             <artifactId>spring-boot-starter-web</artifactId>
  27.         </dependency>
  29.         <dependency>
  30.             <groupId>de.codecentric</groupId>
  31.             <artifactId>spring-boot-admin-starter-server</artifactId>
  32.         </dependency>
  34.         <dependency>
  35.             <groupId>org.springframework.boot</groupId>
  36.             <artifactId>spring-boot-starter-security</artifactId>
  37.         </dependency>
  39.         <dependency>
  40.             <groupId>org.springframework.boot</groupId>
  41.             <artifactId>spring-boot-configuration-processor</artifactId>
  42.             <optional>true</optional>
  43.         </dependency>
  44.         <dependency>
  45.             <groupId>org.projectlombok</groupId>
  46.             <artifactId>lombok</artifactId>
  47.             <optional>true</optional>
  48.         </dependency>
  49.         <dependency>
  50.             <groupId>org.springframework.boot</groupId>
  51.             <artifactId>spring-boot-starter-test</artifactId>
  52.             <scope>test</scope>
  53.         </dependency>
  54.     </dependencies>
  56.     <dependencyManagement>
  57.         <dependencies>
  58.             <dependency>
  59.                 <groupId>org.springframework.boot</groupId>
  60.                 <artifactId>spring-boot-dependencies</artifactId>
  61.                 <version>${spring-boot.version}</version>
  62.                 <type>pom</type>
  63.                 <scope>import</scope>
  64.             </dependency>
  66.             <dependency>
  67.                 <groupId>de.codecentric</groupId>
  68.                 <artifactId>spring-boot-admin-dependencies</artifactId>
  69.                 <version>2.3.0</version>
  70.                 <type>pom</type>
  71.                 <scope>import</scope>
  72.             </dependency>
  74.         </dependencies>
  75.     </dependencyManagement>
  77.     <build>
  78.         <plugins>
  79.             <plugin>
  80.                 <groupId>org.apache.maven.plugins</groupId>
  81.                 <artifactId>maven-compiler-plugin</artifactId>
  82.                 <version>3.8.1</version>
  83.                 <configuration>
  84.                     <source>1.8</source>
  85.                     <target>1.8</target>
  86.                     <encoding>UTF-8</encoding>
  87.                 </configuration>
  88.             </plugin>
  89.             <plugin>
  90.                 <groupId>org.springframework.boot</groupId>
  91.                 <artifactId>spring-boot-maven-plugin</artifactId>
  92.                 <version>${spring-boot.version}</version>
  93.                 <configuration>
  94.                     <mainClass>cn.mt.dft.App</mainClass>
  95.                 </configuration>
  96.                 <executions>
  97.                     <execution>
  98.                         <id>repackage</id>
  99.                         <goals>
  100.                             <goal>repackage</goal>
  101.                         </goals>
  102.                     </execution>
  103.                 </executions>
  104.             </plugin>
  105.         </plugins>
  106.     </build>
  108. </project>

启动类配置

  1. package cn.mt.dft;
  4. import de.codecentric.boot.admin.server.config.EnableAdminServer;
  5. import org.springframework.boot.SpringApplication;
  6. import org.springframework.boot.autoconfigure.SpringBootApplication;
  8. import org.springframework.scheduling.annotation.EnableScheduling;
  11. @EnableAdminServer
  12. @SpringBootApplication
  13. public class App {
  15.     public static void main(String[] args) {
  17.         SpringApplication.run(App.class, args);
  18.     }
  19. }

内置访问认证配置

  1. package cn.mt.dft;
  3. import de.codecentric.boot.admin.server.config.AdminServerProperties;
  4. import org.springframework.context.annotation.Configuration;
  5. import org.springframework.http.HttpMethod;
  6. import org.springframework.security.config.Customizer;
  7. import org.springframework.security.config.annotation.web.builders.HttpSecurity;
  8. import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
  9. import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
  10. import org.springframework.security.web.authentication.SavedRequestAwareAuthenticationSuccessHandler;
  11. import org.springframework.security.web.csrf.CookieCsrfTokenRepository;
  12. import org.springframework.security.web.util.matcher.AntPathRequestMatcher;
  14. import java.util.UUID;
  16. @Configuration
  17. @EnableWebSecurity
  18. public class SecurityConfig extends WebSecurityConfigurerAdapter {
  21.     private final AdminServerProperties adminServerProperties;
  23.     public SecurityConfig(AdminServerProperties adminServerProperties) {
  25.         this.adminServerProperties = adminServerProperties;
  26.     }
  29.     @Override
  30.     protected void configure(HttpSecurity http) throws Exception {
  32.         SavedRequestAwareAuthenticationSuccessHandler successHandler = new SavedRequestAwareAuthenticationSuccessHandler();
  33.         successHandler.setTargetUrlParameter("redirectTo");
  34.         successHandler.setDefaultTargetUrl(this.adminServerProperties.path("/"));
  36.         http.authorizeRequests(
  37.                 (authorizeRequests) -> authorizeRequests.antMatchers(this.adminServerProperties.path("/assets/**")).permitAll()
  38.                         .antMatchers(this.adminServerProperties.path("/login")).permitAll().anyRequest().authenticated()
  39.         ).formLogin(
  40.                 (formLogin) -> formLogin.loginPage(this.adminServerProperties.path("/login")).successHandler(successHandler).and()
  41.         ).logout((logout) -> logout.logoutUrl(this.adminServerProperties.path("/logout"))).httpBasic(Customizer.withDefaults())
  42.                 .csrf((csrf) -> csrf.csrfTokenRepository(CookieCsrfTokenRepository.withHttpOnlyFalse())
  43.                         .ignoringRequestMatchers(
  44.                                 new AntPathRequestMatcher(this.adminServerProperties.path("/instances"),
  45.                                         HttpMethod.POST.toString()),
  46.                                 new AntPathRequestMatcher(this.adminServerProperties.path("/instances/*"),
  47.                                         HttpMethod.DELETE.toString()),
  48.                                 new AntPathRequestMatcher(this.adminServerProperties.path("/actuator/**"))
  49.                         ))
  50.                 .rememberMe((rememberMe) -> rememberMe.key(UUID.randomUUID().toString()).tokenValiditySeconds(1209600));
  52.     }
  53. }

application.yml配置

  1. server:
  2.   port: 8814
  3.   compression:
  4.     enabled: true  # 开启Gzip压缩,响应数据超过1kb时触发gzip自动压缩,以提高前端响应时间
  5.     min-response-size: 1KB
  6.   servlet:
  7.     session:
  8.       timeout: PT30M  #默认会话过期时间30分钟
  9.     encoding:
  10.       enabled: true
  11.       charset: UTF-8
  12.       force: true
  13.   tomcat:
  14.     uri-encoding: UTF-8
  19. # http://localhost:8811/actuator/info 查看info端点会返还自定义的info信息
  20. info:
  21.   appname: dftjk
  22.   ver: 1.0
  24. # http://localhost:8811/actuator 查看暴露的所有可访问的端点
  25. # http://localhost:8811/actuator/health 查看health端点
  26. management:
  27.   endpoints:
  28.     web:
  29.       exposure:
  31.         include: [health,info,mappings] #开启health,info,mappings端点, 若配置*表示暴露所有端点
  32.   endpoint:
  33.     health:
  34.       show-details: always # health端点展示详细信息
  38. spring:
  39.   security:
  40.     user:
  41.       name: root
  42.       password: root
  43.   application:
  44.     name: dftjk
  45.   servlet:
  46.     multipart:
  47.       max-file-size: 50MB  #单个文件的最大上限
  48.       max-request-size: 200MB  #单个请求的文件总大小限制
  49.       location: ${
  50.     user.home}/.${
  51.     spring.application.name}/tempDir
  57. logging:
  58.   file:
  59.     #最终的存储路径是:  系统用户目录/.应用名称/logs/端口号/spring.log
  60.     path: ${
  61.     user.home}/.${
  62.     spring.application.name}/logs/${
  63.     server.port}
  64.     max-history: 7
  65.     max-size: 10MB
  66.   pattern:
  67.     console: "%date  %clr(%level) [${PID}]  [%thread] [%magenta(%X{traceId})] %cyan(%logger{10}) [%file : %line] %msg%n"
  68.     file: "%date %level [${PID}]   [%thread] [%X{traceId}] %logger{10} [%file : %line] %msg%n"

测试启动后的访问效果

  1. 访问localhost:8814
    请添加图片描述

登录密码是 root / root

  1. 登录进入主页
    请添加图片描述

因为此时还没有服务注册到spring-boot-admin-server，所以这里暂时没有应用记录

搭建spring-boot-admin的client端app

部分pom配置

  1. <dependencies>
  2.         <dependency>
  3.             <groupId>de.codecentric</groupId>
  4.             <artifactId>spring-boot-admin-starter-client</artifactId>
  5.         </dependency>
  6.         <dependency>
  7.             <groupId>org.springframework.boot</groupId>
  8.             <artifactId>spring-boot-starter-actuator</artifactId>
  9.         </dependency>
  10. </dependencies>
  11. <dependencyManagement>
  12.         <dependencies>
  13.             <dependency>
  14.                 <groupId>org.springframework.boot</groupId>
  15.                 <artifactId>spring-boot-dependencies</artifactId>
  16.                 <version>${spring-boot.version}</version>
  17.                 <type>pom</type>
  18.                 <scope>import</scope>
  19.             </dependency>
  21.             <dependency>
  22.                 <groupId>de.codecentric</groupId>
  23.                 <artifactId>spring-boot-admin-dependencies</artifactId>
  24.                 <version>2.3.0</version>
  25.                 <type>pom</type>
  26.                 <scope>import</scope>
  27.             </dependency>
  29.         </dependencies>
  30.     </dependencyManagement>

部分application.yml配置

  1. # http://localhost:8811/actuator/info 查看info端点会返还自定义的info信息
  2. info:
  3.   appname: dft
  4.   ver: 1.0
  6. # http://localhost:8811/actuator 查看暴露的所有可访问的端点
  7. # http://localhost:8811/actuator/health 查看health端点
  8. management:
  9.   endpoints:
  10.     web:
  11.       exposure:
  12.         include: '*'
  13. #        include: [health,info,mappings] #开启health,info,mappings端点, 若配置*表示暴露所有端点
  14.   endpoint:
  15.     health:
  16.       show-details: always # health端点展示详细信息
  17.     shutdown:
  18.       enabled: true #允许优雅停机
  19. logging:
  20.   file:
  21.     #最终的存储路径是:  系统用户目录/.应用名称/logs/端口号/spring.log
  22.     path: ${
  23.     user.home}/.${
  24.     spring.application.name}/logs/${
  25.     server.port}
  26.     max-history: 7
  27.     max-size: 10MB
  28.   pattern:
  29.     console: "%date  %clr(%level) [${PID}]  [%thread] [%magenta(%X{traceId})] %cyan(%logger{10}) [%file : %line] %msg%n"
  30.     file: "%date %level [${PID}]   [%thread] [%X{traceId}] %logger{10} [%file : %line] %msg%n"
  33. spring:
  34.   application:
  35.     name: dft
  36.   boot:
  37.     admin:
  38.       client:
  39.         enabled: true #启用spring-boot-admin
  40.         url: http://127.0.0.1:8814 #服务器端的访问地址
  41.         username: root #服务器端的访问账号
  42.         password: root #服务器端的访问密码

测试启动后的spring-boot-admin效果

  1. 启动刚刚建的client服务，然后访问spring-boot-admin服务器端-访问localhost:8814
    请添加图片描述
  2. 查看应用列表
    请添加图片描述
  3. 查看应用详情
    请添加图片描述
  4. 查看实时日志
    请添加图片描述

发表评论

表情：
评论列表 （有 0 条评论，134人围观）

还没有评论，来说两句吧...

相关阅读