首頁手記 Spring Boot項目開發教程：輕松入門與實踐

Spring Boot項目開發教程：輕松入門與實踐

標簽：

SpringBoot

概述

本文提供了全面的Spring Boot项目开发教程，涵盖环境搭建、项目创建、应用运行和配置等内容。通过详细步骤和示例代码，帮助开发者快速入门并实践Spring Boot项目开发。文章还介绍了持久层开发、RESTful API设计以及应用测试和部署的方法。全文旨在帮助读者轻松掌握Spring Boot项目开发教程。

Spring Boot项目开发教程：轻松入门与实践

Spring Boot简介与环境搭建

Spring Boot是什么

Spring Boot 是由Pivotal团队提供的全新框架，其主要目标是简化Spring应用的初始搭建以及开发过程。通过Spring Boot，开发者能够快速、方便地构建独立的、生产级别的基于Spring的应用程序。它集成了大量的Spring第三方库，简化了Spring应用的配置，使得开发人员可以专注于业务逻辑的实现，而无需过多关注框架的配置细节。

Spring Boot 使用约定优于配置的原则，自动配置了许多常见的场景，如数据库连接、视图渲染等。它还可以通过嵌入式Servlet容器（如Tomcat、Jetty）直接运行应用，无需再部署到外部应用服务器。

开发环境搭建

要开始使用Spring Boot进行开发，你需要先搭建好开发环境：

安装Java开发工具包（JDK）：Spring Boot应用需要Java环境。你可以在Oracle官网或OpenJDK官网下载并安装最新版本的JDK。
安装IDE：Spring Boot支持多种IDE，如IntelliJ IDEA、Eclipse、STS（Spring Tool Suite）等。本教程推荐使用IntelliJ IDEA，因为它是Spring Boot开发的官方推荐IDE之一。
安装Maven或Gradle：Spring Boot应用的构建依赖于一个构建工具，如Maven或Gradle。Maven是使用更为广泛的构建工具，同时也能很好地支持Spring Boot项目。
安装Spring Boot CLI（可选）：Spring Boot Command Line Interface (CLI) 是一个命令行工具，用于快速创建Spring Boot应用。虽然不是必需的，但CLI可以提升开发效率。可以通过Spring官网下载CLI。

创建第一个Spring Boot项目

本节将指导你创建第一个Spring Boot项目。你将学习如何使用Spring Initializr来快速生成项目结构。

使用Spring Initializr创建项目

访问Spring Initializr。
选择项目类型，如Maven项目或Gradle项目。
填写项目基本信息，如项目名、语言、Spring Boot版本等。
选择需要的依赖，如Web、Thymeleaf、JPA等。
点击“Generate”按钮，下载生成的项目压缩包。
解压包后，将项目导入到你的IDE中。

使用IDE创建项目

使用IntelliJ IDEA创建新项目：

打开IntelliJ IDEA，选择"File" -> "New" -> "Project"。
在弹出的对话框中，选择"Maven"项目。
勾选"Create from archetype"，选择org.springframework.boot:spring-boot-starter-parent作为父项目。
填写Project name、Group Id、Artifact Id等信息。
点击“Next”按钮，进入下一步。
选择Java版本，建议使用11或更高版本。
点击“Finish”按钮完成项目创建。

创建完成后，你的项目结构将如下所示：

src
└── main
    ├── java
    │   └── com.example.demo
    │       └── DemoApplication.java
    └── resources
        ├── application.properties
        └── static
            └── index.html

运行Spring Boot应用

在IDE中运行Spring Boot应用：

打开DemoApplication.java文件，确保其内容如下：

package com.example.demo;

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

