Spring Boot 3 单模块项目工程搭建 - 上(个人开发模板)
在现代Java开发中,Spring Boot作为一种简化开发流程的框架,已经成为了开发者的首选之一。它通过自动配置和约定优于配置的原则,提高了开发效率。本篇文章将为大家介绍如何搭建一个Spring Boot 3的单模块项目,同时会提供一些基础的代码示例,帮助大家快速上手。
一、准备工作
在开始构建项目之前,请确保你已经安装了以下工具:
- JDK 17+:因为Spring Boot 3要求Java 17及以上版本。
- Maven:用于项目构建管理。
- IDE:推荐使用IntelliJ IDEA或Eclipse。
二、创建项目
我们可以通过Spring Initializr来快速初始化一个Spring Boot项目。访问Spring Initializr,根据以下步骤创建项目:
- 选择项目类型:选择
Maven Project
。 - 选择语言:选择
Java
。 - 选择Spring Boot版本:选择
3.0.0
或以上版本。 - 填写项目信息:
- Group:
com.example
- Artifact:
demo
- Name:
demo
- Description:
Spring Boot demo project
- Package name:
com.example.demo
- Packaging:
Jar
- Java:
17
- 添加依赖:请添加以下依赖项:
Spring Web
Spring Data JPA
H2 Database
(用于开发和测试)
点击“Generate”按钮下载项目构建包,并解压缩到本地。
三、项目结构
解压后的项目结构大致如下:
demo
├── src
│ ├── main
│ │ ├── java
│ │ │ └── com
│ │ │ └── example
│ │ │ └── demo
│ │ │ └── DemoApplication.java
│ │ └── resources
│ │ ├── application.properties
└── pom.xml
四、编写代码
接下来,我们需要在项目中实现一个简单的RESTful API,以示范如何使用Spring Boot的特性。我们将创建一个用户实体(User)及其对应的控制器(UserController)和服务(UserService)。
1. 创建用户实体类
在src/main/java/com/example/demo
目录下创建User.java
文件:
package com.example.demo;
import jakarta.persistence.Entity;
import jakarta.persistence.GeneratedValue;
import jakarta.persistence.GenerationType;
import jakarta.persistence.Id;
@Entity
public class User {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Long id;
private String name;
private String email;
// Getters and Setters
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;
}
}
2. 创建用户控制器
在同一目录下创建UserController.java
文件:
package com.example.demo;
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();
}
@PostMapping
public User createUser(@RequestBody User user) {
return userService.createUser(user);
}
}
3. 创建用户服务
在同一目录下创建UserService.java
文件:
package com.example.demo;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import java.util.ArrayList;
import java.util.List;
@Service
public class UserService {
private List<User> users = new ArrayList<>();
public List<User> getAllUsers() {
return users;
}
public User createUser(User user) {
users.add(user);
return user;
}
}
4. 修改配置文件
在src/main/resources/application.properties
中,可以添加H2数据库的配置(如果需要的话):
spring.h2.console.enabled=true
spring.datasource.url=jdbc:h2:mem:testdb
spring.datasource.driver-class-name=org.h2.Driver
spring.datasource.username=sa
spring.datasource.password=password
五、运行项目
在IDE中运行DemoApplication.java
,你的Spring Boot项目就启动成功了!可以通过Postman或者浏览器访问http://localhost:8080/users
查看所有用户信息,使用POST请求向/users
路径发送JSON格式的数据来新增用户。
至此,我们的Spring Boot 3单模块项目的基础搭建已经完成。下一部分的文章中,我们将探讨如何引入持久化存储、数据验证和异常处理等更高级的功能。希望这篇文章对你搭建Spring Boot项目有所帮助!