This version is still in development and is not considered stable yet. For the latest stable version, please use Spring Boot 3.3.4!spring-doc.cn

This version is still in development and is not considered stable yet. For the latest stable version, please use Spring Boot 3.3.4!spring-doc.cn

Spring Boot can be used with “classic” Java development tools or installed as a command line tool. Either way, you need Java SDK v17 or higher. Before you begin, you should check your current Java installation by using the following command:spring-doc.cn

$ java -version

If you are new to Java development or if you want to experiment with Spring Boot, you might want to try the Spring Boot CLI (Command Line Interface) first. Otherwise, read on for “classic” installation instructions.spring-doc.cn

Installation Instructions for the Java Developer

You can use Spring Boot in the same way as any standard Java library. To do so, include the appropriate spring-boot-*.jar files on your classpath. Spring Boot does not require any special tools integration, so you can use any IDE or text editor. Also, there is nothing special about a Spring Boot application, so you can run and debug a Spring Boot application as you would any other Java program.spring-doc.cn

Although you could copy Spring Boot jars, we generally recommend that you use a build tool that supports dependency management (such as Maven or Gradle).spring-doc.cn

Maven Installation

Spring Boot is compatible with Apache Maven 3.6.3 or later. If you do not already have Maven installed, you can follow the instructions at maven.apache.org.spring-doc.cn

On many operating systems, Maven can be installed with a package manager. If you use OSX Homebrew, try brew install maven. Ubuntu users can run sudo apt-get install maven. Windows users with Chocolatey can run choco install maven from an elevated (administrator) prompt.

Spring Boot dependencies use the org.springframework.boot group id. Typically, your Maven POM file inherits from the spring-boot-starter-parent project and declares dependencies to one or more starters. Spring Boot also provides an optional Maven plugin to create executable jars.spring-doc.cn

More details on getting started with Spring Boot and Maven can be found in the Getting Started section of the Maven plugin’s reference guide.spring-doc.cn

Gradle Installation

Spring Boot is compatible with Gradle 7.x (7.6.4 or later) or 8.x (8.4 or later). If you do not already have Gradle installed, you can follow the instructions at gradle.org.spring-doc.cn

Spring Boot dependencies can be declared by using the org.springframework.boot group. Typically, your project declares dependencies to one or more starters. Spring Boot provides a useful Gradle plugin that can be used to simplify dependency declarations and to create executable jars.spring-doc.cn

Gradle Wrapper

The Gradle Wrapper provides a nice way of “obtaining” Gradle when you need to build a project. It is a small script and library that you commit alongside your code to bootstrap the build process. See docs.gradle.org/current/userguide/gradle_wrapper.html for details.spring-doc.cn

More details on getting started with Spring Boot and Gradle can be found in the Getting Started section of the Gradle plugin’s reference guide.spring-doc.cn

On many operating systems, Maven can be installed with a package manager. If you use OSX Homebrew, try brew install maven. Ubuntu users can run sudo apt-get install maven. Windows users with Chocolatey can run choco install maven from an elevated (administrator) prompt.

Installing the Spring Boot CLI

The Spring Boot CLI (Command Line Interface) is a command line tool that you can use to quickly prototype with Spring.spring-doc.cn

You do not need to use the CLI to work with Spring Boot, but it is a quick way to get a Spring application off the ground without an IDE.spring-doc.cn

Manual Installation

You can download one of the spring-boot-cli-*-bin.zip or spring-boot-cli-*-bin.tar.gz files from the Spring software repository.spring-doc.cn

Once downloaded, follow the INSTALL.txt instructions from the unpacked archive. In summary, there is a spring script (spring.bat for Windows) in a bin/ directory in the .zip file. Alternatively, you can use java -jar with the .jar file (the script helps you to be sure that the classpath is set correctly).spring-doc.cn

Installation with SDKMAN!

SDKMAN! (The Software Development Kit Manager) can be used for managing multiple versions of various binary SDKs, including Groovy and the Spring Boot CLI. Get SDKMAN! from sdkman.io and install Spring Boot by using the following commands:spring-doc.cn

$ sdk install springboot
$ spring --version
Spring CLI v3.4.0-SNAPSHOT

If you develop features for the CLI and want access to the version you built, use the following commands:spring-doc.cn

$ sdk install springboot dev /path/to/spring-boot/spring-boot-cli/target/spring-boot-cli-3.4.0-SNAPSHOT-bin/spring-3.4.0-SNAPSHOT/
$ sdk default springboot dev
$ spring --version
Spring CLI v3.4.0-SNAPSHOT

The preceding instructions install a local instance of spring called the dev instance. It points at your target build location, so every time you rebuild Spring Boot, spring is up-to-date.spring-doc.cn

You can see it by running the following command:spring-doc.cn

$ sdk ls springboot

================================================================================
Available Springboot Versions
================================================================================
> + dev
* 3.4.0-SNAPSHOT

================================================================================
+ - local version
* - installed
> - currently in use
================================================================================

OSX Homebrew Installation

If you are on a Mac and use Homebrew, you can install the Spring Boot CLI by using the following commands:spring-doc.cn

$ brew tap spring-io/tap
$ brew install spring-boot

Homebrew installs spring to /usr/local/bin.spring-doc.cn

If you do not see the formula, your installation of brew might be out-of-date. In that case, run brew update and try again.

MacPorts Installation

If you are on a Mac and use MacPorts, you can install the Spring Boot CLI by using the following command:spring-doc.cn

$ sudo port install spring-boot-cli

Command-line Completion

The Spring Boot CLI includes scripts that provide command completion for the BASH and zsh shells. You can source the script named spring (_spring for zsh) or put it in your personal or system-wide bash completion initialization. On a Debian system, the system-wide scripts are in <installation location>/shell-completion/<bash|zsh> and all scripts in that directory are executed when a new shell starts. For example, to run the script manually if you have installed by using SDKMAN!, use the following commands:spring-doc.cn

$ . ~/.sdkman/candidates/springboot/current/shell-completion/bash/spring
$ spring <HIT TAB HERE>
  encodepassword  help  init  shell  version
If you install the Spring Boot CLI by using Homebrew or MacPorts, the command-line completion scripts are automatically registered with your shell.

Windows Scoop Installation

If you are on a Windows and use Scoop, you can install the Spring Boot CLI by using the following commands:spring-doc.cn

$ scoop bucket add extras
$ scoop install springboot

Scoop installs spring to ~/scoop/apps/springboot/current/bin.spring-doc.cn

If you do not see the app manifest, your installation of scoop might be out-of-date. In that case, run scoop update and try again.
If you do not see the formula, your installation of brew might be out-of-date. In that case, run brew update and try again.
If you install the Spring Boot CLI by using Homebrew or MacPorts, the command-line completion scripts are automatically registered with your shell.
If you do not see the app manifest, your installation of scoop might be out-of-date. In that case, run scoop update and try again.