【Spring fest 2019】徹底解剖Spring MVCアーキテクチャー

徹底解剖
Spring MVCアーキテクチャー
-DispatcherServletの中身を覗いてきました-
株式会社カサレアル
菊池真登
2019/12/18
SPRING FEST ❜19
(C) CASAREAL, Inc. All rights reserved. 1

突然ですが
@Controller
public class TestController {
@PostMapping("/test")
public String post(@Validated TestForm testForm,
BindingResult result,
Model model) {
return "test";
}
}
ごくごく一般的なコントローラー
の実装ですよね！？

気になったことはありませんか？
@Controller
Model model) {
return "test";
}
}
リクエストURLと
メソッドの関係は？
引数のインスタンス
はどこからくる？
戻り値って文字列以外でもOK？

気になったことはありませんか？
@Controller
Model model) {
return "test";
}
}
引数に設定可能な
型って何個ある？
@ValidatedとBindingResult以外って
順番決まりなさそうだけど。。。

くっ、黒魔術！？

このセッションは
Spring MVCのアーキテクチャーを
ソースコードリーディングをもとに解き明か
していく45分間です
Spring MVCのアーキテクチャーをより詳しく
知りたい方が対象です
内部構造を詳細に把握することでトラブルに
強くなれます

自己紹介：菊池真登
 研修トレーナー＠カサレアル
 登壇実績：Spring / Java SE
 開発歴[Spring]：2012年から
 開発歴[Angular]：2015年頃に
1.5年間AngularJSに触れて冬眠

株式会社カサレアル
他社にはない色々なプログラミング言語の
研修を提供しています！

目次
1.Spring MVC のアーキテクチャー
2.URLとコントローラーメソッド
3.コントローラーメソッドの引数
4.コントローラーメソッドの戻り値
5.全体を俯瞰

目次
5.全体を俯瞰

Spring MVC のアーキテクチャー
Dispatcher
Servlet
Handler
Mapping
Handler
Adapter
View
Resolver Model
Controller
view name
View
1
2 3
4
56

関係を詳しく見ると
Dispatcher
Servlet DIコンテナ
Handler
Mapping
Handler
Adapter
DispatcherServletはDIコンテナをもつ
そのDIコンテナがHandlerMappingや
HandlerAdapterなどをもつ

処理実行時は
Dispatcher
Servlet
Handler
Adapter
Handler
Mapping
DispatcherServletの初期化処理で
DIコンテナからインスタンスを取り出し
フィールドに直接保持する

