Spring Docs

# Installing Spring Boot

Spring Boot can be used with “classic” Java development tools or installed as a command line tool. Either way, you need Java SDK v1.8 (opens new window) or higher. Before you begin, you should check your current Java installation by using the following command:

$ 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 (opens new window) (Command Line Interface) first. Otherwise, read on for “classic” installation instructions.

# 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.

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).

# Maven Installation

Spring Boot is compatible with Apache Maven 3.3 or above. If you do not already have Maven installed, you can follow the instructions at maven.apache.org (opens new window).

Tip:

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 (opens new window) can run choco install maven from an elevated (administrator) prompt.

Spring Boot dependencies use the org.springframework.boot groupId. Typically, your Maven POM file inherits from the spring-boot-starter-parent project and declares dependencies to one or more “Starters” (opens new window). Spring Boot also provides an optional Maven plugin (opens new window) to create executable jars.

More details on getting started with Spring Boot and Maven can be found in the Getting Started section (opens new window) of the Maven plugin’s reference guide.

# Gradle Installation

Spring Boot is compatible with Gradle 6.8, 6.9, and 7.x. If you do not already have Gradle installed, you can follow the instructions at gradle.org (opens new window).

Spring Boot dependencies can be declared by using the org.springframework.boot group. Typically, your project declares dependencies to one or more “Starters” (opens new window). Spring Boot provides a useful Gradle plugin (opens new window) that can be used to simplify dependency declarations and to create executable jars.

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.

More details on getting started with Spring Boot and Gradle can be found in the Getting Started section (opens new window) of the Gradle plugin’s reference guide.

# 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. It lets you run Groovy (opens new window) scripts, which means that you have a familiar Java-like syntax without so much boilerplate code.

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.

# Manual Installation

You can download the Spring CLI distribution from the Spring software repository:

Cutting edge snapshot distributions (opens new window) are also available.

Once downloaded, follow the INSTALL.txt (opens new window) 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).

# 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 (opens new window) and install Spring Boot by using the following commands:

$ sdk install springboot
$ spring --version
Spring CLI v2.6.4

If you develop features for the CLI and want access to the version you built, use the following commands:

$ sdk install springboot dev /path/to/spring-boot/spring-boot-cli/target/spring-boot-cli-2.6.4-bin/spring-2.6.4/
$ sdk default springboot dev
$ spring --version
Spring CLI v2.6.4

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.

You can see it by running the following command:

$ sdk ls springboot

================================================================================
Available Springboot Versions
================================================================================
> + dev
* 2.6.4

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

# OSX Homebrew Installation

If you are on a Mac and use Homebrew (opens new window), you can install the Spring Boot CLI by using the following commands:

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

Homebrew installs spring to /usr/local/bin.

Note:

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 (opens new window), you can install the Spring Boot CLI by using the following command:

$ sudo port install spring-boot-cli

# Command-line Completion

The Spring Boot CLI includes scripts that provide command completion for the BASH (opens new window) and zsh (opens new window) shells. You can source the script (also named spring) in any shell or put it in your personal or system-wide bash completion initialization. On a Debian system, the system-wide scripts are in /shell-completion/bash 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:

$ . ~/.sdkman/candidates/springboot/current/shell-completion/bash/spring
$ spring <HIT TAB HERE>
  grab  help  jar  run  test  version

Note:

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 (opens new window), you can install the Spring Boot CLI by using the following commands:

> scoop bucket add extras
> scoop install springboot

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

Note:

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.

# Quick-start Spring CLI Example

You can use the following web application to test your installation. To start, create a file called app.groovy, as follows:

@RestController
class ThisWillActuallyRun {

    @RequestMapping("/")
    String home() {
        "Hello World!"
    }

}

Then run it from a shell, as follows:

$ spring run app.groovy

Note:

The first run of your application is slow, as dependencies are downloaded. Subsequent runs are much quicker.

Open localhost:8080 in your favorite web browser. You should see the following output:

Hello World!

原文链接: https://docs.spring.io/spring-boot/docs/2.6.4/reference/html/getting-started.html#getting-started.installing

← Spring initializr →