Need help with sofa-boot?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

sofastack
4.4K Stars 1.1K Forks Apache License 2.0 426 Commits 16 Opened issues

Description

SOFABoot is a framework that enhances Spring Boot and fully compatible with it, provides readiness check, class isolation, etc.

Services available

!
?

Need anything else?

Contributors list

SOFABoot

build Coverage Status license Average time to resolve an issue Percentage of issues still open maven

中文版本

SOFABoot is an open source Java development framework based on Spring Boot.

Varieties of enhancements such as application readiness check, Spring context isolation, class isolation, log space separation, etc. are provided out of box. In addition, SOFABoot accommodates SOFAStack middlewares more comfortably and seamlessly for developers coming from Spring Boot world.

Background

Spring Boot makes it easy to create stand-alone, production-grade Spring-based applications which "just run". However, some domain-specific issues remain open:

  • Spring Boot provides health indicators to reveal the liveness of application but not readiness (aka the capability of servicing requests).
  • No built-in class isolation scheme to support finer modular applications.
  • Log configurations of all SDKs used by application are repeatedly arranged.

To address the above issues while maintaining the advantages of Spring Boot, Ant Group develops the SOFABoot based on Spring Boot and make it open source. In SOFABoot, SOFAStack middleware SDKs are packaged as self-contained "starters" to provide the corresponding facet or functionality dependencies.

Quick Start

Please refer to SOFAStack Documentation for SOFABoot quick start guide.

Demos

Some SOFABoot demo projects to get your hands dirty: - Class Isolation - Spring Context Isolation - SOFA RPC - Scheduler with Batch

Functionality

To supplement the abilities of deploying large-scale microservices in production environment for Spring Boot, SOFABoot offers following enhancements:

Readiness Check

If request traffic reaches service instance before it is fully initialized, requests are subject to timeout or exceptions. While Spring Boot health indicators are practical real-time exposure of application health, it doesn't help determine when services are available. Therefore, readiness check is an indispensable part of deployment automation in production environment and SOFABoot provides the readiness check for application out of box. For reliable application startup, all SOFAStack middleware services won't reveal themselves (e.g., RPC services publishing to Service Registry) until readiness check passes.

Platform PAAS can also make use of the readiness check result via URL

http://localhost:8080/health/readiness
to control gracefully external traffic originating such as gateway, load balancer, etc.

Class Isolation

Aimed to solve class or dependency conflicts, SOFAArk is created. Compared with unwieldy OSGi class isolation implementation, SOFAArk is a light-weight scheme and focuses on the point of class loading between application and middleware modules. Also, it is easy to make a third party SDK into SOFAArk module because the high extensibility of SOFAArk.

See further on SOFAArk documentation.

Spring Context Isolation

Two common forms of modularization are popular in Java world: 1. Modularization based on code organization: different functional codes are organized under separate Java projects and packaged into different JARs. All Java classes are loaded by same classloader when running. 2. Modularization based on classloader: each module has its own classloader and classpath between different modules differs.

SOFABoot supplies a third option with degree of modularity between above two, which is built upon Spring Context. Different modules owns by itself a distinct Spring Context and all contexts forms a simple dependency tree. Bean resolution of dependency injection happens in the path up to the tree root. It is obvious that bean and configuration conflicts are avoided between different modules, communication between teams during enterprise-level multi-module development is reduced effectively.

More details about SOFABoot modularization are introduced in this article.

Unified Logging

In Spring Boot, the responsibility of log configurations is left to users: all the users of a certain SDK need to configure for its logging, but the configurations are basically the same in most cases. In order to save the repeated configuration, SOFABoot utilizes the sofa-common-tools to provide for each SDKs basic log configurations. Users don't need to worry about SDk logging anymore. Besides, every SDK has a different logging directory to separate it from application logs to assist handy monitoring based on logging.

Built-in SOFAStack Middlewares

Based on the auto-configuring and dependencies descriptor (aka starter) in Spring Boot, SOFABoot offers easy-to-use programming interface for all SOFAStack middlewares. All of them are packaged as self-contained "starters" to provide the corresponding facet dependencies and are independently pluggable.

Contribution

We love contributions! Before taking any further steps, please take a look at Contributing to SOFABoot.

SOFABoot is compiled under JDK 8 currently and needs Apache Maven 3.2.5 or higher version.

Community

See our community materials.

Scan the QR code below with DingTalk(钉钉) to join the SOFAStack user group.

Scan the QR code below with WeChat(微信) to Follow our Official Accounts.

Acknowledgements

The first version of SOFA is created by Felix(阿玺), lots of thanks are given to Felix for laying a solid foundation for SOFA. It is also very grateful to the people who have contributed codes in the history of SOFA.

License

Ant Group SOFABoot is distributed under the Apache License, version 2.0. The licenses of third parity dependencies of SOFABoot are explained here.

Known Users

The SOFABoot users (the names are in no particular order). Please leave a comment here to tell us your scenario to make SOFABoot better.

蚂蚁集团 网商银行 恒生电子 数立信息 Paytm 天弘基金 中国人保 信美相互 南京银行 民生银行 重庆农商行 中信证券 富滇银行 挖财 拍拍贷 OPPO金融 运满满 译筑科技 杭州米雅信息科技 邦道科技 申通快递 深圳大头兄弟文化 烽火科技 亚信科技 成都云智天下科技 上海溢米辅导 态赋科技 风一科技 武汉易企盈 极致医疗 京东 小象生鲜 北京云族佳 欣亿云网 山东网聪 深圳市诺安赛威 上扬软件 长沙点三 网易云音乐 虎牙直播 中国移动 无纸科技 黄金钱包 独木桥网络 wueasy 北京攸乐科技 易宝支付 威马汽车 亿通国际 新华三 klilalagroup

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.