<p>「インターセプターのクラスを作るの面倒くさいなぁ・・・Laravelだったらartisanコマンドでやってくれそうなのに、ほんとSpringって使えねーな」</p>
<p>と思ったそこのあなた、自動生成タスクを作成してLaravelのartisanコマンドのようにクラスを自動生成しましょう。</p>
<p>この記事は過去記事のおさらいです。もう一回同じことやれと言われたら自信がありません。。なので順番にゆっくりと落ち着いて書いていきます。</p>
<p><a href="/posts/p1294">リンク</a></p>
<h2>buildSrcプロジェクトの作成</h2>
<p>ビルドスクリプトで使いたいソースを格納していきます。Gradleは自動的にクラスを読み込んでクラスパスに追加してくれます。</p>
<p>projectroot/buildSrcとなるようにフォルダを作成します。ここには実際の処理を記載するgroovyスクリプトを置いていきます。</p>
<p>build.gradleを作成して以下のように記載します</p>
<div class="remark-highlight"><pre class="language-JSON"><code class="language-JSON">buildscript {
    ext {
        springBootVersion = &#x26;quot;2.0.6.RELEASE&#x26;quot;
        groovyVersion = &#x26;quot;2.5.3&#x26;quot;
    }
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath &#x26;quot;org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}&#x26;quot;
    }
}

apply plugin: &#x26;#39;groovy&#x26;#39;
apply plugin: &#x26;quot;io.spring.dependency-management&#x26;quot;

