关于SpringBoot的一些常用知识点整合

喜欢ヅ旅行 2022-11-24 11:23 195阅读 0赞

## 一，Spring Config ##

在Spring3.0之前，我们的bean一直通过XML文件来配置的，后来在Spring3.0之后为我们提供了java的config版本。而且在Spring4.0之后推荐我们使用，这篇文章基于Spring5.2来分析。希望在平时使用和面试的时候对你有一丝帮助。

**一、实例演示**

我们先给出一个例子，看看如何使用，然后再来分析。创建一个普通的maven项目。

**第一步：添加pom依赖**

<dependencies>
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-core</artifactId>
                 <version>5.2.2.RELEASE</version>
            </dependency>
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-beans</artifactId>
                <version>5.2.2.RELEASE</version>
            </dependency>
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-context</artifactId>
                <version>5.2.2.RELEASE</version>
            </dependency>
            <dependency>
                <groupId>org.junit.jupiter</groupId>
                <artifactId>junit-jupiter-api</artifactId>
                <version>5.3.2</version>
                <scope>test</scope>
            </dependency>
    </dependencies>

这里面添加了最核心的依赖。

**第二步：在bean包添加User类**

public class User {
        private Integer id;
        private String name;
        private String password;
        public User() {
        }
        public User(Integer id, String name, String password) {
            this.id = id;
            this.name = name;
            this.password = password;
        }
        //setter和getter方法
        //toString方法
    }

**第三步：在service包添加UserService类**

public class UserService {
        public List<User> queryAll(){
            //创建一个新的list集合，用来承接数据，充当返回值
            List<User> users=new ArrayList<User>();
            //添加数据name,pass
            for (int i=0;i<10;i++){
                User user = new User();
                user.setId(i);
                user.setName("name==>"+i);
                user.setPassword("pass==>"+i);
                users.add(user);
            }
            return users;
        }
    }

注意这里没有@Service注解。目的就是我们自己注入。

**第四步：在config包添加UserConfig类**

@Configuration
    public class UserConfig {
        @Bean
        public UserService userService(){
            return new UserService();
        }
    }

## 二，如何重新加载 Spring Boot 上的更改，而无需重新启动服务器 (SpringBoot热部署) ##

**开启热部署:**

<dependency>
    
       <groupId>org.springframework.boot</groupId>
    
       <artifactId>spring-boot-devtools</artifactId>
    
       <optional>true</optional>
    
    </dependency>

## 三，Spring Boot 中的监视器 --Actuator 监控应用 ##

微服务的特点决定了功能模块的部署是分布式的，大部分功能模块都是运行在不同的机器上，彼此通过服务调用进行交互，前后台的业务流会经过很多个微服务的处理和传递，出现了异常如何快速定位是哪个环节出现了问题？

在这种框架下，微服务的监控显得尤为重要。本文主要结合 Spring Boot Actuator，跟大家一起分享微服务 Spring Boot Actuator 的常见用法，方便我们在日常中对我们的微服务进行监控治理。

## Actuator 监控 ##

Spring Boot 使用“习惯优于配置的理念”，采用包扫描和自动化配置的机制来加载依赖 Jar 中的 Spring bean，不需要任何 Xml 配置，就可以实现 Spring 的所有配置。虽然这样做能让我们的代码变得非常简洁，但是整个应用的实例创建和依赖关系等信息都被离散到了各个配置类的注解上，这使得我们分析整个应用中资源和实例的各种关系变得非常的困难。

Actuator 是 Spring Boot 提供的对应用系统的自省和监控的集成功能，可以查看应用配置的详细信息，例如自动化配置信息、创建的 Spring beans 以及一些环境属性等。

为了保证 actuator 暴露的监控接口的安全性，需要添加安全控制的依赖`spring-boot-start-security`依赖，访问应用监控端点时，都需要输入验证信息。Security 依赖，可以选择不加，不进行安全管理，但不建议这么做。

## Actuator 的 REST 接口 ##

