首页手记创建Springboot项目教程：一步一步学起来

创建Springboot项目教程：一步一步学起来

标签：

SpringBoot

本文详细介绍了如何创建Spring Boot项目，包括环境搭建、IDE配置、本地Maven或Gradle配置等准备工作。接着讲解了如何使用IDE或Spring Initializr创建项目，并详细介绍了Spring Boot配置文件的使用。文章还展示了如何实现简单的REST API以及数据库的集成与使用。最后，提供了运行和测试项目的指导。

环境搭建与准备工作

安装Java开发环境

为了开始创建Spring Boot项目，首先需要确保你的计算机上已经安装了Java开发环境。Spring Boot构建在Spring框架之上，而Spring框架则完全基于Java，因此Java的正确安装和配置是至关重要的。

下载Java JDK

访问Oracle官网下载页面，选择最新的Java SE开发工具包（JDK）版本。下载完成后，按照安装向导进行安装。安装过程中，确保勾选"Add JDK to PATH"选项，这会将Java添加到系统的环境变量中，使从命令行调用Java变得容易。
验证Java安装

安装完成后，可以通过命令行验证Java是否安装成功。打开命令提示符或终端窗口，输入以下命令：
```
java -version
```
如果安装成功，你应该会看到类似如下的输出，显示了已安装的Java版本：
```
java version "1.8.0_301"
Java(TM) SE Runtime Environment (build 1.8.0_301-b04)
Java HotSpot(TM) 64-Bit Server VM (build 25.301-b04, mixed mode)
```

安装IDE

选择合适的集成开发环境（IDE）对于提高开发效率和代码质量是非常重要的。这里以IntelliJ IDEA为例，但它并不是唯一的选择，Eclipse也是一个流行的IDE。

下载并安装IntelliJ IDEA

访问JetBrains官网下载页面，选择IntelliJ IDEA的社区版本（Community Edition）。下载完成后，解压文件并运行安装向导。安装向导会引导你完成安装过程。
配置IntelliJ IDEA

安装完成后，启动IntelliJ IDEA，它会提示你进行初始配置。建议选择"Create New Project"来开始一个新的项目。按照以下步骤进行Spring Boot项目的创建：
1. 打开IntelliJ IDEA，选择"File" -> "New" -> "Project"，然后选择"Maven"，确保已经选择了正确的Maven版本。在"Group Id"和"Artifact Id"字段中输入你的项目名称，然后点击"Next"。
```
Group Id: com.example
Artifact Id: mySpringBootApp
```
2. 在下一个页面中，选择"Spring Boot"，然后点击"Next"。接着，选择"Spring Web"作为你的第一个依赖项，然后点击"Next"。这些配置将自动生成一个基础的Spring Boot项目结构。

配置本地Maven或Gradle

为了构建Spring Boot项目，你需要配置本地的构建工具，如Maven或Gradle。

下载并安装Maven

访问Maven官网，下载最新版本的Maven。解压下载的文件，并将Maven的bin目录添加到系统的环境变量PATH中。这样，从命令行调用Maven命令就会变得容易。

验证Maven安装

打开命令行工具，输入以下命令来验证Maven是否安装成功：

mvn -v

如果安装成功，你将看到类似如下的输出：

Apache Maven 3.8.6 (c16f52b5d9c3a2d9c3b3d5a5a91e5b689597fa1e; 2022-10-10T00:03:16Z)
Maven home: C:\Program Files\Apache\maven
Java version: 1.8.0_301, vendor: Oracle Corporation, runtime: C:\Program Files\Java\jdk1.8.0_301
Default locale: en_US, platform encoding: Cp1252
OS name: "windows 10", version: "10.0", arch: "amd64", family: "windows"

下载并安装Gradle

访问Gradle官网下载页面，下载最新版本的Gradle。解压下载的文件，并将Gradle的bin目录添加到系统的环境变量PATH中。这样，从命令行调用Gradle命令就会变得容易。

验证Gradle安装

打开命令行工具，输入以下命令来验证Gradle是否安装成功：

gradle -v

如果安装成功，你将看到类似如下的输出：

Gradle 7.4.2
Build time:   2022-04-13 14:03:51 UTC
Revision:     818c27ef4d8e7460c03847d4c69b52a227a67450
Kotlin DSL:   1.6.20
Kotlin:       1.6.20
OS:           Windows 10 10.0 amd64

创建Spring Boot项目

使用IDE创建新项目

在安装和配置好Java、IDE以及构建工具（如Maven或Gradle）之后，就可以在IDE中创建Spring Boot项目了。

配置IntelliJ IDEA

打开IntelliJ IDEA，选择"File" -> "New" -> "Project"，然后选择"Maven"，确保已经选择了正确的Maven版本。在"Group Id"和"Artifact Id"字段中输入你的项目名称，然后点击"Next"。
```
Group Id: com.example
Artifact Id: mySpringBootApp
```
在下一个页面中，输入应用名称，例如"mySpringBootApp"，然后点击"Next"。选择"Spring Boot"，然后点击"Next"。接着，选择"Spring Web"作为你的第一个依赖项，然后点击"Next"。这些配置将自动生成一个基础的Spring Boot项目结构。
使用Spring Initializr在线创建项目

