首页手记 Spring Boot项目开发学习：从入门到实战

Spring Boot项目开发学习：从入门到实战

标签：

Java SpringBoot

概述

本文介绍了Spring Boot项目开发学习的全过程，从环境搭建到快速入门项目创建，涵盖了Spring Boot的核心概念与组件，并提供了数据库集成、RESTful API创建等实战示例。此外，文章还详细讲解了应用的部署与运行、常见问题排查以及一些进阶知识点。通过丰富的实践内容，帮助开发者全面掌握Spring Boot框架。

Spring Boot简介与环境搭建

Spring Boot简介

Spring Boot是Spring生态系统中一个非常受欢迎的框架，它简化了Spring应用的开发流程。Spring Boot旨在通过多种方式减轻开发者的负担，如自动配置、约定优于配置等。它支持创建独立的、生产级别的基于Spring的应用程序，项目无需过多配置即可快速运行。

Spring Boot的核心思想是尽可能减少配置，这使得开发者能够专注于业务逻辑的实现。它支持多种部署方式（如嵌入式Tomcat、Jetty等），并提供了许多内置的starter依赖，简化了依赖管理和配置。

开发环境搭建

在开始开发Spring Boot应用之前，需要搭建开发环境。以下步骤适用于Windows、Linux或macOS系统。

安装JDK：
- 下载并安装Java Development Kit (JDK)。Spring Boot要求Java 11或更高版本。可以访问Oracle官网或OpenJDK下载合适的JDK版本。
- 验证JDK是否安装成功，打开命令行并输入以下命令检查：
```
java -version
```
安装IDE：
- 推荐使用IntelliJ IDEA或Spring Tool Suite（STS），这两个IDE都提供了对Spring Boot项目的卓越支持。
- 其他如Eclipse也可以，但需安装额外的插件来支持Spring Boot。
安装Maven或Gradle：
- 下载并安装Maven或Gradle，Maven和Gradle是Spring Boot项目最常用的构建工具。
- 验证Maven或Gradle是否安装成功，例如，通过命令行运行：
```
mvn -v
```
  或
```
gradle -v
```

快速入门项目创建

创建一个Spring Boot项目，可以通过Spring Initializr网站（https://start.spring.io/）或者使用IDE的内置功能。这里以IDEA为例：

打开IntelliJ IDEA，选择“File” -> “New” -> “Project”。
在弹出的对话框中，选择“Spring Initializr”，点击“Next”。
输入项目基本信息，如项目名、组名（通常使用域名反转）等。
选择语言为Java，版本为Java 11或更高。
选择Spring Boot版本，建议使用最新的稳定版本。
选择项目依赖，例如，选择“Web”来创建一个简单的Web应用。
选择构建工具为Maven或Gradle。
点击“Next”，然后“Finish”，IDE会自动生成项目目录和必要的文件。

生成的项目目录结构如下：

my-spring-boot-app/
├── pom.xml
├── .gitignore
├── src
│   ├── main
│   │   ├── java
│   │   │   └── com
│   │   │       └── example
│   │   │           └── app
│   │   │               ├── Application.java
│   │   │               └── controller
│   │   │                   └── HelloController.java
│   │   └── resources
│   │       ├── application.properties
│   │       └── static
│   │           └── index.html
└── README.md

示例代码

创建一个简单的Spring Boot应用，可以定义一个简单的控制器，如下所示：

package com.example.app;

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 Application {

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

@RestController
class HelloController {

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

在pom.xml中添加Web依赖：

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

运行Application类中的main方法，启动Spring Boot应用。访问http://localhost:8080，可以看到输出Hello World!。

Spring Boot核心概念与组件

自动配置原理

Spring Boot的核心特性之一是自动配置。它通过@SpringBootApplication注解来启用自动配置，这意味着Spring Boot将根据类路径中的依赖来自动配置应用。例如，如果类路径中包含spring-boot-starter-web依赖，Spring Boot将自动配置一个嵌入式的Tomcat服务器，并提供一个Spring MVC应用。

Spring Boot的自动配置是通过SpringApplication类中的prepareAutoConfiguration方法实现的。这个方法会查找类路径中包含的类，然后根据这些类来配置应用。

示例代码

下面是一个简单的例子，展示了如何使用@SpringBootApplication注解：

package com.example.app;

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);
    }
}

