{"id":27462789,"url":"https://github.com/alipay/sofa-boot","last_synced_at":"2026-01-11T16:59:28.841Z","repository":{"id":38808717,"uuid":"127727728","full_name":"sofastack/sofa-boot","owner":"sofastack","description":"SOFABoot is a framework that enhances Spring Boot and fully compatible with it, provides readiness check, class isolation, etc.","archived":false,"fork":false,"pushed_at":"2025-04-09T10:43:14.000Z","size":4817,"stargazers_count":5019,"open_issues_count":9,"forks_count":1266,"subscribers_count":314,"default_branch":"master","last_synced_at":"2025-04-09T15:02:40.649Z","etag":null,"topics":["sofa-boot","sofa-boot-starter","sofastack"],"latest_commit_sha":null,"homepage":"https://www.sofastack.tech/sofa-boot/docs/Home","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sofastack.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-04-02T08:28:14.000Z","updated_at":"2025-04-06T14:24:18.000Z","dependencies_parsed_at":"2023-02-19T17:01:15.609Z","dependency_job_id":"e78ad4ff-4d58-401c-bfb9-90d72a3aa4bb","html_url":"https://github.com/sofastack/sofa-boot","commit_stats":{"total_commits":601,"total_committers":44,"mean_commits":"13.659090909090908","dds":0.7470881863560732,"last_synced_commit":"8aebd1889211c1cde8fba1fff49b976fe7ca2b42"},"previous_names":["alipay/sofa-boot"],"tags_count":80,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sofastack%2Fsofa-boot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sofastack%2Fsofa-boot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sofastack%2Fsofa-boot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sofastack%2Fsofa-boot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sofastack","download_url":"https://codeload.github.com/sofastack/sofa-boot/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249161129,"owners_count":21222472,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["sofa-boot","sofa-boot-starter","sofastack"],"created_at":"2025-04-15T22:00:56.017Z","updated_at":"2025-04-15T22:01:50.923Z","avatar_url":"https://github.com/sofastack.png","language":"Java","readme":"## SOFABoot\n\n[![Build And Test](https://github.com/sofastack/sofa-boot/actions/workflows/maven.yml/badge.svg)](https://github.com/sofastack/sofa-boot/actions/workflows/maven.yml)\n[![Coverage Status](https://codecov.io/gh/sofastack/sofa-boot/branch/master/graph/badge.svg)](https://codecov.io/gh/sofastack/sofa-boot/branch/master)\n![license](https://img.shields.io/badge/license-Apache--2.0-green.svg)\n[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/sofastack/sofa-boot.svg)](http://isitmaintained.com/project/sofastack/sofa-boot \"Average time to resolve an issue\")\n[![Percentage of issues still open](http://isitmaintained.com/badge/open/sofastack/sofa-boot.svg)](http://isitmaintained.com/project/sofastack/sofa-boot \"Percentage of issues still open\")\n![maven](https://img.shields.io/github/release/sofastack/sofa-boot.svg)\n\n[中文版本](./README_ZH.md)\n\nSOFABoot is an open source Java development framework based on Spring Boot.\n\nVarieties of enhancements such as application readiness check, Spring context isolation, class isolation, log space separation, etc. are provided out of box.\nIn addition, SOFABoot accommodates SOFAStack middlewares more comfortably and seamlessly for developers coming from Spring Boot world.\n\n## Background\n\nSpring Boot makes it easy to create stand-alone, production-grade Spring-based applications which \"just run\". However, some domain-specific issues remain open:\n\n- Spring Boot provides health indicators to reveal the liveness of application but not readiness (aka the capability of servicing requests).\n- No built-in class isolation scheme to support finer modular applications.\n- Log configurations of all SDKs used by application are repeatedly arranged.\n\nTo 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.\nIn SOFABoot, SOFAStack middleware SDKs are packaged as self-contained \"starters\" to provide the corresponding facet or functionality dependencies. \n\n## Quick Start\nPlease refer to SOFAStack Documentation for [SOFABoot quick start guide](https://www.sofastack.tech/en/projects/sofa-boot/quick-start/).\n\n### Demos\nSome SOFABoot demo projects to get your hands dirty:\n* [Standard project](https://github.com/sofastack-guides/sofa-boot-guides/tree/4.x/sofaboot-sample)\n- [Class Isolation](https://github.com/sofastack-guides/sofa-boot-guides/tree/4.x/sofaboot-sample-with-isolation)\n- [Spring Context Isolation](https://github.com/sofastack-guides/sofa-boot-guides/tree/4.x/sofaboot-sample-with-isolation)\n- [SOFA RPC](https://github.com/sofastack-guides/sofa-boot-guides/tree/4.x/sofaboot-sample-with-rpc)\n\n## Functionality\nTo supplement the abilities of deploying large-scale microservices in production environment for Spring Boot, SOFABoot offers following enhancements:\n\n### Readiness Check\nIf request traffic reaches service instance before it is fully initialized, requests are subject to timeout or exceptions.\nWhile Spring Boot health indicators are practical real-time exposure of application health, it doesn't help determine when services are available. \nTherefore, readiness check is an indispensable part of deployment automation in production environment and SOFABoot provides the readiness check for application out of box.\nFor reliable application startup, all SOFAStack middleware services won't reveal themselves (e.g., RPC services publishing to Service Registry) until readiness check passes.\n\nPlatform PaaS can also make use of the readiness check result via URL `http://localhost:8080/actuator/readiness` to control gracefully external traffic originating such as gateway, load balancer, etc.\n\n### Class Isolation\nAimed to solve class or dependency conflicts, [SOFAArk](https://github.com/sofastack/sofa-ark) is created.\nCompared 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.\nAlso, it is easy to make a third party SDK into SOFAArk module because the high extensibility of SOFAArk.\n\nSee further on [SOFAArk documentation](https://www.sofastack.tech/en/projects/sofa-boot/sofa-ark-readme/).\n\n### Spring Context Isolation\nTwo common forms of modularization are popular in Java world:\n1. 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.\n2. Modularization based on classloader: each module has its own classloader and classpath between different modules differs.\n\nSOFABoot supplies a third option with degree of modularity between above two, which is built upon Spring Context.\nDifferent modules owns by itself a distinct Spring Context and all contexts forms a simple dependency tree.\nBean resolution of dependency injection happens in the path up to the tree root.\nIt is obvious that bean and configuration conflicts are avoided between different modules, communication between teams during enterprise-level multi-module development is reduced effectively.\n\nMore details about SOFABoot modularization are introduced in this [article](https://www.sofastack.tech/posts/2018-07-25-01).\n\n### Unified Logging\nIn 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.\nIn order to save the repeated configuration, SOFABoot utilizes the [sofa-common-tools](https://github.com/sofastack/sofa-common-tools) to provide for each SDKs basic log configurations.\nUsers don't need to worry about SDk logging anymore.\nBesides, every SDK has a different logging directory to separate it from application logs to assist handy monitoring based on logging. \n\n### Built-in SOFAStack Middlewares\nBased on the auto-configuring and dependencies descriptor (aka starter) in Spring Boot, SOFABoot offers easy-to-use programming interface for all SOFAStack middlewares.\nAll of them are packaged as self-contained \"starters\" to provide the corresponding facet dependencies and are independently pluggable.\n\n## Contribution\nWe love contributions! Before taking any further steps, please take a look at [Contributing to SOFABoot](./CONTRIBUTING.md).\n\nSOFABoot is compiled under JDK 17 currently and needs [Apache Maven 3.5.4](https://archive.apache.org/dist/maven/maven-3/3.5.4/binaries/) or higher version.\n\n### Community\nSee our community [materials](https://github.com/sofastack/community/blob/master/ROLES-EN.md).\n\n### Contact Us\nSee [Community contact way](https://www.sofastack.tech/awesome/#community)\n\n## Acknowledgements\nThe first version of SOFA is created by Felix(阿玺), lots of thanks are given to Felix for laying a solid foundation for SOFA.\nIt is also very grateful to the people who have contributed codes in the history of SOFA.\n\n## License\nAnt Group SOFABoot is distributed under the [Apache License, version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html).\nThe licenses of third parity dependencies of SOFABoot are explained [here](https://www.sofastack.tech/projects/sofa-boot/notice/).\n\n## Known Users\nThe SOFABoot users (the names are in no particular order). Please leave a comment [here](https://github.com/sofastack/sofastack.tech/issues/5) to tell us your scenario to make SOFABoot better.\n\u003cdiv\u003e\n\u003cimg alt=\"蚂蚁集团\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*aK79TJUJykkAAAAAAAAAAAAAARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"网商银行\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*uAmFRZQ0Z4YAAAAAAAAAAABjARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"恒生电子\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*_iGLRq0Ih-IAAAAAAAAAAABjARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"数立信息\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*JAgIRpjz-IgAAAAAAAAAAABjARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"Paytm\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*a0fvTKJ1Xv8AAAAAAAAAAABjARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"天弘基金\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*99OQT7lDBsMAAAAAAAAAAABjARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"中国人保\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*P1BARJxwv1sAAAAAAAAAAABjARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"信美相互\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*jAzWQpIgFUAAAAAAAAAAAABjARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"南京银行\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*q9PMQI7hs8sAAAAAAAAAAABjARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"民生银行\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*GnUuSKmOtS4AAAAAAAAAAABjARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"重庆农商行\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*FKrxSYhdi2wAAAAAAAAAAABjARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"中信证券\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*t-xbQb3WSjcAAAAAAAAAAABkARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"富滇银行\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*JCDYT6u6_asAAAAAAAAAAAAAARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"挖财\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*lVrVT4dpSDEAAAAAAAAAAABjARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"拍拍贷\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*TAePS6j56LsAAAAAAAAAAABjARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"OPPO金融\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*mU40QaJkwZYAAAAAAAAAAABjARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"运满满\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*_kBbQYUYdIQAAAAAAAAAAABjARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"译筑科技\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*wuKSTpZSEkEAAAAAAAAAAABjARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"杭州米雅信息科技\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*b-o5SITMKu0AAAAAAAAAAABjARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"邦道科技\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*nsw1S5bt9DkAAAAAAAAAAABjARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"申通快递\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*C3ncSpDsjS8AAAAAAAAAAABjARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"深圳大头兄弟文化\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*8AYmRowxSC0AAAAAAAAAAABjARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"烽火科技\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*MjuuT4omCrwAAAAAAAAAAABjARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"亚信科技\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*vBBIRomYoEUAAAAAAAAAAABjARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"成都云智天下科技\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*p0OkQbC5RvsAAAAAAAAAAABjARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"上海溢米辅导\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*mJdtTJsn1PwAAAAAAAAAAABjARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"态赋科技\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*sfLDRL5TJx8AAAAAAAAAAABjARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"风一科技\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*EGeMR4qprnkAAAAAAAAAAABjARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"武汉易企盈\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*31WRQ7zg3HIAAAAAAAAAAABjARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"极致医疗\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*cPOiS5q8NCwAAAAAAAAAAABjARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"京东\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*INhuS44qO8YAAAAAAAAAAABjARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"小象生鲜\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*K5ERQYbCRBgAAAAAAAAAAABjARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"北京云族佳\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*qzxjSZ2tlmIAAAAAAAAAAABjARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"欣亿云网\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*huOKQKvoLzwAAAAAAAAAAABjARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"山东网聪\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*INUFR7XIH1gAAAAAAAAAAABjARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"深圳市诺安赛威\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*eVGbR7RhDDkAAAAAAAAAAABjARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"上扬软件\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*VsqMT7n7p0AAAAAAAAAAAABjARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"长沙点三\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*2eEzSqdPIc0AAAAAAAAAAABjARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"网易云音乐\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*66KbQ6seDqoAAAAAAAAAAABkARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"虎牙直播\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*uzr3RLUZ3RwAAAAAAAAAAABkARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"中国移动\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*vEo-T55XTOAAAAAAAAAAAABkARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"无纸科技\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*9aFQSLfyPhMAAAAAAAAAAABkARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"黄金钱包\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*tYZJRpANxNoAAAAAAAAAAABkARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"独木桥网络\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*GW6oTLIlAbcAAAAAAAAAAABkARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"wueasy\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*4uFWQacI-RwAAAAAAAAAAABkARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"北京攸乐科技\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*CD5VT50FXqMAAAAAAAAAAABkARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"易宝支付\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*oy0ZSquXXjAAAAAAAAAAAABkARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"威马汽车\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*LPf2TbTeJPwAAAAAAAAAAABkARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"亿通国际\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*tlq4R7QqUaEAAAAAAAAAAABkARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"新华三\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*gw9uTbZvsbAAAAAAAAAAAAAAARQnAQ\" height=\"60\" /\u003e\n\u003cimg alt=\"klilalagroup\" src=\"https://gw.alipayobjects.com/mdn/sofastack/afts/img/A*0cskToqBSi8AAAAAAAAAAAAAARQnAQ\" height=\"60\" /\u003e\n\u003c/div\u003e\n","funding_links":[],"categories":["大厂开源"],"sub_categories":["阿里开源"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falipay%2Fsofa-boot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falipay%2Fsofa-boot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falipay%2Fsofa-boot/lists"}