Spring Initializr是一个在线工具，可以快速生成基本的Spring Boot项目结构。Spring Initializr提供了一个简单的Web界面，用于选择项目所需的依赖项和配置。
1. 访问Spring Initializr官网
  
  打开浏览器，访问Spring Initializr官网。
2. 选择项目信息
  
  输入你的项目的组ID和艺术事实ID，以及你的应用名。例如：
```
Group Id: com.example
Artifact Id: mySpringBootApp
Version: 2.6.3
Package Name: com.example.mySpringBootApp
```
3. 选择项目依赖
  
  在依赖选项中，选择你想要添加的依赖项。例如，选择"Spring Web"，并确保选择了"Enable Auto-configuration"。
4. 下载生成的项目
  
  单击"Generate"按钮，生成项目配置。下载生成的压缩文件并解压到本地。将解压后的项目文件夹导入到IntelliJ IDEA中，选择"File" -> "Open"，选择项目文件夹，点击"OK"。

Spring Boot配置文件详解

Spring Boot的配置文件主要分为两种：application.properties和application.yml。这两种文件的作用非常相似，但是使用.yml文件可以更方便地编写复杂的数据结构，如列表和映射。

application.properties与application.yml基本配置

默认配置

Spring Boot允许通过application.properties或application.yml文件来配置应用程序的属性。这些配置文件通常位于src/main/resources目录下。默认情况下，Spring Boot会自动加载这些文件中的配置。
```
# application.properties
server.port=8080
spring.application.name=mySpringBootApp
```
```
# application.yml
server:
 port: 8080
spring:
 application:
   name: mySpringBootApp
```
外部化配置

Spring Boot支持将配置文件放在不同的位置，如作为系统属性、环境变量或命令行参数。这样可以更灵活地管理配置，特别是在不同的部署环境中。
```
-Dserver.port=8080
```
使用外部化配置

外部化配置文件可以放置在src/main/resources目录下，也可以通过命令行参数或环境变量来指定。例如：
```
# application.properties
server.port=8081
```
或者通过环境变量：
```
export SERVER_PORT=8081
```

使用配置文件管理数据库连接

配置数据库连接是Spring Boot配置文件中的一个常见需求。以下是使用application.properties和application.yml配置MySQL数据库连接的示例。

添加数据库依赖

首先，在项目的pom.xml或build.gradle文件中添加数据库驱动依赖。例如，对于MySQL，可以在pom.xml中添加如下依赖：
```
<dependency>
   <groupId>mysql</groupId>
   <artifactId>mysql-connector-java</artifactId>
   <version>8.0.25</version>
</dependency>
```

配置数据库连接

然后，在application.properties或application.yml中配置数据库连接的详细信息。

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

# application.yml
spring:
 datasource:
   url: jdbc:mysql://localhost:3306/mydb
   username: root
   password: password

实现一个简单的REST API

创建Controller

Controller是Spring Boot中处理HTTP请求的关键部分。这里我们将创建一个简单的Controller来响应HTTP GET请求。

创建Controller类

在src/main/java/com/example/myspringbootapp/controller目录下创建一个名为HelloController.java的类。

package com.example.myspringbootapp.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/hello")
public class HelloController {

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

测试Controller

启动应用程序，通过浏览器或命令行工具（如curl）访问http://localhost:8080/api/hello。你应该能够看到返回的字符串"Hello, World!"。

使用Spring Boot注解处理HTTP请求

Spring Boot通过一系列注解来简化HTTP请求的处理。本节将展示如何使用这些注解来创建一个能够接收参数并返回数据的基本REST API。

添加参数处理

修改HelloController类，使其能够处理带参数的GET请求。

package com.example.myspringbootapp.controller;

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

@RestController
@RequestMapping("/api/greet")
public class HelloController {

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

测试参数处理

访问http://localhost:8080/api/greet/John，你应该能够看到返回的字符串"Hello, John!"。
调试Controller

在IntelliJ IDEA中，可以通过断点调试Controller代码。在需要调试的代码行上设置断点，启动应用程序并访问相应的API端点，IDE会自动暂停执行并允许你检查变量和调用栈。
使用Postman测试REST API

使用Postman客户端工具，可以更方便地测试API。在Postman中创建一个GET请求，设置URL为http://localhost:8080/api/greet/John，并发送请求查看返回的响应。

返回JSON数据

在实际项目中，通常需要返回更复杂的JSON数据。

创建一个简单的实体类

在src/main/java/com/example/myspringbootapp/model目录下创建一个名为Greeting.java的类。

package com.example.myspringbootapp.model;

import java.util.Date;

public class Greeting {
  private String content;
  private Date date;

  public Greeting(String content) {
      this.content = content;
      this.date = new Date();
  }

  public String getContent() {
      return content;
  }

