Free MyBatis Tool 插件安装与使用指南

Free MyBatis Tool 插件安装与使用指南

项目地址:https://gitcode.com/gh_mirrors/fr/Free-Mybatis-Tool

1. 项目目录结构及介绍

Free MyBatis Tool 是一个用于增强 IntelliJ IDEA 对 MyBatis 支持的插件。以下是该项目的目录结构及其主要文件的介绍：

Free-Mybatis-Tool/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   ├── com/
│   │   │   │   ├── moztl/
│   │   │   │   │   ├── freemybatistool/
│   │   │   │   │   │   ├── actions/
│   │   │   │   │   │   ├── config/
│   │   │   │   │   │   ├── icons/
│   │   │   │   │   │   ├── utils/
│   │   │   │   │   │   ├── FreeMybatisTool.java
│   │   ├── resources/
│   │   │   ├── META-INF/
│   │   │   │   ├── plugin.xml
├── .gitignore
├── LICENSE
├── README.md

主要目录和文件介绍

• src/main/java/com/moztl/freemybatistool/: 插件的主要代码目录，包含插件的核心功能实现。

  • actions/: 包含插件的各种操作类，如生成Mapper XML文件、代码跳转等。
  • config/: 包含插件的配置类，用于管理插件的配置选项。
  • icons/: 包含插件使用的图标文件。
  • utils/: 包含插件的工具类，提供一些辅助功能。
  • FreeMybatisTool.java: 插件的主类，负责插件的初始化和启动。

• src/main/resources/META-INF/plugin.xml: 插件的配置文件，定义了插件的基本信息、依赖关系和扩展点。

• .gitignore: Git 忽略文件，指定哪些文件和目录不需要被版本控制。

• LICENSE: 项目的开源许可证文件。

• README.md: 项目的说明文档，包含项目的介绍、安装和使用说明。

2. 项目的启动文件介绍

Free MyBatis Tool 插件的启动文件是 FreeMybatisTool.java，位于 src/main/java/com/moztl/freemybatistool/ 目录下。该文件是插件的主类，负责插件的初始化和启动。

主要功能

• 初始化插件: 在插件启动时，FreeMybatisTool.java 会初始化插件的各种功能模块，如代码生成、代码跳转等。
• 注册插件操作: 通过 plugin.xml 配置文件，插件会注册各种操作类，如生成Mapper XML文件、代码跳转等。
• 加载配置: 插件会加载用户在 IDEA 中的配置，如数据库连接信息、代码生成路径等。

3. 项目的配置文件介绍

Free MyBatis Tool 插件的配置文件是 plugin.xml，位于 src/main/resources/META-INF/ 目录下。该文件定义了插件的基本信息、依赖关系和扩展点。

主要配置项

• 插件信息: 定义插件的名称、版本、作者等信息。
• 依赖关系: 定义插件依赖的其他插件或库。
• 扩展点: 定义插件提供的扩展点，如代码生成、代码跳转等。
• 操作类: 定义插件的各种操作类，如生成Mapper XML文件、代码跳转等。

示例配置

<idea-plugin>
    <id>com.moztl.freemybatistool</id>
    <name>Free MyBatis Tool</name>
    <version>1.0.0</version>
    <vendor email="support@example.com" url="https://example.com">Moztl</vendor>

    <description><![CDATA[
        Free MyBatis Tool is a plugin that enhances IntelliJ IDEA support for MyBatis.
    ]]></description>

    <depends>com.intellij.modules.platform</depends>

    <extensions defaultExtensionNs="com.intellij">
        <!-- 定义插件的扩展点 -->
    </extensions>

    <actions>
        <!-- 定义插件的操作类 -->
    </actions>
</idea-plugin>

通过以上配置，Free MyBatis Tool 插件可以在 IntelliJ IDEA 中正常运行，并提供增强的 MyBatis 支持功能。

Free-Mybatis-Tool Free MyBatis Tool is a plugin that enhances idea support for mybatis. 项目地址: https://gitcode.com/gh_mirrors/fr/Free-Mybatis-Tool