怎么搭建第一个Spring项目

发布时间：2021-11-20 16:39:48 作者：小新
来源：亿速云阅读：167

怎么搭建第一个Spring项目

引言
环境准备
创建Spring项目
- 使用Spring Initializr
- 手动配置Maven项目
项目结构
- 主要目录和文件
- Spring Boot主类
编写第一个控制器
- 创建Controller类
- 运行项目
配置数据库连接
- 添加数据库依赖
- 配置数据源
创建实体类和Repository
- 定义实体类
- 创建Repository接口
实现简单的CRUD操作
- 创建Service层
- 编写Controller方法
测试API
- 使用Postman测试
- 单元测试
部署项目
- 打包应用
- 服务器">部署到服务器
总结

引言

Spring框架是Java开发中最流行的框架之一，它提供了全面的基础设施支持，使得开发者可以专注于业务逻辑的实现。Spring Boot进一步简化了Spring应用的开发，通过自动配置和约定优于配置的原则，使得开发者可以快速搭建和运行Spring项目。

本文将详细介绍如何从零开始搭建第一个Spring项目，涵盖环境准备、项目创建、代码编写、测试和部署等各个环节。通过本文的学习，你将掌握Spring项目的基本开发流程，并能够独立完成一个简单的Spring应用。

环境准备

在开始搭建Spring项目之前，首先需要准备好开发环境。以下是搭建Spring项目所需的基本环境配置。

Java开发环境

Spring项目是基于Java开发的，因此首先需要安装Java开发工具包（JDK）。建议使用JDK 8或更高版本。

下载JDK：访问Oracle官网或OpenJDK下载适合你操作系统的JDK版本。
安装JDK：按照安装向导完成JDK的安装。
配置环境变量：
- Windows：在系统环境变量中添加JAVA_HOME，指向JDK的安装目录，并在Path中添加%JAVA_HOME%\bin。
- Linux/Mac：在~/.bashrc或~/.zshrc中添加以下内容：
```
export JAVA_HOME=/path/to/jdk
export PATH=$JAVA_HOME/bin:$PATH
```
验证安装：打开终端或命令提示符，输入java -version，如果显示JDK版本信息，则说明安装成功。

Maven安装

Maven是Java项目的构建工具，Spring项目通常使用Maven来管理依赖和构建过程。

下载Maven：访问Maven官网下载最新版本的Maven。
安装Maven：
- Windows：解压下载的Maven压缩包，并将解压后的目录添加到系统环境变量Path中。
- Linux/Mac：解压下载的Maven压缩包，并在~/.bashrc或~/.zshrc中添加以下内容：
```
export MAVEN_HOME=/path/to/maven
export PATH=$MAVEN_HOME/bin:$PATH
```
验证安装：打开终端或命令提示符，输入mvn -v，如果显示Maven版本信息，则说明安装成功。

IDE选择

集成开发环境（IDE）可以大大提高开发效率。常用的Java IDE有IntelliJ IDEA、Eclipse和VS Code等。本文推荐使用IntelliJ IDEA，因为它对Spring Boot的支持非常友好。

下载IntelliJ IDEA：访问JetBrains官网下载适合你操作系统的IntelliJ IDEA版本。
安装IntelliJ IDEA：按照安装向导完成IntelliJ IDEA的安装。
配置Maven：在IntelliJ IDEA中，打开File -> Settings -> Build, Execution, Deployment -> Build Tools -> Maven，确保Maven的路径配置正确。

创建Spring项目

Spring项目的创建可以通过多种方式实现，本文将介绍两种常见的方法：使用Spring Initializr和手动配置Maven项目。

使用Spring Initializr

Spring Initializr是一个在线工具，可以帮助你快速生成Spring Boot项目的基本结构。

访问Spring Initializr：打开浏览器，访问Spring Initializr。
配置项目：
- Project：选择Maven Project。
- Language：选择Java。
- Spring Boot：选择最新的稳定版本。
- Project Metadata：填写Group、Artifact、Name、Description等信息。
- Dependencies：添加Spring Web、Spring Data JPA、H2 Database等依赖。
生成项目：点击Generate按钮，下载生成的项目压缩包。
导入项目：解压下载的压缩包，并使用IntelliJ IDEA打开项目。