repositories {
    mavenLocal()
    mavenCentral()
}
dependencyManagement {
    imports {
        mavenBom org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES
    }
}
dependencies {
    implementation gradleApi()
    implementation localGroovy()
    implementation &#x26;quot;org.apache.commons:commons-lang3&#x26;quot;
    implementation &#x26;quot;org.thymeleaf:thymeleaf&#x26;quot;
}</code></pre></div>
<p>次にbuildSrcのsrc/main/groovyを作成します。groovyはgradle source setsから選択します。(青色のフォルダマークになります）</p>
<p><img src="/3149/1.png" alt="画像"></p>
<p>ArtisanPluginとArtisanTaskというGroovyClassをcom.volkrussというパッケージに作成します。</p>
<p><img src="/3149/2.png" alt="画像"></p>
<p>それぞれ以下のよう記載します</p>
<div class="remark-highlight"><pre class="language-rs"><code class="language-rs">package com.volkruss

import org.gradle.api.DefaultTask
import org.gradle.api.tasks.TaskAction

class ArtisanTask extends DefaultTask {
    @TaskAction
    def doTask(){
        println(&#x26;quot;fire artisan command.&#x26;quot;)
    }
}</code></pre></div>
<ul>
<li>DefaultTaskを継承します</li>
<li>タスクとして行う内容の詳細を記載します。
<ul>
<li>今回はログにfire artisan command.と出力するだけのタスクを定義しています</li>
</ul>
</li>
<li>メソッド名のdoTaskはお好きなメソッド名でも構いません</li>
</ul>
<div class="remark-highlight"><pre class="language-rs"><code class="language-rs">package com.volkruss

import org.gradle.api.Plugin
import org.gradle.api.Project

class ArtisanPlugin implements Plugin&#x26;lt;Project&#x26;gt;{
    @Override
    void apply(Project project) {
        project.task(&#x26;quot;This is Task Name&#x26;quot;, type: ArtisanTask)
    }
}</code></pre></div>
<ul>
<li>Pluginを実装します
<ul>
<li>これによってプラグインとして認識されます</li>
</ul>
</li>
<li>applyメソッドで行うのは実行するタスクの設定です
<ul>
<li>This is Task Nameというタスクを定義して、その実装は先ほど作成したArtisanTaskになります</li>
</ul>
</li>
</ul>
<p>次にルートプロジェクトのbuild.gradleにプラグインの有効化を設定しておきます。先ほど作成したプラグインクラスをインポートして有効化します</p>
<div class="remark-highlight"><pre class="language-rs"><code class="language-rs">import com.volkruss.ArtisanPlugin
....(省略)
apply plugin: ArtisanPlugin</code></pre></div>
<p>ここでGradleProjectの更新を行うと先ほど登録したタスクが表示されます</p>
<p><img src="/3149/3.png" alt="画像"></p>
<p>Tasks/otherに先ほど登録した”This is Task Name”というタスクが作成されていますこれを実行すると定義したログが出力されます</p>
<p><img src="/3149/4.png" alt="画像"></p>
<p>しかしこんな変な名前のタスクは嫌なのでタスク名を変更します</p>
<div class="remark-highlight"><pre class="language-rs"><code class="language-rs">package com.volkruss

import org.gradle.api.Plugin
import org.gradle.api.Project

class ArtisanPlugin implements Plugin&#x26;lt;Project&#x26;gt;{
    @Override
    void apply(Project project) {
        project.task(&#x26;quot;artisan&#x26;quot;, type: ArtisanTask)
    }
}</code></pre></div>
<p>これで更新をするといい感じです</p>
<p><img src="/3149/5.png" alt="画像"></p>
<h2>コマンドラインから実行して引数を受け取る</h2>
<p>コマンドラインからも実行できるのでやってみます</p>
<p>gradle タスク名で実行できます。</p>
<div class="remark-highlight"><pre class="language-unknown"><code class="language-unknown">PS D:\work\automake\automake&#x26;gt; gradle artisan

&#x26;gt; Task :artisan
fire artisan command.
</code></pre></div>
<p>gradleがインストールされていない場合は付属のgradlewを使えます。</p>
<div class="remark-highlight"><pre class="language-unknown"><code class="language-unknown">PS D:\work\automake\automake&#x26;gt; .\gradlew artisan

&#x26;gt; Task :artisan
fire artisan command.
</code></pre></div>
<p>次に引数を渡します。引数は-Pオプションにkey=と続けることで渡すことが可能なので、引数を受け取ってログに出力してみます。</p>
<div class="remark-highlight"><pre class="language-rs"><code class="language-rs">package com.volkruss

import org.gradle.api.DefaultTask
import org.gradle.api.tasks.TaskAction

class ArtisanTask extends DefaultTask {
    @TaskAction
    def doTask(){
        println(&#x26;quot;fire artisan command.&#x26;quot;)
        if(!project.hasProperty(&#x26;quot;title&#x26;quot;)){
            println(&#x26;quot;引数 title が設定されていません&#x26;quot;)
            return
        }
        println(&#x26;quot;受け取った引数は&#x26;quot; + project.title.toString())
        println(&#x26;quot;--------end-------&#x26;quot;)
    }
}</code></pre></div>
<div class="remark-highlight"><pre class="language-unknown"><code class="language-unknown">3 actionable tasks: 3 executed
PS D:\work\automake\automake&#x26;gt; gradle artisan -Ptitle=Rust

&#x26;gt; Task :artisan
fire artisan command.
受け取った引数はRust
--------end-------
</code></pre></div>
<p>※ちなみにnameという引数を使うと自動的にプロジェクト名が入ってきます。</p>
<h2>設定ファイルから値の読み込み</h2>
<p>設定ファイルから値を読み取って利用してみます</p>
<p>まずは設定ファイルを作成します。ArtisanExtensionというGroovy Classを作成します</p>
<div class="remark-highlight"><pre class="language-rs"><code class="language-rs">package com.volkruss

class ArtisanExtension {
    public String fullName = &#x26;quot;kamijo toma&#x26;quot;
}</code></pre></div>
<p>タスクからproject.extensions.findByType(Class)を利用することで設定クラスの値を利用することができます</p>
<p>しかしプラグイン側でもエクステンションの利用について設定してあげる必要がありますのでやってみます。</p>
<div class="remark-highlight"><pre class="language-rs"><code class="language-rs">package com.volkruss

import org.gradle.api.Plugin
import org.gradle.api.Project

class ArtisanPlugin implements Plugin&#x26;lt;Project&#x26;gt;{
    @Override
    void apply(Project project) {
        project.extensions.create(&#x26;quot;artisan&#x26;quot;,ArtisanExtension)
        project.task(&#x26;quot;artisan&#x26;quot;, type: ArtisanTask)
    }
}</code></pre></div>
<p>これを利用するには以下のようにします</p>
<div class="remark-highlight"><pre class="language-rs"><code class="language-rs">class ArtisanTask extends DefaultTask {
    @TaskAction
    def doTask(){
        def ext = project.extensions.findByType(ArtisanExtension)
        println(ext.fullName)
    }
}</code></pre></div>
<div class="remark-highlight"><pre class="language-unknown"><code class="language-unknown">&#x26;gt; Task :artisan
kamijotoma
</code></pre></div>
<h2>インターセプタークラスのテンプレートファイルを作成する</h2>
<p>次にテンプレートとなるテキストファイルを作成します。これはresourcesフォルダを作成してtemplates.srcフォルダにtxtファイルを作成します</p>
<p><img src="/3149/6.png" alt="画像"></p>
<p>今回はInterceptor.txtというファイルを作成して内容を以下のようにしました</p>
<div class="remark-highlight"><pre class="language-java"><code class="language-java"></code></pre></div>

Springにはartisanコマンドがない？ならファイル自動生成タスクを作成する