@SpringBootApplication
public class DemoApplication {

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

运行DemoApplication类的main方法。程序启动后，控制台输出信息表明应用已启动并监听在默认端口8080上。
打开浏览器，访问http://localhost:8080，应能看到默认的欢迎页面。

至此，你已经成功创建并运行了第一个Spring Boot项目。

项目结构与核心配置

项目目录结构介绍

Spring Boot项目结构简单且统一，具有良好的可维护性。标准目录结构如下：

src
└── main
    ├── java
    │   └── com.example.demo
    │       ├── DemoApplication.java
    │       └── controller
    │           └── HelloController.java
    └── resources
        ├── application.properties
        ├── static
        │   └── index.html
        └── templates
            └── hello.html

java目录存放Java源码文件。
resources目录存放资源文件，如配置文件和静态资源文件。
src/main/java目录是Java源码文件的存放位置，包括主类和控制器类。
src/main/resources目录包含资源文件，如配置文件、静态资源文件等。

应用配置详解

Spring Boot使用默认配置来简化配置工作。你可以在src/main/resources/application.properties或application.yml文件中自定义应用配置。

常见配置项

端口配置：
- server.port: 指定应用监听的端口，默认为8080。
- 示例：
```
server.port=8080
```
静态资源路径配置：
- spring.mvc.static-path-pattern: 指定静态资源的路径。
- 示例：
```
spring.mvc.static-path-pattern=/static/**
```
数据库连接配置：
- spring.datasource.url: 数据库连接URL。
- spring.datasource.username: 数据库用户名。
- spring.datasource.password: 数据库密码。
- 示例：
```
spring.datasource.url=jdbc:mysql://localhost:3306/demo
spring.datasource.username=root
spring.datasource.password=root
```
JPA配置：
- spring.jpa.hibernate.ddl-auto: 数据库DDL操作模式。
- spring.jpa.show-sql: 是否显示SQL语句。
- 示例：
```
spring.jpa.hibernate.ddl-auto=update
spring.jpa.show-sql=true
```

自动配置原理

Spring Boot通过@EnableAutoConfiguration注解自动配置应用。该注解会扫描应用的依赖和配置文件，并根据约定进行配置。例如，当发现Spring Data JPA相关依赖时，会自动配置JPA。

@SpringBootApplication注解实际上是@Configuration、@EnableAutoConfiguration和@ComponentScan三个注解的组合，简化了配置过程。

@Configuration：标识一个类作为配置类。
@EnableAutoConfiguration：启用自动配置。
@ComponentScan：扫描组件，包括控制器、服务等。

控制器与RESTful API开发

创建控制器

控制器负责接收HTTP请求并返回响应。Spring Boot通过@Controller或@RestController注解定义控制器。区别在于@RestController会自动将返回的对象转换为JSON。

示例代码

创建控制器：

在src/main/java/com.example.demo/controller目录下创建一个HelloController.java文件。

示例代码如下：

package com.example.demo.controller;

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!";
    }
}

运行应用并访问控制器：
- 运行DemoApplication类的main方法。
- 打开浏览器，访问http://localhost:8080/hello，应能看到返回的“Hello, World!”。

RESTful API设计

RESTful API是一种基于HTTP协议的应用程序接口设计风格。设计RESTful API时，应遵循以下原则：

资源唯一标识：每个资源都有一个唯一的URL。
使用标准HTTP动词：GET用于获取数据，POST用于创建资源，PUT用于更新资源，DELETE用于删除资源。
无状态：每个请求都应包含所有必要的信息，不应依赖于之前的请求信息。

示例代码

创建用户资源：

创建一个UserController.java文件，实现用户资源的CRUD操作。

示例代码如下：

package com.example.demo.controller;

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

@RestController
@RequestMapping("/users")
public class UserController {

    @GetMapping("/{id}")
    public ResponseEntity<String> getUserById(@PathVariable long id) {
        return ResponseEntity.ok("User with ID " + id);
    }

    @PostMapping("/")
    public ResponseEntity<String> createUser(@RequestBody String user) {
        return ResponseEntity.ok("Created user: " + user);
    }

    @PutMapping("/{id}")
    public ResponseEntity<String> updateUser(@PathVariable long id, @RequestBody String user) {
        return ResponseEntity.ok("Updated user with ID " + id + ": " + user);
    }

    @DeleteMapping("/{id}")
    public ResponseEntity<String> deleteUser(@PathVariable long id) {
        return ResponseEntity.ok("Deleted user with ID " + id);
    }
}

运行应用并访问控制器：
- 运行DemoApplication类的main方法。
- 使用Postman或curl工具测试不同HTTP动词的请求。

使用Spring MVC注解

Spring Boot提供了多种注解来简化控制器的定义。常见的注解包括：

