Spring Initializrをハックする-カスタマイズを通してその内部実装を覗く

© 2019 NTT DATA Corporation
2019/11/15 日本Springユーザ会主催 Spring One 2019報告会
株式会社NTTデータシステム技術本部齊加匠
Spring Initializrをハックする
-カスタマイズを通してその内部実装を覗く

© 2019 NTT DATA Corporation 2
｛
“name”: {
“ja”: “齊加匠”,
”en”: “SAIKA TAKUMI”,
},
“company”: “NTTDATA”,
“favorites”: [“Arch Linux”, “Golang”, “Neovim”],
“github”: “takumi34”,
“twitter”: “@Untergrund_idol”,
“blog”: “takumi34.github.io”,
}
自己紹介

現地での写真
NTTデータの出展ブース

話すこと
Spring Initializrの
カスタマイズについて

「Creating “The Second Best Place on the Internet”
with Spring Initializr」
Stéphane Nicoll
https://content.pivotal.io/slides/creating-the-second-best-place-on-the-internet-
with-spring-initializr
https://github.com/snicoll/demo-custom-initializr
聴講したセッション

1.軽い紹介
2.歴史
3.カスタマイズ
もくじ

© 2019 NTT DATA Corportion 7
第一部

Spring Initializr

Web, IDE, CLIなどのクライアントから
Spring Bootのプロジェクトを
生成できるツール
Spring Initializr

WEB UI
https://start.spring.io/

start.spring.io
https://github.com/spring-io/start.spring.io

Initializr
https://github.com/spring-io/initializr

Spring Initializr
の軽い説明

例

Webだと

https://start.spring.io/

コマンドライン
でも出来る

➜ curl https://start.spring.io/starter.tgz -d dependencies=web | tar -xzvf –
➜ tree
.
├── HELP.md
├── mvnw
├── mvnw.cmd
├── pom.xml
└── src
├── main
│ ├── java
│ │ └── com
│ │ └── example
│ │ └── demo
│ │ └── DemoApplication.java
│ └── resources
│ ├── application.properties
│ ├── static
│ └── templates
└── test
└── java
└── com
└── example
└── demo
└── DemoApplicationTests.java
14 directories, 7 files
Curlだと

IDEでも出来る

IntelliJ IDEA Ultimateだと

ちなみに
Spring Boot CLIでも

ここまでは
ちょっとした紹介

第二部

歴史

２０１３誕生

Initializr
e

Initializr

最初は簡単なgroovy script
https://content.pivotal.io/slides/creating-the-second-best-place-on-the-internet-with-spring-initializr

• Terminal Support
– Spring Boot CLI (March 2014)
– CURL, HTTP (Jan 2015)
• IDE
– STS, IntelliJ IDEA (March 2015)
– Netbeans (May 2016)
– VSCode (Jan 2018)
Supportの広がり

Spring Initializr
の凄さ

Spring Bootの
エコシステムを
形成

一か月で世界で
１M以上の
ダウンロード

すごい！

第三部

カスタマイズの
話

そもそもカスタマイズし
て何がうれしい？

例えば
こんなことが出来る

• UIの変更
• パッケージのオプションの変更
• デフォルトの依存関係の変更
• 3rd partyの依存関係の追加
• .gitignoreの変更やREADMEの追加
など
カスタマイズの例

実際に
カスタマイズして
いる事例

https://github.com/ssherwood/presentations/blob/master/springone-2016/easy-
microservices/initializr-guide.adoc
↑内容はちょっと古い
https://www.slideshare.net/SpringCentral/easy-consumption-of-microservices
Spring One 2016の発表

まずはInitializr
の中身見てみる

https://github.com/spring-io/initializr

旧新（2019年2月から）
https://spring.io/blog/2019/02/20/what-s-new-with-spring-initializr

複雑になってる

なんで？

時は2017年に遡る
https://github.com/spring-io/initializr/issues/340

今までもInitializrをカスタマイズす
ることは可能だった

しかし、libraryをforkして変更しな
ければならなかった

2019年10月に
Spring Initializr 0.8.0がリリースされた

Spring Initializr 0.8 brings a complete rewrite of the project
generation API with dedicated abstractions for common assets of
JVM-based projects.
（中略）
This should make the creation of a custom instance easier than
ever!
Spring Initializr 0.8.0リリースの目玉
https://spring.io/blog/2019/10/14/spring-initializr-0-8-0-available-now

• BuildCustomizer to add dependencies, plugins
or other configuration items
• ProjectContributor, a high-level hook-point to
add assets to a directory structure
https://spring.io/blog/2019/02/20/what-s-new-with-spring-initializr
新たに追加されたAPI

これがあると何
がうれしい？

実際に自分
で使ってカスタ
マイズしてみた

セッションとは
違うカスタマイ
ズ

まずは
依存関係に追記

