Spring Boot——2分钟构建spring web mvc REST风格HelloWorld

亦凉 2022-07-15 05:22 361阅读 0赞

[Spring Boot——2分钟构建spring web mvc REST风格HelloWorld][Spring Boot_2_spring web mvc REST_HelloWorld]

*  **博客分类：**
 *  [springmvc杂谈][springmvc]

[spring][] [spring boot][]

之前有一篇《[5分钟构建spring web mvc REST风格HelloWorld][5_spring web mvc REST_HelloWorld]》介绍了普通方式开发spring web mvc web service。接下来看看使用spring boot如何快速构建一个。

Spring Boot使我们更容易去创建基于Spring的独立和产品级的可以”即时运行“的应用和服务。支持约定大于配置，目的是尽可能快地构建和运行Spring应用。

之前我们创建基于Spring的项目需要考虑添加哪些Spring依赖和第三方的依赖。使用Spring Boot后，我们可以以最小化的依赖开始spring应用。大多数Spring Boot应用需要很少的配置即可运行，比如我们可以创建独立独立大Java应用，然后通过java -jar运行启动或者传统的WAR部署。其也提供了命令行工具来直接运行Spring脚本（如groovy脚本）。也就是说Spring Boot让Spring应用从配置到运行变的更加简单，但不对Spring本身提供增强（即额外的功能）。

## 目的： ##

让所有Spring开发变得更快，且让更多的人更快的进行Spring入门体验，提供“starter” POM来简化我们的Maven配置（也就是说使用Spring Boot只有配合maven/gradle等这种依赖管理工具才能发挥它的能力），不像以前，构建一个springmvc项目需要进行好多配置等

开箱即用，快速开始需求开发而不被其他方面影响（如果可能会自动配置Spring）

提供一些非功能性的常见的大型项目类特性（如内嵌服务器、安全、度量、健康检查、外部化配置），如可以直接地内嵌Tomcat/Jetty（不需要单独去部署war包）

绝无代码生成，且无需XML配置

## **我的构建环境** ##

JDK 7

Maven 3

Servlet3容器

## **创建项目** ##

首先使用Maven创建一个普通Maven应用即可，不必是web的。

## 添加Spring Boot相关POM配置 ##

在pom.xml中添加如下配置

Java代码 [ ![复制代码][icon_copy.gif]][_icon_copy.gif]  ![收藏代码][icon_star.png]![spinner.gif][]

1.   
2. <parent>  
3.     <groupId>org.springframework.boot</groupId>  
4.     <artifactId>spring-boot-starter-parent</artifactId>  
5.     <version>0.5.0.BUILD-SNAPSHOT</version>  
6. </parent>  
7.   
8.   
9. <dependencies>  
10.     <dependency>  
11.         <groupId>org.springframework.boot</groupId>  
12.         <artifactId>spring-boot-starter-web</artifactId>  
13.     </dependency>  
14. </dependencies>  
15.   
16.   
17. <build>  
18.     <plugins>  
19.         <plugin>  
20.             <groupId>org.springframework.boot</groupId>  
21.             <artifactId>spring-boot-maven-plugin</artifactId>  
22.         </plugin>  
23.     </plugins>  
24. </build>  
25.   
26.   
27.   
28. <repositories>  
29.     <repository>  
30.         <id>spring-snapshots</id>  
31.         <url>http://repo.spring.io/snapshot</url>  
32.         <snapshots><enabled>true</enabled></snapshots>  
33.     </repository>  
34.     <repository>  
35.         <id>spring-milestones</id>  
36.         <url>http://repo.spring.io/milestone</url>  
37.         <snapshots><enabled>true</enabled></snapshots>  
38.     </repository>  
39. </repositories>  
40. <pluginRepositories>  
41.     <pluginRepository>  
42.         <id>spring-snapshots</id>  
43.         <url>http://repo.spring.io/snapshot</url>  
44.     </pluginRepository>  
45.     <pluginRepository>  
46.         <id>spring-milestones</id>  
47.         <url>http://repo.spring.io/milestone</url>  
48.     </pluginRepository>  
49. </pluginRepositories>

