返回

解锁Ruoyi-vue项目新建模块SQL输出的配置技巧

后端

Ruoyi-vue 新模块 SQL 输出配置指南:解锁数据持久化

引言

在 Ruoyi-vue 项目中,创建新模块需要配置 SQL 输出,这是连接数据库并启用数据持久化的关键步骤。本指南将深入探讨 SQL 输出配置的两个方面:数据源配置和持久层配置,以及使用代码生成器自动化生成 Java 代码和资源文件的步骤。

数据源配置

数据源配置指定了模块所使用的数据库连接信息。在 application.yml 文件中配置以下内容:

spring:
  datasource:
    type: com.zaxxer.hikari.HikariDataSource
    url: jdbc:mysql://localhost:3306/ruoyi
    username: root
    password: root

持久层配置

持久层配置包含以下两个组件:

实体类:

实体类是映射数据库表的 Java 类,继承自 com.baomidou.mybatisplus.annotation.TableName 注解。例如:

// User.java
@TableName("t_user")
public class User {

    private Long id;
    private String username;
    private String password;

    // 省略 getter 和 setter 方法
}

持久层接口:

持久层接口是操作数据库的接口,继承自 com.baomidou.mybatisplus.core.mapper.BaseMapper 接口。例如:

// UserMapper.java
public interface UserMapper extends BaseMapper<User> {

    // 定义自定义方法
}

SQL 映射文件配置

SQL 映射文件定义了实体类和持久层接口之间的映射关系。这些文件位于 src/main/resources/mapper 目录,后缀为 .xml。例如,UserMapper.xml 内容如下:

<mapper namespace="com.ruoyi.user.mapper.UserMapper">

    <insert id="insert" useGeneratedKeys="true" keyProperty="id">
        INSERT INTO t_user (username, password) VALUES (#{username}, #{password})
    </insert>

    <select id="selectById" resultType="com.ruoyi.user.domain.User">
        SELECT * FROM t_user WHERE id = #{id}
    </select>

    <update id="update" parameterType="com.ruoyi.user.domain.User">
        UPDATE t_user SET username = #{username}, password = #{password} WHERE id = #{id}
    </update>

    <delete id="deleteById" parameterType="java.lang.Long">
        DELETE FROM t_user WHERE id = #{id}
    </delete>

</mapper>

运行代码生成器

在配置好数据源、持久层和 SQL 映射文件后,使用代码生成器来生成 Java 代码和资源文件。在 src/main/java/com/ruoyi 目录的 generator 子目录中运行 RunGenerator.java 文件。

注意事项

  • 确保实体类、持久层接口和 SQL 映射文件之间的映射关系正确。
  • 在运行代码生成器时,请正确配置 generatorConfig
  • 在使用新建模块时,请在 application.yml 文件中配置数据源信息。

常见问题解答

  1. 如何在 Ruoyi-vue 项目中配置新模块的 SQL 输出?
    按照本指南中的步骤配置数据源、持久层和 SQL 映射文件,并运行代码生成器。

  2. 数据源配置中哪些属性是必填项?
    typeurlusernamepassword

  3. 持久层接口应该继承哪个基类?
    com.baomidou.mybatisplus.core.mapper.BaseMapper

  4. 如何编写 SQL 映射文件中的查询语句?
    使用 MyBatis XML 语法,如 INSERTSELECTUPDATEDELETE

  5. 在运行代码生成器之前需要做什么准备?
    确保已配置好数据源、持久层和 SQL 映射文件。

结语

通过遵循本指南中的步骤,您可以轻松地在 Ruoyi-vue 项目中配置新模块的 SQL 输出。这将使您能够连接到数据库并持久化您的数据,从而为应用程序实现灵活的数据管理。