{"id":14029,"date":"2020-02-03T03:56:53","date_gmt":"2020-02-03T02:56:53","guid":{"rendered":"http:\/\/blog.wenzlaff.de\/?p=14029"},"modified":"2020-02-02T19:51:08","modified_gmt":"2020-02-02T18:51:08","slug":"ein-eigenes-maven-plugin-in-15-minuten-erstellen-mit-doku-in-6-schritten","status":"publish","type":"post","link":"http:\/\/blog.wenzlaff.de\/?p=14029","title":{"rendered":"Ein eigenes Maven-Plugin in 15 Minuten inklusive Dokumentation erstellen"},"content":{"rendered":"

Ein eigenes Maven-Plugin zu erstellen ist nicht schwer und ist schnell gemacht. Wir wollen ein Plugin welches einen Verzeichnis Inhalt mit ls -la<\/strong> in das Log schreibt erstellen. Es k\u00f6nnen aber auch andere Linux Befehle \u00fcbergeben werden. Hier nun die 6 Schritte mit den Vorlagen die mind. n\u00f6tig sind.
\n

\"Freut<\/a>
Always rejoice, mit freundlicher Genehmigung meines Lieblingsk\u00fcnstlers<\/a><\/figcaption><\/figure><\/p>\n

1. Wir legen in Eclipse ein neue Maven Projekt mit Java 1.8 an. mit Artifact Id und Group Id de.wenzlaff.command.maven.plugin<\/strong><\/p>\n

\"\"<\/a><\/p>\n

2. In der pom.xml f\u00fcgen wir die folgenden Abh\u00e4ngikeiten hinzu:<\/p>\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\r\n<project xmlns=\"http:\/\/maven.apache.org\/POM\/4.0.0\"\r\n\txmlns:xsi=\"http:\/\/www.w3.org\/2001\/XMLSchema-instance\"\r\n\txsi:schemaLocation=\"http:\/\/maven.apache.org\/POM\/4.0.0 https:\/\/maven.apache.org\/xsd\/maven-4.0.0.xsd\">\r\n\t<modelVersion>4.0.0<\/modelVersion>\r\n\r\n\t<groupId>de.wenzlaff.command.maven.plugin<\/groupId>\r\n\t<artifactId>de.wenzlaff.command.maven.plugin<\/artifactId>\r\n\t<version>1.0-SNAPSHOT<\/version>\r\n\t<packaging>maven-plugin<\/packaging>\r\n\r\n\t<name>Command Maven Plugin<\/name>\r\n\t<description>Command Maven Plugin<\/description>\r\n\r\n\t<organization>\r\n\t\t<name>Thomas Wenzlaff<\/name>\r\n\t\t<url>https:\/\/www.wenzlaff.info<\/url>\r\n\t<\/organization>\r\n\r\n\t<prerequisites>\r\n\t\t<maven>3.5.0<\/maven>\r\n\t<\/prerequisites>\r\n\r\n\t<properties>\r\n\t\t<maven.compiler.source>1.8<\/maven.compiler.source>\r\n\t\t<maven.compiler.target>1.8<\/maven.compiler.target>\r\n\t\t<project.build.sourceEncoding>UTF-8<\/project.build.sourceEncoding>\r\n\t\t<project.reporting.outputEncoding>UTF-8<\/project.reporting.outputEncoding>\r\n\t<\/properties>\r\n\r\n\t<reporting>\r\n\t\t<plugins>\r\n\t\t\t<plugin>\r\n\t\t\t\t<groupId>org.apache.maven.plugins<\/groupId>\r\n\t\t\t\t<artifactId>maven-plugin-plugin<\/artifactId>\r\n\t\t\t\t<reportSets>\r\n\t\t\t\t\t<reportSet>\r\n\t\t\t\t\t\t<reports>\r\n\t\t\t\t\t\t\t<report>report<\/report>\r\n\t\t\t\t\t\t<\/reports>\r\n\t\t\t\t\t<\/reportSet>\r\n\t\t\t\t<\/reportSets>\r\n\t\t\t<\/plugin>\r\n\t\t<\/plugins>\r\n\t<\/reporting>\r\n\r\n\t<dependencies>\r\n\t\t<dependency>\r\n\t\t\t<groupId>org.apache.maven<\/groupId>\r\n\t\t\t<artifactId>maven-plugin-api<\/artifactId>\r\n\t\t\t<version>3.6.3<\/version>\r\n\t\t\t<scope>provided<\/scope>\r\n\t\t<\/dependency>\r\n\t\t<dependency>\r\n\t\t\t<groupId>org.apache.maven<\/groupId>\r\n\t\t\t<artifactId>maven-core<\/artifactId>\r\n\t\t\t<version>3.6.0<\/version>\r\n\t\t\t<scope>provided<\/scope>\r\n\t\t<\/dependency>\r\n\t\t<dependency>\r\n\t\t\t<groupId>org.apache.maven.plugin-tools<\/groupId>\r\n\t\t\t<artifactId>maven-plugin-annotations<\/artifactId>\r\n\t\t\t<version>3.5<\/version>\r\n\t\t\t<scope>provided<\/scope>\r\n\t\t<\/dependency>\r\n\t<\/dependencies>\r\n\r\n\t<build>\r\n\t\t<pluginManagement>\r\n\t\t\t<plugins>\r\n\t\t\t\t<plugin>\r\n\t\t\t\t\t<groupId>org.apache.maven.plugins<\/groupId>\r\n\t\t\t\t\t<artifactId>maven-plugin-plugin<\/artifactId>\r\n\t\t\t\t\t<version>3.6.0<\/version>\r\n\t\t\t\t<\/plugin>\r\n\t\t\t\t<plugin>\r\n\t\t\t\t\t<groupId>org.apache.maven.plugins<\/groupId>\r\n\t\t\t\t\t<artifactId>maven-site-plugin<\/artifactId>\r\n\t\t\t\t\t<version>3.8.2<\/version>\r\n\t\t\t\t<\/plugin>\r\n\t\t\t\t<!--This plugin's configuration is used to store Eclipse m2e settings \r\n\t\t\t\t\tonly. It has no influence on the Maven build itself. -->\r\n\t\t\t\t<plugin>\r\n\t\t\t\t\t<groupId>org.eclipse.m2e<\/groupId>\r\n\t\t\t\t\t<artifactId>lifecycle-mapping<\/artifactId>\r\n\t\t\t\t\t<version>1.0.0<\/version>\r\n\t\t\t\t\t<configuration>\r\n\t\t\t\t\t\t<lifecycleMappingMetadata>\r\n\t\t\t\t\t\t\t<pluginExecutions>\r\n\t\t\t\t\t\t\t\t<pluginExecution>\r\n\t\t\t\t\t\t\t\t\t<pluginExecutionFilter>\r\n\t\t\t\t\t\t\t\t\t\t<groupId>org.apache.maven.plugins<\/groupId>\r\n\t\t\t\t\t\t\t\t\t\t<artifactId>maven-plugin-plugin<\/artifactId>\r\n\t\t\t\t\t\t\t\t\t\t<versionRange>[3.6.0,)<\/versionRange>\r\n\t\t\t\t\t\t\t\t\t\t<goals>\r\n\t\t\t\t\t\t\t\t\t\t\t<goal>descriptor<\/goal>\r\n\t\t\t\t\t\t\t\t\t\t<\/goals>\r\n\t\t\t\t\t\t\t\t\t<\/pluginExecutionFilter>\r\n\t\t\t\t\t\t\t\t\t<action>\r\n\t\t\t\t\t\t\t\t\t\t<ignore><\/ignore>\r\n\t\t\t\t\t\t\t\t\t<\/action>\r\n\t\t\t\t\t\t\t\t<\/pluginExecution>\r\n\t\t\t\t\t\t\t<\/pluginExecutions>\r\n\t\t\t\t\t\t<\/lifecycleMappingMetadata>\r\n\t\t\t\t\t<\/configuration>\r\n\t\t\t\t<\/plugin>\r\n\t\t\t<\/plugins>\r\n\t\t<\/pluginManagement>\r\n\t<\/build>\r\n<\/project>\r\n<\/pre>\n
3. Dann brauchen wir noch ein Mojo. Mit einem Parameter, der default das ls -la<\/strong> ausf\u00fchrt.<\/p>\n
Dazu die folgende Klasse im Package de.wenzlaff.command.maven.plugin<\/strong> anlegen:<\/p>\n
package de.wenzlaff.command.maven.plugin;\r\n\r\nimport java.io.BufferedReader;\r\nimport java.io.IOException;\r\nimport java.io.InputStreamReader;\r\n\r\nimport org.apache.maven.plugin.AbstractMojo;\r\nimport org.apache.maven.plugin.MojoExecutionException;\r\nimport org.apache.maven.plugin.MojoFailureException;\r\nimport org.apache.maven.plugins.annotations.LifecyclePhase;\r\nimport org.apache.maven.plugins.annotations.Mojo;\r\nimport org.apache.maven.plugins.annotations.Parameter;\r\nimport org.apache.maven.project.MavenProject;\r\n\r\n\/**\r\n * Ein Kommando-Mojo.\r\n * \r\n * @author Thomas Wenzlaff\r\n *\r\n *\/\r\n@Mojo(name = \"info\", defaultPhase = LifecyclePhase.INITIALIZE)\r\npublic class CommandMojo extends AbstractMojo {\r\n\r\n\t\/**\r\n\t * Der command Parameter. Wenn er nicht angegeben wird, wird default: ls -la\r\n\t * verwendet.\r\n\t * \r\n\t * Es kann aber auch noch ein Verzeichnis \u00fcbergeben werden, das \u00fcberwacht werden\r\n\t * soll. Z.B.\r\n\t * \r\n\t * mvn de.wenzlaff.dir.maven.plugin:de.wenzlaff.command.maven.plugin:info\r\n\t * -Dcommand=\"ls -la \/Users\/thomaswenzlaff\"\r\n\t * \r\n\t *\/\r\n\t@Parameter(property = \"command\", defaultValue = \"ls -la\")\r\n\tprivate String command;\r\n\r\n\t@Parameter(property = \"project\", readonly = true)\r\n\tprivate MavenProject project;\r\n\r\n\tpublic void execute() throws MojoExecutionException, MojoFailureException {\r\n\r\n\t\tgetLog().info(\"Thomas sein Command-Plugin in Version: \" + project.getVersion() + \", ArtifactId: \" + project.getArtifactId());\r\n\t\tgetLog().info(\"F\u00fchre das Kommando aus: \" + command);\r\n\r\n\t\tString commandoErgebnis = getCommand(command);\r\n\r\n\t\tgetLog().info(commandoErgebnis);\r\n\t}\r\n\r\n\tpublic String getCommand(String command) throws MojoExecutionException {\r\n\r\n\t\tString s = null;\r\n\t\tStringBuilder buffer = new StringBuilder(\"\\n\");\r\n\r\n\t\ttry {\r\n\t\t\tProcess p = Runtime.getRuntime().exec(command);\r\n\r\n\t\t\ttry (BufferedReader stdInput = new BufferedReader(new InputStreamReader(p.getInputStream()))) {\r\n\r\n\t\t\t\twhile ((s = stdInput.readLine()) != null) {\r\n\t\t\t\t\tbuffer.append(s);\r\n\t\t\t\t\tbuffer.append(\"\\n\");\r\n\t\t\t\t}\r\n\t\t\t}\r\n\r\n\t\t\ttry (BufferedReader stdError = new BufferedReader(new InputStreamReader(p.getErrorStream()))) {\r\n\r\n\t\t\t\twhile ((s = stdError.readLine()) != null) {\r\n\t\t\t\t\tbuffer.append(\"Error: \" + s);\r\n\t\t\t\t}\r\n\t\t\t}\r\n\t\t} catch (IOException e) {\r\n\t\t\tthrow new MojoExecutionException(\"Fehler beim ausf\u00fchren des Kommandos: '\" + command, e);\r\n\t\t}\r\n\r\n\t\treturn buffer.toString();\r\n\r\n\t}\r\n}\r\n<\/pre>\n
Die Klasse CommandMojo<\/strong> wird von dem AbstractMojo<\/strong> abgeleitet. Es muss nur eine Methode (execute<\/strong>) implementiert werden. Das Projekt sieht nun so aus:<\/p>\n
\"\"<\/a><\/p>\n
4. Jetzt k\u00f6nnen wir das Plugin schon bauen mit: mvn clean install<\/strong><\/p>\n
5. Das Plugin testen wir auf der Kommandozeile, indem wir in das Projektverzeichnis wechseln (da wo die pom.xml liegt) und das info Goal aufrufen:<\/p>\n
mvn de.wenzlaff.command.maven.plugin:de.wenzlaff.command.maven.plugin:info<\/strong><\/p>\n
Es wird nun das Verzeichnis augegeben und im log geschrieben:<\/p>\n
\"\"<\/a><\/p>\n
Wenn man einen anderen als den default Parameter haben will, kann der mit -D<\/strong> angegeben werden z.B.<\/p>\n
mvn de.wenzlaff.command.maven.plugin:de.wenzlaff.command.maven.plugin:info -Dcommand=“ps“<\/strong><\/p>\n
um alle Prozesse auszugeben.<\/p>\n
6. Mit mvn site<\/strong> kann auch leicht der gewohnt Report erzeugt werden:<\/p>\n
\"\"<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"
Ein eigenes Maven-Plugin zu erstellen ist nicht schwer und ist schnell gemacht. Wir wollen ein Plugin welches einen Verzeichnis Inhalt mit ls -la in das Log schreibt erstellen. Es k\u00f6nnen aber auch andere Linux Befehle \u00fcbergeben werden. Hier nun die 6 Schritte mit den Vorlagen die mind. n\u00f6tig sind. 1. Wir legen in Eclipse ein … <\/p>\n
\u201eEin eigenes Maven-Plugin in 15 Minuten inklusive Dokumentation erstellen\u201c <\/span>weiterlesen<\/a><\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[220,3161,5,3897,1361,3163,7],"tags":[3899,2178,2193,66,3898,3900,293,256,322],"class_list":["post-14029","post","type-post","status-publish","format-standard","hentry","category-anleitung","category-build","category-java","category-java-programmierung","category-java-8","category-maven","category-tools","tag-erstellen-maven-plugin","tag-java","tag-java-8","tag-maven","tag-maven-plugin","tag-maven-tool","tag-plugin","tag-tool","tag-verzeichnis"],"_links":{"self":[{"href":"http:\/\/blog.wenzlaff.de\/index.php?rest_route=\/wp\/v2\/posts\/14029","targetHints":{"allow":["GET"]}}],"collection":[{"href":"http:\/\/blog.wenzlaff.de\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/blog.wenzlaff.de\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/blog.wenzlaff.de\/index.php?rest_route=\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"http:\/\/blog.wenzlaff.de\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=14029"}],"version-history":[{"count":0,"href":"http:\/\/blog.wenzlaff.de\/index.php?rest_route=\/wp\/v2\/posts\/14029\/revisions"}],"wp:attachment":[{"href":"http:\/\/blog.wenzlaff.de\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=14029"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/blog.wenzlaff.de\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=14029"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/blog.wenzlaff.de\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=14029"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}