首页手记 Spring Boot项目实战：入门与初级教程

Spring Boot项目实战：入门与初级教程

标签：

SpringBoot

概述

Spring Boot项目实战旨在简化Spring应用的开发流程，通过自动配置、嵌入式服务器等功能，帮助开发者快速搭建独立的生产级应用。本文将详细介绍如何使用Spring Boot创建和配置项目，并深入探讨数据库集成、应用打包部署及监控等关键步骤。

1. 引入Spring Boot

什么是Spring Boot

Spring Boot是由Pivotal团队提供的开源框架，旨在简化Spring应用的初始搭建和开发过程。它使用约定优于配置的原则来简化开发流程，使得开发者可以快速构建独立的、生产级别的基于Spring的应用。通过Spring Boot，开发者可以避免编写大量的配置代码，转而专注于业务逻辑的开发。

Spring Boot的设计宗旨在于提供开箱即用的功能，例如自动配置、嵌入式服务器、自动重启、内置的性能指标等。这些特性使得开发人员能够快速搭建起可运行的Spring应用。

Spring Boot的优势

简化配置：Spring Boot能够自动配置大多数常见的场景，减少了开发者手动配置的繁琐步骤。
嵌入式服务器：Spring Boot支持嵌入式Servlet容器（如Tomcat、Jetty、Undertow等），可以将应用打包成可执行的jar文件，方便部署。
快速起步：内置了许多模块的默认配置，开发者可以通过简单的注解和类名来快速启动应用。
无依赖性：Spring Boot应用可以独立运行，无需额外的外部配置。
全面监控：内置了多种监控工具，如Actuator，帮助开发者监控应用的运行状态。
自动重启：当应用代码发生变化时，Spring Boot会自动重新启动应用，便于开发调试。

如何开始第一个Spring Boot项目

在开始一个新的Spring Boot项目之前，你需要确保已经安装了Java开发环境和Maven或Gradle构建工具。以下是使用Maven创建一个新的Spring Boot项目的步骤：

1. 创建Spring Boot项目

你可以通过以下步骤使用Maven来创建一个新的Spring Boot项目：

创建一个新的Maven项目。
使用Spring Initializr的在线工具（https://start.spring.io/）生成一个Spring Boot项目的基础代码。此工具可以自动生成项目的基础结构，包括依赖项、配置文件等。
选择项目类型为Maven，填写项目的基本信息（如项目名、包名、依赖项等）。

2. 添加Spring Boot Starter依赖

在pom.xml文件中添加Spring Boot Starter的依赖。例如，添加spring-boot-starter-web依赖来创建一个Web应用：

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
        <version>2.7.3</version>
    </dependency>
</dependencies>

3. 创建主启动类

创建一个Spring Boot应用的主类，使用@SpringBootApplication注解来注解这个类。这个注解是所有Spring Boot应用的基础，它结合了@Configuration、@EnableAutoConfiguration和@ComponentScan的功能。

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

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

4. 创建一个简单的控制器

创建一个简单的控制器类，并使用@RestController注解来定义这个类是一个REST控制器。

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

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

5. 运行应用

在IDE中运行主类，或者通过Maven命令mvn spring-boot:run来启动应用。在浏览器中访问http://localhost:8080/，应该可以看到输出“Hello, World!”。

2. Spring Boot项目搭建

使用IDE创建Spring Boot项目

大多数现代IDE（如IntelliJ IDEA和Eclipse）都提供了创建Spring Boot项目的向导。以IntelliJ IDEA为例，其内置了Spring Initializr的支持，可以方便地创建新的Spring Boot项目。

打开IntelliJ IDEA，并选择“File” -> “New” -> “Project”。
在项目向导中选择“Spring Initializr”。
输入项目的基本信息，如项目名、语言、Spring Boot版本等。
选择需要的依赖项。
点击“Finish”完成项目的创建。

配置文件详解（application.properties/application.yml）

Spring Boot项目通常会包含一个application.properties或application.yml配置文件，用于定义应用的各种配置。下面是一些常用的配置项：

application.properties示例

# 端口号
server.port=8080

# 数据源配置
spring.datasource.url=jdbc:mysql://localhost:3306/mydb
spring.datasource.username=root
spring.datasource.password=root

# 日志配置
logging.level.root=INFO
logging.file.name=app.log

# 其他配置
spring.profiles.active=dev

application.yml示例

server:
  port: 8080

spring:
  datasource:
   url: jdbc:mysql://localhost:3306/mydb
   username: root
   password: root
 profiles:
   active: dev