dependencies {
implementation ("org.springframework.boot:spring-boot-starter-web“)
implementation("io.spring.initializr:initializr-web")
implementation("io.spring.initializr:initializr-generator-spring")
}
dependencyManagement {
imports {
mavenBom "io.spring.initializr:initializr-bom:0.8.0.RELEASE"
}
}
build.gradle

dependencies {
implementation ("org.springframework.boot:spring-boot-starter-web“)
implementation("io.spring.initializr:initializr-web")
implementation("io.spring.initializr:initializr-generator-spring")
}
dependencyManagement {
imports {
mavenBom "io.spring.initializr:initializr-bom:0.8.0.RELEASE"
}
}
build.gradle
BOM(a Bill of Materials)

これでlocalhost:8080ア
クセスすると

jsonが出る

IntelliJ IDEAなどでlocalhost:8080にアクセスするとやりやすい

次は
BuildCustomizer
ProjectContributer
を使ってみる

io.spring.initializr.generator.project.ProjectGenerationConfiguration=＼
com.chika.custominitializr.contributer.SampleProjectGenerationConfiguration
spring.factoriesにパス記載

io.spring.initializr.generator.project.ProjectGenerationConfiguration=＼
com.chika.custominitializr.contributer.SampleProjectGenerationConfiguration
spring.factoriesにパス記載
自動でコンポーネントスキャンされるわけじゃないの
で、spring.factoriesで登録する必要あり

@ProjectGenerationConfiguration
public class SampleProjectGenerationConfiguration {
@Bean
public BannerContributor bannerContributor() {
return new BannerContributor();
}
@Bean
public BuildCustomizer<MavenBuild> devtoolsContributor () {
return (build) -> build.dependencies().add("devtools",
"org.springframework.boot","spring-boot-devtools", DependencyScope.COMPILE);
}
}
デフォルトの依存関係をカスタマイズ

@Bean
}
@Bean
}
}
このアノテーション

@Bean
}
@Bean
}
}
このアノテーション
依存関係に
devtoolsを追加

実際に
プロジェクトを
生成すると

pom.xmlが変更されている

起動バナーをカスタマイズ
public class BannerContributor implements ProjectContributor {
public void contribute(Path projectRoot) throws IOException {
Path bannerDirectory = projectRoot
.resolve("src/main/resources");
Files.createDirectories(bannerDirectory);
Path file =Files.createFile(bannerDirectory.resolve("banner.txt"));
try (PrintWriter writer = new PrintWriter(Files.newBufferedWriter(file))) {
writer.println(
" _____ _ _ _ ¥n" +
" / ____| | | (_) | | ¥n" +
" | | | |__ _ | | __ __ _ ¥n" +
" | | | '_ ¥¥ | | | |/ / / _` |¥n" +
" | |____ | | | | | | | < | (_| |¥n" +
" ¥¥_____| |_| |_| |_| |_|¥¥_¥¥ ¥¥__,_|¥n"
);
}
}
}

実際に
プロジェクトを
生成すると

起動バナーが変更されている

他にも

例えばapplication.ymlに
こう書くと

initializr:
dependencies:
- name: Web
content:
- name: Web
id: web
description: webだよ！！！
types:
- name: Maven Project
id: maven-project
description: mvn
tags:
build: maven
format: project
default: true
action: /starter.zip
application.yml
packagings:
- name: Jar
id: jar
default: true
javaVersions:
- id: 11
default: true
languages:
- name: Java
id: java
default: true
- name: Kotlin
id: kotlin
default: false
group-id:
value: org.chika

initializr:
dependencies:
- name: Web
content:
- name: Web
id: web
description: webだよ！！！
types:
- name: Maven Project
id: maven-project
description: mvn
tags:
build: maven
format: project
default: true
action: /starter.zip
application.yml
packagings:
- name: Jar
id: jar
default: true
javaVersions:
- id: 11
default: true
languages:
- name: Java
id: java
default: true
- name: Kotlin
id: kotlin
default: false
group-id:
value: org.chika
Descriptio
nを変更
Defaultも
変えられる
initializrの
namespace
で指定
chika
になってる

STSでプロジェクトを生成しようとすると

STSでプロジェクトを生成しようとすると
Discriptionが
変更されてる

とりあえず
やってみたい方

https://github.com/spring-io/initializr/tree/master/initializr-service-sample

簡単に試せる

Spring Initializr凄い！
まとめ

カスタマイズやってみよ
う！
まとめ

https://github.com/takumi34/custom-spring-initializr
今回使ったコードはここに格納しています

Spring Initializrをハックする-カスタマイズを通してその内部実装を覗く

More Related Content

What's hot

Similar to Spring Initializrをハックする-カスタマイズを通してその内部実装を覗く

More from apkiban

Spring Initializrをハックする-カスタマイズを通してその内部実装を覗く