手动配置Maven项目

如果你更喜欢手动配置项目，可以按照以下步骤创建一个Maven项目。

创建Maven项目：
- 打开IntelliJ IDEA，选择File -> New -> Project。
- 选择Maven，点击Next。
- 填写GroupId、ArtifactId、Version等信息，点击Next。
- 选择项目存储路径，点击Finish。

配置pom.xml：

打开pom.xml文件，添加Spring Boot的父依赖：


<parent>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-parent</artifactId>
 <version>2.5.4</version>
 <relativePath/> <!-- lookup parent from repository -->
</parent>

添加Spring Boot的起步依赖：


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

添加Maven插件：


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

项目结构

Spring Boot项目的结构相对固定，以下是一个典型的Spring Boot项目结构。

主要目录和文件

src/main/java：Java源代码目录。
src/main/resources：资源文件目录，包括配置文件、静态资源等。
src/test/java：测试代码目录。
pom.xml：Maven项目的配置文件。

Spring Boot主类

Spring Boot项目的入口是一个带有@SpringBootApplication注解的主类。

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

}

编写第一个控制器

在Spring Boot中，控制器（Controller）负责处理HTTP请求并返回响应。下面我们将创建一个简单的控制器。

创建Controller类

在src/main/java/com/example/demo目录下创建一个新的包controller。
在controller包中创建一个新的类HelloController。

package com.example.demo.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 HelloController {

    @GetMapping("/hello")
    public String sayHello() {
        return "Hello, Spring Boot!";
    }

}

运行项目

在IntelliJ IDEA中，右键点击DemoApplication类，选择Run 'DemoApplication'。
打开浏览器，访问http://localhost:8080/api/hello，你将看到页面显示Hello, Spring Boot!。

配置数据库连接

在实际开发中，数据库是必不可少的。Spring Boot支持多种数据库，本文将使用H2内存数据库作为示例。

添加数据库依赖

在pom.xml中，我们已经添加了spring-boot-starter-data-jpa和h2依赖。

配置数据源

在src/main/resources/application.properties文件中，添加以下配置：

spring.datasource.url=jdbc:h2:mem:testdb
spring.datasource.driverClassName=org.h2.Driver
spring.datasource.username=sa
spring.datasource.password=password
spring.jpa.database-platform=org.hibernate.dialect.H2Dialect
spring.h2.console.enabled=true

创建实体类和Repository

在Spring Data JPA中，实体类（Entity）对应数据库中的表，Repository接口用于操作数据库。

定义实体类

在src/main/java/com/example/demo目录下创建一个新的包entity。
在entity包中创建一个新的类User。

package com.example.demo.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;
    private String email;

    // Getters and Setters
}

创建Repository接口

在src/main/java/com/example/demo目录下创建一个新的包repository。
在repository包中创建一个新的接口UserRepository。

package com.example.demo.repository;

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

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

实现简单的CRUD操作

在Spring Boot中，通常将业务逻辑放在Service层，Controller层负责处理HTTP请求。

创建Service层

在src/main/java/com/example/demo目录下创建一个新的包service。
在service包中创建一个新的类UserService。

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;
import java.util.Optional;

@Service
public class UserService {

    @Autowired
    private UserRepository userRepository;

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

    public Optional<User> getUserById(Long id) {
        return userRepository.findById(id);
    }

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

    public User updateUser(Long id, User userDetails) {
        User user = userRepository.findById(id).orElseThrow(() -> new RuntimeException("User not found"));
        user.setName(userDetails.getName());
        user.setEmail(userDetails.getEmail());
        return userRepository.save(user);
    }

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

编写Controller方法

在controller包中创建一个新的类UserController。

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.*;

import java.util.List;
import java.util.Optional;

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

    @Autowired
    private UserService userService;

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

    @GetMapping("/{id}")
    public Optional<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 userDetails) {
        return userService.updateUser(id, userDetails);
    }

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

测试API

在开发过程中，测试是非常重要的环节。本文将介绍如何使用Postman进行API测试，并编写简单的单元测试。

使用Postman测试