logging:
 level:
   root: INFO
 file:
   name: app.log

这里展示了一些基本的配置项：

Server Configuration
- server.port: 定义应用运行的端口号。
DataSource Configuration
- spring.datasource.url: 数据库连接URL。
- spring.datasource.username: 数据库用户名。
- spring.datasource.password: 数据库密码。
Logging Configuration
- logging.level.root: 设置日志的级别。
- logging.file.name: 设置日志文件的名称。
Profile Configuration
- spring.profiles.active: 指定激活的配置文件。

3. Spring Boot基础组件使用

Spring Boot中的Controller、Service、Repository

Spring Boot应用通常使用Controller、Service和Repository这三个主要组件来组织代码结构。

Controller

在Spring Boot中，通常使用@RestController注解来定义一个REST控制器，用于处理HTTP请求。

示例代码：

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

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

Service

Service层通常用于处理业务逻辑，可以使用@Service注解来定义一个服务类。

示例代码：

import org.springframework.stereotype.Service;

@Service
public class UserService {
    public String getUserName() {
        return "John Doe";
    }
}

Repository

Repository层用于处理数据访问逻辑，可以使用@Repository注解来定义一个数据访问类。

示例代码：

import org.springframework.stereotype.Repository;

@Repository
public class UserRepository {
    public String getUserNameById(Long id) {
        // 数据库操作逻辑
        return "John Doe";
    }
}

Spring Boot的自动配置原理

Spring Boot的自动配置功能会根据类路径中的依赖来自动配置应用。例如，当项目中添加了spring-boot-starter-web依赖后，Spring Boot会自动配置一个嵌入式的Tomcat服务器，并提供DispatcherServlet等Web组件。

自动配置的核心在于@SpringBootApplication注解中的@EnableAutoConfiguration。这个注解会启用自动配置功能，同时会扫描特定的类路径来决定需要哪些配置。

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

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

4. 数据库集成与操作

连接数据库（MySQL/PostgreSQL等）

Spring Boot可以方便地连接到不同的数据库，如MySQL和PostgreSQL。以下是一个简单的MySQL连接配置示例。

spring.datasource.url=jdbc:mysql://localhost:3306/mydb
spring.datasource.username=root
spring.datasource.password=root

以下是PostgreSQL连接配置示例：

spring.datasource.url=jdbc:postgresql://localhost:5432/mydb
spring.datasource.username=root
spring.datasource.password=root

使用JPA进行CRUD操作

Spring Boot集成了JPA（Java Persistence API），可以方便地进行数据库的CRUD操作。

1. 添加依赖

在pom.xml添加spring-boot-starter-data-jpa依赖。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-jpa</artifactId>
    <version>2.7.3</version>
</dependency>

2. 创建实体类

定义一个简单的用户实体类，使用@Entity注解来标识它。

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;

@Entity
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String name;

    // 省略getter和setter方法
}

3. 创建Repository接口

创建一个继承自JpaRepository的接口，用于定义CRUD操作。

import org.springframework.data.jpa.repository.JpaRepository;

public interface UserRepository extends JpaRepository<User, Long> {
}

4. 创建Service类

定义一个服务类来使用Repository进行CRUD操作。

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

import java.util.List;

@Service
public class UserService {
    @Autowired
    private UserRepository userRepository;

    public List<User> getAllUsers() {
        return userRepository.findAll();
    }

    public User getUserById(Long id) {
        return userRepository.findById(id).orElse(null);
    }

    public User createUser(User user) {
        return userRepository.save(user);
    }

    public User updateUser(Long id, User user) {
        User existingUser = userRepository.findById(id).orElse(null);
        if (existingUser != null) {
            existingUser.setName(user.getName());
            return userRepository.save(existingUser);
        }
        return null;
    }

    public void deleteUser(Long id) {
        userRepository.deleteById(id);
    }
}

5. 创建Controller类

创建Controller类来暴露服务给外部调用。

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

import java.util.List;

@RestController
@RequestMapping("/users")
public class UserController {
    @Autowired
    private UserService userService;

    @GetMapping
    public List<User> getAllUsers() {
        return userService.getAllUsers();
    }

    @GetMapping("/{id}")
    public User getUserById(@PathVariable Long id) {
        return userService.getUserById(id);
    }

    @PostMapping
    public User createUser(@RequestBody User user) {
        return userService.createUser(user);
    }

