Maven Plugin Nasıl Geliştirilir?

Merhaba arkadaşlar, bu yazımızda sizlere bir Maven plugin'in nasıl geliştirileceğinden bahsetmek istiyorum.

Apache Maven, Java teknolojileriyle uğraşanların ağırlıklı olarak kullandığı bir ürün. Maven ile projelerinizin bağımlı olduğu JAR paketlerini kolaylıkla yönetebildiğiniz gibi, Plugin desteği sayesinde, çeşitli yaşam döngüsü anlarında istediğiniz aksiyonların koşturulmasını sağlayabiliyorsunuz.

Maven sunucularında halihazırda yazılmış tonlarca eklenti bulunsa da, biz bugün öğretim amacıyla basit bir plugin geliştirmiş olacağız.

Not: Eğer henüz Maven aracının ne olduğuna dair fikriniz yok ise, Apache Maven Teknolojisine Giriş adresindeki başlangıç vidyosunu izlemenizi öneririz.

 

Şimdi herhangi bir Maven çalışma evresinde üretilen bir dosyanın, istenilen bir dizine, istenilen bir evrede, otomatik olarak kopyalanması görevini yürüten bir Maven Plugin projesini beraber geliştirelim.

Gereksinimler

1) pom.xml içerisindeki paketleme biçimi maven-plugin olarak düzenlenir.

<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.kodcu</groupId>
    <artifactId>copy-maven-plugin</artifactId> <!-- Eklenti adı -->
    <version>1.0.0</version>


    <packaging>maven-plugin</packaging> <!-- Dikkat!! -->

</project>

2) maven-plugin-api ve maven-plugin-annotations bağımlılıkları, pom.xml içerisine eklenir.

<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.kodcu</groupId>
    <artifactId>copy-maven-plugin</artifactId>

    <version>1.0.0</version>
    <packaging>maven-plugin</packaging>

    <dependencies>
        <dependency>
            <groupId>org.apache.maven</groupId>
            <artifactId>maven-plugin-api</artifactId>
            <version>3.2.2</version>
        </dependency>
        <dependency>
            <groupId>org.apache.maven.plugin-tools</groupId>
            <artifactId>maven-plugin-annotations</artifactId>
            <version>3.3</version>
            <scope>provided</scope>
        </dependency>
    </dependencies>

</project>

Bir Maven Plugin geliştirebilmek için, pom.xml üzerinde asgari ölçekte 1. ve 2. numaralı düzenleme yeterli olmaktadır.

Mojo Tanımlayın

Mojo, "Maven Old Java Object" ifadesinin kısaltılmış halidir. Maven ekosisteminde bir nesnenin Mojo kabül edilebilmesi için Mojo arayüzüne erişmesi gerekmektedir. Mojo sınıfların konfigürasyonu için ise @Mojo isimli notasyon kullanılmaktadır.

public interface Mojo {

    String ROLE = Mojo.class.getName();

    void execute() throws ...;

    void setLog( Log log );

    Log getLog();
}

Mojo arayüzü oldukça basittir. Maven ortamında tanımlanan bir Mojo sınıfı, bir Maven golüne denk gelmektedir. "goal" ise Maven ortamında koşturulacak bir görevin isim olarak temsili halidir. Koşturulması istenen görev veya görevler ise, mevcut Mojo nesnesinin execute() metodunda koşturulmaktadır.

Şimdi kopyalama golünü yürütecek bir Mojo sınıfını tanımlayalım.

@Mojo(name = "copy")
public class Copier extends AbstractMojo {

@Parameter
private String sourcePath;

@Parameter
private String targetPath;

@Override
public void execute() throws ... {

 Path source = Paths.get(sourcePath);
 Path target = Paths.get(targetPath).resolve(source.getFileName());

 getLog().info("*** Copying Started ***");
	
 Files.copy(source, target, StandardCopyOption.REPLACE_EXISTING);
	
 getLog().info("*** Copying Completed ***");

 }
}

Copier sınıfı, sourcePath ve targetPath isimli iki parametreye ihtiyaç duymaktadır. Bu parametreler copy-maven-plugin eklentisini kullanan projelerin pom.xml dosyalarında bir XML elemanı olarak deklare edilmesi gerekmektedir.

Maven eklenti geliştirirken, bir parametre tanımlamak için, Mojo sınıfı içerisindeki global alanın başına @Parameter notasyonu getirilmelidir.

@Mojo notasyonunun "name" alanı ise, Mojo sınıfına karşılık gelen golün ismini belirtmektedir. "copy" golünün hedefi ise, execute() metodu içerisindeki kopyalama işleminin koşturulmasıdır.

Maven Plugin Hazır

Bu adımlar sonunda basit bir Maven Plugin'i oluşturulmuş oldu. Daha detaylı bilgiler için Guide to Development Maven Plugin başlıklı dökümanı okumanızı önermekteyim.

copy-maven-plugin 'in İnşa Edilmesi

$ mvn clean install

"mvn clean install" komut girdisi, pom.xml'in bulunduğu dizinde koşturulduğunda, lokal maven deponuzda plugin'in paketlenmiş halini görebilirsiniz.

Lokal maven deposu <UserHome>/.m2/repository dizininde yer almaktadır. Örneğin şuanki çalışma ortamımda copy-maven-plugin aşağıdaki dizinde yer almaktadır.

C:Usersusta.m2repositorycomkodcucopy-maven-plugin1.0.0

Dizin içerisinde ise eklentinin çıktılarını görebiliriz.

copy-maven-plugin 'in Kullanılması

Eklenti lokal depoya yansıtıldığına göre artık kendi projelerimizde copy-maven-plugin' i kullanabiliriz. Kullanım için, eklenti projenizin pom.xml dosyasına tanımlanmalıdır.

<plugin>
<groupId>com.kodcu</groupId>
<artifactId>copy-maven-plugin</artifactId>
<version>1.0.0</version>
<configuration>
  <sourcePath>${project.build.directory}/${project.name}-${project.version}.war</sourcePath>
  <targetPath>E:apache-tomcat-8.0.8webapps</targetPath>
</configuration>
<executions>
 <execution>
   <phase>package</phase> <!-- war sonrasında -->
   <goals>
	 <goal>copy</goal> <!-- kopyala -->
   </goals>	
 </execution>
</executions>
</plugin>

copy-maven-plugin'in kullanım örneğini yukarıdaki kod parçasında görebilmekteyiz. sourcePath ve targetPath parametreleri Mojo içerisinde tanımlandığı üzere, burada da konfigüre edilmiştir. sourcePath projenin target dizinindeki war çıktısının adresini gösterirken, targetPath ise, sistem üzerinde yer alan Tomcat sunucusunun webapps isimli dizinini referans almaktadır.

Copier mojosunun golü "copy" dir, ve kopyalama işleminin ne zaman yapılacağı ise, "phase" elemanı içerisinde tanımlanmıştır. Kısacası, war paketlemesi yapıldığında, "copy" golü koşturulmaktadır. "copy" golü burada "package" evresinde koşturulmaktadır fakat, Maven ortamında tanımlı herhangi bir evre de, ihtiyacınıza binaen kullanılabilecektir. Diğer evreler için http://maven.apache.org/guides/introduction/introduction-to-the-lifecycle.html adresini takip edebilirsiniz.

Kaynak kod

Kaynak kod ve uygulama örneğine aşağıdaki bağlantıdan erişebilirsiniz.

Tekrar görüşmek dileğiyle.