启动项目：在IntelliJ IDEA中运行DemoApplication。
打开Postman：下载并安装Postman。
测试API：
- GET /api/users：获取所有用户。
- GET /api/users/{id}：根据ID获取用户。
- POST /api/users：创建新用户。
- PUT /api/users/{id}：更新用户信息。
- DELETE /api/users/{id}：删除用户。

单元测试

在src/test/java/com/example/demo目录下创建一个新的包controller。
在controller包中创建一个新的类UserControllerTest。

package com.example.demo.controller;

import com.example.demo.entity.User;
import com.example.demo.service.UserService;
import org.junit.jupiter.api.Test;
import org.mockito.Mockito;
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 java.util.Arrays;
import java.util.Optional;

import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*;

@WebMvcTest(UserController.class)
public class UserControllerTest {

    @Autowired
    private MockMvc mockMvc;

    @MockBean
    private UserService userService;

    @Test
    public void testGetAllUsers() throws Exception {
        User user = new User();
        user.setId(1L);
        user.setName("John Doe");
        user.setEmail("john.doe@example.com");

        Mockito.when(userService.getAllUsers()).thenReturn(Arrays.asList(user));

        mockMvc.perform(get("/api/users"))
                .andExpect(status().isOk())
                .andExpect(jsonPath("$[0].name").value("John Doe"));
    }

    @Test
    public void testGetUserById() throws Exception {
        User user = new User();
        user.setId(1L);
        user.setName("John Doe");
        user.setEmail("john.doe@example.com");

        Mockito.when(userService.getUserById(1L)).thenReturn(Optional.of(user));

        mockMvc.perform(get("/api/users/1"))
                .andExpect(status().isOk())
                .andExpect(jsonPath("$.name").value("John Doe"));
    }

    @Test
    public void testCreateUser() throws Exception {
        User user = new User();
        user.setId(1L);
        user.setName("John Doe");
        user.setEmail("john.doe@example.com");

        Mockito.when(userService.createUser(Mockito.any(User.class))).thenReturn(user);

        mockMvc.perform(post("/api/users")
                .contentType("application/json")
                .content("{\"name\":\"John Doe\",\"email\":\"john.doe@example.com\"}"))
                .andExpect(status().isOk())
                .andExpect(jsonPath("$.name").value("John Doe"));
    }

    @Test
    public void testUpdateUser() throws Exception {
        User user = new User();
        user.setId(1L);
        user.setName("John Doe");
        user.setEmail("john.doe@example.com");

        Mockito.when(userService.updateUser(Mockito.anyLong(), Mockito.any(User.class))).thenReturn(user);

        mockMvc.perform(put("/api/users/1")
                .contentType("application/json")
                .content("{\"name\":\"John Doe\",\"email\":\"john.doe@example.com\"}"))
                .andExpect(status().isOk())
                .andExpect(jsonPath("$.name").value("John Doe"));
    }

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

部署项目

在开发完成后，通常需要将项目部署到服务器上。Spring Boot项目可以打包为可执行的JAR文件，方便部署。

打包应用

使用Maven打包：在项目根目录下运行以下命令：
```
mvn clean package
```
查看打包结果：打包完成后，在target目录下会生成一个demo-0.0.1-SNAPSHOT.jar文件。

部署到服务器

上传JAR文件：将生成的JAR文件上传到服务器。
运行应用：在服务器上运行以下命令启动应用：
```
java -jar demo-0.0.1-SNAPSHOT.jar
```
访问应用：在浏览器中访问http://服务器IP:8080/api/hello，验证应用是否正常运行。

总结

通过本文的学习，你已经掌握了如何从零开始搭建一个Spring Boot项目。从环境准备、项目创建、代码

怎么搭建第一个Spring项目

怎么搭建第一个Spring项目

目录

引言

环境准备

Java开发环境

Maven安装

IDE选择

创建Spring项目

使用Spring Initializr

手动配置Maven项目

项目结构

主要目录和文件

Spring Boot主类

编写第一个控制器

创建Controller类

运行项目

配置数据库连接

添加数据库依赖

配置数据源

创建实体类和Repository

定义实体类

创建Repository接口

实现简单的CRUD操作

创建Service层

编写Controller方法

测试API

使用Postman测试

单元测试

部署项目

打包应用

部署到服务器

总结

相关阅读