1. 程式人生 > >手寫maven外掛

手寫maven外掛

一、建立外掛專案

1、建立一個maven專案,如下圖:



2、引入jar包:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.ayb</groupId>
    <artifactId>ayb-plugin</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>maven-plugin</packaging>
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.7</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.apache.maven</groupId>
            <artifactId>maven-plugin-api</artifactId>
            <version>3.5.0</version>
        </dependency>
        <dependency>
            <groupId>org.apache.maven.plugin-tools</groupId>
            <artifactId>maven-plugin-annotations</artifactId>
            <version>3.5</version>
            <scope>provided</scope>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.1</version>
                <configuration>
                    <verbose>true</verbose>
                    <fork>true</fork>
                    <executable>${JAVA_HOME}/bin/javac</executable>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>
3、實現自己的外掛功能:

package com.ayb;

import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;

/**
 * Created by Administrator on 2018/6/23 0023.
 */
    @Mojo(name="myPlugin",defaultPhase = LifecyclePhase.PACKAGE)
    public class MyMojo extends AbstractMojo{
    public void execute() throws MojoExecutionException, MojoFailureException {
        System.out.println("我的外掛");
    }
}
4、使用install命令,在maven倉庫生成jar包

二、在一個新的專案中引入剛剛建立的maven外掛

1、建立maven專案,過程同上。或者選擇已有的專案


2、在這個專案的pom檔案中引入外掛


<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.ayb</groupId>
    <artifactId>spring-mini-1.0</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>war</packaging>

    <name>spring-mini-1.0</name>
    <!-- FIXME change it to the project's website -->
    <url>http://www.example.com</url>


    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.7</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.11</version>
            <scope>test</scope>
        </dependency>

        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>javax.servlet-api</artifactId>
            <version>3.0.1</version>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>jsp-api</artifactId>
            <version>2.0</version>
            <scope>provided</scope>
            <exclusions>
                <exclusion>
                    <groupId>javax.servlet</groupId>
                    <artifactId>servlet-api</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>jstl</artifactId>
            <version>1.2</version>
        </dependency>
    </dependencies>

    <build>
        <finalName>spring-mini-1.0</finalName>
        <pluginManagement><!-- lock down plugins versions to avoid using Maven defaults (may be moved to parent pom) -->
            <plugins>
                <plugin>
                    <artifactId>maven-clean-plugin</artifactId>
                    <version>3.0.0</version>
                </plugin>
                <!-- see http://maven.apache.org/ref/current/maven-core/default-bindings.html#Plugin_bindings_for_war_packaging -->
                <plugin>
                    <artifactId>maven-resources-plugin</artifactId>
                    <version>3.0.2</version>
                </plugin>
                <plugin>
                    <artifactId>maven-compiler-plugin</artifactId>
                    <version>3.7.0</version>
                </plugin>
                <plugin>
                    <artifactId>maven-surefire-plugin</artifactId>
                    <version>2.20.1</version>
                </plugin>
                <plugin>
                    <artifactId>maven-war-plugin</artifactId>
                    <version>3.2.0</version>
                </plugin>
                <plugin>
                    <artifactId>maven-install-plugin</artifactId>
                    <version>2.5.2</version>
                </plugin>
                <plugin>
                    <artifactId>maven-deploy-plugin</artifactId>
                    <version>2.8.2</version>
                </plugin>

            </plugins>
        </pluginManagement>
        <plugins>
            <plugin>
                <groupId>org.apache.tomcat.maven</groupId>
                <artifactId>tomcat7-maven-plugin</artifactId> <!--如果不設定,則預設為貓的自定義埠,專案路徑為http://localhost:預設埠/專案名 -->
                <configuration> <!--如果埠號改為8081:那麼訪問的時候路徑的埠就要寫成8081,否則404 -->
                    <port>8080
                    </port> <!-- 如果設定為/,則專案了路徑為http://localhost:埠號 /--> <!-- 如果設定為/123,則專案了路徑為http://localhost:埠號/123 -->
                    <path>/</path>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.1</version>
                <configuration>
                    <verbose>true</verbose>
                    <fork>true</fork>
                    <executable>${JAVA_HOME}/bin/javac</executable>
                </configuration>
            </plugin>
            <plugin>
                <groupId>com.ayb</groupId>
                <artifactId>ayb-plugin</artifactId>
                <version>1.0-SNAPSHOT</version>
            </plugin>
        </plugins>
    </build>


</project>
3、重新整理後Plugins列表中出現新引入的外掛,雙擊執行,控制檯輸出我們在外掛中輸出的內容

4、重新執行install命令,會發現新引入的外掛未執行

