Spring Boot の auto-configuration の作り方

バージョン情報

  • Spring Boot 1.4.2.RELEASE

作り方

auto-configuration の作成方法は、リファレンスの 43. Creating your own auto-configuration に書かれています。

リファレンスの説明にある通り、spring-boot-autoconfigure と spring-boot-starter の2つのモジュールを作成することが推奨されていますが、 spring-boot-starter だけにすることもできると書かれていますので、GitHub に demo-spring-boot-starter を作成して試してみました。

demo-spring-boot-starter に DemoAutoConfiguration クラスを作成し、META-INF/spring.factories を次の内容で作成しています。

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
jp.pigumer.boot.autoconfigure.DemoAutoConfiguration

JAXB の Marshaller

JAXB の marshal 時に XML 宣言を生成しないようにする

Java SE 6の Javadoc にも記述されていますが、 XML 宣言を出力したくない場合は、プロパティ jaxb.fragment の値を true にします。

jp.pigumer.Data

package jp.pigumer;

import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;

@XmlRootElement
public class Data {

    @XmlElement
    public String elem1;

    @XmlElement
    public String elem2;

}

jp.pigumer.JAXBTest

package jp.pigumer;

import org.junit.Before;
import org.junit.Test;

import javax.xml.bind.*;
import java.io.IOException;
import java.io.StringWriter;

import static org.junit.Assert.*;
import static org.hamcrest.CoreMatchers.*;

public class JAXBTest {

    Marshaller marshaller;

    Data sut;

    @Before
    public void setUp() throws JAXBException {
        sut = new Data();
        sut.elem1 = "test1";
        sut.elem2 = "test2";

        JAXBContext context = JAXBContext.newInstance(Data.class);
        marshaller = context.createMarshaller();
    }

    @Test
    public void defaultMarshallerTest() throws JAXBException, IOException {
        String out;
        try (StringWriter wr = new StringWriter()) {
            marshaller.marshal(sut, wr);
            out = wr.toString();
        }
        assertThat(out, is(not(nullValue())));
        System.out.println("default: " + out);
    }

    @Test
    public void fragmentMarshallerTest() throws JAXBException, IOException {
        marshaller.setProperty(Marshaller.JAXB_FRAGMENT, true);

        String out;
        try (StringWriter wr = new StringWriter()) {
            marshaller.marshal(sut, wr);
            out = wr.toString();
        }
        assertThat(out, is(not(nullValue())));
        System.out.println("fragment: " + out);
    }
}

実行結果

fragment: <data><elem1>test1</elem1><elem2>test2</elem2></data>
default: <?xml version="1.0" encoding="UTF-8" standalone="yes"?><data><elem1>test1</elem1><elem2>test2</elem2></data>
広告を非表示にする

Gradle の compile で OutOfMemoryError が発生したときにしたこと

stackoverflow の記事を参考に、gradle.build に下のような記述を追加して対応しました。

compileJava {
    options.fork = true
    options.forkOptions.setMemoryMaximumSize("4g")
}

Spring Boot 1.4.1 - Controller

Controller

Thymeleaf については次のリンクを参照してください。

http://www.thymeleaf.org/doc/tutorials/2.1/usingthymeleaf_ja.html

Thymeleaf を Spring Boot で使えるようにするために、build.gradle の dependencies に次の行を追加します。

 compile('org.springframework.boot:spring-boot-starter-thymeleaf')

1. Index

PROJECT_ROOT/src/main/resources/templates/index.html を作成します。

<html xmlns="http://www.w3.org/1999/xhtml"
      xmlns:th="http://www.thymeleaf.org">
  <head>
    <meta charset="UTF-8"/>
    <title th:text="#{title}">TITLE</title>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
  </head>
  <body>
    <p th:text="#{welcome}">WELCOME</p>
  </body>
</html>

PROJECT_ROOT/src/main/resources/messages.properties を作成します。

title=title
welcome=Welcome!!

コントローラを作成します。

package com.example;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;

@Controller
public class IndexController {

    @GetMapping("/")
    public String index() {
        return "index";
    }

}

