Skip to content

Commit 99a25f4

Browse files
committed
Merge pull request spring-projects#1 from btalbott/master
Edit README and SIDEBAR, add comments to commit
2 parents f8594a4 + bbca2d1 commit 99a25f4

File tree

2 files changed

+49
-48
lines changed

2 files changed

+49
-48
lines changed

README.ftl.md

Lines changed: 42 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,15 @@
33
What you'll build
44
-----------------
55

6-
This guide provides an introduction to [Spring Boot][spring-boot] by building a simple web application. This doesn't demonstrate all of its features but will help you get started with the concepts Spring Boot has to offer.
6+
This guide walks you through the process of building a simple web application with [Spring Boot][spring-boot]. The guide provides a sampling of how Spring Boot helps you accelerate and facilitate app development. As you read more Spring getting started guides, you will see more use cases for Spring Boot.
77

88
What you'll need
99
----------------
1010

1111
- About 15 minutes
1212
- <@prereq_editor_jdk_buildtools/>
1313

14-
15-
## <@how_to_complete_this_guide jump_ahead="Warming up with Spring Boot"/>
14+
## <@how_to_complete_this_guide jump_ahead='Learn what you can do with Spring Boot'/>
1615

1716

1817
<a name="scratch"></a>
@@ -27,41 +26,45 @@ Set up the project
2726

2827
<@snippet path="pom.xml" prefix="initial"/>
2928

30-
Warming up with Spring Boot
31-
---------------------------
29+
Learn what you can do with Spring Boot
30+
--------------------------------------
3231

33-
What does Spring Boot provide? At the core, it offers a much faster way to build applications because it make reasonable assumptions such as looking at your classpath and other beans you have configured to see what you're missing.
32+
Spring Boot offers a fast way to build applications. It looks at your classpath and at beans you have configured, makes reasonable assumptions about what you're missing, and adds it. With Spring Boot you can focus more on business features and less on infrastructure.
3433

