首页手记 Spring Boot框架入门教程：轻松搭建第一个项目

Spring Boot框架入门教程：轻松搭建第一个项目

标签：

SpringBoot

概述

Spring Boot框架是一个基于Spring框架的工具，旨在简化新应用的搭建和开发过程，通过提供默认配置和开箱即用的功能，使得开发者能够快速构建独立的、生产级别的应用。Spring Boot的核心特性包括自动配置、基于Java的配置、内嵌的Servlet容器支持和对主流框架的全面集成，如MyBatis、Redis、MongoDB等。Spring Boot的优势在于简化的配置、快速启动、内嵌容器支持、全面集成主流框架、生产就绪的特性及约定优于配置的原则。

引导与简介

什么是Spring Boot框架

Spring Boot 是一个基于Spring框架的框架，它旨在简化新Spring应用的初始搭建及开发过程。Spring Boot通过提供一系列开箱即用的配置选项和特性，使得开发者能够快速构建独立的、生产级别的应用。Spring Boot的核心特性包括自动配置、基于Java的配置、内嵌的Servlet容器支持、对主流框架的全面集成、热部署等。

Spring Boot的核心组件包括Spring Boot Starter、Spring Boot Actuator 和 Spring Boot DevTools。Spring Boot Starter通过提供一系列预定义的依赖，简化了项目的配置过程。Spring Boot Actuator提供了生产就绪的特性，如健康检查、审计、指标收集等，以帮助监控应用的状态。Spring Boot DevTools则提供了开发过程中的改进体验，如自动重启、静态资源缓存等。

Spring Boot框架的优势

使用Spring Boot框架有以下几点优势：

简化的配置：Spring Boot通过提供默认配置，减少了开发者配置Spring的繁琐工作量。开发者只需关注业务逻辑。
快速启动：Spring Boot允许开发者快速启动一个应用，而无需配置复杂的依赖和环境。
内嵌的容器支持：Spring Boot允许开发者内嵌Tomcat、Jetty或Undertow等Servlet容器，使得应用可以作为独立的可执行jar文件运行。
对主流框架的全面集成：Spring Boot集成了许多常用的框架，如MyBatis、Redis、MongoDB等，使得开发者可以方便地在应用中使用这些框架。
生产就绪的特性：Spring Boot提供了许多生产就绪的特性，如健康检查、审计、指标收集等，帮助开发者监控应用的状态。
无代码生成的约定优于配置：Spring Boot采用了约定优于配置的原则，使得开发者无需编写大量的配置代码。

开发环境搭建

为了使用Spring Boot，您需要安装以下软件：

Java开发工具包（JDK）：确保安装了最新版本的JDK，并配置好环境变量。
集成开发环境（IDE）：推荐使用IntelliJ IDEA或Eclipse等IDE，它们提供了对Spring Boot的良好支持。
Maven或Gradle：选择一种构建工具来管理项目的依赖和构建过程。
Git：用于版本控制，推荐使用Git来管理代码。

创建Spring Boot项目有多种方式：

使用Spring Initializr：Spring Initializr 是Spring官方提供的一个在线工具，允许开发者选择应用程序的类型（例如Web应用、数据访问等）以及需要的依赖。它会自动生成项目的基本结构和配置。
使用Spring Boot CLI：Spring Boot CLI 是一个命令行工具，它允许开发者使用Spring Boot创建和运行Spring项目。
手动创建项目：在IDE中手动创建一个Spring Boot项目，然后添加必要的依赖和配置。

下面是一个使用Spring Initializr创建Spring Boot项目的示例：

访问Spring Initializr。
选择项目的基本信息，如Spring Boot版本、项目类型、语言、构建工具等。
选择需要的依赖，例如Web、Thymeleaf、Spring Data JPA等。
点击“Generate”按钮，下载生成的项目。
解压文件，导入到IDE中进行开发。

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.example</groupId>
  <artifactId>demo</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <name>demo</name>
  <description>Demo project for Spring Boot</description>
  <properties>
    <java.version>1.8</java.version>
  </properties>
  <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>
</project>

快速开始Spring Boot项目

创建第一个Spring Boot项目

创建第一个Spring Boot项目，首先需要通过Spring Initializr创建项目。以下是创建一个简单的Spring Boot项目的步骤：