配置文件使用

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

示例代码

在application.properties文件中定义端口号：

server.port=8080

在application.yml文件中定义相同的信息（注意YAML的语法）：

server:
  port: 8080

Starter依赖管理

Spring Boot提供了一组预定义的Starter依赖，这些依赖通常包含多个库，这样开发者可以快速地将应用从IDE或命令行启动起来，而无需手动配置每个库。例如，spring-boot-starter-web依赖包含Spring MVC、Thymeleaf模板引擎、JSP等。

示例代码

在pom.xml文件中添加spring-boot-starter-web依赖：

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

添加后，这个依赖将自动引入所有需要的库，从而可以快速地创建一个Web应用。

Spring Boot项目实战

创建RESTful API

创建一个RESTful API是Spring Boot应用中最常见的任务之一。通过Spring MVC，可以定义RESTful接口，处理HTTP请求和响应。

示例代码

定义一个简单的RESTful API接口：

package com.example.app.controller;

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

@RestController
@RequestMapping("/api")
public class MyController {

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

在浏览器中访问http://localhost:8080/api/hello，可以返回一个简单的响应。

数据库集成（如JPA、MyBatis）

Spring Boot支持多种数据库集成方式，如JPA、MyBatis等。这里以JPA和MyBatis为例，分别介绍如何集成数据库。

JPA示例代码

在pom.xml中添加JPA依赖：

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-jpa</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-redis</artifactId>
    </dependency>
    <dependency>
        <groupId>com.h2database</groupId>
        <artifactId>h2</artifactId>
        <scope>runtime</scope>
    </dependency>
</dependencies>

在application.properties中配置数据库连接信息：

spring.datasource.url=jdbc:h2:mem:testdb
spring.datasource.driverClassName=org.h2.Driver
spring.datasource.username=root
spring.datasource.password=root
spring.jpa.database-platform=org.hibernate.dialect.H2Dialect
spring.jpa.properties.hibernate.hbm2ddl.auto=update

定义一个简单的实体类：

package com.example.app.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.AUTO)
    private Long id;
    private String name;
    private String email;

    // getters and setters
}

定义一个数据访问层接口：

package com.example.app.repository;

import com.example.app.entity.User;
import org.springframework.data.jpa.repository.JpaRepository;

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

定义一个服务层，用于处理业务逻辑：

package com.example.app.service;

import com.example.app.entity.User;
import com.example.app.repository.UserRepository;
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();
    }
}

定义一个控制器来处理HTTP请求：

package com.example.app.controller;

import com.example.app.entity.User;
import com.example.app.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.List;

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

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

MyBatis示例代码

在pom.xml中添加MyBatis依赖：

<dependencies>
    <dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-starter</artifactId>
        <version>2.1.3</version>
    </dependency>
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.23</version>
    </dependency>
</dependencies>

在application.properties文件中配置数据库连接信息：