3534
For example:
36-
- Got Spring MVC? There are a handful of needed beans people almost always use in that situation. Spring Boot adds them automatically. But why stop there? A Spring MVC app needs a servlet container so Spring Boot automatically configures embedded Tomcat.
37-
- Got Jetty? You probably do NOT want Tomcat, but instead embedded Jetty. Don't lift a finger; Spring Boot handles it for you.
38-
- Got Thymeleaf? There are a few beans that must always be added to your application context. Why should you have to deal with that? Let Spring Boot handle it for you.
39-
- Doing multipart file uploads? The [MultipartConfigElement](http://docs.oracle.com/javaee/6/api/javax/servlet/MultipartConfigElement.html) is part of the servlet 3.0 spec and let's you define upload parameters in pure Java. Why should you have to worry about plugging that into your servlet? Define one in your application context and Spring Boot will snatch it up and plug it into Spring MVC's battle tested `DispatcherServlet`.
35+
- Got Spring MVC? There are several specific beans you almost always need, and Spring Boot adds them automatically. A Spring MVC app also needs a servlet container, so Spring Boot automatically configures embedded Tomcat.
36+
- Got Jetty? If so, you probably do NOT want Tomcat, but instead embedded Jetty. Spring Boot handles that for you.
37+
- Got Thymeleaf? There are a few beans that must always be added to your application context; Spring Boot adds them for you.
38+
- Doing multipart file uploads? [MultipartConfigElement](http://docs.oracle.com/javaee/6/api/javax/servlet/MultipartConfigElement.html) is part of the servlet 3.0 spec and lets you define upload parameters in pure Java. With Spring Boot, you don't have to plug that into your servlet. Define one in your application context and Spring Boot will plug it into Spring MVC's battle-tested `DispatcherServlet`.
4039

41-
It doesn't stop there. These are just a few examples of the automatic configuration provided by Spring Boot. But it doesn't get in your way. For example, Spring Boot may make assumptions and add a `SpringTemplateEngine` for your Thymeleaf-based application, unless you've already defined one. At that point, Spring Boot automatically steps aside and lets you take control.
40+
These are just a few examples of the automatic configuration Spring Boot provides. At the same time, Spring Boot doesn't get in your way. For example, Spring Boot may make assumptions and add a `SpringTemplateEngine` for your Thymeleaf-based application, unless you've already defined one. At that point, Spring Boot automatically steps aside and lets you take control.
4241

43-
Creating a simple web application
42+
Create a simple web application
4443
---------------------------------
45-
You already have the base build file at the top. Next step is to create a web controller for a simple web application.
44+
You already have the base build file at the top. Now you can create a web controller for a simple web application.
4645

4746
<@snippet path="src/main/java/hello/HelloController.java" prefix="initial"/>
4847

49-
The class is flagged as a `@Controller` meaning it's ready for use by Spring MVC to handle web requests. `@RequestMapping` maps `/` to the `index()` method. When invoked from a browser or using curl on the command line, it returns pure text thanks to the `@ResponseBody` annotation.
48+
The class is flagged as a `@Controller`, meaning it's ready for use by Spring MVC to handle web requests. `@RequestMapping` maps `/` to the `index()` method. When invoked from a browser or using curl on the command line, the method returns pure text thanks to the `@ResponseBody` annotation.
5049

51-
To make it executable, create an `Application` class:
50+
Create an Application class
51+
---------------------------
52+
Here you create an `Application` class with the components:
5253

5354
<@snippet path="src/main/java/hello/Application.java" prefix="initial"/>
5455

5556
- `@Configuration` tags the class as a source of bean definitions for the application context.
56-
- `@EnableAutoConfiguration` tells Spring Boot to get going and start adding beans based on classpath settings, other beans, and various property settings.
57+
- `@EnableAutoConfiguration` tells Spring Boot to start adding beans based on classpath settings, other beans, and various property settings.
5758
- `@EnableWebMvc` signals Spring MVC that this application is a web application and to activate key behaviors such as setting up a `DispatcherServlet`.
5859
- `@ComponentScanning` tells Spring to look for other components, configurations, and services in the the `hello` package, allowing it to find the `HelloController`.
5960

6061
The `main()` method uses Spring Boot's `SpringApplication.run()` method to launch an application. Did you notice that there wasn't a single line of XML? No **web.xml** file either. This web application is 100% pure Java and you didn't have to deal with configuring any plumbing or infrastructure.
6162

6263
The `run()` method returns an `ApplicationContext` and this application then retrieves all the beans that were created either by your app or were automatically added thanks to Spring Boot. It sorts them and prints them out.
6364

64-
To run it, execute:
65+
Run the application
66+
-------------------
67+
To run the application, execute:
6568

6669
```sh
6770
$ mvn package spring-boot:run
@@ -116,9 +119,9 @@ $ curl localhost:8080
116119
Greetings from Spring Boot!
117120
```
118121
119-
Switching to Jetty
120-
------------------
121-
What if you preferred Jetty over Tomcat? They're both compliant servlet containers, so it should be darn simple to switch. And it is!
122+
Switch from Tomcat to Jetty
123+
---------------------------
124+
Jetty and Tomcat are both compliant servlet containers, so it's easy to switch.
122125

123126
Add this to your build file's list of dependencies:
124127
@@ -129,24 +132,24 @@ Add this to your build file's list of dependencies:
129132
</dependency>
130133
```
131134
132-
Adding multipart upload support
135+
Add multipart upload support
133136
-------------------------------
134-
Imagine you also want to add file upload support. To do that, update your configuration and add a `MultipartConfigElement` to the application context.
137+
Suppose you want to add file upload support. To do that, update your configuration and add a `MultipartConfigElement` to the application context.
135138
136139
<@snippet path="src/main/java/hello/Application.java" prefix="complete"/>
137140
138-
> **Note:** A production version of `MultipartConfigElement` would not be empty but instead specify things like target upload path, file size upload limits, etc.
141+
> **Note:** A production version of `MultipartConfigElement` would not be empty; it would specify target upload path, file size upload limits, and so forth.
139142
140-
Re-run the app
141-
--------------
143+
Re-run the application
144+
----------------------
142145
143146
Run the app again:
144147
145148
```sh
146149
$ mvn package spring-boot:run
147150
```
148151
149-
Now check out the output:
152+
Now check the output:
150153
151154
```sh
152155
Let's inspect the beans provided by Spring Boot:
@@ -189,15 +192,15 @@ simpleControllerHandlerAdapter
189192
viewControllerHandlerMapping
190193
```
191194

192-
There is little change from the previous output, except there is no longer a `tomcatEmbeddedServletContainerFactory`. Instead, there is a new `jettyEmbeddedServletContainer`.
195+
Little changes from the previous output, except there is no longer a `tomcatEmbeddedServletContainerFactory`. Instead, there is a new `jettyEmbeddedServletContainer`.
193196

194197
There is also the `multipartConfigElement` you added. But along with it came a `multipartResolver` [courtesy of Spring Boot](https://github.com/SpringSource/spring-boot/blob/master/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/MultipartAutoConfiguration.java), a bean recommended to support file uploads with Spring MVC.
195198

196-
Other than that, everything else appears the same, as it should be. Most the beans listed above provide Spring MVC's production-grade features. Just swapping one part, the servlet container, and adding upload support shouldn't cause a system wide ripple.
199+
Otherwise, everything is the same, as it should be. Most beans listed above provide Spring MVC's production-grade features. Simply swapping one part, the servlet container, and adding upload support shouldn't cause a system-wide ripple.
197200

198-
Adding consumer-grade services
201+
Add consumer-grade services
199202
------------------------------
200-
If you are building a web site for your business, there are probably some management services you are thinking about adding. Spring Boot provides several out of the box with its [actuator module][spring-boot-actuator] like health, audits, beans, and more.
203+
If you are building a web site for your business, you probably need to add some management services. Spring Boot provides several out of the box with its [actuator module][spring-boot-actuator], such as health, audits, beans, and more.
201204

202205
Add this to your pom.xml:
203206
```xml
@@ -243,14 +246,14 @@ You can invoke shutdown through curl.
243246
$ curl -X POST localhost:8080/shutdown
244247
```
245248

246-
The response shows that shutdown through REST is currently disabled by default (thank goodness!):
249+
The response shows that shutdown through REST is currently disabled by default:
247250
```sh
248251
{"message":"Shutdown not enabled, sorry."}
249252
```
250253

251-
For more details about each of these REST points and how you can tune their settings with an ``application.properties` file, feel free to dig into the [Spring Boot][spring-boot] project.
254+
For more details about each of these REST points and how you can tune their settings with an ``application.properties` file, check out the [Spring Boot][spring-boot] project.
252255

253-
Spring Boot's starters
256+
View Spring Boot's starters
254257
----------------------
255258
You have seen some of Spring Boot's **starters**. Here is a complete list:
256259
- spring-boot-starter-actuator
@@ -265,9 +268,9 @@ You have seen some of Spring Boot's **starters**. Here is a complete list:
265268
- spring-boot-starter-web
266269

267270

268-
That is not all
269-
---------------
270-
That last example showed how Spring Boot makes it easy to wire beans you may not be aware you need. And it showed how to turn on convenient management services.
271+
JAR support and Groovy support
272+
------------------------------
273+
The last example showed how Spring Boot makes it easy to wire beans you may not be aware that you need. And it showed how to turn on convenient management services.
271274

272275
But Spring Boot does yet more. It supports not only traditional WAR file deployments, but also makes it easy to put together executable JARs thanks to Spring Boot's loader module. The various guides demonstrate this dual support through the `spring-boot-maven-plugin`.
273276

@@ -290,7 +293,7 @@ class ThisWillActuallyRun {
290293

291294
Next, [install Spring Boot's CLI](https://github.com/SpringSource/spring-boot#installing-the-cli).
292295

293-
Finally, run it as follows:
296+
Run it as follows:
294297

295298
```sh
296299
$ spring run app.groovy
@@ -300,11 +303,9 @@ Hello World!
300303

301304
Spring Boot dynamically adds key annotations to your code and leverages [Groovy Grapes](http://groovy.codehaus.org/Grape) to pull down needed libraries to make the app run.
302305

303-
Congratulations!
306+
Summary
304307
----------------
305-
Spring Boot is powerful, but frankly too big to fit into a single guide. This is just a sampling of how much it can ramp up your development pace, letting you focus on business features and not worry about infrastructure.
306-
307-
As you read more of this site's getting started guides, you will see it used all over the place. It might not be obvious at first, because Spring Boot is so good at adding the things you need without getting in your way. But after using it for a bit, you may wonder how you lived without it.
308+
Congratulations! You built a simple web application with Spring Boot and learned how it can ramp up your development pace.
308309

309310
[spring-boot]: https://github.com/SpringSource/spring-boot
310311
[spring-boot-actuator]: https://github.com/SpringSource/spring-boot/blob/master/spring-boot-actuator/README.md

SIDEBAR.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
1-
## Related Resources
1+
## Related resources
22

3-
Spring Boot provides a wide range of support for various services. It's used for most of these guides. This list contains some of them, showing its diverse support.
3+
Spring Boot provides a wide range of support for various services, including most services doumented in the Spring Getting Started guides. Some of these guides are listed here.
44

5-
### Getting Started Guides
5+
### Getting Started guides
66

77
* [Building a RESTful Web Service with Spring Boot Actuator][gs-actuator-service]
88
* [Accessing Data with JPA][gs-accessing-data-jpa]
99
* [Creating Asynchronous Methods][gs-async-method]
1010
* [Creating a Batch Service][gs-batch-processing]
1111
* [Securing a Web Application][gs-securing-web]
1212
* [Uploading a File][gs-uploading-files]
13-
* [Converting a Spring Boot JAR-based application into a WAR][gs-convert-jar-to-war]
13+
* [Converting a Spring Boot JAR-based application to a WAR][gs-convert-jar-to-war]
1414

1515
[gs-actuator-service]: /guides/gs/actuator-service/content
1616
[gs-accessing-data-jpa]: /guides/gs/accessing-data-jpa/content
17-
[gs-async-method]: /guides/gs/async-methd/content
17+
[gs-async-method]: /guides/gs/async-method/content
1818
[gs-batch-processing]: /guides/gs/batch-processing/content
1919
[gs-securing-web]: /guides/gs/securing-web/content
2020
[gs-uploading-files]: /guides/gs/uploading-files/content
21-
[gs-convert-jar-to-war]: /guides/gs/converting-jar-to-war/content
21+
[gs-convert-jar-to-war]: /guides/gs/convert-jar-to-war/content
2222

2323
### Tutorials
2424

2525
* [Tutorial TBD][tut-tbd]
2626

2727
[tut-tbd]: /guides/tutorials/tbd
2828

29-
### Concepts and Technologies
29+
### Concepts and technologies
3030

3131
* [REST][u-rest]
3232
* [JSON][u-json]

0 commit comments

Comments
 (0)