DispatcherServlet#initHandlerMappings() - 一部
private void initHandlerMappings(ApplicationContext context) {
this.handlerMappings = null;
if (this.detectAllHandlerMappings) {
Map<String, HandlerMapping> matchingBeans =
BeanFactoryUtils.beansOfTypeIncludingAncestors(context,
HandlerMapping.class, true, false);
if (!matchingBeans.isEmpty()) {
this.handlerMappings = new ArrayList<>(matchingBeans.values());
AnnotationAwareOrderComparator.sort(this.handlerMappings);
}
}
インスタンスを取り出し、
フィールド変数に代入

HandlerMapping
Dispatcher
Servlet
Handler
Mapping
Controller
1
リクエストURLとコントローラー
クラスのメソッドとの関係とは？

HandlerAdapter – 実行前
Dispatcher
Servlet
Handler
Adapter
Controller
2 3
コントローラークラスのメソッド
の引数はどのようにして解決？

HandlerAdapter – 実行後
Dispatcher
Servlet
Handler
Adapter
Controller
view name
2 3
4
コントローラークラスのメソッドの
戻り値はどのように処理される？

目次
5.全体を俯瞰

Dispatcher
Servlet
Handler
Mapping
Handler
Adapter
View
Resolver Model
Controller
view name
View
1
2 3
4
56

HandlerMapping
Dispatcher
Servlet
Handler
Mapping
Controller
1
リクエストURLとコントローラー
クラスのメソッドとの関係とは？

押さえておきたい登場人物
 HandlerMapping
 RequestMappingInfo
 MappingRegistry
 HandlerMethod
 AbstractHandlerMethodMapping

ざっくりとした関係図
HandlerMapping
MappingRegistry
RequestMappingInfo
RequestMappingInfo
RequestMappingInfo
HandlerMethod
HandlerMethod
HandlerMethod

 HandlerMapping
 MappingRegistry
 HandlerMethod

関係図
HandlerMapping

HandlerMapping
 インタフェース
 getHandlerメソッドが一つだけ定義されている
 戻り値が現在のリクエストを処理するメソッドになる
HandlerExecutionChain getHandler(HttpServletRequest request)
throws Exception;

RequestMappingHandlerMapping
 HandlerMappingを実装したクラス
 コントローラークラス用
 @EnableWebMvcアノテーションで有効化
 Spring Bootではアノテーションは不要
 一般的には下記の説明
Bean定義されているContorllerから
@RequestMappingアノテーションを読み取り、
URLと合致するControllerのメソッドを探す

 HandlerMapping
 MappingRegistry
 HandlerMethod

HandlerMapping
関係図
RequestMappingInfo
RequestMappingInfo
RequestMappingInfo

RequestMappingInfo
 @RequestMappingの設定値を保持する
 コントローラーメソッドの定義情報を表すクラス
 コントローラーメソッドの数だけ作られる
 １メソッド：１Info
 アプリ実行中はMappingRegistryに保持される

RequestMappingInfo
public final class RequestMappingInfo implements
RequestCondition<RequestMappingInfo> {
@Nullable
private final String name;
private final PatternsRequestCondition patternsCondition;
private final RequestMethodsRequestCondition methodsCondition;
@RequestMappingの
value：URL
method：リクエストメソッド
の設定値を保持する

RequestMappingInfo 続き
private final ParamsRequestCondition paramsCondition;
private final HeadersRequestCondition headersCondition;
private final ConsumesRequestCondition consumesCondition;
private final ProducesRequestCondition producesCondition;
private final RequestConditionHolder customConditionHolder;
params
headers
consumes
produces
の設定値を
保持する

 HandlerMapping
 MappingRegistry
 HandlerMethod

関係図
HandlerMapping
MappingRegistry
RequestMappingInfo
RequestMappingInfo
RequestMappingInfo

MappingRegistry
 リクエストURLとRequestMappingInfoを紐づける
 AbstractHandlerMethodMapping内にあるクラス
 アクセス修飾子なしのクラス
 実行中はAbstractHandlerMethodMappingのフィールドに
インスタンスが保持される

MappingRegistry
class MappingRegistry {
private final Map<RequestMappingInfo,HandlerMethod> mappingLookup;
private final MultiValueMap<String, RequestMappingInfo > urlLookup;
@RequestMappingアノテーションのvalue属性すなわち
URL を key にして、 RequestMappingInfo が保持される
RequestMappingInfo を key に HandlerMethod が保持される
*見やすさのため、実際のソースコードとは異なります

 HandlerMapping
 MappingRegistry
 HandlerMethod

関係図
HandlerMapping
MappingRegistry
RequestMappingInfo
RequestMappingInfo
RequestMappingInfo
HandlerMethod
HandlerMethod
HandlerMethod

HandlerMethod
 コントローラーメソッドの化身
 メソッドのリフレクションをもつ
 フレームワーク内部でコントローラメソッドを
取り扱うためのもの

ここで、
RequestMappingInfoとHandlerMethod
の関係を整理しましょう

【例】コントローラークラスの定義
@Controller
@GetMapping("/")
public String index() { return "index"; }
@GetMapping("/test")
public String get() { return "get"; }
public String post() { return "post"; }
}
・URL:”/”、メソッド: GET
・URL:”/test”、メソッド GET
・URL:”/test”、メソッド POST
の３つを定義する

MappingRegistryのurlLookupの状態
“/”
“/test”
Patterns:”/”
Methods:”GET”
Patterns:”/test”
Methods:”GET”
Methods:”POST”
key : URL value : RequestMappingInfo

MappingRegistryのmappingLookupの状態
Patterns:”/”
Methods:”GET”
Methods:”GET”
Methods:”POST”
key : RequestMappingInfo value : HandlerMethod
TestController#index()
TestController#get()
TestController#post()

まとめると
Patterns:”/”
Methods:”GET”
Methods:”GET”
Methods:”POST”
TestController#post()
“/”
“/test”
URL RequestMappingInfo HandlerMethod

 HandlerMapping
 MappingRegistry
 HandlerMethod

継承関係
RequestMappingHandlerMapping
AbstractHandlerMethodMapping
HandlerMapping

AbstractHandlerMethodMapping
 HandlerMappingの処理の根幹
 RequestMappingHandlerMappingが継承
 lookupHandlerMethodメソッドが肝！
ざっくりいうと下記の二段構成
1. リクエストURLと完全一致するものを探す
2. なければ全検索でパターンマッチを行う

リクエストURLと完全一致するものを探す

AbstractHandlerMethodMapping#lookupHandlerMethod()
protected HandlerMethod lookupHandlerMethod(String lookupPath,
HttpServletRequest request) throws Exception {
List<Match> matches = new ArrayList<>();
List<T> directPathMatches
= this.mappingRegistry.getMappingsByUrl(lookupPath);
if (directPathMatches != null) {
addMatchingMappings(directPathMatches, matches, request);
}
リクエストURLをKeyに
RequestMappingInfoを取り出す

MappingRegistry#getMappingsByUrl()
class MappingRegistry {
private final MultiValueMap<String, RequestMappingInfo> urlLookup
public List<RequestMappingInfo> getMappingsByUrl(String urlPath) {
return this.urlLookup.get(urlPath);
}

【例】リクエストURLが / の場合
“/”
Patterns:”/”
Methods:”GET”
このRequestMappingInfo
が選択される

【例】リクエストURLが /test の場合
“/test”
Methods:”GET”
Methods:”POST”
これらのRequestMappingInfo
が選択される

リクエストメソッドなど細かい判定を行う
 リクエストメソッド等細かな条件で絞り込む
 RequestMappingInfo#getMatchingCondition()で行う
 @RequestMappingのすべての属性値が判定対象
 method
 params
 headers
 consumes
 produces

List<RequestMappingInfo> directPathMatches
}
リクエストメソッドなどの
より細かな精査を行う

RequestMappingInfo#getMatchingCondition()
public RequestMappingInfo getMatchingCondition(HttpServletRequest request) {
RequestMethodsRequestCondition methods
= this.methodsCondition.getMatchingCondition(request);
if (methods == null) { // リクエストメソッドの判定
return null;
}
ParamsRequestCondition params
= this.paramsCondition.getMatchingCondition(request);
if (params == null) { // リクエストパラメータの判定
return null;
}
先ほどのaddMatchingMappings
メソッドの呼び出しで
最終的に呼ばれるメソッド

getMatchingCondition - 続き
HeadersRequestCondition headers
= this.headersCondition.getMatchingCondition(request);
if (headers == null) { // リクエストヘッダーの判定
return null;
}
ConsumesRequestCondition consumes
= this.consumesCondition.getMatchingCondition(request);
if (consumes == null) { // Content-Typeの判定
return null;
}

ProducesRequestCondition produces
= this.producesCondition.getMatchingCondition(request);
if (produces == null) { // Acceptの判定
return null;
}
PatternsRequestCondition patterns
= this.patternsCondition.getMatchingCondition(request);
if (patterns == null) { // リクエストURLのパターン判定
return null;
}

RequestConditionHolder custom
= this.customConditionHolder.getMatchingCondition(request);
if (custom == null) { // カスタム判定
return null;
}
return new RequestMappingInfo(this.name, patterns,
methods, params, headers, consumes, produces,
custom.getCondition());
}

なければ全検索でパターンマッチを行う
@RequestMappingにワイルドカード
を指定した場合など

List<T> directPathMatches
}
if (matches.isEmpty()) {
addMatchingMappings(
this.mappingRegistry.getMappings().keySet(), matches, request);
}
全RequestMappingInfoから
パターンマッチを行う

@Controller
@GetMapping("/**")
}
・URL:”/**”、メソッド: GET
・URL:”/test”、メソッド GET
の２つを定義する

MappingRegistryのurlLookupの状態
“/**”
“/test”
Patterns:”/**”
Methods:”GET”
Methods:”GET”

MappingRegistryのmappingLookupの状態
Patterns:”/**”
Methods:”GET”
Methods:”GET”
key : RequestMappingInfo value : HandlerMethod

リクエストURL : “/” メソッド : “GET”
Patterns:”/**”
Methods:”GET”
Methods:”GET”
“/**”
“/test”
リクエストURL : /
は完全一致しない
全RequestMappingInfo
からパターンマッチ
を行う

パターンマッチは前述の
RequestMappingInfo#getMatchingCondition()
を使う

RequestMappingInfo#getMatchingCondition() – 再掲
public RequestMappingInfo getMatchingCondition(HttpServletRequest request) {
RequestMethodsRequestCondition methods
= this.methodsCondition.getMatchingCondition(request);
if (methods == null) {
return null;
}
// 中略
PatternsRequestCondition patterns
= this.patternsCondition.getMatchingCondition(request);
if (patterns == null) {
return null;
}
@GetMapping("/**")
メソッド : GET、にマッチ
@GetMapping("/**")
URL : /**、にマッチ

@Controller
@GetMapping("/**")
}
ゆえに、indexメソッドが選択
される

このようにして選択されたHandlerMethodを
HandlerAdapterが実行する

目次
5.全体を俯瞰

Dispatcher
Servlet
Handler
Mapping
Handler
Adapter
View
Resolver Model
Controller
view name
View
1
2 3
4
56

Handler Adapter – 実行前
Dispatcher
Servlet
Handler
Adapter
Controller
2 3
コントローラークラスのメソッド
の引数はどのようにして解決？

 HandlerMethodArgumentResolver
 HandlerAdapter
 ServletInvocableHandlerMethod

関係図
HandlerAdapter
HandlerMethodArgumentResolver
ServletInvocableHandlerMethod
（リクエストごとに作られる）

 HandlerAdapter

関係図

 コントローラーメソッドの引数の調達役
 インタフェースであり、これを多数のクラスが実装
 Form
 BindingResult
 Servlet API
など、各クラス分実装クラスが存在する
 Spring SecurityやSpring Data Commons 等にも実装クラス
が存在する
 メソッドで UserDetails 等を取得するのもこの機能

public interface HandlerMethodArgumentResolver {
boolean supportsParameter(MethodParameter parameter);
Object resolveArgument(MethodParameter parameter,
@Nullable ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
@Nullable WebDataBinderFactory binderFactory)
throws Exception;
}

 supportsParameter()
 メソッド引数の型や付加したアノテーションなどか
らサポート対象かを判定するメソッド
 resolveArgument()
 メソッド引数のインスタンスを調達するメソッド
以後、ArgumentResolver と省略した場合は、
こちらを示しています。

 HandlerAdapter

関係図
HandlerAdapter

HandlerAdapter
 HandlerMappingで選択されたHandlerMethodを実行する
 インタフェース
 handle()メソッド内で HandlerMethod を実行する

RequestMappingHandlerAdapter
 @RequestMappingで定義されたHandlerMethodを
サポートするHandlerAdapterの実装クラス
 HandlerMethodArgumentResolverのインスタンスを保持
 ServletInvocableHandlerMethodに
HandlerMethodArgumentResolverのインスタンスを
渡して委譲する

継承関係
HandlerAdapter

 HandlerAdapter

関係図
HandlerAdapter

 HandlerMethodを継承している
 RequestMappingHandlerAdapterから借り受けた
HandlerMethodArgumentResolverを使って
引数のインスタンスを調達する
 コントローラーメソッドを実行する

継承関係
HandlerMethod

関係図
RequestMapping
HandlerAdapter
ServletInvocable
HandlerMethod
リクエストごとに
new
this.argumentResolvers
setHandlerMethodArgumentResolvers
これ使って！任せとけ！

InvocableHandlerMethod#invokeForRequest()
public Object invokeForRequest(NativeWebRequest request,
Object... providedArgs) throws Exception {
Object[] args
= getMethodArgumentValues(request,
mavContainer, providedArgs);
if (logger.isTraceEnabled()) {
logger.trace("Arguments: " + Arrays.toString(args));
}
return doInvoke(args);
}
引数のインスタンス
を調達
メソッドの実行！

InvocableHandlerMethod#getMethodArgumentValues ()
protected Object[] getMethodArgumentValues(
NativeWebRequest request,
MethodParameter[] parameters = getMethodParameters();
if (ObjectUtils.isEmpty(parameters)) {
return EMPTY_ARGS;
}
引数なしの場合は
そのままreturn
引数リストを取得

InvocableHandlerMethod#getMethodArgumentValues()
Object[] args = new Object[parameters.length];
for (int i = 0; i < parameters.length; i++) {
MethodParameter parameter = parameters[i];
parameter.initParameterNameDiscovery(this.parameterNameDiscoverer);
args[i] = findProvidedArgument(parameter, providedArgs);
if (args[i] != null) { continue; }
if (!this.resolvers.supportsParameter(parameter)) {
throw new IllegalStateException();
}
try {
args[i] = this.resolvers.resolveArgument(parameter,
mavContainer, request, this.dataBinderFactory);
}
catch (Exception ex) {
}
}
引数一つずつを処理
サポート可能な引数
か判定
サポート可能ならイ
ンスタンスを調達

@Controller
Model model) {
return "test";
}
}
・Form
・BindingResult
・Model
の三つの引数を設定

動作概要
[0] [1] [2]
TestForm BindingResult Model
BindingResult担当
Form担当 Model担当
引数リスト
ArgumentResolverたち

引数リスト[0]
[0]
TestForm
BindingResult担当
引数リスト
俺の出番
だな！
サポート不可。。

引数リスト[1]
[1]
BindingResult
BindingResult担当
引数リスト
任せて！

引数リスト[2]
[2]
Model
BindingResult担当
引数リスト
いっきまーす！
出来ません！

引数に指定可能な型は？
 指定可能な型が多すぎる
https://docs.spring.io/spring/docs/5.2.1.RELEASE/spring-
framework-reference/web.html#mvc-ann-arguments
 Spring Security、Spring Data Commons等を追加すると
さらに増える
 丸暗記ではなく取捨選択が重要
 ソースコード上からも指定可能な型を確認できる

RequestMappingHandlerAdapter#getDefaultArgumentResolvers()
private List<HandlerMethodArgumentResolver> getDefaultArgumentResolvers() {
List<HandlerMethodArgumentResolver> resolvers = new ArrayList<>();
// Annotation-based argument resolution
resolvers.add(new RequestParamMethodArgumentResolver(getBeanFactory(), false));
resolvers.add(new RequestParamMapMethodArgumentResolver());
resolvers.add(new PathVariableMethodArgumentResolver());
resolvers.add(new PathVariableMapMethodArgumentResolver());
resolvers.add(new MatrixVariableMethodArgumentResolver());
resolvers.add(new MatrixVariableMapMethodArgumentResolver());
resolvers.add(new ServletModelAttributeMethodProcessor(false));

resolvers.add(new RequestResponseBodyMethodProcessor(getMessageConverters(),
this.requestResponseBodyAdvice));
resolvers.add(new RequestPartMethodArgumentResolver(getMessageConverters(),
resolvers.add(new RequestHeaderMethodArgumentResolver(getBeanFactory()));
resolvers.add(new RequestHeaderMapMethodArgumentResolver());
resolvers.add(new ServletCookieValueMethodArgumentResolver(getBeanFactory()));
resolvers.add(new ExpressionValueMethodArgumentResolver(getBeanFactory()));
resolvers.add(new SessionAttributeMethodArgumentResolver());
resolvers.add(new RequestAttributeMethodArgumentResolver());

// Type-based argument resolution
resolvers.add(new ServletRequestMethodArgumentResolver());
resolvers.add(new ServletResponseMethodArgumentResolver());
resolvers.add(new HttpEntityMethodProcessor(getMessageConverters(),
resolvers.add(new RedirectAttributesMethodArgumentResolver());
resolvers.add(new ModelMethodProcessor());
resolvers.add(new MapMethodProcessor());
resolvers.add(new ErrorsMethodArgumentResolver());
resolvers.add(new SessionStatusMethodArgumentResolver());
resolvers.add(new UriComponentsBuilderMethodArgumentResolver());

// Custom arguments
if (getCustomArgumentResolvers() != null) {
resolvers.addAll(getCustomArgumentResolvers());
}
// Catch-all
resolvers.add(new RequestParamMethodArgumentResolver(getBeanFactory(), true));
resolvers.add(new ServletModelAttributeMethodProcessor(true));
return resolvers;
}

お腹いっぱいですね。( ;∀;)

いくつか絞ってご紹介
 Form
 BindingResult
 Servlet API
 RequestBody
のArgumentResolverをご紹介します。

 Form
 BindingResult
 Servlet API
 RequestBody

ServletModelAttributeMethodProcessor
 根幹は親クラスのModelAttributeMethodProcessor
 Formクラスのインスタンスの生成と値の入力を行う
 @Validatedがついていたら入力検証も行う
 処理の最後にインスタンスのModelへの追加を行う

ModelAttributeMethodProcessor#supportsParameter()
public boolean supportsParameter(MethodParameter parameter) {
return (parameter.hasParameterAnnotation(ModelAttribute.class) ||
(this.annotationNotRequired &&
!BeanUtils.isSimpleProperty(parameter.getParameterType())));
}
Number型やCharSequence型といった単純な型でない、
自作したFormクラスであればサポート対象

ModelAttributeMethodProcessor#resolveArgument()
try {
attribute = createAttribute(name, parameter, binderFactory, webRequest);
}
catch (BindException ex) {
if (isBindExceptionRequired(parameter)) {
throw ex;
}
if (parameter.getParameterType() == Optional.class) {
attribute = Optional.empty();
}
bindingResult = ex.getBindingResult();
}
この処理が
インスタンス生成の始まり

ModelAttributeMethodProcessor#constructAttribute()
protected Object constructAttribute(Constructor<?> constructor,
String attributeName,
MethodParameter parameter,
WebDataBinderFactory binderFactory,
NativeWebRequest webRequest) throws Exception {
if (constructor.getParameterCount() == 0) {
// A single default constructor -> clearly a standard JavaBeans arrangement.
return BeanUtils.instantiateClass(constructor);
}
デフォルトコンストラクタの場合
はすぐにインスタンス化

引数ありコンストラクタの場合は
https://github.com/spring-projects/spring-framework/blob/master/spring-
web/src/main/java/org/springframework/web/method/annotation/ModelAttrib
uteMethodProcessor.java#L260
こちらをご参照ください

if (bindingResult == null) {
// Bean property binding and validation;
// skipped in case of binding failure on construction.
WebDataBinder binder = binderFactory.createBinder(webRequest, attribute, name);
if (binder.getTarget() != null) {
if (!mavContainer.isBindingDisabled(name)) {
bindRequestParameters(binder, webRequest);
}
validateIfApplicable(binder, parameter);
if (binder.getBindingResult().hasErrors() && isBindExceptionRequired(binder,
parameter)) {
throw new BindException(binder.getBindingResult());
}
}
}
Form、BindingResult
のインスタンスを保持する
WebDataBinderを生成
フォームのsetterでパラメータの代入
Bean Validation実行
・入力検証でエラー
・引数にBindingResultがない
は例外スロー

// Add resolved attribute and BindingResult at the end of the model
Map<String, Object> bindingResultModel = bindingResult.getModel();
mavContainer.removeAttributes(bindingResultModel);
mavContainer.addAllAttributes(bindingResultModel);
return attribute;
Form、BindingResultのインスタンスをModelにセット
この時、Form、BindingResultの順番で追加される

ModelAttributeMethodProcessor#isBindExceptionRequired ()
protected boolean isBindExceptionRequired(MethodParameter parameter) {
int i = parameter.getParameterIndex();
Class<?>[] paramTypes = parameter.getExecutable().getParameterTypes();
boolean hasBindingResult = (paramTypes.length > (i + 1)
&& Errors.class.isAssignableFrom(paramTypes[i + 1]));
return !hasBindingResult;
}
コントローラーメソッドで、
Form、BindingResult
の順で引数を設定しないとエラーになるのは
ここでチェックしている

 Form
 BindingResult
 Servlet API
 RequestBody

ErrorsMethodArgumentResolver
 ServletModelAttributeMethodProcessorでModelに
追加されたBindingResultを返すだけ
 Modelの最後の要素を取得する
 ServletModelAttributeMethodProcessorで、
Form、BindingResultの順でModelに追加
 引数はForm、BindingResultの順で、
設定しないといけない
は、このためと考えられる

ErrorsMethodArgumentResolver#resolveArgument()
ModelMap model = mavContainer.getModel();
String lastKey = CollectionUtils.lastElement(model.keySet());
if (lastKey != null && lastKey.startsWith(BindingResult.MODEL_KEY_PREFIX)) {
return model.get(lastKey);
} Modelの最後の要素のkeyを取得して
valueを取得

 Form
 BindingResult
 Servlet API
 RequestBody

ServletRequestMethodArgumentResolver
ServletResponseMethodArgumentResolver
 ServletRequestMethodArgumentResolver
 ServletRequest、HttpSession、Principal等が該当する
 Spring Security の Authentication も該当
 ServletResponseMethodArgumentResolver
 ServletResponseなどが該当する
比較的単純な処理なのでソースコードの掲載は省略

 Form
 BindingResult
 Servlet API
 RequestBody

RequestResponseBodyMethodProcessor
 JSONをJavaオブジェクトに変換
 インスタンスの生成や値の代入はJacksonに委譲
 supportsParameterメソッドの判定条件は@RequestBody
がついているか否か
 @ValidatedがついていたらBean Validationを実行する

RequestResponseBodyMethodProcessor#resolveArgument()
public Object resolveArgument(
MethodParameter parameter,
NativeWebRequest webRequest,
@Nullable WebDataBinderFactory binderFactory) throws Exception {
parameter = parameter.nestedIfOptional();
Object arg = readWithMessageConverters(webRequest,
parameter, parameter.getNestedGenericParameterType());
String name = Conventions.getVariableNameForParameter(parameter);
Jacksonに JSON ⇒ Javaオブジェクトの変換処理を委譲

RequestResponseBodyMethodProcessor#resolveArgument() - 続き
if (binderFactory != null) {
WebDataBinder binder = binderFactory.createBinder(webRequest, arg, name);
if (arg != null) {
validateIfApplicable(binder, parameter);
if (binder.getBindingResult().hasErrors()
&& isBindExceptionRequired(binder, parameter)) {
throw new MethodArgumentNotValidException(..);
}
}
if (mavContainer != null) {
mavContainer.addAttribute(BindingResult.MODEL_KEY_PREFIX + name,
binder.getBindingResult());
}
}
Bean Validation を実行
引数にBindingResultが
ない場合は例外スロー
BindingResultだけ
Modelに追加

目次
5.全体を俯瞰

Dispatcher
Servlet
Handler
Mapping
Handler
Adapter
View
Resolver Model
Controller
view name
View
1
2 3
4
56

Handler Adapter – 実行後
Dispatcher
Servlet
Handler
Adapter
Controller
view name
2 3
4
コントローラークラスのメソッドの
戻り値はどのように処理される？

 HandlerMethodReturnValueHandler
 HandlerAdapter（ここでも重要）
 ServletInvocableHandlerMethod （ここでも重要）
 ModelAndViewContainer

関係図
HandlerAdapter
HandlerMethodReturnValueHandler

関係図

 コントローラーメソッドの戻り値を処理する
 戻り値の文字列をSpringにView名として認識させる
 RESTの場合は JSON への変換処理を呼び出す
 インタフェースであり、これを多数のクラスが実装
 String
 Map
 ResponseBody
など、各クラス分実装クラスが存在する
 Viewに処理を委譲するか、そのままレスポンスするか
のフラグの更新も担う

public interface HandlerMethodReturnValueHandler {
boolean supportsReturnType(MethodParameter returnType);
void handleReturnValue(@Nullable Object returnValue,
MethodParameter returnType,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest) throws Exception;
}

 supportsReturnType
 メソッドの戻り値の型や付加したアノテーションな
どからサポートするかを判定するメソッド
 handleReturnValue
 メソッドの戻り値を処理するメソッド
以後、ReturnValueHandler と省略した場合は、
こちらを示しています。

関係図
HandlerAdapter

 HandlerMethod用のHandlerAdapterの実装クラス
 HandlerMethodArgumentResolverのインスタンスを保持
 ServletInvocableHandlerMethodに
HandlerMethodArgumentResolverのインスタンスを渡し
て委譲する
 HandlerMethodReturnValueHandlerのインスタンスを保持

関係図
HandlerAdapter

 HandlerMethodを継承している
 RequestMappingHandlerAdapterから借り受けた
HandlerMethodArgumentResolverを使って引数のインス
タンスを調達する
 コントローラーメソッドを実行する
 HandlerMethodReturnValueHandlerを使って、戻り値の
処理を行う

関係図
RequestMapping
HandlerAdapter
ServletInvocable
HandlerMethod
this.returnValueHandlers
setHandlerMethodReturnValueHandlers
これも使って！任せとけ！
リクエストごとに
new

ModelAndViewContainer
 ModelとView名を保持するクラス
 DispatcherServletがViewを見つけ出す橋渡し役でもある
 Viewに処理を委譲する or そのままレスポンスする
を振り分けるフラグをもつ
 requestHandledフィールドが該当

ServletInvocableHandlerMethod#invokeAndHandle()
public void invokeAndHandle(ServletWebRequest webRequest,
Object returnValue = invokeForRequest(webRequest,
mavContainer, providedArgs);
// 中略
mavContainer.setRequestHandled(false);
Assert.state(this.returnValueHandlers != null, "No return value handlers");
HandlerMethod実行後
の戻り値を受け取る

ServletInvocableHandlerMethod#invokeAndHandle()
try {
this.returnValueHandlers.handleReturnValue(
returnValue,
getReturnValueType(returnValue),
mavContainer, webRequest);
}
catch (Exception ex) {
if (logger.isTraceEnabled()) {
logger.trace(formatErrorForReturnValue(returnValue), ex);
}
throw ex;
}
}
戻り値の調整を
行う

@Controller
@GetMapping("/")
public String index(Model model) {
model.addAttribute("name", "masato");
model.addAttribute("age", 1);
return "test";
}
public Map test2() {
return Map.of("name", "masato", "age", 1);
}
}
戻り値の型が違うが
どちらも最終的に
“test.html” を出力

動作概要
Map担当
String担当 ResponseBody担当
戻り値の型
ReturnValueHandlerたち
?

Map担当
戻り値の型
String
戻り値の型がString
俺の出番
だな！

Map担当
戻り値の型
Map
戻り値の型がMap
任せとけ！

Map担当
戻り値の型
ResponseBody
戻り値の型がResponseBody
任せとけ！
できない！

戻り値に指定可能な型は？
 指定可能な型が多すぎる
https://docs.spring.io/spring/docs/5.2.1.RELEASE/spring-
framework-reference/web.html#mvc-ann-return-types
 丸暗記ではなく取捨選択が重要
 ソースコード上からも指定可能な型を確認できる

RequestMappingHandlerAdapter#getDefaultReturnValueHandlers()
private List<HandlerMethodReturnValueHandler> getDefaultReturnValueHandlers() {
List<HandlerMethodReturnValueHandler> handlers = new ArrayList<>();
// Single-purpose return value types
handlers.add(new ModelAndViewMethodReturnValueHandler());
handlers.add(new ModelMethodProcessor());
handlers.add(new ViewMethodReturnValueHandler());
handlers.add(new ResponseBodyEmitterReturnValueHandler(getMessageConverters(),
this.reactiveAdapterRegistry, this.taskExecutor,
this.contentNegotiationManager));
handlers.add(new StreamingResponseBodyReturnValueHandler());
handlers.add(new HttpEntityMethodProcessor(getMessageConverters(),
this.contentNegotiationManager, this.requestResponseBodyAdvice));

handlers.add(new HttpHeadersReturnValueHandler());
handlers.add(new CallableMethodReturnValueHandler());
handlers.add(new DeferredResultMethodReturnValueHandler());
handlers.add(new AsyncTaskMethodReturnValueHandler(this.beanFactory));
// Annotation-based return value types
handlers.add(new ModelAttributeMethodProcessor(false));
handlers.add(new RequestResponseBodyMethodProcessor(getMessageConverters(),
this.contentNegotiationManager, this.requestResponseBodyAdvice));
// Multi-purpose return value types
handlers.add(new ViewNameMethodReturnValueHandler());
handlers.add(new MapMethodProcessor());

// Custom return value types
if (getCustomReturnValueHandlers() != null) {
handlers.addAll(getCustomReturnValueHandlers());
}
// Catch-all
if (!CollectionUtils.isEmpty(getModelAndViewResolvers())) {
handlers.add(new ModelAndViewResolverMethodReturnValueHandler(
getModelAndViewResolvers()));
}
else {
handlers.add(new ModelAttributeMethodProcessor(true));
}
return handlers;
}

いくつか絞ってご紹介します

 Viewに委譲するパターン
 String
 Map
 Viewに委譲しないパターン（REST）
 ResponseBody
 ResponseEntity

 String
 Map
 ResponseBody
 ResponseEntity

ViewNameMethodReturnValueHandler
 戻り値を文字列にした場合が該当する
 戻り値をModelAndViewContainerが持つView名として
セットする

public boolean supportsReturnType(MethodParameter returnType) {
Class<?> paramType = returnType.getParameterType();
return (void.class == paramType
|| CharSequence.class.isAssignableFrom(paramType));
}
ViewNameMethodReturnValueHandler#supportsReturnType()
意外にもサポート対象の型に
CharSequenceだけでなく
voidも含まれる

ViewNameMethodReturnValueHandler#handleReturnValue()
public void handleReturnValue(@Nullable Object returnValue,
if (returnValue instanceof CharSequence) {
String viewName = returnValue.toString();
mavContainer.setViewName(viewName);
if (isRedirectViewName(viewName)) {
mavContainer.setRedirectModelScenario(true);
}
}
戻り値をViewName
としてセット

なぜvoidもサポート対象なのか？
 明示しない場合、リクエストURLが論理View名となる
 http://localhost:8080/test とアクセスした場合、
論理View名に “test” を指定した動作になる

 String
 Map
 ResponseBody
 ResponseEntity

MapMethodProcessor
 戻り値をMap型にした場合が該当する
 戻り値をModelAndViewContainerの
Modelにすべて追加する

return Map.class.isAssignableFrom(returnType.getParameterType());
}
MapMethodProcessor#supportsReturnType()
戻り値がMap型がサポート対象

public void handleReturnValue(@Nullable Object returnValue,
if (returnValue instanceof Map){
mavContainer.addAllAttributes((Map) returnValue);
}
}
MapMethodProcessor#handleReturnValue()
戻り値のMapの値をすべて
Modelに追加している

@Controller
@GetMapping("/")
public String index(Model model) {
model.addAttribute("name", "masato");
model.addAttribute("age", 1);
return "test";
}
public Map test2() {
return Map.of("name", "masato", "age", 1);
}
}
二つのメソッドは最終的に
同じ挙動になる

 String
 Map
 ResponseBody
 ResponseEntity

RequestResponseBodyMethodProcessor
 @ResponseBodyが付加されている場合が該当する
 クラス、メソッドどちらにも付加可能
 @RestControllerを付加している場合も該当
 @Controllerと@ResponseBodyを合成したもの
 戻り値のJavaオブジェクトをJSONに変換して
レスポンス

return (AnnotatedElementUtils.hasAnnotation(
returnType.getContainingClass(), ResponseBody.class) ||
returnType.hasMethodAnnotation(ResponseBody.class));
}
RequestResponseBodyMethodProcessor#supportsReturnType()
メソッド、もしくはクラスに
@ResponseBodyが付加されてい
る場合サポート対象

public void handleReturnValue(
@Nullable Object returnValue, MethodParameter returnType,
ModelAndViewContainer mavContainer, NativeWebRequest webRequest)
throws IOException, HttpMediaTypeNotAcceptableException,
HttpMessageNotWritableException {
mavContainer.setRequestHandled(true);
ServletServerHttpRequest inputMessage = createInputMessage(webRequest);
ServletServerHttpResponse outputMessage = createOutputMessage(webRequest);
// Try even with null return value. ResponseBodyAdvice could get involved.
writeWithMessageConverters(returnValue, returnType, inputMessage, outputMessage);
}
RequestResponseBodyMethodProcessor#handleReturnValue()
そのままレスポンスする設定
JSONに変換してレスポンスする処理

 String
 Map
 ResponseBody
 ResponseEntity

HttpEntityMethodProcessor
 戻り値をHttpEntity型もしくはResponseEntity型
にした場合が該当
 ResponseEntity型の場合レスポンスステータスをセット
 戻り値のbodyにセットしたJavaオブジェクトをJSONに
変換してレスポンス

return (HttpEntity.class.isAssignableFrom(returnType.getParameterType()) &&
!RequestEntity.class.isAssignableFrom(returnType.getParameterType()));
}
HttpEntityMethodProcessor#supportsReturnType()
HttpEntity型およびResponseEntity型
がサポート対象

public void handleReturnValue(
@Nullable Object returnValue, MethodParameter returnType,
ModelAndViewContainer mavContainer, NativeWebRequest webRequest)
throws IOException, HttpMediaTypeNotAcceptableException,
HttpMessageNotWritableException {
mavContainer.setRequestHandled(true);
// 中略
if (responseEntity instanceof ResponseEntity) {
int returnStatus = ((ResponseEntity<?>) responseEntity).getStatusCodeValue();
outputMessage.getServletResponse().setStatus(returnStatus);
// JSONに変換する処理の呼び出し
}
HttpEntityMethodProcessor#handleReturnValue()
そのままレスポンスする設定
レスポンスステータスの設定

目次
5.全体を俯瞰

Spring MVC のアーキテクチャー再掲
Dispatcher
Servlet
Handler
Mapping
Handler
Adapter
View
Resolver Model
Controller
view name
View
1
2 3
4
56

DispatcherServlet#doDispatch()
が
Spring MVC の骨格です

Dispatcher
Servlet
Handler
Mapping
Controller
1

protected void doDispatch(HttpServletRequest request,
HttpServletResponse response) throws Exception {
// Determine handler for the current request.
mappedHandler = getHandler(processedRequest);
HandlerMapping呼び出し

protected HandlerExecutionChain getHandler(HttpServletRequest request) throws Exception {
if (this.handlerMappings != null) {
for (HandlerMapping mapping : this.handlerMappings) {
HandlerExecutionChain handler = mapping.getHandler(request);
if (handler != null) {
return handler;
}
}
}
return null;
}
DispatcherServlet#getHandler()
HandlerMapping呼び出し

Spring MVC のアーキテクチャ
Dispatcher
Servlet
Handler
Adapter
Controller
view name
2 3
4

// Determine handler adapter for the current request.
HandlerAdapter ha = getHandlerAdapter(mappedHandler.getHandler());
// Actually invoke the handler.
mv = ha.handle(processedRequest, response, mappedHandler.getHandler());
HandlerAdapterの取り出し
コントローラーメソッドの実行

Dispatcher
Servlet
View
Resolver Model
View
56

processDispatchResult(processedRequest,
response, mappedHandler, mv, dispatchException);
Viewの解決とレンダリング処理

RESTの場合

private ModelAndView getModelAndView(ModelAndViewContainer mavContainer,
ModelFactory modelFactory, NativeWebRequest webRequest) throws Exception {
modelFactory.updateModel(webRequest, mavContainer);
if (mavContainer.isRequestHandled()) {
return null;
}
ModelMap model = mavContainer.getModel();
ModelAndView mav = new ModelAndView(mavContainer.getViewName(), model, mavContainer.getStatus());
// 中略
return mav;
}
requestHandledがtrueの場合は、
DispatcherServletに
ModelAndViewを返さない
RequestMappingHandlerAdapter#getModelAndView()

まとめ
 基本となるインタフェースと実装クラスを
抑えれば読解は可能
 引数のインスタンスの生成順序を正確に
把握できるのでトラブルに強くなれる
 initModelやinterceptorなど紹介していない
処理の呼び出しも是非読んでいただきたい

今後
 RequestMappingInfoの生成過程など、
より詳しく知るためにはDIコンテナの
生成過程を知る必要がある
 機会があればアプリの起動時の処理を紹介
したい

ご清聴ありがとうございました！

【Spring fest 2019】徹底解剖Spring MVCアーキテクチャー

Empfohlen

Empfohlen

Weitere ähnliche Inhalte

Was ist angesagt?

Was ist angesagt? (20)

Ähnlich wie 【Spring fest 2019】徹底解剖Spring MVCアーキテクチャー

Ähnlich wie 【Spring fest 2019】徹底解剖Spring MVCアーキテクチャー (11)

【Spring fest 2019】徹底解剖Spring MVCアーキテクチャー