【潜意识Java】使用 Ruoyi 框架开发企业级应用，从零开始的实践指南和分析问题

本文链接：https://blog.youkuaiyun.com/weixin_73355603/article/details/144558265

随着企业级应用的需求不断增加，开发者需要一个灵活、高效且易于扩展的框架来支持日常开发工作。Ruoyi作为基于Spring Boot的开源企业级框架，凭借其模块化、可扩展性强以及与常见开发技术栈的集成，成为了许多开发者的首选。

本文将通过具体的代码示例，帮助大家理解如何使用Ruoyi框架构建一个简单的企业级应用，涵盖基础的配置、常见功能的实现和开发中的注意事项。

1. Ruoyi框架概述

Ruoyi是一个基于Spring Boot的快速开发平台，主要目标是简化企业级应用的开发。框架提供了多种通用模块，包括权限管理、工作流、日志管理、定时任务等，能够帮助开发者快速构建一个完整的应用。

Ruoyi的主要特点：

模块化设计：Ruoyi框架采用了模块化设计，可以根据项目需求灵活选用不同模块。
权限控制：内置了完善的权限管理系统，支持菜单、按钮权限和角色管理。
代码生成器：内置代码生成工具，极大地提高了开发效率。
多数据源支持：支持多种数据库的集成，方便进行分布式数据管理。

2. 环境搭建与初始化项目

首先，我们需要搭建Ruoyi开发环境。Ruoyi框架基于Spring Boot和MyBatis，因此，我们需要配置合适的JDK版本（建议JDK 8及以上）以及数据库（例如MySQL）。

2.1 下载与配置Ruoyi框架

可以从Ruoyi的官方GitHub仓库（https://github.com/yangzongzhuan/RuoYi）下载项目源码，或者直接通过Maven进行初始化。

假设你已经通过Git克隆了项目，并且进入了ruoyi项目目录，接下来按照以下步骤配置项目。

2.2 配置数据库

在application.yml文件中，我们配置数据库连接信息：

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/ruoyi?useUnicode=true&characterEncoding=utf-8&serverTimezone=UTC
    username: root
    password: password
    driver-class-name: com.mysql.cj.jdbc.Driver
  jpa:
    hibernate:
      ddl-auto: update
    properties:
      hibernate:
        dialect: org.hibernate.dialect.MySQL5InnoDBDialect

确保你在本地已经安装并启动了MySQL，并且创建了ruoyi数据库。

2.3 启动项目

执行以下命令启动Spring Boot应用：

mvn spring-boot:run

在浏览器中访问http://localhost:8080，你应该能看到Ruoyi的默认欢迎界面。

3. 创建模块：用户管理系统

接下来，我们将在Ruoyi框架下创建一个用户管理模块，包含基本的CRUD操作。

3.1 创建实体类

首先，在system模块下创建一个User实体类，表示系统用户。

package com.ruoyi.system.domain;

import com.ruoyi.common.core.domain.BaseEntity;

public class User extends BaseEntity {
    private Long userId;
    private String username;
    private String password;
    private String email;
    private Integer status;

    // Getter和Setter方法
    public Long getUserId() {
        return userId;
    }

    public void setUserId(Long userId) {
        this.userId = userId;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }

    public String getEmail() {
        return email;
    }

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

    public Integer getStatus() {
        return status;
    }

    public void setStatus(Integer status) {
        this.status = status;
    }
}

3.2 创建Mapper接口

接下来，我们定义一个UserMapper接口，继承自MyBatis的BaseMapper接口，用于执行数据库操作。

package com.ruoyi.system.mapper;

import com.ruoyi.system.domain.User;
import org.apache.ibatis.annotations.Mapper;
import java.util.List;

@Mapper
public interface UserMapper {
    // 获取所有用户
    List<User> selectUserList(User user);

    // 插入新用户
    int insertUser(User user);

    // 更新用户信息
    int updateUser(User user);

    // 删除用户
    int deleteUserByIds(Long[] userIds);
}

3.3 创建Service层

在system模块下创建一个UserService类，封装业务逻辑，提供用户管理的具体操作。

package com.ruoyi.system.service;

import com.ruoyi.system.domain.User;
import java.util.List;

public interface IUserService {
    List<User> selectUserList(User user);
    int insertUser(User user);
    int updateUser(User user);
    int deleteUserByIds(Long[] userIds);
}

并提供实现类UserServiceImpl：

package com.ruoyi.system.service.impl;

import com.ruoyi.system.domain.User;
import com.ruoyi.system.mapper.UserMapper;
import com.ruoyi.system.service.IUserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import java.util.List;

@Service
public class UserServiceImpl implements IUserService {

    @Autowired
    private UserMapper userMapper;

    @Override
    public List<User> selectUserList(User user) {
        return userMapper.selectUserList(user);
    }

    @Override
    public int insertUser(User user) {
        return userMapper.insertUser(user);
    }

    @Override
    public int updateUser(User user) {
        return userMapper.updateUser(user);
    }

    @Override
    public int deleteUserByIds(Long[] userIds) {
        return userMapper.deleteUserByIds(userIds);
    }
}

3.4 创建Controller层

最后，我们创建一个RESTful API控制器来处理HTTP请求：

package com.ruoyi.system.controller;

import com.ruoyi.system.domain.User;
import com.ruoyi.system.service.IUserService;
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 IUserService userService;

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

    // 创建新用户
    @PostMapping("/add")
    public int addUser(@RequestBody User user) {
        return userService.insertUser(user);
    }

    // 更新用户信息
    @PutMapping("/update")
    public int updateUser(@RequestBody User user) {
        return userService.updateUser(user);
    }

    // 删除用户
    @DeleteMapping("/delete/{userIds}")
    public int deleteUser(@PathVariable Long[] userIds) {
        return userService.deleteUserByIds(userIds);
    }
}

3.5 测试接口

通过Postman或者其他API工具测试上述接口：

添加用户：发送POST请求到/user/add，请求体包含用户信息。
查询用户：发送GET请求到/user/list，返回用户列表。
更新用户：发送PUT请求到/user/update，请求体包含更新后的用户信息。
删除用户：发送DELETE请求到/user/delete/{userIds}，其中userIds为要删除的用户ID数组。