<parent>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-parent</artifactId>
 <version>0.5.0.BUILD-SNAPSHOT</version>
 </parent>
 
 
 <dependencies>
 <dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-web</artifactId>
 </dependency>
 </dependencies>
 
 
 <build>
 <plugins>
 <plugin>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-maven-plugin</artifactId>
 </plugin>
 </plugins>
 </build>
 
 
 
 <repositories>
 <repository>
 <id>spring-snapshots</id>
 <url>http://repo.spring.io/snapshot</url>
 <snapshots><enabled>true</enabled></snapshots>
 </repository>
 <repository>
 <id>spring-milestones</id>
 <url>http://repo.spring.io/milestone</url>
 <snapshots><enabled>true</enabled></snapshots>
 </repository>
 </repositories>
 <pluginRepositories>
 <pluginRepository>
 <id>spring-snapshots</id>
 <url>http://repo.spring.io/snapshot</url>
 </pluginRepository>
 <pluginRepository>
 <id>spring-milestones</id>
 <url>http://repo.spring.io/milestone</url>
 </pluginRepository>
 </pluginRepositories>

继承spring-boot-starter-parent后我们可以继承一些默认的依赖，这样就无需添加一堆相应的依赖，把依赖配置最小化；spring-boot-starter-web提供了对web的支持，spring-boot-maven-plugin提供了直接运行项目的插件，我们可以直接mvn spring-boot:run运行。

## 实体 ##

Java代码 [ ![复制代码][icon_copy.gif]][_icon_copy.gif]  ![收藏代码][icon_star.png]![spinner.gif][]

1. package com.sishuok.entity;  
2.   
3. /\*\* 
4.  \* User: Zhang Kaitao 
5.  \* Date: 13-12-22 
6.  \* Version: 1.0 
7.  \*/  
8. public class User \{  
9.     private Long id;  
10.     private String name;  
11.   
12.     public Long getId() \{  
13.         return id;  
14.     \}  
15.   
16.     public void setId(Long id) \{  
17.         this.id = id;  
18.     \}  
19.   
20.     public String getName() \{  
21.         return name;  
22.     \}  
23.   
24.     public void setName(String name) \{  
25.         this.name = name;  
26.     \}  
27.   
28.     @Override  
29.     public boolean equals(Object o) \{  
30.         if (this == o) return true;  
31.         if (o == null || getClass() != o.getClass()) return false;  
32.   
33.         User user = (User) o;  
34.   
35.         if (id != null ? !id.equals(user.id) : user.id != null) return false;  
36.   
37.         return true;  
38.     \}  
39.   
40.     @Override  
41.     public int hashCode() \{  
42.         return id != null ? id.hashCode() : 0;  
43.     \}  
44. \}

package com.sishuok.entity;
 
 /**
 * User: Zhang Kaitao
 * Date: 13-12-22
 * Version: 1.0
 */
 public class User {
 private Long id;
 private String name;
 
 public Long getId() {
 return id;
 }
 
 public void setId(Long id) {
 this.id = id;
 }
 
 public String getName() {
 return name;
 }
 
 public void setName(String name) {
 this.name = name;
 }
 
 @Override
 public boolean equals(Object o) {
 if (this == o) return true;
 if (o == null || getClass() != o.getClass()) return false;
 
 User user = (User) o;
 
 if (id != null ? !id.equals(user.id) : user.id != null) return false;
 
 return true;
 }
 
 @Override
 public int hashCode() {
 return id != null ? id.hashCode() : 0;
 }
 }

## 控制器 ##

Java代码 [ ![复制代码][icon_copy.gif]][_icon_copy.gif]  ![收藏代码][icon_star.png]![spinner.gif][]

