Skip to content
Browse files
add why we need this maven plugin
  • Loading branch information
EricJoy2048 committed Jun 24, 2020
1 parent 8a152f6 commit 2078bafb2e6cce6791a73652bebbf9d1bf580de5
Showing 1 changed file with 8 additions and 1 deletion.
@@ -1,8 +1,15 @@
This is a maven plugin for DolphinScheduler , It has three functions:
### This is a maven plugin for DolphinScheduler , It has three functions:

1. It is allowed to add <packaging>dolphinscheduler-plugin</packaging> to the pom file. If <packaging>dolphinscheduler-plugin</packaging> is added to the pom file, the DolphinScheduler service will load this model as a DolphinScheduler plugin.

2. Automatically check the model with <packaging>dolphinscheduler-plugin</packaging> added to the pom file, and will automatically generate META-INF/services/org.apache.dolphinscheduler.spi.DolphinScheduler file when compile.

3. Automatically check DolphinScheduler's maven dependency. Especially the dependencies used by plugins.

### Why we need this maven plugin?

If we are running on the server deployment. Because the plug-ins are in the corresponding plug-in directory, and the plug-in jar package has the corresponding META-INF/services, there is no problem.

However, when we develop locally in IDE, we have no plug-ins dir and no plug-ins jar file . If we want to test and debug the plugin code, we need add the plugin module to the pom.xml of alert module ,But this violates the original intention of SPI. So we can`t add the plug-in module to the alert module as a dependency, So there will be a problem that the alert module cannot find the plug-in classes.
With this maven plug-in, by scanning the pom file of the project ,The pluginloader can find the module identified by <package>dolphinscheduler-plugin</package>, then can load this module`s class files and its dependent third-party jars from the target/classes dir of the plug-in module. This will debug locally

0 comments on commit 2078baf

Please sign in to comment.