Spring Boot makes it easy to create Spring-powered, production-grade applications and services with absolute minimum fuss. It takes an opinionated view of the Spring platform so that new and existing users can quickly get to the bits they need.
You can use Spring Boot to create stand-alone Java applications that can be started using
java -jar or more traditional WAR deployments. We also provide a command line tool
that runs spring scripts.
Our primary goals are:
-
Provide a radically faster and widely accessible getting started experience for all Spring development
-
Be opinionated out of the box, but get out of the way quickly as requirements start to diverge from the defaults
-
Provide a range of non-functional features that are common to large classes of projects (e.g. embedded servers, security, metrics, health checks, externalized configuration)
-
Absolutely no code generation and no requirement for XML configuration
The reference documentation includes detailed
installation instructions
as well as a comprehensive getting
started guide. Documentation is published in HTML,
PDF and EPUB
formats.
Here is a quick teaser of a complete Spring Boot application in Java:
import org.springframework.boot.*;
import org.springframework.boot.autoconfigure.*;
import org.springframework.web.bind.annotation.*;
@RestController
@SpringBootApplication
public class Example {
@RequestMapping("/")
String home() {
return "Hello World!";
}
public static void main(String[] args) throws Exception {
SpringApplication.run(Example.class, args);
}
}Having trouble with Spring Boot? We’d like to help!
-
Check the reference documentation, especially the How-to’s — they provide solutions to the most common questions.
-
Learn the Spring basics — Spring Boot builds on many other Spring projects, check the spring.io web-site for a wealth of reference documentation. If you are just starting out with Spring, try one of the guides.
-
Ask a question - we monitor stackoverflow.com for questions tagged with
spring-boot. -
Report bugs with Spring Boot at github.com/spring-projects/spring-boot/issues.
Spring Boot uses GitHub’s integrated issue tracking system to record bugs and feature requests. If you want to raise an issue, please follow the recommendations below:
-
Before you log a bug, please search the issue tracker to see if someone has already reported the problem.
-
If the issue doesn’t already exist, create a new issue.
-
Please provide as much information as possible with the issue report, we like to know the version of Spring Boot that you are using, as well as your Operating System and JVM version.
-
If you need to paste code, or include a stack trace use Markdown ``` escapes before and after your text.
-
If possible try to create a test-case or project that replicates the issue. You can submit sample projects as pull-requests against the spring-boot-issues GitHub project. Use the issue number for the name of your project.
You don’t need to build from source to use Spring Boot (binaries in repo.spring.io), but if you want to try out the latest and greatest, Spring Boot can be easily built with the maven wrapper. You also need JDK 1.8 (although Boot applications can run on Java 1.6).
$ ./mvnw clean install
If you want to build with the regular mvn command, you will need
Maven v3.2.1 or above.
|
Note
|
You may need to increase the amount of memory available to Maven by setting
a MAVEN_OPTS environment variable with the value -Xmx512m. Remember
to set the corresponding property in your IDE as well if you are building and running
tests there (e.g. in Eclipse go to Preferences→Java→Installed JREs and edit the
JRE definition so that all processes are launched with those arguments). This property
is automatically set if you use the maven wrapper.
|
Also see CONTRIBUTING.adoc if you wish to submit pull requests, and in particular please fill out the Contributor’s Agreement before your first change, however trivial. (Or if you filed such an agreement already for another project just mention that in your pull request.)
The reference documentation requires the documentation of the Maven plugin to be available so you need to build that first since it’s not generated by default.
$ ./mvnw clean install -pl spring-boot-tools/spring-boot-maven-plugin -Pdefault,full
The documentation also includes auto-generated information about the starters. To allow this information to be collected, the starter projects must be built first:
$ ./mvnw clean install -f spring-boot-starters
Once this is done, you can build the reference documentation with the command below:
$ ./mvnw clean prepare-package -pl spring-boot-docs -Pdefault,full
|
Tip
|
The generated documentation is available from spring-boot-docs/target/contents/reference
|