Actuator 监控分成两类：原生端点和用户自定义端点；自定义端点主要是指扩展性，用户可以根据自己的实际应用，定义一些比较关心的指标，在运行期进行监控。

原生端点是在应用程序里提供众多 Web 接口，通过它们了解应用程序运行时的内部状况。原生端点又可以分成三类：

*  应用配置类：可以查看应用在运行期的静态信息：例如自动配置信息、加载的 springbean 信息、yml 文件配置信息、环境信息、请求映射信息；
 *  度量指标类：主要是运行期的动态信息，例如堆栈、请求连、一些健康指标、metrics 信息等；
 *  操作控制类：主要是指 shutdown,用户可以发送一个请求将应用的监控功能关闭。

Actuator 提供了 13 个接口，具体如下表所示。

<table> 
 <thead> 
  <tr> 
   <th>HTTP 方法</th> 
   <th>路径</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>GET</td> 
   <td>/auditevents</td> 
   <td>显示应用暴露的审计事件 (比如认证进入、订单失败)</td> 
  </tr> 
  <tr> 
   <td>GET</td> 
   <td>/beans</td> 
   <td>描述应用程序上下文里全部的 Bean，以及它们的关系</td> 
  </tr> 
  <tr> 
   <td>GET</td> 
   <td>/conditions</td> 
   <td>就是 1.0 的 /autoconfig ，提供一份自动配置生效的条件情况，记录哪些自动配置条件通过了，哪些没通过</td> 
  </tr> 
  <tr> 
   <td>GET</td> 
   <td>/configprops</td> 
   <td>描述配置属性(包含默认值)如何注入Bean</td> 
  </tr> 
  <tr> 
   <td>GET</td> 
   <td>/env</td> 
   <td>获取全部环境属性</td> 
  </tr> 
  <tr> 
   <td>GET</td> 
   <td>/env/{name}</td> 
   <td>根据名称获取特定的环境属性值</td> 
  </tr> 
  <tr> 
   <td>GET</td> 
   <td>/flyway</td> 
   <td>提供一份 Flyway 数据库迁移信息</td> 
  </tr> 
  <tr> 
   <td>GET</td> 
   <td>/liquidbase</td> 
   <td>显示Liquibase 数据库迁移的纤细信息</td> 
  </tr> 
  <tr> 
   <td>GET</td> 
   <td>/health</td> 
   <td>报告应用程序的健康指标，这些值由 HealthIndicator 的实现类提供</td> 
  </tr> 
  <tr> 
   <td>GET</td> 
   <td>/heapdump</td> 
   <td>dump 一份应用的 JVM 堆信息</td> 
  </tr> 
  <tr> 
   <td>GET</td> 
   <td>/httptrace</td> 
   <td>显示HTTP足迹，最近100个HTTP request/repsponse</td> 
  </tr> 
  <tr> 
   <td>GET</td> 
   <td>/info</td> 
   <td>获取应用程序的定制信息，这些信息由info打头的属性提供</td> 
  </tr> 
  <tr> 
   <td>GET</td> 
   <td>/logfile</td> 
   <td>返回log file中的内容(如果 logging.file 或者 logging.path 被设置)</td> 
  </tr> 
  <tr> 
   <td>GET</td> 
   <td>/loggers</td> 
   <td>显示和修改配置的loggers</td> 
  </tr> 
  <tr> 
   <td>GET</td> 
   <td>/metrics</td> 
   <td>报告各种应用程序度量信息，比如内存用量和HTTP请求计数</td> 
  </tr> 
  <tr> 
   <td>GET</td> 
   <td>/metrics/{name}</td> 
   <td>报告指定名称的应用程序度量值</td> 
  </tr> 
  <tr> 
   <td>GET</td> 
   <td>/scheduledtasks</td> 
   <td>展示应用中的定时任务信息</td> 
  </tr> 
  <tr> 
   <td>GET</td> 
   <td>/sessions</td> 
   <td>如果我们使用了 Spring Session 展示应用中的 HTTP sessions 信息</td> 
  </tr> 
  <tr> 
   <td>POST</td> 
   <td>/shutdown</td> 
   <td>关闭应用程序，要求endpoints.shutdown.enabled设置为true</td> 
  </tr> 
  <tr> 
   <td>GET</td> 
   <td>/mappings</td> 
   <td>描述全部的 URI路径，以及它们和控制器(包含Actuator端点)的映射关系</td> 
  </tr> 
  <tr> 
   <td>GET</td> 
   <td>/threaddump</td> 
   <td>获取线程活动的快照</td> 
  </tr> 
 </tbody> 
