手动搭建一个简单的SoFaBoot框架（一）

环境准备

观看本系列博客之前请确保本地版本无问题

要使用 SOFABoot，需要先准备好基础环境，SOFABoot 依赖以下环境： - JDK7 或 JDK8 - 需要采用 Apache Maven 3.2.5 或者以上的版本来编译

简介：

SOFABoot 是蚂蚁金服开源的基于 Spring Boot 的研发框架，它在 Spring Boot 的基础上，提供了诸如 Readiness Check，类隔离，日志空间隔离等能力。在增强了 Spring Boot 的同时，SOFABoot 提供了让用户可以在 Spring Boot 中非常方便地使用 SOFA 中间件的能力。
为了方便拉取sofaBoot的相关jar包 可能会涉及到修改本地Maven的Setting 文件，根据实际场景决定是否修改

<profile>
    <id>default</id>
    <activation>
        <activeByDefault>true</activeByDefault>
    </activation>
    <repositories>
        <repository>
            <snapshots>
                <enabled>true</enabled>
            </snapshots>
            <id>maven-snapshot</id>
            <url>https://oss.sonatype.org/content/repositories/snapshots</url>
        </repository>
    </repositories>
    <pluginRepositories>
        <pluginRepository>
            <snapshots>
                <enabled>true</enabled>
            </snapshots>
            <id>maven-snapshot</id>
            <url>https://oss.sonatype.org/content/repositories/snapshots</url>
        </pluginRepository>
    </pluginRepositories>
</profile>

二、功能简介

为了解决 Spring Boot 在实施大规模微服务架构时候的问题，SOFABoot 提供了以下的能力：

2.1 增强 Spring Boot 的健康检查能力

针对 Spring Boot 缺少 Readiness Check 能力的情况，SOFABoot 增加了 Spring Boot 现有的健康检查的能力，提供了 Readiness Check 的能力。利用 Readiness Check 的能力，SOFAStack 下各种中间件只有在 Readiness Check 通过之后，才将流量引入到应用的实例中，比如 RPC，只有在 Readiness Check 通过之后，才会向服务注册中心注册，后面来自上游应用的流量才会进入。

除了中间件可以利用 Readiness Check 的事件来控制流量的进入之外，PAAS 系统也可以通过访问 http://localhost:8080/health/readiness 来获取应用的 Readiness Check 的状况，用来控制例如负载均衡设备等等的流量。

2.2 提供类隔离的能力

为了解决 Spring Boot 下的类依赖冲突的问题，SOFABoot 基于 SOFAArk 提供了 Spring Boot 上的类隔离的能力，在一个 SOFABoot 的系统中，只要引入 SOFAArk 相关的依赖，就可以将 SOFAStack 的中间件相关的类和应用相关的类的 ClassLoader 进行隔离，防止出现类冲突。当然，用户也可以基于 SOFAArk，将其他的中间件、第三方的依赖和应用的类进行隔离。

2.3 日志空间隔离能力

为了统一大规模微服务场景下的中间件日志的打印，SOFABoot 提供了日志空间隔离的能力给各个 SOFAStack 的中间件，各个 SOFAStack 的中间件采用日志空间隔离的能力之后，自动就会将本身的日志和应用的普通日志隔离开来，并且打印的日志的路径也是相对固定，非常方便进行统一地监控。

2.4 SOFAStack 中间件的集成管理

基于 Spring Boot 的自动配置能力，SOFABoot 提供了 SOFAStack 中间件统一易用的编程接口以及 Spring Boot 的 Starter，方便在 Spring Boot 环境下使用 SOFAStack 中间件，每一个 SOFAStack 中间件都是独立可插拔的组件，节约开发时间，和后期维护的成本。

下满我们创建一个 Spring Boot 的工程，引入 SOFABoot 基础依赖，并且引入 SOFABoot 的健康检查扩展能力，演示如何快速上手 SOFABoot。

功能描述

SOFABoot 在 Spring Boot 基础上，提供了以下能力：

扩展 Spring Boot 健康检查的能力：在 Spring Boot 健康检查能力基础上，提供了 Readiness Check 的能力，保证应用实例安全上线。
提供模块化开发的能力：基于 Spring 上下文隔离提供模块化开发能力，每个 SOFABoot 模块使用独立的 Spring 上下文，避免不同 SOFABoot 模块间的 BeanId 冲突。
增加模块并行加载和 Spring Bean 异步初始化能力，加速应用启动；
增加日志空间隔离的能力：中间件框架自动发现应用的日志实现依赖并独立打印日志，避免中间件和应用日志实现绑定，通过 sofa-common-tools 实现。
增加类隔离的能力：基于 SOFAArk 框架提供类隔离能力，方便使用者解决各种类冲突问题。
增加中间件集成管理的能力：统一管控、提供中间件统一易用的编程接口、每一个 SOFA 中间件都是独立可插拔的组件。
提供完全兼容 Spring Boot的能力：SOFABoot 基于 Spring Boot 的基础上进行构建，并且完全兼容 Spring Boot。

应用场景

SOFABoot 本身就脱胎于蚂蚁金服内部对于 Spring Boot 的实践，补充了 Spring Boot 在大规模金融级生产场景下一些不足的地方，所以 SOFABoot 特别适合于这样的场景。

当然，SOFABoot 的每个组件都是可选的，用户可以灵活选择其中的功能来使用，比如如果仅仅想在 Spring Boot 下面引入 SOFA 中间件，可以不需引入 SOFABoot 中的类隔离能力。

代码实践

首先创建一个 Springboot的Web 工程

更改parent标签

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>3.1.5</version>
    <relativePath/> 
</parent>

然后 增加jar依赖 添加一个 （SOFABoot 健康检查扩展能力的依赖-- 和SOFA boot的 web依赖）

<dependency>
            <groupId>com.alipay.sofa</groupId>
            <artifactId>healthcheck-sofa-boot-starter</artifactId>
        </dependency>

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

配置文件中需要添加

# Application Name 必要参数 相当于表示当前的应用名称
spring.application.name=SOFABoot Demo
# logging path
logging.path=./logs

然后即可运行项目 根据自己选择的sofaBoot版本可选择如下访问地址
SOFA3.X http://localhost:8080/actuator/versions
<SOFA3.x http://localhost:8080/sofaboot/versions
来查看当前 SOFABoot 中使用 Maven 插件生成的版本信息汇总.
并且 可以通过如下地址 查看应用 Readiness Check 的状况
SOFA3.X http://localhost:8080/actuator/readiness
<SOFA3.x http://localhost:8080/health/readiness

status: “UP” 表示应用 Readiness Check 健康的。可以通过在浏览器中输入如下地址 来查看应用的运行时健康状态（可能会随着时间发生变化）。

SOFA3.X http://localhost:8080/actuator/health
<SOFA3.x http://localhost:8080/health

测试

我们知道，SpringBoot 官方提供了和 JUnit4 集成的 SpringRunner, 用于集成测试用例的编写； 在 SOFABoot 中，依然可以使用原生的 SpringRunner， 但是推荐使用 SOFABoot 自带的 SofaBootRunner 以及 SofaJUnit4Runner 编写集成测试和单元测试；应用需要额外引入如下 Starter:

<dependency>
    <groupId>com.alipay.sofa</groupId>
    <artifactId>test-sofa-boot-starter</artifactId>
</dependency>

需要注意的是，如果需要使用 SOFABoot 的类隔离的能力，则必须需要引入上述的依赖，并且使用 SofaBootRunner 和 SofaJUnit4Runner 来测试。

下一篇本分类博文讲讲述模块化开发SOFA-BOOT工程