1. package com.sishuok.controller;  
2.   
3. import com.sishuok.entity.User;  
4. import org.springframework.boot.SpringApplication;  
5. import org.springframework.boot.autoconfigure.EnableAutoConfiguration;  
6. import org.springframework.web.bind.annotation.PathVariable;  
7. import org.springframework.web.bind.annotation.RequestMapping;  
8. import org.springframework.web.bind.annotation.RestController;  
9.   
10. /\*\* 
11.  \* User: Zhang Kaitao 
12.  \* Date: 13-12-22 
13.  \* Version: 1.0 
14.  \*/  
15. //@EnableAutoConfiguration  
16. @RestController  
17. @RequestMapping("/user")  
18. public class UserController \{  
19.   
20.     @RequestMapping("/\{id\}")  
21.     public User view(@PathVariable("id") Long id) \{  
22.         User user = new User();  
23.         user.setId(id);  
24.         user.setName("zhang");  
25.         return user;  
26.     \}  
27.   
28.     //public static void main(String\[\] args) \{   
29.     //    SpringApplication.run(UserController.class);  
30.     //\}  
31.   
32. \}

package com.sishuok.controller;
 
 import com.sishuok.entity.User;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 
 /**
 * User: Zhang Kaitao
 * Date: 13-12-22
 * Version: 1.0
 */
 //@EnableAutoConfiguration
 @RestController
 @RequestMapping("/user")
 public class UserController {
 
 @RequestMapping("/{id}")
 public User view(@PathVariable("id") Long id) {
 User user = new User();
 user.setId(id);
 user.setName("zhang");
 return user;
 }
 
 //public static void main(String[] args) {
 // SpringApplication.run(UserController.class);
 //}
 
 }

## 运行   ##

**第一种方式**

通过在UserController中加上@EnableAutoConfiguration开启自动配置，然后通过SpringApplication.run(UserController.class);运行这个控制器；这种方式只运行一个控制器比较方便；

**第二种方式**

通过@Configuration+@ComponentScan开启注解扫描并自动注册相应的注解Bean

Java代码 [ ![复制代码][icon_copy.gif]][_icon_copy.gif]  ![收藏代码][icon_star.png]![spinner.gif][]

1. package com.sishuok;  
2.   
3. import com.sishuok.controller.UserController;  
4. import org.springframework.boot.SpringApplication;  
5. import org.springframework.boot.autoconfigure.EnableAutoConfiguration;  
6. import org.springframework.context.annotation.ComponentScan;  
7. import org.springframework.context.annotation.Configuration;  
8.   
9. /\*\* 
10.  \* User: Zhang Kaitao 
11.  \* Date: 13-12-22 
12.  \* Version: 1.0 
13.  \*/  
14. @Configuration  
15. @ComponentScan  
16. @EnableAutoConfiguration  
17. public class Application \{  
18.     public static void main(String\[\] args) \{  
19.         SpringApplication.run(Application.class);  
20.     \}  
21. \}

package com.sishuok;
 
 import com.sishuok.controller.UserController;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
 import org.springframework.context.annotation.ComponentScan;
 import org.springframework.context.annotation.Configuration;
 
 /**
 * User: Zhang Kaitao
 * Date: 13-12-22
 * Version: 1.0
 */
 @Configuration
 @ComponentScan
 @EnableAutoConfiguration
 public class Application {
 public static void main(String[] args) {
 SpringApplication.run(Application.class);
 }
 }

到此，一个基本的REST风格的web应用就构建完成了。

地址栏输入http://localhost:8080/user/1即可看到json结果。

如果大家查看其依赖，会发现自动添加了需要相应的依赖（不管你用/不用），但是开发一个应用确实变得非常快速，对于想学习/体验Spring的新手，快速建立项目模型等可以考虑用这种方式。当然如果不想依赖这么多的jar包，可以去掉parent，然后自己添加依赖。

