Groovyには自前でライブラリ解決する機能があります。インターネットに接続されている環境であれば、スクリプトを実行時に足りないライブラリをダウンロードして解決するところまでやってくれます。(@Grabや@Grapes)
それはそれで超便利なのですが、企業内で開発などしているとインターネット接続を制限されている状況も少なくないです。せっかくGroovyで補助ツールなどを書いても、ネット接続が制限される実行環境では使えない、使いにくい、ということも。
そこでGroovyでプログラムを書きつつ、依存するライブラリを同梱した実行可能jarを作成する、というのをMavenプロジェクトでやってみました(ちなみにMaven初心者です)。せっかくなのでメモを残しておこうと思います。
<?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.nttd-teranos.teranos5.websh</groupId>
<artifactId>groovy-maven-sample</artifactId>
<version>1.0-SNAPSHOT</version>
<name>groovyでmavenのサンプル</name>
<packaging>jar</packaging>
<description>groovyでmavenのサンプル</description>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<java.version>1.6</java.version>
</properties>
<build>
<plugins>
<!-- Antプラグインでコンパイルする -->
<plugin>
<groupId>info.komina</groupId>
<artifactId>maven-antrun-plugin</artifactId>
<executions>
<execution>
<id>compile</id>
<phase>compile</phase>
<configuration>
<tasks>
<mkdir dir="${basedir}/src/main/groovy" />
<taskdef name="groovyc"
classname="org.codehaus.groovy.ant.Groovyc">
<classpath refid="maven.compile.classpath"/>
</taskdef>
<mkdir dir="${project.build.outputDirectory}" />
<groovyc destdir="${project.build.outputDirectory}"
srcdir="${basedir}/src/main/groovy/"
listfiles="true">
<classpath refid="maven.compile.classpath" />
</groovyc>
</tasks>
</configuration>
<goals>
<goal>run</goal>
</goals>
</execution>
<execution>
<id>test-compile</id>
<phase>test-compile</phase>
<configuration>
<tasks>
<mkdir dir="${basedir}/src/test/groovy" />
<taskdef name="groovyc"
classname="org.codehaus.groovy.ant.Groovyc">
<classpath refid="maven.test.classpath"/>
</taskdef>
<mkdir dir="${project.build.testOutputDirectory}" />
<groovyc destdir="${project.build.testOutputDirectory}"
srcdir="${basedir}/src/test/groovy/"
listfiles="true">
<classpath refid="maven.test.classpath" />
</groovyc>
</tasks>
</configuration>
<goals>
<goal>run</goal>
</goals>
</execution>
</executions>
</plugin>
<!-- 依存関係をまとめた実行可能jarを作成する -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-assembly-plugin</artifactId>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>single</goal>
</goals>
</execution>
</executions>
<configuration>
<descriptorRefs>
<descriptorRef>jar-with-dependencies</descriptorRef>
</descriptorRefs>
<archive>
<manifest>
<!-- 実行するクラスを指定する -->
<mainClass>App1</mainClass>
</manifest>
</archive>
</configuration>
</plugin>
<!-- テスト時の文字化け対策 -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<version>2.12.4</version>
<configuration>
<junitArtifactName>junit:junit</junitArtifactName>
<argLine>-Dfile.encoding=UTF-8</argLine>
<skipTests>false</skipTests>
</configuration>
</plugin>
</plugins>
</build>
<dependencies>
<!-- 使用するバージョンのGroovyを指定する -->
<dependency>
<groupId>org.codehaus.groovy</groupId>
<artifactId>groovy-all</artifactId>
<version>2.4.20</version>
</dependency>
<!-- Groovyでテストを記述する用 -->
<dependency>
<groupId>org.spockframework</groupId>
<artifactId>spock-core</artifactId>
<version>1.3-groovy-2.4</version>
<scope>test</scope>
</dependency>
</dependencies>
</project>
./src/main/groovy | 主処理のスクリプトを置く場所。 |
./src/test/groovy | テスト用のスクリプトを置く場所。 |
./target/ | コンパイルすると自動作成されるフォルダ。コンパイル結果やjarはここに出力される。 |
下記コマンドで、コンパイル、テスト、jar作成まで行ってくれます。
> maven package
出来上がったjarは下記のようにして実行します。
> java -jar groovy-maven-sample-1.0-SNAPSHOT-jar-with-dependencies.jar
Mavenでのコンパイルについては下記サイトを参照しました。
The Apache Groovy programming language – groovyc – the Groovy compiler
https://groovy-lang.org/groovyc.html
5. Maven integration
依存しているライブラリを同梱した実行可能jarの作り方は下記サイトを参考にしました。
Mavenで実行可能なJARファイルを作成
https://yhayashi30.org/java/maven-create-jar-file/
Groovyのテスト方法については下記サイト。
mavenプロジェクトでJUnitとSpockを実行する | BLOG TRECH
https://blog.trech.co.jp/maven%e3%83%97%e3%83%ad%e3%82%b8%e3%82%a7%e3%82%af%e3%83%88%e3%81%a7junit%e3%81%a8spock%e3%82%92%e5%ae%9f%e8%a1%8c%e3%81%99%e3%82%8b/
ユニットテスト – Apache Groovyチュートリアル
https://koji-k.github.io/groovy-tutorial/unit-test/index.html
The Apache Groovy programming language – Testing guide
https://groovy-lang.org/testing.html#_testing_with_spock