  public Date getDate() {
      return date;
  }
}

修改Controller返回JSON

修改HelloController类，使其返回一个JSON对象。

package com.example.myspringbootapp.controller;

import com.example.myspringbootapp.model.Greeting;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/api/greet")
public class HelloController {

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

测试返回JSON

访问http://localhost:8080/api/greet/John，你应该会看到如下格式的JSON输出：
```
{
  "content": "Hello, John!",
  "date": "2023-10-05T12:34:56Z"
}
```

数据库集成与使用

添加依赖并配置Spring Boot连接数据库

在本节中，我们将使用Spring Data JPA来处理数据库操作。这将简化数据库访问并提供一系列高层抽象。

添加依赖

在项目的pom.xml或build.gradle文件中添加Spring Data JPA和MySQL依赖。

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

配置数据库连接

在application.properties或application.yml文件中配置数据库连接信息，如前所述。

创建实体类与数据库表映射

实体类是Spring Data JPA中的核心概念，它们代表了数据库中的表。

定义实体类

在src/main/java/com/example/myspringbootapp/model目录下创建一个名为User.java的实体类。

package com.example.myspringbootapp.model;

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;
   private String email;

   // Getters and Setters
}

创建数据库表

启动应用程序，Spring Boot将根据实体类自动创建相应的数据库表。你可以在数据库管理工具中确认表的存在。

使用Spring Data JPA进行CRUD操作

Spring Data JPA提供了简单的接口来执行CRUD操作。

创建Repository接口

在src/main/java/com/example/myspringbootapp/repository目录下创建一个名为UserRepository.java的接口。

package com.example.myspringbootapp.repository;

import com.example.myspringbootapp.model.User;
import org.springframework.data.jpa.repository.JpaRepository;

public interface UserRepository extends JpaRepository<User, Long> {
   User findByName(String name);
}

使用Repository

在Controller中使用UserRepository执行CRUD操作。

package com.example.myspringbootapp.controller;

import com.example.myspringbootapp.model.User;
import com.example.myspringbootapp.repository.UserRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

import java.util.List;

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

   @Autowired
   private UserRepository userRepository;

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

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

   @GetMapping("/{name}")
   public User getUserByName(@PathVariable String name) {
       return userRepository.findByName(name);
   }
}

调试CRUD操作

在IntelliJ IDEA中，通过断点调试控制器方法，可以更深入地检查数据库操作的细节。在需要调试的方法中设置断点，启动应用程序并访问相应的API端点以触发数据库操作。
测试CRUD操作

访问http://localhost:8080/api/users，你将看到所有用户的列表。使用POST请求向http://localhost:8080/api/users发送用户数据，并使用GET请求访问单个用户，如http://localhost:8080/api/users/John。

运行与测试项目

启动项目并访问API

启动项目后，可以通过浏览器或命令行工具访问之前创建的API端点。

启动项目

在IntelliJ IDEA中，右键点击项目根目录，选择"Run 'MySpringBootApplication'"来启动Spring Boot应用程序。
访问API

使用浏览器或命令行工具访问http://localhost:8080/api/hello，你应该能够看到返回的字符串"Hello, World!"。
调试启动过程

通过在MySpringBootApplication类的main方法中添加断点，可以调试应用程序的启动过程，检查环境变量、配置文件加载等信息。

使用Postman测试REST API

Postman是一个流行的HTTP客户端工具，用于测试和调试REST API。

安装Postman

访问Postman官网下载页面，下载并安装Postman。
创建请求

在Postman中创建一个新请求，设置URL为http://localhost:8080/api/hello，选择GET方法，然后发送请求。你应该会看到返回的字符串"Hello, World!"。
测试其他API端点

使用Postman测试其他API端点，如GET /api/greet/John和POST /api/users，并检查返回的响应是否符合预期。

总结

通过本教程，你已经了解了如何搭建Java开发环境，使用IDE和Spring Initializr创建Spring Boot项目，配置Spring Boot的配置文件，实现REST API，并集成数据库。这些步骤为创建更复杂的应用程序奠定了坚实的基础。如果你需要更深入的学习，可以参考Sprint Boot官方文档，也可以在Moo课网上找到更多关于Spring Boot的课程。

点击查看更多内容

为 TA 点赞

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

评论

评论

共同学习，写下你的评论

评论加载中...

展开查看更多评论

作者其他优质文章

正在加载中

哆啦的时光机

手记
篇

粉丝

20

获赞与收藏

53

关注作者，订阅最新文章

阅读免费教程

后端通用面试教程

41个小节 30583 343

网络编程入门教程

20个小节 12561 237

Pandas 入门教程

25个小节 18498 337

推荐

评论

收藏

共同学习，写下你的评论



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

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

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

支付方式

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

今天注册有机会得

100积分直接送

付费专栏免费学

大额优惠券免费领

立即参与放弃机会

点击
抽奖

慕课手记新用户专享福利

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

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

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

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

作者：

免费赠送

兑换码：1111222211 复制

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

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

热搜

最近搜索清空