当前位置：首页 > news >正文

IDEA 的 EasyCode 插件使用指南：从入门到自定义模板

news 来源：原创 2025/6/15 23:05:26

引言

在开发过程中，编写重复的代码（如实体类、Mapper 接口、Service 层代码等）往往耗时且容易出错。JetBrains IDEA 的 EasyCode 插件是一款强大的代码生成工具，它可以根据数据库表结构自动生成代码，并支持自定义模板，满足不同项目的需求。

本文将详细介绍 EasyCode 插件的安装、配置、使用方法，并深入讲解如何自定义模板语法，帮助你快速上手并灵活使用 EasyCode。

一、安装 EasyCode 插件

打开 IDEA：
- 启动 IntelliJ IDEA。
进入插件市场：
- 点击菜单栏的 File -> Settings（Windows）或 IntelliJ IDEA -> Preferences（macOS）。
- 在设置窗口中，选择 Plugins。
搜索 EasyCode：
- 在插件市场的搜索框中输入 EasyCode。
- 找到 EasyCode 插件后，点击 Install 进行安装。
重启 IDEA：
- 安装完成后，重启 IDEA 以激活插件。

二、配置 EasyCode

1. 配置数据源

EasyCode 需要连接数据库以获取表结构信息。以下是配置步骤：

打开数据库工具窗口：
- 在 IDEA 右侧边栏，点击 Database 工具窗口。
添加数据源：
- 点击 + 按钮，选择你的数据库类型（如 MySQL、PostgreSQL 等）。
- 填写数据库连接信息（主机、端口、数据库名、用户名、密码等）。
- 点击 Test Connection 测试连接是否成功。
保存配置：
- 连接成功后，点击 OK 保存数据源配置。

2. 配置代码生成模板

EasyCode 提供了默认的代码生成模板，但你也可以根据项目需求自定义模板。

打开 EasyCode 设置：
- 点击菜单栏的 File -> Settings。
- 在设置窗口中，选择 EasyCode -> Template Setting。
编辑模板：
- 你可以编辑现有的模板（如 entity.java、mapper.java 等），或者添加新的模板。
- 模板使用 Velocity 语法，支持动态生成代码。
保存模板：
- 编辑完成后，点击 Apply 保存更改。

三、使用 EasyCode 生成代码

1. 生成单表代码

选择表：
- 在 Database 工具窗口中，展开你的数据库，找到需要生成代码的表。
右键菜单：
- 右键点击表名，选择 EasyCode -> Generate Code。
选择生成选项：
- 在弹出的窗口中，选择需要生成的代码类型（如 Entity、Mapper、Service、Controller 等）。
- 选择代码生成的目标包路径。
生成代码：
- 点击 OK，EasyCode 会根据表结构自动生成代码，并保存到指定的包路径中。

2. 批量生成代码

如果你需要为多张表生成代码，可以使用批量生成功能。

选择多张表：
- 在 Database 工具窗口中，按住 Ctrl（Windows）或 Command（macOS）选择多张表。
右键菜单：
- 右键点击选中的表，选择 EasyCode -> Generate Code。
选择生成选项：
- 在弹出的窗口中，选择需要生成的代码类型和目标包路径。
生成代码：
- 点击 OK，EasyCode 会为每张表生成对应的代码。

四、自定义模板语法教学

EasyCode 使用 Velocity 模板引擎来生成代码。Velocity 是一种基于 Java 的模板引擎，语法简单且功能强大。以下是常用的 Velocity 语法和 EasyCode 模板变量。

1. 基本语法

变量：$variable
- 例如：$tableInfo.name 表示表名。
方法调用：$variable.method()
- 例如：$tableInfo.getComment() 获取表注释。
条件判断：#if(condition) ... #end
- 例如：
```
#if($tableInfo.pkCount > 0)
@Id
#end
```

循环：#foreach($item in $list) ... #end

例如：

#foreach($column in $tableInfo.fullColumn)
private $column.shortType $column.name;
#end

2. EasyCode 模板变量

EasyCode 提供了许多内置变量，可以在模板中使用。以下是一些常用变量：

表信息：
- $tableInfo.name：表名。
- $tableInfo.comment：表注释。
- $tableInfo.pkCount：主键数量。
- $tableInfo.fullColumn：所有列信息。
列信息：
- $column.name：列名。
- $column.type：列类型（数据库类型）。
- $column.shortType：列类型（Java 类型）。
- $column.comment：列注释。
- $column.pk：是否是主键。

3. 自定义模板示例

以下是一个自定义实体类模板的示例：

package $package.Entity;

import java.io.Serializable;
#if($tableInfo.pkCount > 0)
import javax.persistence.Id;
#end
#if($importList)
#foreach($import in $importList)
import $import;
#end
#end

/**
 * $tableInfo.comment
 */
public class $tableInfo.name implements Serializable {
    private static final long serialVersionUID = 1L;

#foreach($column in $tableInfo.fullColumn)
    /**
     * $column.comment
     */
    #if($column.pk)
    @Id
    #end
    private $column.shortType $column.name;

#end

#foreach($column in $tableInfo.fullColumn)
    public $column.shortType get${column.capitalName}() {
        return $column.name;
    }

    public void set${column.capitalName}($column.shortType $column.name) {
        this.$column.name = $column.name;
    }

#end
}