</table>

## 快速上手 ##

### 相关配置 ###

**项目依赖**

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

**配置文件**

info.app.name=spring-boot-actuator
    info.app.version= 1.0.0
    info.app.test=test
    
    management.endpoints.web.exposure.include=*
    management.endpoint.health.show-details=always
    #management.endpoints.web.base-path=/monitor
    
    management.endpoint.shutdown.enabled=true

*  `management.endpoints.web.base-path=/monitor` 代表启用单独的url地址来监控 Spring Boot 应用，为了安全一般都启用独立的端口来访问后端的监控信息
 *  `management.endpoint.shutdown.enabled=true` 启用接口关闭 Spring Boot

配置完成之后，启动项目就可以继续验证各个监控功能了。

## 命令详解 ##

在 Spring Boot 2.x 中为了安全期间，Actuator 只开放了两个端点 `/actuator/health` 和 `/actuator/info`。可以在配置文件中设置打开。

可以打开所有的监控点

management.endpoints.web.exposure.include=*

也可以选择打开部分

management.endpoints.web.exposure.exclude=beans,trace

Actuator 默认所有的监控点路径都在`/actuator/*`，当然如果有需要这个路径也支持定制。

management.endpoints.web.base-path=/manage

设置完重启后，再次访问地址就会变成`/manage/*`

## 四，禁用SpringBoot  Actuator 端点安全性 ##

默认情况下，所有敏感的HTTP端点都是安全的，只有具有ACTUATOR角色的用户才能访问它们。

安全性是使用标准的HttpServletRequest.isUserInRole方法实施的。 我们可以使用management.security.enabled = false 来禁用安全性。只有在执行机构端点在防火墙后访问时，才建议禁用安全性。

## 五，SpringBoot应用程序自定义端口 ##

为了在自定义端口上运行 Spring Boot 应用程序，您可以在 application.properties 中指定端口。

server.port=8090

## 六，什么是YAML ##

**YAML（/ˈjæməl/，尾音类似*camel*骆驼）是一个可读性高，用来表达数据[序列化][Link 1]的格式。**YAML参考了其他多种语言，包括：[C语言][C]、[Python][]、[Perl][]，并从[XML][]、电子邮件的数据格式（RFC 2822）中获得灵感。Clark Evans在2001年首次发表了这种语言，另外Ingy döt Net与Oren Ben-Kiki也是这语言的共同设计者。当前已经有数种编程语言或脚本语言支持（或者说解析）这种语言。

## 七，开启 Spring Boot 应用程序的安全性 ##

为了实现 Spring Boot 的安全性，我们使用 spring-boot-starter-security 依赖项，并且必须添加安全配置。它只需要很少的代码。配置类将必须扩展WebSecurityConfigurerAdapter 并覆盖其方法。

## 八，SpringBoot-您使用了哪些starter maven依赖项 ##

使用了下面的一些依赖项  
spring-boot-starter-activemq  
spring-boot-starter-security  
spring-boot-starter-web  
这有助于增加更少的依赖关系，并减少版本的冲突。

# #

[Link 1]: https://baike.baidu.com/item/%E5%BA%8F%E5%88%97%E5%8C%96
[C]: https://baike.baidu.com/item/C%E8%AF%AD%E8%A8%80
[Python]: https://baike.baidu.com/item/Python
[Perl]: https://baike.baidu.com/item/Perl
[XML]: https://baike.baidu.com/item/XML