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

时间:2023-12-11 15:41:20

之前有一篇《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中添加如下配置

  1. <!-- Inherit defaults from Spring Boot -->
  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. <!-- Add typical dependencies for a web application -->
  8. <dependencies>
  9. <dependency>
  10. <groupId>org.springframework.boot</groupId>
  11. <artifactId>spring-boot-starter-web</artifactId>
  12. </dependency>
  13. </dependencies>
  14. <!-- Package as an executable JAR -->
  15. <build>
  16. <plugins>
  17. <plugin>
  18. <groupId>org.springframework.boot</groupId>
  19. <artifactId>spring-boot-maven-plugin</artifactId>
  20. </plugin>
  21. </plugins>
  22. </build>
  23. <!-- Allow access to Spring milestones and snapshots -->
  24. <!-- (you don't need this if you are using anything after 0.5.0.RELEASE) -->
  25. <repositories>
  26. <repository>
  27. <id>spring-snapshots</id>
  28. <url>http://repo.spring.io/snapshot</url>
  29. <snapshots><enabled>true</enabled></snapshots>
  30. </repository>
  31. <repository>
  32. <id>spring-milestones</id>
  33. <url>http://repo.spring.io/milestone</url>
  34. <snapshots><enabled>true</enabled></snapshots>
  35. </repository>
  36. </repositories>
  37. <pluginRepositories>
  38. <pluginRepository>
  39. <id>spring-snapshots</id>
  40. <url>http://repo.spring.io/snapshot</url>
  41. </pluginRepository>
  42. <pluginRepository>
  43. <id>spring-milestones</id>
  44. <url>http://repo.spring.io/milestone</url>
  45. </pluginRepository>
  46. </pluginRepositories>

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

实体

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

控制器

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

运行

第一种方式

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

第二种方式

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

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

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

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

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

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

参考

https://github.com/spring-projects/spring-boot