@RequestMapping：标记控制器类或方法，指定请求的URL。
@GetMapping：处理GET请求。
@PostMapping：处理POST请求。
@PutMapping：处理PUT请求。
@DeleteMapping：处理DELETE请求。
@PathVariable：绑定URL中的路径变量到方法参数。
@RequestBody：将请求体绑定到方法参数。
@RequestParam：从请求的查询字符串中获取参数值。

示例代码

获取请求参数：

在HelloController.java中添加获取请求参数的方法。

示例代码如下：

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

提交表单数据：

创建一个简单的HTML表单，提交数据到控制器。

示例HTML代码如下：

<form action="/hello" method="get">
    <input type="text" name="name" placeholder="Enter your name">
    <input type="submit" value="Submit">
</form>

运行应用并测试：
- 运行DemoApplication类的main方法。
- 打开浏览器，访问http://localhost:8080/hello/John，应能看到返回的“Hello, John!”。

持久层开发：使用JPA与Spring Data

数据库连接

在Spring Boot中，通过配置文件中的spring.datasource.*属性来连接数据库。例如，连接MySQL数据库配置：

spring.datasource.url=jdbc:mysql://localhost:3306/demo
spring.datasource.username=root
spring.datasource.password=root
spring.jpa.hibernate.ddl-auto=update
spring.jpa.show-sql=true

实体类设计

在持久层开发中，实体类是与数据库表对应的Java类。实体类应遵循以下约定：

使用@Entity注解：标识一个实体类。
使用@Id注解：标识主键字段。
使用@GeneratedValue注解：指定主键生成策略。
使用@Column注解：指定字段的属性，如列名、长度等。

示例代码

定义实体类：

创建一个User.java文件。

示例代码如下：

package com.example.demo.entity;

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

@Entity
@Table(name = "users")
public class User {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private long id;
    private String name;
    private String email;

    // getter和setter方法
    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;
    }

    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }
}

查询与操作数据库

Spring Boot通过JPA和Spring Data提供了丰富的数据库查询和操作功能。Spring Data JPA支持多种查询方式，如@Query注解、findBy方法等。

示例代码

创建仓库接口：

创建一个UserRepository.java文件，继承JpaRepository。

示例代码如下：

package com.example.demo.repository;

import com.example.demo.entity.User;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.stereotype.Repository;

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

定义服务类：

创建一个UserService.java文件，实现用户相关服务。

示例代码如下：

package com.example.demo.service;

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

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

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

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

使用服务类进行数据库操作：

在UserController.java中调用服务类方法。

示例代码如下：

package com.example.demo.controller;

import com.example.demo.entity.User;
import com.example.demo.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

@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.saveUser(user);
    }

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

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

测试Spring Boot应用

单元测试

单元测试是指测试应用中的单个类或方法。Spring Boot提供了@SpringBootTest注解，使得单元测试更加方便。

示例代码

创建单元测试类：

创建一个UserServiceTest.java文件，测试UserService类的功能。

示例代码如下：

package com.example.demo.service;

import com.example.demo.entity.User;
import com.example.demo.repository.UserRepository;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

import java.util.List;

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

@SpringBootTest
public class UserServiceTest {

    @Autowired
    private UserService userService;

    @Autowired
    private UserRepository userRepository;

    @Test
    public void testGetAllUsers() {
        List<User> users = userService.getAllUsers();
        assertNotNull(users);
    }

    @Test
    public void testGetUserById() {
        User user = userService.getUserById(1L);
        assertNotNull(user);
    }

    @Test
    public void testSaveUser() {
        User user = new User();
        user.setName("Test User");
        user.setEmail("[email protected]");
        User savedUser = userService.saveUser(user);
        assertNotNull(savedUser);
        user.setId(savedUser.getId());
        userService.deleteUser(user.getId());
    }

    @Test
    public void testDeleteUser() {
        User user = new User();
        user.setName("Test User");
        user.setEmail("[email protected]");
        User savedUser = userService.saveUser(user);
        assertNotNull(savedUser);
        userService.deleteUser(savedUser.getId());
        assertNull(userService.getUserById(savedUser.getId()));
    }
}

集成测试

集成测试是指测试应用中多个组件之间的交互。Spring Boot提供了@SpringBootTest注解，使得集成测试更加方便。