コントローラのメソッドが返す文字列に .html を付加した templates ディレクトリにあるファイルを Thymeleaf のテンプレートとして使用して、HTML をブラウザに返します。

./gradlew bootRun

で起動して、ブラウザで http://localhost:8080 にアクセスした画面は下のようになります。

f:id:section27:20161025222402p:plain

2. ロケール

デフォルトでは、org.springframework.web.servlet.i18n.AcceptHeaderLocaleResolver を使用して、ブラウザから送られる accept-language を使用したロケールでメッセージが表示されます。

org.springframework.web.servlet.i18n.CookieLocaleResolver, org.springframework.web.servlet.i18n.SessionLocaleResolver, org.springframework.web.servlet.i18n.FixedLocaleResolver を使用した、クッキー、セッション、固定といったあらかじめ用意された LocaleResolver を使用することもできます。

ここでは独自の LocaleResolver を作成して日本語(osaka_JP)になるようにしてみます。

package com.example;

import org.springframework.web.servlet.LocaleResolver;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.Locale;

public class OsakaLocaleResolver implements LocaleResolver {

    @Override
    public Locale resolveLocale(HttpServletRequest request) {
        return new Locale("osaka", "JP");
    }

    @Override
    public void setLocale(HttpServletRequest request, 
            HttpServletResponse response,
            Locale locale) {
        throw new UnsupportedOperationException("unsupported");
    }
}
package com.example;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;

@SpringBootApplication
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }

    @Bean
    OsakaLocaleResolver localeResolver() {
        return new OsakaLocaleResolver();
    }
}

PROJECT_ROOT/src/main/resources/messages_osaka.properties を作成します。

title=タイトル
welcome=大阪にようこそ

実行して、http://localhost:8080 にアクセスしてみます。

./gradlew bootRun

f:id:section27:20161025222418p:plain

Spring Boot 1.4.1 - RestController

1. Hello World

コントローラクラスを作成します。

最初にテストを記述します。

package com.example;

import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.web.client.TestRestTemplate;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.test.context.junit4.SpringRunner;

import static org.hamcrest.CoreMatchers.is;
import static org.junit.Assert.assertThat;

@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public class DemoApplicationTests {

    @Autowired
    TestRestTemplate template;

    @Test
    public void contextLoads() {
        ResponseEntity<String> res = template.getForEntity("/", String.class);
        assertThat(res.getStatusCode(), is(HttpStatus.OK));
        assertThat(res.getBody(), is("Hello World!!"));
    }

}

次に、IndexControllerを作成します。

package com.example;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class IndexController {

    @GetMapping("/")
    public String index() {
        return "Hello World!!";
    }
}

REST のコントローラには、@RestController アノテーションを使ってクラスを作成します。 コントローラのメソッドには URL のマッピングを設定します。 ここで使用している GetMapping 以外に、PostMapping や、PutMpping、DeleteMapping 等があります。

最初のステップでは、Hello World!! という文字列を返しました。

2. コントローラのメソッドの引数

コントローラのメソッドは、HttpServletRequest や HttpServletResponse やその他さまざまなオブジェクトを受け取ることができます。

package com.example;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.Objects;

@RestController
public class IndexController {

    @GetMapping("/")
    public String index(HttpServletRequest req, HttpServletResponse res) {
        Objects.nonNull(req);
        Objects.nonNull(res);
        return "Hello World!!";
    }
}

3. PathVariable

URLパスの変数の値を受け取ることができます。

package com.example;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class IndexController {

    @GetMapping("/{id}")
    public String index(@PathVariable String id) {
        return "ID: " + id;
    }
}
package com.example;

import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.web.client.TestRestTemplate;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.test.context.junit4.SpringRunner;

import static org.hamcrest.CoreMatchers.is;
import static org.junit.Assert.assertThat;

@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public class DemoApplicationTests {

    @Autowired
    TestRestTemplate template;

    @Test
    public void contextLoads() {
        ResponseEntity<String> res = template.getForEntity("/123", String.class);
        assertThat(res.getStatusCode(), is(HttpStatus.OK));
        assertThat(res.getBody(), is("ID: 123"));
    }

}

4. Request パラメータ

Request パラメータを受け取ることももちろんできます。

