基于 Spring Boot 和 MyBatis-Plus 的简单用户管理系统

原创于 2024-12-17 19:56:26 发布 · 1.9k 阅读

39 ·

CC 4.0 BY-SA版权

文章标签：

#spring boot #mybatis #后端

该文章已生成可运行项目，

前言

随着互联网技术的发展，Web 应用程序已成为我们日常生活中不可或缺的一部分。在开发 Web 应用时，Spring Boot 作为一个高效的开发框架，广泛应用于企业级应用的开发中。Spring Boot 提供了一个简单且高效的开发环境，它能自动化配置和开发流程，减少开发者的负担。而在数据持久化方面，MyBatis-Plus 是一个增强 MyBatis 的工具，它提供了很多便捷的方法来简化开发，使得我们可以更专注于业务逻辑。

本文将介绍如何通过 Spring Boot 和 MyBatis-Plus 实现一个简单的用户管理系统，展示如何通过这两个框架实现常见的增删改查（CRUD）功能。我们将详细讲解如何配置 Spring Boot 项目，如何使用 MyBatis-Plus 进行数据库操作，以及如何设计整个项目的架构。

一、开发环境与技术栈

在本项目中，我们使用以下技术栈：

Spring Boot：一个用于构建独立的、生产级别的 Spring 应用程序的框架。它极大地简化了开发过程，提供了自动化配置、内嵌 Web 服务器、健康检查、监控等功能。
MyBatis-Plus：一个 MyBatis 的增强工具，提供了大量常用的数据库操作功能，如增删改查、分页查询、自动填充等，简化了代码。
H2 数据库：一个轻量级的嵌入式数据库，适用于开发和测试环境。在生产环境中，可以根据需求替换为 MySQL、PostgreSQL 等。
Lombok：一个 Java 库，用于简化代码，自动生成常用的 getter/setter、toString、hashCode 等方法，减少冗长的代码。

二、项目搭建与配置

1.创建 Spring Boot 项目

我们可以使用 Spring Initializr （https://start.spring.io/）来快速生成一个 Spring Boot 项目。在创建项目时，我们选择以下依赖：

Spring Web：用于构建 RESTful Web 服务。
MyBatis-Plus：增强 MyBatis，简化数据库操作。
H2 Database：用于存储数据，支持内存数据库，适合开发和测试。
Spring Boot DevTools：支持热部署和自动重启，提升开发效率。

生成项目后，解压并导入到 IDE（如 IntelliJ IDEA）中。

2.配置 `application.yml`

在项目的 src/main/resources 目录下，找到 application.yml 文件，并进行如下配置：

spring:
  datasource:
    url: jdbc:h2:mem:testdb
    driver-class-name: org.h2.Driver
    username: sa
    password: password
    hikari:
      maximum-pool-size: 10
  mybatis-plus:
    mapper-locations: classpath:/mappers/**/*.xml
    type-aliases-package: com.example.demo.entity
    global-config:
      db-config:
        id-type: auto  # 主键策略：AUTO

在这段配置中，我们配置了数据源的连接信息，指定使用 H2 数据库。mybatis-plus 配置中，我们指定了映射文件和实体类所在的包。

3.添加 Maven 依赖

在 pom.xml 中，我们需要添加 Spring Boot、MyBatis-Plus、H2 数据库和 Lombok 的相关依赖：

<dependencies>
    <!-- Spring Boot Starter Web -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <!-- MyBatis-Plus Starter -->
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-boot-starter</artifactId>
        <version>3.5.0</version> <!-- 请根据需要使用适当的版本 -->
    </dependency>

    <!-- H2 Database (可以替换为其他数据库，例如MySQL) -->
    <dependency>
        <groupId>com.h2database</groupId>
        <artifactId>h2</artifactId>
        <scope>runtime</scope>
    </dependency>

    <!-- Lombok (简化代码) -->
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <optional>true</optional>
    </dependency>

    <!-- Spring Boot Starter Test -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>

这些依赖项帮助我们引入了 Spring Boot Web、MyBatis-Plus 和 H2 数据库的支持。

三、项目结构与功能实现

1.创建数据库实体类

首先，我们需要为数据库表创建实体类。在本例中，我们将创建一个简单的用户表，实体类如下：

package com.example.demo.entity;

import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import com.baomidou.mybatisplus.annotation.IdType;
import lombok.Data;

@Data
@TableName("user")
public class User {
    @TableId(value = "id", type = IdType.AUTO)
    private Long id;
    private String username;
    private String email;
    private Integer age;
}

@TableName 注解指定了数据库中的表名。
@TableId 注解标记了主键，并指定了主键的生成策略（AUTO 表示自动生成）。

2.创建 Mapper 接口

接下来，我们创建一个 Mapper 接口，它继承自 BaseMapper，这个接口为我们提供了 MyBatis-Plus 的基本数据库操作功能：

package com.example.demo.mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.example.demo.entity.User;

public interface UserMapper extends BaseMapper<User> {
    // 可以添加自定义的查询方法
}

BaseMapper 提供了许多常用的数据库操作方法，如 insert、delete、update 和 select，无需手动编写 SQL。

3.创建 Service 层

在 Service 层中，我们定义了与数据库交互的业务逻辑。通过继承 MyBatis-Plus 提供的 ServiceImpl，我们能够实现 CRUD 操作。

package com.example.demo.service.impl;

import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import com.example.demo.entity.User;
import com.example.demo.mapper.UserMapper;
import com.example.demo.service.UserService;
import org.springframework.stereotype.Service;

@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService {
    // 可以在这里添加自定义的业务逻辑
}

4.创建 Controller 层

Controller 层是暴露 API 接口的地方。我们可以定义 RESTful 风格的接口，实现用户的增删改查操作。

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;

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

    @Autowired
    private UserService userService;

    // 创建用户
    @PostMapping("/create")
    public String createUser(@RequestBody User user) {
        userService.save(user);
        return "User created successfully!";
    }

    // 获取所有用户
    @GetMapping("/list")
    public List<User> listUsers() {
        return userService.list();
    }

    // 根据ID获取用户
    @GetMapping("/{id}")
    public User getUserById(@PathVariable Long id) {
        return userService.getById(id);
    }

    // 更新用户
    @PutMapping("/update")
    public String updateUser(@RequestBody User user) {
        userService.updateById(user);
        return "User updated successfully!";
    }

    // 删除用户
    @DeleteMapping("/delete/{id}")
    public String deleteUser(@PathVariable Long id) {
        userService.removeById(id);
        return "User deleted successfully!";
    }
}

@RestController 注解表示这是一个控制器，处理 HTTP 请求。
@RequestMapping 指定了路径前缀，@PostMapping、@GetMapping、@PutMapping 和 @DeleteMapping 分别用于处理不同类型的 HTTP 请求。

5.启动主类

直接启动主类就可以运行整个项目了。

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