示例代码

创建集成测试类：

创建一个UserControllerTest.java文件，测试UserController类的功能。

示例代码如下：

package com.example.demo.controller;

import com.example.demo.entity.User;
import com.example.demo.repository.UserRepository;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.boot.test.mock.mockito.MockBean;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;
import org.springframework.test.web.servlet.result.MockMvcResultMatchers;

import java.util.Arrays;

import static org.mockito.Mockito.when;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

@WebMvcTest(UserController.class)
public class UserControllerTest {

    @Autowired
    private MockMvc mockMvc;

    @MockBean
    private UserRepository userRepository;

    @BeforeEach
    public void setUp() {
        User user1 = new User(1L, "User 1", "[email protected]");
        User user2 = new User(2L, "User 2", "[email protected]");
        when(userRepository.findAll()).thenReturn(Arrays.asList(user1, user2));
        when(userRepository.findById(1L)).thenReturn(java.util.Optional.of(user1));
        when(userRepository.findById(2L)).thenReturn(java.util.Optional.of(user2));
    }

    @Test
    public void testGetAllUsers() throws Exception {
        mockMvc.perform(MockMvcRequestBuilders.get("/users"))
                .andExpect(status().isOk())
                .andExpect(MockMvcResultMatchers.content().string("[{\"id\":1,\"name\":\"User 1\",\"email\":\"[email protected]\"},{\"id\":2,\"name\":\"User 2\",\"email\":\"[email protected]\"}]"));

    }

    @Test
    public void testGetUserById() throws Exception {
        mockMvc.perform(MockMvcRequestBuilders.get("/users/1"))
                .andExpect(status().isOk())
                .andExpect(MockMvcResultMatchers.content().string("{\"id\":1,\"name\":\"User 1\",\"email\":\"[email protected]\"}"));
    }

    @Test
    public void testCreateUser() throws Exception {
        User user = new User();
        user.setName("Test User");
        user.setEmail("[email protected]");

        mockMvc.perform(MockMvcRequestBuilders.post("/users")
                .contentType("application/json")
                .content("{\"name\":\"Test User\",\"email\":\"[email protected]\"}"))
                .andExpect(status().isOk())
                .andExpect(MockMvcResultMatchers.content().string("{\"id\":3,\"name\":\"Test User\",\"email\":\"[email protected]\"}"));
    }

    @Test
    public void testUpdateUser() throws Exception {
        User user = new User();
        user.setName("Updated User");
        user.setEmail("[email protected]");

        mockMvc.perform(MockMvcRequestBuilders.put("/users/1")
                .contentType("application/json")
                .content("{\"id\":1,\"name\":\"Updated User\",\"email\":\"[email protected]\"}"))
                .andExpect(status().isOk())
                .andExpect(MockMvcResultMatchers.content().string("{\"id\":1,\"name\":\"Updated User\",\"email\":\"[email protected]\"}"));
    }

    @Test
    public void testDeleteUser() throws Exception {
        mockMvc.perform(MockMvcRequestBuilders.delete("/users/1"))
                .andExpect(status().isOk());
    }
}

使用Mockito进行Mock测试

Mockito是Java中广泛使用的Mock对象库，可以方便地创建和管理模拟对象，帮助进行单元测试和集成测试。

示例代码

配置Mockito：

在测试类中使用@MockBean注解模拟依赖组件。

示例代码如下：

@MockBean
private UserRepository userRepository;

@BeforeEach
public void setUp() {
    User user1 = new User(1L, "User 1", "[email protected]");
    User user2 = new User(2L, "User 2", "[email protected]");
    when(userRepository.findAll()).thenReturn(Arrays.asList(user1, user2));
    when(userRepository.findById(1L)).thenReturn(java.util.Optional.of(user1));
    when(userRepository.findById(2L)).thenReturn(java.util.Optional.of(user2));
}

部署与运行Spring Boot应用

打包应用

Spring Boot应用可以通过Maven或Gradle进行打包。打包后的应用是一个可执行的JAR文件，可以直接运行。

使用Maven打包