访问Spring Initializr。
选择项目的基本信息，如项目类型（Maven Project）、语言（Java）、构建工具（Maven）、Java版本（8）等。
选择需要的依赖，例如Web、Thymeleaf等。
点击“Generate”按钮，下载生成的项目。
解压文件，导入到IDE中进行开发。

接下来，我们将创建一个简单的RESTful API服务。在项目中创建一个新的Java类，并添加必要的注解。例如，创建一个简单的控制器类如下：

package com.example.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@SpringBootApplication
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }

}

@RestController
class HelloController {
    @GetMapping("/hello")
    public String hello() {
        return "Hello, World!";
    }
}

在上述代码中，@SpringBootApplication注解标记了该类是一个Spring Boot应用入口。@RestController注解表示该类是一个控制器类，用于处理HTTP请求。@GetMapping注解定义了一个GET请求的处理器。项目启动后，访问http://localhost:8080/hello，将返回字符串"Hello, World!"。

Spring Boot项目结构介绍

一个典型的Spring Boot项目结构如下：

src
└───main
    ├───java
    │   └───com
    │       └───example
    │           └───demo
    │               ├───DemoApplication.java
    │               └───HelloController.java
    └───resources
        └───application.properties

DemoApplication.java：应用的入口类，包含了@SpringBootApplication注解。
HelloController.java：一个简单的控制器类，处理HTTP请求。
application.properties：配置文件，用于存储应用的配置信息。

Maven与Gradle支持

Spring Boot支持两种主流的构建工具：Maven和Gradle。

Maven支持

Maven是一个强大的项目管理和构建工具，它使用POM（Project Object Model）文件来描述项目的配置。在Spring Boot项目中，Maven配置文件是pom.xml。以下是一个简单的pom.xml文件示例：

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.example</groupId>
  <artifactId>demo</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <name>demo</name>
  <description>Demo project for Spring Boot</description>
  <properties>
    <java.version>1.8</java.version>
  </properties>
  <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>
</project>

Gradle支持

Gradle是一个基于Groovy的构建工具，它使用build.gradle文件来描述项目的配置。以下是一个简单的build.gradle文件示例：

plugins {
  id 'org.springframework.boot' version '2.3.4.RELEASE'
  id 'io.spring.dependency-management' version '1.0.11.RELEASE'
  id 'java'
}

group = 'com.example'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '1.8'

repositories {
  mavenCentral()
}

dependencies {
  implementation 'org.springframework.boot:spring-boot-starter-web'
  testImplementation 'org.springframework.boot:spring-boot-starter-test'
}

Spring Boot核心功能介绍

自动配置与依赖注入

Spring Boot的核心功能之一是自动配置。自动配置允许开发者无需编写大量的配置代码就可以快速启动一个应用。Spring Boot提供了许多默认配置，开发者可以在必要时覆盖这些配置。

依赖注入是Spring框架的核心特性之一。Spring Boot通过@Autowired注解实现依赖注入。例如，下面是一个简单的服务类，它依赖于一个配置类：

package com.example.demo;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class SampleService {

  private final SampleConfig config;

  @Autowired
  public SampleService(SampleConfig config) {
    this.config = config;
  }

  public void doSomething() {
    System.out.println("Value: " + config.getValue());
  }
}

配置文件的使用

Spring Boot支持多种配置文件，包括application.properties和application.yml。这些配置文件位于src/main/resources目录下。配置文件可以用于定义各种应用的配置选项，如端口号、数据库连接信息等。

下面是一个application.properties文件的示例：

server.port=8080
spring.datasource.url=jdbc:mysql://localhost:3306/db
spring.datasource.username=root
spring.datasource.password=root

应用的打包与部署

Spring Boot允许开发者将应用打包为一个可执行的jar文件。开发过程中可以使用IDE自带的功能或命令行工具来运行应用，发布时可以使用Maven或Gradle的插件来打包应用。

使用Maven打包应用：

mvn clean package

使用Gradle打包应用：

./gradlew bootJar

打包完成后，可以在命令行中运行jar文件：

java -jar target/demo-0.0.1-SNAPSHOT.jar

实战：构建RESTful API

使用Spring MVC创建控制器