package com.example;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class IndexController {

    @GetMapping("/foo")
    public String index(@RequestParam String id) {
        return "ID: " + id;
    }
}
package com.example;

import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.web.client.TestRestTemplate;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.test.context.junit4.SpringRunner;

import static org.hamcrest.CoreMatchers.is;
import static org.junit.Assert.assertThat;

@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public class DemoApplicationTests {

    @Autowired
    TestRestTemplate template;

    @Test
    public void contextLoads() {
        ResponseEntity<String> res = template.getForEntity("/foo?id=bar", String.class);
        assertThat(res.getStatusCode(), is(HttpStatus.OK));
        assertThat(res.getBody(), is("ID: bar"));
    }

}

ModelAttribute

Request パラメータが多い場合等は、ModelAttribute を使って、Request パラメータの値が設定されたオブジェクトを受け取ることができるようにすることができます。

package com.example;

public class Foo {

    private String id;

    public void setId(String id) {
        this.id = id;
    }

    public String getId() {
        return id;
    }
}
package com.example;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class IndexController {

    @GetMapping("/foo")
    public String index(@ModelAttribute Foo foo) {
        return "ID: " + foo.getId();
    }
}
package com.example;

import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.web.client.TestRestTemplate;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.test.context.junit4.SpringRunner;

import static org.hamcrest.CoreMatchers.is;
import static org.junit.Assert.assertThat;

@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public class DemoApplicationTests {

    @Autowired
    TestRestTemplate template;

    @Test
    public void contextLoads() {
        ResponseEntity<String> res = template.getForEntity("/foo?id=bar", String.class);
        assertThat(res.getStatusCode(), is(HttpStatus.OK));
        assertThat(res.getBody(), is("ID: bar"));
    }

}

5. HandlerMethodArgumentResolver

HandlerMethodArgumentResolver の実装クラスを作成して、任意のオブジェクトをコントローラのメソッドで受け取ることができるようにすることができます。 Spring Security を使ってログインしているユーザの Principal をコントローラで受け取る場合などこの仕組みが多く使用されています。

package com.example;

public class Foo {

    public final String foo = "foo";

}
package com.example;

import org.springframework.core.MethodParameter;
import org.springframework.web.bind.support.WebDataBinderFactory;
import org.springframework.web.context.request.NativeWebRequest;
import org.springframework.web.method.support.HandlerMethodArgumentResolver;
import org.springframework.web.method.support.ModelAndViewContainer;

public class FooHandlerMethodArgumentResolver implements HandlerMethodArgumentResolver {

    @Override
    public boolean supportsParameter(MethodParameter parameter) {
        return Foo.class.isAssignableFrom(parameter.getParameterType());
    }

    @Override
    public Object resolveArgument(MethodParameter parameter, 
                                  ModelAndViewContainer mavContainer,
                                  NativeWebRequest webRequest,
                                  WebDataBinderFactory binderFactory)
            throws Exception {
        return new Foo();
    }
}
package com.example;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.method.support.HandlerMethodArgumentResolver;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;

import java.util.List;

@SpringBootApplication
public class DemoApplication extends WebMvcConfigurerAdapter {

    @Override
    public void addArgumentResolvers(
            List<HandlerMethodArgumentResolver> argumentResolvers) {
        argumentResolvers.add(new FooHandlerMethodArgumentResolver());
    }

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}
package com.example;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class IndexController {

    @GetMapping("/")
    public String index(Foo foo) {
        return foo.foo;
    }
}
package com.example;

import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.web.client.TestRestTemplate;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.test.context.junit4.SpringRunner;

import static org.hamcrest.CoreMatchers.is;
import static org.junit.Assert.assertThat;

@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public class DemoApplicationTests {

    @Autowired
    TestRestTemplate template;

    @Test
    public void contextLoads() {
        ResponseEntity<String> res = template.getForEntity("/", String.class);
        assertThat(res.getStatusCode(), is(HttpStatus.OK));
        assertThat(res.getBody(), is("foo"));
    }

}

AWS CLIを使った環境構築

AWS CLIを使って環境構築する手順をまとめようと思いGitHubにあげてみました。