Maven Maven Plugin Example: do-it-Yourself Authoring maven Plug-ins

Requirements:

When Maven compiles the project, the amount of code, that is, the number of files in the project, the number of lines of code, including the Java files and configuration files Two, where the configuration file (SQL, XML, properties) lines/4 processing.

To Create a project:

First make sure that the M2eclipse plugin is installed: http://eclipse.org/m2e/

Eclipse-new-maven Project, select archetype = Maven-archetype-plugin: (or use the command mvn archetype:generate, and then follow the prompts)

The next step is to set up coordinate information to create a MAVEN plugin project.

The resulting pom.xml files are as follows (with manual changes, see comments):

<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.alpha.wang</groupId> <artifactId> Maven-statis-plugin</artifactid> <version>0.0.1-SNAPSHOT</version> <packaging> maven-plugin</packaging> <name>alpha-statis-plugin Maven plugin</name> <url>http:// Blog.csdn.net/vking_wang</url> <properties> <project.build.sourceencoding>utf-8</ project.build.sourceencoding> </properties> <dependencies> <dependency> <groupid&gt ;org.apache.maven</groupid> <artifactId>maven-plugin-api</artifactId> <version>2.0< /version> </dependency> <!--Otherwise, the Org.apache.maven.model.Resource in Mojo cannot be resolved--&GT     <dependency>         <groupid>org.apache.maven</ groupid>         <artifactId>maven-model</artifactId>         <version>2.2.1</version>     </dependency>  < dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <versi on>3.8.1</version> <scope>test</scope> </dependency> </dependencies> <b
        uild> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-plugin-plugin</artifactId> <version>2.5.1</version> <configur ation> <!--[Warning]goal prefix is specified as: ' Maven-statis-plugin '. Maven currently expects it to be ' statis ' .--> <!--goalprefix>maVen-statis-plugin</goalprefix--> <goalPrefix>statis</goalPrefix> </configuration&gt
        ; <executions> <execution> <id>generated-helpmojo</id> &LT;GOALS&G
              T
      <goal>helpmojo</goal> </goals> </execution> </executions> </plugin> <!--generics are not supported In-source 1.3 (Use-source 5 or higher to enable generics)--&G
      T <plugin> <groupId>org.apache.maven.plugins</groupId> &LT;ARTIFACTID&GT;MAVEN-COMPILER-PL ugin</artifactid> <version>2.5.1</version> <configuration> <source&gt ;1.5</source> <target>1.5</target> </configuration> </plugin&gt
    ; </plugins> </build> </project>

Note that packing is maven-plugin and dependent on MAVEN-PLUGIN-API.

Also automatically generates a source file for public class Mymojo extends Abstractmojo. Write Mojo

Mojo = Maven old Java Object, which needs to inherit Abstractmojo and implement its Execute method.

The previous step has automatically generated a mojo, we delete the recreate one:

Import Org.apache.maven.model.Resource;
Import Org.apache.maven.plugin.AbstractMojo;
Import org.apache.maven.plugin.MojoExecutionException; /** * * @goal count * * @phase process-sources/public class Countmojo extends Abstractmojo {private static FINA	
	L string[] Includes_default = {"Java", "xml", "SQL", "Properties"};
	private static final string[] Ratios_default = {"1.0", "0.25", "0.25", "0.25"};
    private static final String DOT = ".";
    /** * @parameter expression= "${project.basedir}" * @required * @readonly/private File basedir; /** * @parameter expression= "${project.build.sourcedirectory}" * @required * @readonly * * * priv
    Ate File SourceDir; /** * @parameter expression= "${project.build.testsourcedirectory}" * @required * @readonly * * * priv
    Ate File Testsourcedir; /** * @parameter expression= "${project.resources}" * @required * @readonly/private List<reso Urce> resources;
    private list<file> resources; /** * @parameter expression= "${project.testresources}" * @required * @readonly/private list<
    Resource> testresources;
    Private list<file> testresources;
    /** * @parameter * * Private string[] includes; /** * @parameter/private string[] Ratios;//todo is defined as double[], prompting java.lang.ClassCastException when reading from XML: [D can
    
    Not being cast to [Ljava.lang.Object;
    Private map<string, double> ratiomap = new hashmap<string, double> ();
    Private long realtotal;

    Private long faketotal;
    	public void execute () throws Mojoexecutionexception {Initratiomap ();
    		try{Countdir (SourceDir);
    		
    		Countdir (Testsourcedir);
    		for (Resource res:resources) {countdir (New File (Res.getdirectory ()));
    		for (Resource res:testresources) {countdir (New File (Res.getdirectory ())); } Getlog (). Info ("Total LINES: +faketotal+" ("+realtotal+"));
    	}catch (IOException e) {throw new Mojoexecutionexception ("Unable to count lines of code", e); }
       
    }
}

The tool methods that are invoked are defined as follows:

    private void Initratiomap () throws mojoexecutionexception{if (includes = = NULL | | includes.length = 0) {in
    		Cludes = Includes_default;
    	ratios = Ratios_default;
    		} if (ratios = NULL | | ratios.length = = 0) {ratios = new string[includes.length];
    		for (int i=0; i<includes.length; i++) {Ratios[i] = "1.0"; } if (Includes.length!= ratios.length) {throw new Mojoexecutionexception ("Pom.xml error:the length of I
    	Ncludes is inconsistent with ratios! ");}
    	Ratiomap.clear ();
    	for (int i=0; i<includes.length; i++) {ratiomap.put (Includes[i].tolowercase (), double.parsedouble (ratios[i));
    	} private void Countdir (File dir) throws IOException {if (! dir.exists ()) {return;
    	} list<file> collected = new arraylist<file> ();
    	
    	Collectfiles (collected, dir);
    	int realline = 0;
    	int fakeline = 0; for (File file:collected) {int[] line = CouNtline (file);
    		Realline + = line[0];
    	Fakeline + = line[1];
    	String path = Dir.getabsolutepath (). substring (Basedir.getabsolutepath (). Length ()); StringBuilder info = new StringBuilder (). Append (Path). Append (":"). Append (Fakeline). Append ("(" +realline+) "). App
    	End ("Lines of code in"). Append (Collected.size ()). Append ("files");    	
    	
    GetLog (). info (info.tostring ()); } private void Collectfiles (list<file> collected, File file) throws ioexception{if (File.isfile (
    		) {if (isfiletypeinclude (file)) {collected.add (file);
    		}}else{for (File files:file.listFiles ()) {collectfiles (collected, files); }} private int[] countline (file file) throws ioexception{BufferedReader reader = new Buff
    	Eredreader (new FileReader (file));
    	int realline = 0;
    			try{while (Reader.ready ()) {reader.readline ();
    		Realline + +;
}}finally{    		Reader.close ();
    	int fakeline = (int) (Realline * getratio (file));
    	Realtotal + = Realline;
    	
    	Faketotal + = Fakeline; StringBuilder info = new StringBuilder (). Append (File.getname ()). Append (":"). Append (Fakeline). Append ("(" +realline+ "
    	). Append ("lines");
    	
    	GetLog (). Debug (Info.tostring ());
    return new Int[]{realline, fakeline};
    	Private double getratio (file file) {double ratio = 1.0;
    	String type = getfiletype (file);
    	if (Ratiomap.containskey (type)) {ratio = Ratiomap.get (type);
    return ratio;
    	Private Boolean isfiletypeinclude (file file) {Boolean result = false;
    	String fileType = getfiletype (file);    		
    	if (fileType!= null && ratiomap.keyset (). Contains (Filetype.tolowercase ())) {result = true;
    return result;
    	private string Getfiletype (file file) {string result = NULL; String fname = File.getnamE ();
    	int index = Fname.lastindexof (DOT);
    		if (Index > 0) {String type = fname.substring (index+1);
    	result = Type.tolowercase ();
    return result;
     }

Note here annotationUse, such as @parameter expression= "${project.build.sourcedirectory}" automatically assigns the project source code path to the SourceDir variable.

Pay special attention to @goalthat each plug-in can have multiple targets, which you need to use when using the MVN command. Goal perform

You can use the MVN clean install to install the custom plug-in to the local repository.

MVN clean Install

Then, in the project directory where statistics are required, you can count lines of code by calling the following command:

MVN Com.alpha.wang:maven-statis-plugin:0.0.1-snapshot:count

After the last colon is the @goal defined above.

Obviously, this command is too long and inconvenient to use and can be configured in Settings.xml as follows:

	<pluginGroups>
		<pluginGroup>com.alpha.wang</pluginGroup>
	</pluginGroups>

Such an order may be abbreviated as:

MVN Statis:count

provide configuration points

The mojo includes, ratios variable is marked as @parameter, indicating that the user can configure the field in Pom.xml, for example by adding the following to the pom.xml of the target project:

	<build>
		<plugins>
		    <plugin>
				<groupId>com.alpha.wang</groupId>
				<artifactId>maven-statis-plugin</artifactId>
				<version>0.0.1-SNAPSHOT</version>
				<configuration>
					<includes>
					   <!--include>java</include-->
					   <include >properties</include>
					</includes>
					<ratios>
					   <ratio>1.5</ratio>
					</ratios>
				</configuration>
			</plugin>

When you run MVN Statis:count on the project, you will only be able to statistic the properties file and *1.5 the code quantity.

D:\>MVN statis:count
[INFO] scanning for projects ...
[INFO] searching repository for plugin with prefix: ' Statis '.
[INFO]------------------------------------------------------------------------
[info] building com ....
[info]    task-segment: [Statis:count]
[INFO]--------------------------------------------- ---------------------------
[INFO] [statis:count]
[info] \src\main\java:0 (0) lines of code in 0 FILES
[info] \src\main\resources:18 (a) lines of code in 1 files
[info] Total lines:18 ()
[INFO]------- -----------------------------------------------------------------
[INFO] Build successful
[INFO]---------- --------------------------------------------------------------
[INFO] Total time: < 1 second
[INFO] Finished At:tue Feb 17:11:22 CST 2013
[info] Final memory:6m/215m
[INFO]------------------------------------ ------------------------------------

binding Plug-ins

So every time you have to manually execute the command to count the amount of code. We can bind plug-ins to a certain stage of the lifecycle, such as the install phase, so that the amount of code is automatically counted whenever the project is install.

Modify the Pom file for the target item, and note the

	<build>
		<plugins>
		        <plugin>
				<groupId>com.alpha.wang</groupId>
				<artifactId>maven-statis-plugin</artifactId>
				<version>0.0.1-SNAPSHOT</version>
				<configuration>
					<includes>
					   <include>java</include>
					   <include> properties</include>
					</includes>
					<ratios>
					   <ratio>1.0</ratio>
					   <ratio>0.5</ratio>
                                        </ratios>
				</configuration>
				<executions>
					<execution>
						<id>count line number</id>
						<phase>install</phase>
						<goals>
							<goal>count</goal>							
						</goals>
					</execution>
				</ Executions>
			</plugin>