构建RESTful API是Spring Boot项目中最常见的任务之一。Spring Boot通过Spring MVC提供了一种简单的方式来创建控制器类。控制器类负责处理HTTP请求，并返回相应的响应。

以下是一个简单的控制器类示例：

package com.example.demo;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {

  @GetMapping("/hello")
  public String hello() {
    return "Hello, World!";
  }

}

在上述代码中，@RestController注解标记了该类是一个控制器类，@GetMapping注解定义了一个GET请求处理器。项目启动后，访问http://localhost:8080/hello，将返回字符串"Hello, World!"。

RESTful API设计原则

RESTful API设计原则包括以下几个方面：

URI设计：URI应该清晰地描述资源，避免使用动词和过长的路径。
HTTP动词：使用标准的HTTP动词来定义资源的操作，如GET、POST、PUT、DELETE。
资源标识：使用资源的唯一标识符作为路径的一部分。
超媒体作为应用状态引擎：返回的数据中应包含指向其他资源的链接。
无状态：每个请求都是独立的，不应依赖于之前的请求状态。
分层系统：应使用分层架构来实现系统。
缓存：允许客户端缓存响应，减少服务器的负担。

使用Spring MVC创建控制器类

以下是一个简单的RESTful API控制器类示例：

package com.example.demo;

import org.springframework.web.bind.annotation.*;

@RestController
public class UserController {

  private final UserRepository userRepository;

  @Autowired
  public UserController(UserRepository userRepository) {
    this.userRepository = userRepository;
  }

  @GetMapping("/users/{id}")
  public User getUser(@PathVariable Long id) {
    return userRepository.findById(id);
  }

  @PostMapping("/users")
  public User createUser(@RequestBody User user) {
    return userRepository.save(user);
  }

  @PutMapping("/users/{id}")
  public User updateUser(@PathVariable Long id, @RequestBody User user) {
    User existingUser = userRepository.findById(id);
    existingUser.setName(user.getName());
    return userRepository.save(existingUser);
  }

  @DeleteMapping("/users/{id}")
  public void deleteUser(@PathVariable Long id) {
    userRepository.deleteById(id);
  }
}

上述代码中，@RestController注解标记了该类是一个控制器类，@GetMapping、@PostMapping、@PutMapping、@DeleteMapping注解用于定义HTTP请求处理器。

返回JSON格式数据

Spring Boot默认支持将对象序列化为JSON格式。Spring Boot使用Jackson库来序列化和反序列化JSON数据。

package com.example.demo;

import org.springframework.web.bind.annotation.*;

@RestController
public class UserController {

  private final UserRepository userRepository;

  @Autowired
  public UserController(UserRepository userRepository) {
    this.userRepository = userRepository;
  }

  @GetMapping("/users/{id}")
  public User getUser(@PathVariable Long id) {
    return userRepository.findById(id);
  }

  @PostMapping("/users")
  public User createUser(@RequestBody User user) {
    return userRepository.save(user);
  }

  @PutMapping("/users/{id}")
  public User updateUser(@PathVariable Long id, @RequestBody User user) {
    User existingUser = userRepository.findById(id);
    existingUser.setName(user.getName());
    return userRepository.save(existingUser);
  }

  @DeleteMapping("/users/{id}")
  public void deleteUser(@PathVariable Long id) {
    userRepository.deleteById(id);
  }
}

上述代码中，@RestController注解标记了该类是一个控制器类，@GetMapping、@PostMapping、@PutMapping、@DeleteMapping注解用于定义HTTP请求处理器。

日志与监控

使用Spring Boot进行日志管理

Spring Boot提供了对多种日志框架的支持，包括SLF4J、Logback、Log4j等。默认情况下，Spring Boot使用Logback作为日志框架。

配置日志级别可以通过修改application.properties文件来完成：

logging.level.root=INFO
logging.level.com.example=DEBUG

上述代码中，logging.level.root=INFO设置根日志级别为INFO，logging.level.com.example=DEBUG设置com.example包的日志级别为DEBUG。

应用监控与健康检查

Spring Boot Actuator提供了多种生产就绪的功能，包括健康检查、审计、指标收集等。要启用Actuator，只需在项目中添加spring-boot-starter-actuator依赖。