"C:\Program Files (x86)\Java\jdk1.7.0_25\bin\java" -Dmaven.multiModuleProjectDirectory=E:\java\workspace\spring-mini-1.0 -Dmaven.home=E:\software\apache-maven-3.3.9 -Dclassworlds.conf=E:\software\apache-maven-3.3.9\bin\m2.conf -Didea.launcher.port=7535 "-Didea.launcher.bin.path=E:\java\idea\IntelliJ IDEA 15.0.6\bin" -Dfile.encoding=UTF-8 -classpath "E:\software\apache-maven-3.3.9\boot\plexus-classworlds-2.5.2.jar;E:\java\idea\IntelliJ IDEA 15.0.6\lib\idea_rt.jar" com.intellij.rt.execution.application.AppMain org.codehaus.classworlds.Launcher -Didea.version=15.0.6 -s E:\software\apache-maven-3.3.9\conf\settings.xml install
[INFO] Scanning for projects...
[INFO]                                                                         
[INFO] ------------------------------------------------------------------------
[INFO] Building spring-mini-1.0 1.0-SNAPSHOT
[INFO] ------------------------------------------------------------------------
[INFO] 
[INFO] --- maven-resources-plugin:3.0.2:resources (default-resources) @ spring-mini-1.0 ---
[INFO] Using 'UTF-8' encoding to copy filtered resources.
[INFO] Copying 1 resource
[INFO] 
[INFO] --- maven-compiler-plugin:3.1:compile (default-compile) @ spring-mini-1.0 ---
[INFO] Nothing to compile - all classes are up to date
[INFO] 
[INFO] --- maven-resources-plugin:3.0.2:testResources (default-testResources) @ spring-mini-1.0 ---
[INFO] Using 'UTF-8' encoding to copy filtered resources.
[INFO] skip non existing resourceDirectory E:\java\workspace\spring-mini-1.0\src\test\resources
[INFO] 
[INFO] --- maven-compiler-plugin:3.1:testCompile (default-testCompile) @ spring-mini-1.0 ---
[INFO] No sources to compile
[INFO] 
[INFO] --- maven-surefire-plugin:2.20.1:test (default-test) @ spring-mini-1.0 ---
[INFO] No tests to run.
[INFO] 
[INFO] --- maven-war-plugin:3.2.0:war (default-war) @ spring-mini-1.0 ---
[INFO] Packaging webapp
[INFO] Assembling webapp [spring-mini-1.0] in [E:\java\workspace\spring-mini-1.0\target\spring-mini-1.0]
[INFO] Processing war project
[INFO] Copying webapp resources [E:\java\workspace\spring-mini-1.0\src\main\webapp]
[INFO] Webapp assembled in [84 msecs]
[INFO] Building war: E:\java\workspace\spring-mini-1.0\target\spring-mini-1.0.war
[INFO] 
[INFO] --- maven-install-plugin:2.5.2:install (default-install) @ spring-mini-1.0 ---
[INFO] Installing E:\java\workspace\spring-mini-1.0\target\spring-mini-1.0.war to D:\MAVEN\com\ayb\spring-mini-1.0\1.0-SNAPSHOT\spring-mini-1.0-1.0-SNAPSHOT.war
[INFO] Installing E:\java\workspace\spring-mini-1.0\pom.xml to D:\MAVEN\com\ayb\spring-mini-1.0\1.0-SNAPSHOT\spring-mini-1.0-1.0-SNAPSHOT.pom
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 3.006 s
[INFO] Finished at: 2018-06-24T15:32:39+08:00
[INFO] Final Memory: 9M/47M
[INFO] ------------------------------------------------------------------------

Process finished with exit code 0

是因為新引入的外掛沒有掛載到maven的生命週期中

5、掛載外掛


<executions>
                    <execution>
                        <phase>package</phase>
                        <goals>
                            <goal>myPlugin</goal>
                        </goals>
                    </execution>
                </executions>
6、重新執行install命令,發現新引入的外掛被執行

三、向外掛中插入引數:

1、在外掛實現類中宣告一個全域性變數

package com.ayb;

import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;


/**
 * Created by Administrator on 2018/6/23 0023.
 */
    @Mojo(name="myPlugin",defaultPhase = LifecyclePhase.PACKAGE)
    public class MyMojo extends AbstractMojo{
    @Parameter
    private String msg;
    public void execute() throws MojoExecutionException, MojoFailureException {
        System.out.println("我的外掛"+msg);
    }
}

2、在引入外掛專案的pom檔案中新增引數

3、執行 Install命令

4、傳入集合


5、傳入命令引數