Gradle JOOQ Plugin 使用教程

1. 项目的目录结构及介绍

Gradle JOOQ Plugin 是一个用于集成 JOOQ 代码生成器的 Gradle 插件。以下是该项目的目录结构及其介绍：

gradle-jooq-plugin/
├── build.gradle
├── gradle
│   └── wrapper
│       ├── gradle-wrapper.jar
│       └── gradle-wrapper.properties
├── gradlew
├── gradlew.bat
├── README.md
├── settings.gradle
└── src
    ├── main
    │   ├── groovy
    │   │   └── nu
    │   │       └── studer
    │   │           └── gradle
    │   │               └── jooq
    │   │                   ├── JooqPlugin.groovy
    │   │                   └── JooqTask.groovy
    │   └── resources
    │       └── META-INF
    │           └── gradle-plugins
    │               └── nu.studer.jooq.properties
    └── test
        ├── groovy
        │   └── nu
        │       └── studer
        │           └── gradle
        │               └── jooq
        │                   └── JooqPluginTest.groovy
        └── resources
            └── test
                └── jooq
                    └── generator
                        └── generatorConfig.xml

目录结构介绍

• build.gradle: 项目的构建脚本。
• gradle/wrapper/: 包含 Gradle Wrapper 的文件，用于确保项目使用特定版本的 Gradle 进行构建。
• gradlew 和 gradlew.bat: 分别是 Unix 和 Windows 下的 Gradle Wrapper 脚本。
• README.md: 项目的说明文档。
• settings.gradle: 项目的设置文件，包含项目名称和子项目信息。
• src/main/groovy/nu/studer/gradle/jooq/: 包含插件的主要实现代码。
  • JooqPlugin.groovy: 插件的主类。
  • JooqTask.groovy: 插件的任务类。
• src/main/resources/META-INF/gradle-plugins/nu.studer.jooq.properties: 插件的标识文件。
• src/test/groovy/nu/studer/gradle/jooq/JooqPluginTest.groovy: 插件的测试类。
• src/test/resources/test/jooq/generator/generatorConfig.xml: 用于测试的 JOOQ 配置文件。

2. 项目的启动文件介绍

项目的启动文件主要是 JooqPlugin.groovy，它是插件的主类，负责注册和配置 JOOQ 任务。以下是该文件的简要介绍：

package nu.studer.gradle.jooq

import org.gradle.api.Plugin
import org.gradle.api.Project

class JooqPlugin implements Plugin<Project> {
    @Override
    void apply(Project project) {
        // 注册 JooqTask 任务
        project.tasks.create('generateJooq', JooqTask)
    }
}

启动文件介绍

• JooqPlugin.groovy: 实现了 Gradle 的 Plugin 接口，负责将 JooqTask 任务注册到项目中。
• apply 方法: 在项目中应用插件时调用，创建并注册 generateJooq 任务。

3. 项目的配置文件介绍

项目的配置文件主要是 build.gradle 和 generatorConfig.xml。以下是这两个文件的简要介绍：

build.gradle

build.gradle 是项目的构建脚本，包含插件的依赖和任务配置。以下是一个示例：

plugins {
    id 'nu.studer.jooq' version '6.0.1'
}

dependencies {
    jooqGenerator 'org.postgresql:postgresql:42.2.5'
}

jooq {
    version = '3.14.4'
    edition = 'OSS'
    configurations {
        main {
            generationTool {
                logging = org.jooq.meta.jaxb.Logging.WARN
                jdbc {
                    driver = 'org.postgresql.Driver'
                    url