    @PutMapping("/{id}")
    public User updateUser(@PathVariable Long id, @RequestBody User user) {
        return userService.updateUser(id, user);
    }

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

5. Spring Boot项目打包与部署

打包Spring Boot应用

你可以使用Maven或Gradle来打包Spring Boot应用。以下是使用Maven打包的示例：

mvn clean package

执行以上命令后，将在target目录下生成一个可执行的jar文件。

部署到本地或云服务器

部署到本地服务器

将生成的jar文件拷贝到目标服务器上，并通过以下命令运行：

java -jar your-application.jar

部署到云服务器

你可以将应用部署到云服务器上，例如阿里云、腾讯云等。以下是部署到阿里云ECS的简要步骤：

登录阿里云ECS控制台，创建一个新的ECS实例。
将生成的jar文件上传到ECS实例上。
安装JDK和依赖的库。
创建一个启动脚本，自动启动应用。

示例启动脚本：

#!/bin/bash
java -jar /path/to/your-application.jar &

可以通过设置定时任务或使用系统服务管理器（如systemd）来确保应用在服务器重启后自动启动。

6. 日志与监控

使用Spring Boot的日志框架

Spring Boot默认集成了Spring Boot Actuator，它提供了一系列的生产特性，包括健康检查、信息暴露、审计等。默认情况下，Actuator会提供一些有用的端点，如/actuator/health、/actuator/metrics等。

配置日志框架

在application.properties中配置日志框架：

# 使用logback作为日志框架
logging.config=classpath:logback-spring.xml

创建一个logback-spring.xml文件，定义日志的输出格式和级别：

<configuration>
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss} - %msg%n</pattern>
        </encoder>
    </appender>

    <root level="INFO">
        <appender-ref ref="STDOUT" />
    </root>
</configuration>

应用监控与健康检查

检查健康状态

可以通过访问/actuator/health端点来检查应用的健康状态。

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

输出示例：

{
    "status": "UP",
    "components": {
        "diskSpace": {
            "status": "UP",
            "details": {
                "total": 25097390080,
                "free": 18962587648,
                "threshold": 10485760,
                "exists": true
            }
        }
    }
}

配置Actuator端点

在application.properties中配置Actuator端点：

management.endpoints.web.exposure.include=health,info
management.endpoint.health.show-details=always

这些配置项可以暴露health和info端点，并显示详细信息。

使用Prometheus监控

你可以将Spring Boot应用集成到Prometheus监控系统中。首先添加相关依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
    <groupId>io.micrometer</groupId>
    <artifactId>micrometer-registry-prometheus</artifactId>
</dependency>

然后，在application.properties中配置Prometheus相关配置：

management.endpoints.web.exposure.include=prometheus
management.metrics.web.server.auto-expiration-enabled=true
management.metrics.web.server.max-age-seconds=60

这样，你可以通过访问/actuator/prometheus端点来获取Prometheus格式的metrics数据。

点击查看更多内容

为 TA 点赞

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

评论

评论

共同学习，写下你的评论

评论加载中...

展开查看更多评论

作者其他优质文章

正在加载中

噜噜哒

移动开发工程师

手记
篇

粉丝

8

获赞与收藏

25

关注作者，订阅最新文章

阅读免费教程

后端通用面试教程

41个小节 30828 345

网络编程入门教程

20个小节 12721 239

Pandas 入门教程

25个小节 18601 342

推荐

评论

收藏

共同学习，写下你的评论



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

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

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

支付方式

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

今天注册有机会得

100积分直接送

付费专栏免费学

大额优惠券免费领

立即参与放弃机会

点击
抽奖

慕课手记新用户专享福利

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

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

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

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

作者：

免费赠送

兑换码：1111222211 复制

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

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

热搜

最近搜索清空

Spring Boot项目实战：入门与初级教程

什么是Spring Boot

Spring Boot的优势

如何开始第一个Spring Boot项目

1. 创建Spring Boot项目

2. 添加Spring Boot Starter依赖

3. 创建主启动类

4. 创建一个简单的控制器

5. 运行应用

使用IDE创建Spring Boot项目

配置文件详解（application.properties/application.yml）

application.properties示例

application.yml示例

Spring Boot中的Controller、Service、Repository

Controller

Service

Repository

Spring Boot的自动配置原理

连接数据库（MySQL/PostgreSQL等）

使用JPA进行CRUD操作

1. 添加依赖

2. 创建实体类

3. 创建Repository接口

4. 创建Service类

5. 创建Controller类

打包Spring Boot应用

部署到本地或云服务器

部署到本地服务器

部署到云服务器

使用Spring Boot的日志框架

配置日志框架

应用监控与健康检查

检查健康状态

配置Actuator端点

使用Prometheus监控

阅读免费教程