spring.datasource.url=jdbc:mysql://localhost:3306/mydb
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
mybatis.mapper-locations=classpath:mapper/*.xml

定义一个简单的实体类：

package com.example.app.entity;

public class User {
    private Long id;
    private String name;
    private String email;

    // getters and setters
}

定义一个Mapper接口：

package com.example.app.mapper;

import com.example.app.entity.User;
import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Select;

import java.util.List;

@Mapper
public interface UserMapper {
    @Select("SELECT * FROM user")
    List<User> findAll();
}

定义一个数据访问层接口：

package com.example.app.repository;

import com.example.app.entity.User;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Repository;

import java.util.List;

@Repository
public class UserRepository {
    @Autowired
    private UserMapper userMapper;

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

定义一个服务层，用于处理业务逻辑：

package com.example.app.service;

import com.example.app.entity.User;
import com.example.app.repository.UserRepository;
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();
    }
}

定义一个控制器来处理HTTP请求：

package com.example.app.controller;

import com.example.app.entity.User;
import com.example.app.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.List;

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

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

以上代码实现了一个简单的RESTful API接口，用于管理用户信息。通过这些示例代码，可以快速地集成数据库并处理相关业务逻辑。

日志与监控集成

Spring Boot支持多种日志框架，如Logback、Log4j2等。它还支持多种监控工具，如Micrometer、Actuator等。

示例代码

在pom.xml文件中添加Actuator依赖：

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

Actuator提供了一系列的端点，用于监控应用的运行状态。默认情况下，Actuator会启用一些常用的端点，如/actuator/metrics、/actuator/health等。

可以在application.properties中配置这些端点的访问权限：

management.endpoints.web.exposure.include=*
management.endpoint.metrics.enabled=true
management.endpoint.health.enabled=true

通过访问http://localhost:8080/actuator，可以查看所有的Actuator端点信息。

启动应用后，可以通过以下命令访问Actuator端点：

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

这些命令将返回应用的运行状态和性能指标信息。

Spring Boot项目部署与运行

应用打包

Spring Boot应用可以打包成可执行的JAR或WAR文件。通过Maven或Gradle构建工具，可以轻松地将应用打包。

示例代码

在pom.xml文件中添加打包插件：

<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
        </plugin>
    </plugins>
</build>

运行以下命令，将应用打包成JAR文件：

mvn clean package

生成的JAR文件位于target目录下。

部署方式介绍

部署Spring Boot应用有多种方式，如在本地开发机器上运行、部署到云服务（如阿里云、腾讯云）、部署到Docker容器等。

示例代码

在本地开发机器上运行打包好的JAR文件：

java -jar target/my-spring-boot-app.jar

在Docker容器中部署Spring Boot应用：

FROM openjdk:11-jre-slim
COPY target/my-spring-boot-app.jar app.jar
ENTRYPOINT ["java", "-jar", "app.jar"]

构建并运行Docker镜像：

docker build -t my-spring-boot-app .
docker run -p 8080:8080 my-spring-boot-app

常见问题排查

在开发和部署Spring Boot应用时，可能会遇到一些常见问题，如端口冲突、内存不足等。这些问题通常可以通过查看日志、调整配置等方式解决。

示例代码

查看日志文件，通常在target目录下生成的日志文件中可以找到详细信息。例如，通过访问日志文件：

cat target/your-app-name.log

或使用日志工具查看日志文件：

tail -f target/your-app-name.log

这些命令可以查看应用运行时的日志信息，帮助开发者诊断和解决常见问题。

Spring Boot常用技巧

属性文件管理

Spring Boot支持多种属性文件，如application.properties和application.yml。此外，还可以使用@PropertySource注解来读取自定义的属性文件。

示例代码

在application.properties文件中定义属性值：

app.name=MyApp
app.version=1.0.0

在Java代码中读取属性值：

package com.example.app;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

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

@Component
class Config {
    @Value("${app.name}")
    private String appName;

    @Value("${app.version}")
    private String appVersion;

    // getters and setters
}

静态资源处理

Spring Boot默认支持处理静态资源，如HTML、CSS、JavaScript等。这些资源通常位于src/main/resources/static目录下。

示例代码

在src/main/resources/static目录下创建一个index.html文件：

<!DOCTYPE html>
<html>
<head>
    <title>My Spring Boot App</title>
    <link rel="stylesheet" href="/css/style.css">
</head>
<body>
    <h1>Welcome to My Spring Boot App</h1>
</body>
</html>

在src/main/resources/static/css目录下创建一个style.css文件：

body {
    background-color: #f0f0f0;
}

启动应用，访问http://localhost:8080，可以看到渲染后的HTML页面。

日志与异常处理

Spring Boot支持多种日志框架，如Logback、Log4j2等。它还提供了全局异常处理机制，可以捕获并处理未捕获的异常。

示例代码

定义一个全局异常处理器：

package com.example.app.exception;

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

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(Exception.class)
    @ResponseBody
    public ResponseEntity<String> handleException(Exception ex) {
        return new ResponseEntity<>("An error occurred: " + ex.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);
    }
}

定义一个控制器来模拟异常：

package com.example.app.controller;

import com.example.app.exception.GlobalExceptionHandler;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/api")
public class MyController {

    @GetMapping("/throw-exception")
    public String throwException() {
        throw new RuntimeException("This is a simulated exception.");
    }
}

启动应用，访问http://localhost:8080/api/throw-exception，可以看到全局异常处理器捕获并处理了异常。

Spring Boot进阶知识点

项目重构与优化

随着项目的扩大，可能会遇到代码结构混乱、性能瓶颈等问题。Spring Boot提供了多种重构和优化的建议和工具，如使用Spring Profiles、代码审查工具等。

示例代码

定义一个ProfileAwareApplication类，根据不同的Spring Profile加载不同的配置：

package com.example.app;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;

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

@Configuration
@Profile("dev")
public class DevConfig {}

@Configuration
@Profile("prod")
public class ProdConfig {}

在application-dev.properties和application-prod.properties文件中定义不同的配置信息。

测试方法与工具

Spring Boot支持多种测试方法，如单元测试、集成测试等。可以使用JUnit、Mockito等工具进行测试。

示例代码

编写一个简单的单元测试：

package com.example.app.service;

import com.example.app.entity.User;
import com.example.app.repository.UserRepository;
import org.junit.jupiter.api.Test;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.Mockito;
import org.mockito.MockitoAnnotations;

import java.util.Arrays;
import java.util.List;

import static org.junit.jupiter.api.Assertions.assertEquals;

public class UserServiceTest {
    @Mock
    private UserRepository userRepository;

    @InjectMocks
    private UserService userService;

    @Test
    public void testGetAllUsers() {
        MockitoAnnotations.initMocks(this);

        List<User> users = Arrays.asList(
            new User(1L, "Alice", "alice@example.com"),
            new User(2L, "Bob", "bob@example.com")
        );

        Mockito.when(userRepository.findAll()).thenReturn(users);

        List<User> result = userService.getAllUsers();
        assertEquals(users, result);
    }
}

安全性与认证配置

Spring Boot支持多种安全性配置，如Basic认证、OAuth2等。可以使用Spring Security等工具进行配置。

示例代码

在pom.xml文件中添加Spring Security依赖：

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

定义一个简单的Security配置类：

package com.example.app.security;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
import org.springframework.security.core.userdetails.User;
import org.springframework.security.core.userdetails.UserDetails;
import org.springframework.security.core.userdetails.UserDetailsService;
import org.springframework.security.provisioning.InMemoryUserDetailsManager;

@Configuration
@EnableWebSecurity
public class SecurityConfig extends WebSecurityConfigurerAdapter {

    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http.authorizeRequests()
            .antMatchers("/api/hello").permitAll()
            .anyRequest().authenticated()
            .and()
            .httpBasic();
    }

    @Override
    @Bean
    public UserDetailsService userDetailsService() {
        UserDetails user = User.withDefaultPasswordEncoder()
            .username("user")
            .password("password")
            .roles("USER")
            .build();

        return new InMemoryUserDetailsManager(user);
    }
}

启动应用，访问http://localhost:8080/api/hello，需要输入用户名和密码才能访问。

通过以上示例代码，可以快速地实现安全性和认证配置。

点击查看更多内容

为 TA 点赞

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

评论

评论

共同学习，写下你的评论

评论加载中...

展开查看更多评论

作者其他优质文章

正在加载中

慕村9548890

手记
篇

粉丝

227

获赞与收藏

991

关注作者，订阅最新文章

阅读免费教程

Java并发工具

23个小节 19367 315

Java 并发原理入门教程

26个小节 39087 568

Java 入门教程

50个小节 342278 3164

推荐

评论

收藏

共同学习，写下你的评论



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

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

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

支付方式

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

今天注册有机会得

100积分直接送

付费专栏免费学

大额优惠券免费领

立即参与放弃机会

点击
抽奖

慕课手记新用户专享福利

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

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

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

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

作者：

免费赠送

兑换码：1111222211 复制

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

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

热搜

最近搜索清空

Spring Boot项目开发学习：从入门到实战

Spring Boot简介

开发环境搭建

快速入门项目创建

示例代码

自动配置原理

示例代码

配置文件使用

示例代码

Starter依赖管理

示例代码

创建RESTful API

示例代码

数据库集成（如JPA、MyBatis）

JPA示例代码

MyBatis示例代码

日志与监控集成

示例代码

应用打包

示例代码

部署方式介绍

示例代码

常见问题排查

示例代码

属性文件管理

示例代码

静态资源处理

示例代码

日志与异常处理

示例代码

项目重构与优化

示例代码

测试方法与工具

示例代码

安全性与认证配置

示例代码

阅读免费教程