前言

  使用maven外掛可以將一些有意思的功能抽象成maven外掛服務，安裝到本地maven倉庫以後，可以很方便的使用功能，也可以在其他專案當中引用外掛，使用外掛功能。

  下面完成統計目錄下包含的指定型別的檔案，以及該型別所有檔案的行數總和，可以用來統計專案中的程式碼行數~

1、新建maven外掛工程

外掛也就是一個maven工程，可以使用Archetype外掛新建一個maven專案。

1.1 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>cn.zhoucy</groupId>
  <artifactId>maven-plugin</artifactId>
  <version>1.0-SNAPSHOT</version
 
>
  <packaging>maven-plugin</packaging>
  <name>maven-plugin</name>


  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  </properties>

  <dependencies>
    <dependency>
      <groupId>org.apache.maven</groupId
 
>
      <artifactId>maven-plugin-api</artifactId>
      <version>3.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>cn.zhoucy</groupId>
        <artifactId>maven-plugin</artifactId>
        <version>1.0-SNAPSHOT</version>
        <configuration>
          <currentBaseDir>${basedir}</currentBaseDir>
          <suffix>.java</suffix>
        </configuration>
        <executions>
          <execution>
            <!-- phase表示執行在哪個階段 -->
            <phase>clean</phase>
            <goals>
              <!--goal標識執行哪個命令，可以這樣認為-->
              <goal>fileCountTotal</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>

</project>

其中build外掛是該專案測試時，自己呼叫自己，後面會解釋呼叫外掛的兩種方式。
只要注意

<packaging>maven-plugin</packaging>

以及外掛編寫需要引入兩個jar包即可。

1.2 新建java類，程式碼如下：

package cn.zhoucy;

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;

import java.io.BufferedReader;
import java.io.File;
import java.io.FileReader;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;

/**
 * Created by zhoucy on 18/6/1
 **/
@Mojo(name = "fileCountTotal",requiresProject = false,defaultPhase = LifecyclePhase.PACKAGE)

public class CountMojo extends AbstractMojo{

    private static List<String> fileList = new ArrayList<String>();
    private int allLines = 0;

    //獲取檔案路徑
    @Parameter(property = "currentBaseDir",defaultValue = "/Users/pathHome")

    private String currentBaseDir;

    //定義檔案字尾   如果要傳遞 Args的引數需要這樣傳：mvn clean -Dsuffix=.xml
    @Parameter(property = "suffix",defaultValue = ".java")
    private String suffix;


    public void execute() throws MojoExecutionException, MojoFailureException {
        List<String> fileList = scanFile(currentBaseDir);
        System.out.println("FilePath:"+currentBaseDir);
        System.out.println("defaultFileSuffix:"+suffix);
        System.out.println("FileTotal:"+fileList.size());
        System.out.println("allLines:"+allLines);
    }


    /**
     * 遞迴統計檔案，並將符合條件的檔案放入集合中
     * @param filePath
     * @return
     */
    private List<String> scanFile(String filePath) {
        File dir = new File(filePath);
        // 遞迴查詢到所有的class檔案
        for (File file : dir.listFiles()) {
            if (file.isDirectory()) {
                scanFile(file.getAbsolutePath());
            } else {
                if(file.getName().endsWith(suffix)){
                    fileList.add(file.getName());
                    allLines+=countLines(file);
                }
            }
        }
        return fileList;
    }

    private int countLines(File file) {
        int lines = 0;
        try {
            BufferedReader reader = new BufferedReader(new FileReader(file));

            while (reader.ready()) {
                reader.readLine();
                lines++;
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
        return lines;
    }
}

2 核心點及兩種呼叫外掛方式

2.1 檔案中核心點解釋：

• AbstractMojo:編寫的類集成了這個類，這個是編寫maven外掛的類必須要繼承的類，並實現方法execute()，該方法即是maven外掛執行時的入口。
• @Mojo:類上有該註解，其中有很多屬性值，

name="fileCountTotal":表示該類的執行方法名為gileCountTotal，當你在其他專案中引用該外掛的時候goal屬性的值。或者在命令列中直接使用該外掛值，用來區分要執行的類，因為一個maven外掛中，可以有很多繼承了AbstractMojo的類，在類上加該屬性用於區分。

requiresProject = false:該屬性值表示，編寫的外掛所執行的目標專案是否必須為maven專案，顯然我們這裡是想要統計指定目錄下的檔案以及檔案所含內容行數，不需要目標專案必須為maven專案，故為false。

@Parameter:表示的是該引數是可以在呼叫maven外掛的時候動態將引數值傳遞進來的，因為maven外掛有兩種呼叫方式，所以有兩種傳遞引數的方式。

2.2 呼叫及傳參方式

一種呼叫方式為：在maven專案中引用外掛座標：

<build>
    <plugins>
      <plugin>
        <groupId>cn.zhoucy</groupId>
        <artifactId>maven-plugin</artifactId>
        <version>1.0-SNAPSHOT</version>
        <configuration>
          <currentBaseDir>${basedir}</currentBaseDir>
          <suffix>.java</suffix>
        </configuration>
        <executions>
          <execution>
            <!-- phase表示執行在哪個階段 -->
            <phase>clean</phase>
            <goals>
              <!--goal標識執行哪個命令，可以這樣認為-->
              <goal>fileCountTotal</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>

此時通過

        <configuration>
          <currentBaseDir>${basedir}</currentBaseDir>
          <suffix>.java</suffix>
        </configuration>

來傳遞引數值。

其中

<phase>clean</phase>

表示執行的期間是clean。故可以通過mvn clean來呼叫該外掛對當前maven工程中的檔案行數進行統計。

另一種呼叫方式為命令列呼叫：

直接在bash中打入下面命令：

mvn cn.zhoucy:maven-plugin:1.0-SNAPSHOT:fileCountTotal -DcurrentBaseDir=/Users/pathHome/IdeaWorkspace -Dsuffix=.java

命令解析：


mvn groupId:artifactId:version:繫結名 引數...


可得到如下結果：

FilePath:/Users/pathHome/IdeaWorkspace
defaultFileSuffix:.java
FileTotal:240
allLines:14559

提醒：
在呼叫外掛之前，需要使用mvn clean install將外掛安裝到本地maven倉庫。