spring-framework Documentation

Technical Documentation: spring-projects/spring-framework

ℹ️ Provenance: Multi-Tier Ingestion · CodeWiki Reference

Overview (`README.md`) Copy Section

Spring Framework [](https://github.com/spring-projects/spring-framework/actions/workflows/build-and-deploy-snapshot.yml?query=branch%3Amain) [](https://ge.spring.io/scans?search.rootProjectNames=spring)

This is the home of the Spring Framework: the foundation for all Spring projects. Collectively the Spring Framework and the family of Spring projects are often referred to simply as "Spring".

Spring provides everything required beyond the Java programming language for creating enterprise applications for a wide range of scenarios and architectures. Please read the Overview section of the reference documentation for a more complete introduction.

Code of Conduct Copy Chapter

This project is governed by the Spring Code of Conduct. By participating, you are expected to uphold this code of conduct. Please report unacceptable behavior to [email protected].

Access to Binaries Copy Chapter

For access to artifacts or a distribution zip, see the Spring Framework Artifacts wiki page.

Documentation Copy Chapter

The Spring Framework maintains reference documentation (published and source), GitHub wiki pages, and an
API reference. There are also guides and tutorials across Spring projects.

Micro-Benchmarks Copy Chapter

See the Micro-Benchmarks wiki page.

Build from Source Copy Chapter

See the Build from Source section of the CONTRIBUTING.md file.

Continuous Integration Builds Copy Chapter

CI builds are defined with GitHub Actions workflows.

Stay in Touch Copy Chapter

Follow @SpringCentral, @SpringFramework, and its team members on 𝕏. In-depth articles can be found at The Spring Blog, and releases are announced via our releases feed.

License Copy Chapter

The Spring Framework is released under version 2.0 of the Apache License.

Overview (`buildSrc/README.md`) Copy Section

Spring Framework Build

This folder contains the custom plugins and conventions for the Spring Framework build.
They are declared in the build.gradle file in this folder.

Build Conventions Copy Chapter

The org.springframework.build.conventions plugin applies all conventions to the Framework build:

• Configuring the Java compiler, see JavaConventions
• Configuring the Kotlin compiler, see KotlinConventions
• Configuring testing in the build with TestConventions
• Configuring the ArchUnit rules for the project, see org.springframework.build.architecture.ArchitectureRules

This plugin also provides a DSL extension to optionally enable Java preview features for
compiling and testing sources in a module. This can be applied with the following in a
module build file:

springFramework {
	enableJavaPreviewFeatures = true
}

Build Plugins Copy Chapter

Optional dependencies Copy Section

The org.springframework.build.optional-dependencies plugin creates a new optional
Gradle configuration - it adds the dependencies to the project's compile and runtime classpath
but doesn't affect the classpath of dependent projects.
This plugin does not provide a provided configuration, as the native compileOnly and testCompileOnly
configurations are preferred.

MultiRelease Jar Copy Section

The org.springframework.build.multiReleaseJar plugin configures the project with MultiRelease JAR support.
It creates a new SourceSet and dedicated tasks for each Java variant considered.
This can be configured with the DSL, by setting a list of Java variants to configure:

plugins {
    id 'org.springframework.build.multiReleaseJar'
}

multiRelease {
	releaseVersions 21, 24
}

Note, Java classes will be compiled with the toolchain pre-configured by the project, assuming that its
Java language version is equal or higher than all variants we consider. Each compilation task will only
set the "-release" compilation option accordingly to produce the expected bytecode version.

RuntimeHints Java Agent Copy Section

The spring-core-test project module contributes the RuntimeHintsAgent Java agent.

The RuntimeHintsAgentPlugin Gradle plugin creates a dedicated "runtimeHintsTest" test task for each project.
This task will detect and execute tests tagged
with the "RuntimeHintsTests" JUnit tag.
In the Spring Framework test suite, those are usually annotated with the @EnabledIfRuntimeHintsAgent annotation.

By default, the agent will instrument all classes located in the "org.springframework" package, as they are loaded.
The RuntimeHintsAgentExtension allows to customize this using a DSL:

// this applies the `RuntimeHintsAgentPlugin` to the project
plugins {
	id 'org.springframework.build.runtimehints-agent'
}

// You can configure the agent to include and exclude packages from the instrumentation process.
runtimeHintsAgent {
	includedPackages = ["org.springframework", "io.spring"]
	excludedPackages = ["org.example"]
}

dependencies {
    // to use the test infrastructure, the project should also depend on the "spring-core-test" module
	testImplementation(project(":spring-core-test"))
}

With this configuration, ./gradlew runtimeHintsTest will run all tests instrumented by this java agent.
The global ./gradlew check task depends on runtimeHintsTest.

NOTE: the "spring-core-test" module doesn't shade "spring-core" by design, so the agent should never instrument
code that doesn't have "spring-core" on its classpath.

Framework Docs Src Docs Api Dokka Overview (`framework-docs/src/docs/api/dokka-overview.md`) Copy Section

All Modules

See also the Java API documentation (Javadoc).

--- METRICS ---

• Files Extracted: 3
• Estimated Token Budget: ~1660 tokens
• Canonical Reference: https://codewiki.google/github.com/spring-projects/spring-framework