在IDE中运行Maven打包命令：
- 在Maven项目视图中，右键点击pom.xml文件，选择Lifecycle -> package。
- 打包完成后，会在target目录下生成一个.jar文件。
命令行打包：
- 打开命令行，导航到项目根目录。
- 运行mvn package命令。
- 打包完成后，会在target目录下生成一个.jar文件。

使用Gradle打包

在IDE中运行Gradle打包命令：
- 在Gradle项目视图中，右键点击build.gradle文件，选择Task -> build。
- 打包完成后，会在build/libs目录下生成一个.jar文件。
命令行打包：
- 打开命令行，导航到项目根目录。
- 运行gradle build命令。
- 打包完成后，会在build/libs目录下生成一个.jar文件。

部署到Tomcat或直接运行

Spring Boot应用可以通过嵌入式Servlet容器直接运行，无需部署到外部应用服务器。

直接运行：
- 打开命令行，导航到.jar文件所在目录。
- 运行java -jar demo-0.0.1-SNAPSHOT.jar命令启动应用。

使用Docker部署

Docker是一种容器化技术，可以帮助你将应用打包为容器，并部署到任何支持Docker的环境。

创建Dockerfile

创建Dockerfile：
- 在项目根目录下创建一个名为Dockerfile的文件。
- 示例内容如下：
```
FROM openjdk:11-jre-slim
ADD target/demo-0.0.1-SNAPSHOT.jar app.jar
CMD ["java", "-jar", "app.jar"]
```
构建Docker镜像：
- 打开命令行，导航到项目根目录。
- 运行docker build -t spring-boot-demo .命令构建镜像。
运行Docker容器：
- 运行docker run -p 8080:8080 spring-boot-demo命令启动容器。

至此，你已经完成了从创建、开发到部署整个Spring Boot应用的全过程。通过本教程的学习，你应当掌握了Spring Boot的基本概念和开发技巧，可以开始构建自己的Spring Boot应用了。

點擊查看更多內容

為 TA 點贊

若覺得本文不錯，就分享一下吧！

評論

評論

共同學習，寫下你的評論

評論加載中...

展開查看更多評論

作者其他優質文章

正在加載中

慕桂英4014372

手記
篇

粉絲

10

獲贊與收藏

55

關注作者，訂閱最新文章

閱讀免費教程

后端通用面試教程

41個小節 32074 358

網絡編程入門教程

20個小節 13196 249

Pandas 入門教程

25個小節 19564 369

推薦

評論

收藏

共同學習，寫下你的評論



感謝您的支持，我會繼續努力的～

掃碼打賞，你說多少就多少

贊賞金額會直接到老師賬戶

支付方式

打開微信掃一掃，即可進行掃碼打賞哦

今天注冊有機會得

100積分直接送

付費專欄免費學

大額優惠券免費領

立即參與放棄機會

點擊
抽獎

慕課手記新用戶專享福利

恭喜你，你的運氣太好了，居然抽中了 100個積分！

恭喜你，抽中了價值元的專欄！

太棒了，直接落到你賬戶里！

積分商城里的羅技鼠標、機械鍵盤、
Kindle 閱讀器、小米平衡車
Apple iPad （10.2英寸）、大額優惠券
在等著你去兌換了噢

作者：

免費贈送

兌換碼：1111222211 復制

優惠券可用于購買實戰課、體系課
無門檻使用

先去看看，有什么好東西馬上兌換我愛學習，選課去


亚洲在线久爱草,狠狠天天香蕉网,天天搞日日干久草,伊人亚洲日本欧美

熱搜

最近搜索清空

Spring Boot項目開發教程：輕松入門與實踐

Spring Boot是什么

开发环境搭建

创建第一个Spring Boot项目

使用Spring Initializr创建项目

使用IDE创建项目

运行Spring Boot应用

项目目录结构介绍

应用配置详解

常见配置项

自动配置原理

创建控制器

示例代码

RESTful API设计

示例代码

使用Spring MVC注解

示例代码

数据库连接

实体类设计

示例代码

查询与操作数据库

示例代码

单元测试

示例代码

集成测试

示例代码

使用Mockito进行Mock测试

示例代码

打包应用

使用Maven打包

使用Gradle打包

部署到Tomcat或直接运行

使用Docker部署

创建Dockerfile

閱讀免費教程