欢迎加入spring群134755960进行交流。

**参考**

[https://github.com/spring-projects/spring-boot][https_github.com_spring-projects_spring-boot]

*  [spring-boot-helloworld.rar][] (26.2 KB)
 *  下载次数: 2685

**24**  
顶

**3**  
踩

分享到： ![sina.jpg][] ![tec.jpg][]

[OOM分析——错误使用Servlet API导致内存 ...][OOM_Servlet API_ ...] | [ 5分钟构建spring web mvc REST风格HelloW ...][5_spring web mvc REST_HelloWorld]

*  2013-12-30 08:02
 *  浏览 172893
 *  [评论(25)][25]
 *  分类:[企业架构][Link 1]
 *  [相关推荐][Link 2]

##### 参考知识库 #####

[![1456818035722_722.jpg][]][1456818035722_722.jpg 1]

[Java EE知识库][1456818035722_722.jpg 1] *8478*  关注 *|* *730*  收录

##### 评论 #####

25 楼 [ 清风飞扬1988][_1988] 2016-10-28

点击链接加入群【Spring Boot Cloud  交流】： [http://jq.qq.com/?\_wv=1027&k=40umhEo][http_jq.qq.com_wv_1027_k_40umhEo]

24 楼 [ 呵呵6666][_6666] 2016-10-11

spring boot基础学习系列文章： [http://www.roncoo.com/article/detail/124661][http_www.roncoo.com_article_detail_124661]

23 楼 [ flystarfly][flystarfly] 2016-08-24

zyj\_daan 写道

为什么我运行main函数，eclipse就直接要结束进程，什么错误信息都没有？先mvn install了的

我也是install成功了的，但是还是没法运行main函数

22 楼 [ zyj\_daan][zyj_daan] 2016-08-10

为什么我运行main函数，eclipse就直接要结束进程，什么错误信息都没有？先mvn install了的

21 楼 [ zkw0710][zkw0710] 2016-08-09

例子非常好，spring-boot中的tomcat怎样才能绑定域名

20 楼 [ oaoutoaout][oaoutoaout] 2016-03-24

田梦桦 写道

体验下零配置的感觉。

看看playframework吧，让你真正体验到什么是飞一般的感觉！

19 楼 [ liuwuhen][liuwuhen] 2016-03-14

赞一个！ ![icon_idea.gif][]

18 楼 [ 田梦桦][Link 3] 2015-12-29

体验下零配置的感觉。

17 楼 [ lihuanjin][lihuanjin] 2015-08-27

![icon_idea.gif][]

16 楼 [ cactu6][cactu6] 2015-08-21

入门的好教程，这篇写得也不错，推荐给大家： [http://tianmaying.com/tutorial/spring-mvc-quickstart][http_tianmaying.com_tutorial_spring-mvc-quickstart]

15 楼 [ rox][rox] 2015-07-23

涛&哥的秀发呢？

14 楼 [ ruyi0127][ruyi0127] 2015-07-01

涛。哥群进不去

13 楼 [ javaHacker2010][javaHacker2010] 2015-05-19

能否把controller和app分开不同的包？

12 楼 [ string2020][string2020] 2015-03-13

@RestController   和 @Controller   有什么区别？

11 楼 [ yanguoyingliu][yanguoyingliu] 2014-12-25

前面弄错了，先用maven install下载所需jar,然后在运行main函数。

10 楼 [ yanguoyingliu][yanguoyingliu] 2014-12-25

main函数运行不了啊，实例也跑不起来。

9 楼 [ zhch152][zhch152] 2014-12-15

LinApex 写道

这个。。。估计用起来比较纠结，还是喜欢掌握整个项目的感觉

没错，我也认为这样的东西没什么用，虽然说新手用这个很容易上手，但是离开了这个什么也不懂。

8 楼 [ xuhuan1108][xuhuan1108] 2014-11-16

但是这样做的话没有代码提示额？

7 楼 [ liaowb\_1105][liaowb_1105] 2014-11-04

想加一个过滤器怎么加

6 楼 [ yydriver][yydriver] 2014-11-03

zfwdl2005 写道

涛——哥，能不能讲讲spring boot如果要部署在tomcat下，需要注意哪些问题，如何部署，比如我测试的时候，想部署在tomcat下测试一把。

Spring boot可以直接将tomcat内置到你的jar中。不需要部署。  
spring boot本身就是为了持续继承，敏捷开发而产生的。

[Spring Boot_2_spring web mvc REST_HelloWorld]: http://jinnianshilongnian.iteye.com/blog/1997192
[springmvc]: http://jinnianshilongnian.iteye.com/category/277825
[spring]: http://www.iteye.com/blogs/tag/spring
[spring boot]: http://www.iteye.com/blogs/tag/spring%20boot
[5_spring web mvc REST_HelloWorld]: http://jinnianshilongnian.iteye.com/blog/1996071
[icon_copy.gif]: http://jinnianshilongnian.iteye.com/images/icon_copy.gif
[_icon_copy.gif]: http://jinnianshilongnian.iteye.com/blog/1997192#
[icon_star.png]: http://jinnianshilongnian.iteye.com/images/icon_star.png
[spinner.gif]: /images/20220715/4511a2ff0a2d467e89297d11fbc80991.png
[https_github.com_spring-projects_spring-boot]: https://github.com/spring-projects/spring-boot
[spring-boot-helloworld.rar]: http://dl.iteye.com/topics/download/5cf384e9-8905-3fe6-a916-1caa6bd544d1
[sina.jpg]: http://jinnianshilongnian.iteye.com/images/sina.jpg
[tec.jpg]: /images/20220715/d65832070ed4476bad70140553312ed1.png
[OOM_Servlet API_ ...]: http://jinnianshilongnian.iteye.com/blog/1997293
[25]: http://jinnianshilongnian.iteye.com/blog/1997192#comments
[Link 1]: http://www.iteye.com/blogs/category/architecture
[Link 2]: http://www.iteye.com/wiki/blog/1997192
[1456818035722_722.jpg]: http://img.knowledge.csdn.net/upload/base/1456818035722_722.jpg
[1456818035722_722.jpg 1]: http://lib.csdn.net/base/javaee
[_1988]: http://1362802538.iteye.com/
[http_jq.qq.com_wv_1027_k_40umhEo]: http://jq.qq.com/?_wv=1027&k=40umhEo
[_6666]: http://3086264740.iteye.com/
[http_www.roncoo.com_article_detail_124661]: http://www.roncoo.com/article/detail/124661
[flystarfly]: http://flystarfly.iteye.com/
[zyj_daan]: http://zyj-daan.iteye.com/
[zkw0710]: http://zkw0710.iteye.com/
[oaoutoaout]: http://oaoutoaout.iteye.com/
[liuwuhen]: http://liuwuhen.iteye.com/
[icon_idea.gif]: /images/20220715/808302800abd40928f16992c01cfcc4f.png
[Link 3]: http://407122006-qq-com.iteye.com/
[lihuanjin]: http://lihuanjin.iteye.com/
[cactu6]: http://cactu6.iteye.com/
[http_tianmaying.com_tutorial_spring-mvc-quickstart]: http://tianmaying.com/tutorial/spring-mvc-quickstart
[rox]: http://rox.iteye.com/
[ruyi0127]: http://ruyi0127.iteye.com/
[javaHacker2010]: http://javahacker2010.iteye.com/
[string2020]: http://string2020.iteye.com/
[yanguoyingliu]: http://yanguoyingliu.iteye.com/
[zhch152]: http://zhch152.iteye.com/
[xuhuan1108]: http://xuhuan1108.iteye.com/
[liaowb_1105]: http://liaowb-1105.iteye.com/
[yydriver]: http://yydriver.iteye.com/