<dependency>
  <groupId>org.springframework.boot</groupId>
 . <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

健康检查可以通过访问/actuator/health端点来完成。例如，使用curl命令：

curl http://localhost:8080/actuator/health

返回的JSON数据将包括应用的健康状态，例如：

{
  "status": "UP",
  "details": {
    "diskSpace": {
      "status": "UP",
      "total": 250653496320,
      "free": 174659575808,
      "threshold": 10485760
    }
  }
}

错误处理与单元测试

异常处理机制

Spring Boot提供了多种方式来处理异常，例如通过自定义异常处理器和全局异常处理器。

下面是一个简单的全局异常处理器示例：

package com.example.demo;

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;

@ControllerAdvice
public class GlobalExceptionHandler {

  @ExceptionHandler(ResourceNotFoundException.class)
  public ResponseEntity<ErrorResponse> handleResourceNotFoundException(ResourceNotFoundException ex) {
    ErrorResponse errorResponse = new ErrorResponse(HttpStatus.NOT_FOUND, ex.getMessage());
    return new ResponseEntity<>(errorResponse, HttpStatus.NOT_FOUND);
  }

  @ExceptionHandler(Exception.class)
  public ResponseEntity<ErrorResponse> handleException(Exception ex) {
    ErrorResponse errorResponse = new ErrorResponse(HttpStatus.INTERNAL_SERVER_ERROR, ex.getMessage());
    return new ResponseEntity<>(errorResponse, HttpStatus.INTERNAL_SERVER_ERROR);
  }
}

编写单元测试

编写单元测试可以确保代码的正确性。Spring Boot提供了多种工具来编写单元测试，包括JUnit和Spring Test框架。

下面是一个简单的单元测试示例：

package com.example.demo;

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.mock.mockito.MockBean;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.mockito.Mockito.when;

@SpringBootTest
public class SampleServiceTest {

  @Autowired
  private SampleService sampleService;

  @MockBean
  private SampleConfig sampleConfig;

  @Test
  public void testDoSomething() {
    when(sampleConfig.getValue()).thenReturn("test");
    String result = sampleService.doSomething();
    assertEquals("Value: test", result);
  }
}

使用JUnit与Spring Test框架

JUnit是一个流行的Java单元测试框架。Spring Test提供了与Spring框架集成的测试支持。

下面是一个简单的集成测试示例：

package com.example.demo;

import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.web.client.TestRestTemplate;
import org.springframework.boot.web.server.LocalServerPort;

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public class SampleControllerIT {

  @LocalServerPort
  private int port;

  private final TestRestTemplate restTemplate = new TestRestTemplate();

  @Test
  public void shouldReturnDefaultMessage() {
    String body = this.restTemplate.getForObject("http://localhost:" + port + "/hello", String.class);
    assertEquals("Hello, World!", body);
  }
}

点击查看更多内容

为 TA 点赞

若觉得本文不错，就分享一下吧！

评论

评论

共同学习，写下你的评论

评论加载中...

展开查看更多评论

作者其他优质文章

正在加载中

慕运维8079593

手记
篇

粉丝

18

获赞与收藏

62

关注作者，订阅最新文章

阅读免费教程

后端通用面试教程

41个小节 30809 345

网络编程入门教程

20个小节 12721 239

Pandas 入门教程

25个小节 18600 342

推荐

评论

收藏

共同学习，写下你的评论



感谢您的支持，我会继续努力的～

扫码打赏，你说多少就多少

赞赏金额会直接到老师账户

支付方式

打开微信扫一扫，即可进行扫码打赏哦

今天注册有机会得

100积分直接送

付费专栏免费学

大额优惠券免费领

立即参与放弃机会

点击
抽奖

慕课手记新用户专享福利

恭喜你，你的运气太好了，居然抽中了 100个积分！

恭喜你，抽中了价值元的专栏！

太棒了，直接落到你账户里！

积分商城里的罗技鼠标、机械键盘、
Kindle 阅读器、小米平衡车
Apple iPad （10.2英寸）、大额优惠券
在等着你去兑换了噢

作者：

免费赠送

兑换码：1111222211 复制

优惠券可用于购买实战课、体系课
无门槛使用

先去看看，有什么好东西马上兑换我爱学习，选课去


热搜

最近搜索清空