SpringBoot-MVC自動構成の原則

1公式ウェブサイトの読書

  プロジェクトを作成する前に、SpringBootがSpringMVCに対して行った構成(拡張方法やカスタマイズ方法など)についても知っておく必要があります。

  これらが明確になった場合にのみ、将来的に使用するのがより便利になります。パス1:ソースコード分析、パス2:公式ドキュメント!

アドレス:https ://docs.spring.io/spring-boot/docs/2.2.5.RELEASE/reference/htmlsingle/#boot-features-spring-mvc-auto-configuration

Spring MVC Auto-configuration
// Spring Boot为Spring MVC提供了自动配置,它可以很好地与大多数应用程序一起工作。
Spring Boot provides auto-configuration for Spring MVC that works well with most applications.
// 自动配置在Spring默认设置的基础上添加了以下功能:
The auto-configuration adds the following features on top of Spring’s defaults:
// 包含视图解析器
Inclusion of ContentNegotiatingViewResolver and BeanNameViewResolver beans.
// 支持静态资源文件夹的路径,以及webjars
Support for serving static resources, including support for WebJars 
// 自动注册了Converter:
// 转换器,这就是我们网页提交数据到后台自动封装成为对象的东西,比如把"1"字符串自动转换为int类型
// Formatter:【格式化器,比如页面给我们了一个2019-8-10,它会给我们自动格式化为Date对象】
Automatic registration of Converter, GenericConverter, and Formatter beans.
// HttpMessageConverters
// SpringMVC用来转换Http请求和响应的的,比如我们要把一个User对象转换为JSON字符串,可以去看官网文档解释;
Support for HttpMessageConverters (covered later in this document).
// 定义错误代码生成规则的
Automatic registration of MessageCodesResolver (covered later in this document).
// 首页定制
Static index.html support.
// 图标定制
Custom Favicon support (covered later in this document).
// 初始化数据绑定器:帮我们把请求数据绑定到JavaBean中!
Automatic use of a ConfigurableWebBindingInitializer bean (covered later in this document).
/*
如果您希望保留Spring Boot MVC功能,并且希望添加其他MVC配置(拦截器、格式化程序、视图控制器和其他功能),则可以添加自己
的@configuration类,类型为webmvcconfiguer,但不添加@EnableWebMvc。如果希望提供
RequestMappingHandlerMapping、RequestMappingHandlerAdapter或ExceptionHandlerExceptionResolver的自定义
实例,则可以声明WebMVCregistrationAdapter实例来提供此类组件。
*/
If you want to keep Spring Boot MVC features and you want to add additional MVC configuration 
(interceptors, formatters, view controllers, and other features), you can add your own 
@Configuration class of type WebMvcConfigurer but without @EnableWebMvc. If you wish to provide 
custom instances of RequestMappingHandlerMapping, RequestMappingHandlerAdapter, or 
ExceptionHandlerExceptionResolver, you can declare a WebMvcRegistrationsAdapter instance to provide such components.
// 如果您想完全控制Spring MVC,可以添加自己的@Configuration,并用@EnableWebMvc进行注释。
If you want to take complete control of Spring MVC, you can add your own @Configuration annotated with @EnableWebMvc.

  それを注意深く比較して、それがどのように実装されているかを見てみましょう。SpringBootがSpringMVCを自動的に構成し、次に何を自動的に構成したかを示しています。

2ContentNegotiatingViewResolverコンテンツネゴシエーションビューリゾルバー

  ViewResolverは自動的に構成されます。これは、前に学習したSpringMVCのビューリゾルバーです。

  つまり、ビューオブジェクト(View)はメソッドの戻り値に従って取得され、ビューオブジェクトはレンダリング方法(転送、リダイレクト)を決定します。

  ここでソースコードを見てみましょう。WebMvcAutoConfigurationを見つけてから、ContentNegotiatingViewResolverを検索します。以下の方法を見つけてください!

@Bean
@ConditionalOnBean(ViewResolver.class)
@ConditionalOnMissingBean(name = "viewResolver", value = ContentNegotiatingViewResolver.class)
public ContentNegotiatingViewResolver viewResolver(BeanFactory beanFactory) {
    
    
    ContentNegotiatingViewResolver resolver = new ContentNegotiatingViewResolver();
    resolver.setContentNegotiationManager(beanFactory.getBean(ContentNegotiationManager.class));
    // ContentNegotiatingViewResolver使用所有其他视图解析器来定位视图,因此它应该具有较高的优先级
    resolver.setOrder(Ordered.HIGHEST_PRECEDENCE);
    return resolver;
}

このカテゴリをクリックすると表示されます。対応する解析ビューのコードを見つけます。

@Nullable // 注解说明:@Nullable 即参数可为null
public View resolveViewName(String viewName, Locale locale) throws Exception {
    
    
    RequestAttributes attrs = RequestContextHolder.getRequestAttributes();
    Assert.state(attrs instanceof ServletRequestAttributes, "No current ServletRequestAttributes");
    List<MediaType> requestedMediaTypes = this.getMediaTypes(((ServletRequestAttributes)attrs).getRequest());
    if (requestedMediaTypes != null) {
    
    
        // 获取候选的视图对象
        List<View> candidateViews = this.getCandidateViews(viewName, locale, requestedMediaTypes);
        // 选择一个最适合的视图对象,然后把这个对象返回
        View bestView = this.getBestView(candidateViews, requestedMediaTypes, attrs);
        if (bestView != null) {
    
    
            return bestView;
        }
    }
    // .....
}

  続けてクリックして見てみましょう、彼はどのようにして候補者の見解を得たのですか?

  getCandidateViewsで、彼がすべてのビューパーサーを取得し、whileループを実行して、それらを1つずつ解析しているのを確認しました。

Iterator var5 = this.viewResolvers.iterator();

  したがって、結論は次のとおりです。ContentNegotiatingViewResolverこのビューリゾルバーは、すべてのビューリゾルバーを組み合わせるために使用されます

  彼の組み合わせロジックをもう一度調べて、属性viewResolversがあることを確認し、それがどこに割り当てられているかを確認しましょう。

protected void initServletContext(ServletContext servletContext) {
    
    
    // 这里它是从beanFactory工具中获取容器中的所有视图解析器
    // ViewRescolver.class 把所有的视图解析器来组合的
    Collection<ViewResolver> matchingBeans = BeanFactoryUtils.beansOfTypeIncludingAncestors(this.obtainApplicationContext(), ViewResolver.class).values();
    ViewResolver viewResolver;
    if (this.viewResolvers == null) {
    
    
        this.viewResolvers = new ArrayList(matchingBeans.size());
    }
    // ...............
}

  コンテナ内でビューリゾルバを探しているので、ビューリゾルバを実装できると推測できますか?

  ビューリゾルバーを自分でコンテナに追加できます。このクラスは自動的にそれを結合します。実装しましょう。

1.メインプログラムでビューパーサーを書いてみましょう。

@Bean //放到bean中
public ViewResolver myViewResolver(){
    
    
    return new MyViewResolver();
}
//我们写一个静态内部类,视图解析器就需要实现ViewResolver接口
private static class MyViewResolver implements ViewResolver{
    
    
    @Override
    public View resolveViewName(String s, Locale locale) throws Exception {
    
    
        return null;
    }
}

2.自分で作成したビューパーサーが機能するかどうかを確認するにはどうすればよいですか?

  すべてのリクエストはこのメソッドに送られるため、デバッグのためにDispatcherServletのdoDispatchメソッドにブレークポイントを追加しましょう。

img

ビューリゾルバーを見つけてください。私たち自身の定義がここにあることがわかります。

img

  したがって、独自にカスタマイズしたものを使用する場合は、このコンポーネントをコンテナに追加するだけです。SpringBootが残りをやってくれます!

3コンバーターとフォーマッター

フォーマットコンバーターを見つける:

@Bean
@Override
public FormattingConversionService mvcConversionService() {
    
    
    // 拿到配置文件中的格式化规则
    WebConversionService conversionService = 
        new WebConversionService(this.mvcProperties.getDateFormat());
    addFormatters(conversionService);
    return conversionService;
}

クリックして移動:

public String getDateFormat() {
    
    
    return this.dateFormat;
}
/**
* Date format to use. For instance, `dd/MM/yyyy`. 默认的
 */
private String dateFormat;

プロパティファイルでわかるように、自動的に構成できます。

  独自のフォーマット方法を構成すると、それが有効になるようにBeanに登録されます。構成ファイルで日付のフォーマット規則を構成できます。

img

残りは一つずつ例を与えることはありません、あなたは降りてもっと勉強することができます!

4SpringBootのデフォルト構成を変更します

  多くの自動構成の原則は同じです。WebMVCの自動構成の原則の分析を通じて、ソースコードの調査を通じて学習方法を学び、結論を導き出す必要があります。この結論は私たち自身のものでなければならず、すべてが完全。

  SpringBootの最下層はこれらの設計の詳細を多く使用しているため、ソースコードをもっと読む必要があります。結論を得る;

  SpringBootが多くのコンポーネントを自動的に構成する場合、最初にコンテナーにユーザー構成の構成があるかどうかを確認し(ユーザーが@beanを自分で構成する場合)、ある場合はユーザー構成の構成を使用し、ない場合はユーザー構成を使用します。自動構成;

  ビューリゾルバーなど、一部のコンポーネントが複数存在する可能性がある場合は、ユーザー設定と独自のデフォルトを組み合わせてください。

SpringMVCを使用した拡張

公式ドキュメントは次のとおりです。

Spring Boot MVC機能を維持し、MVC構成(インターセプター、フォーマッター、ビューコントローラー、およびその他の機能)を追加する場合は、WebMvcConfigurerタイプの独自の@Configurationクラスを追加できますが、 @EnableWebMvcは追加できませRequestMappingHandlerMapping、RequestMappingHandlerAdapter、またはExceptionHandlerExceptionResolverのカスタムインスタンスを提供する場合は、WebMvcRegistrationsAdapterインスタンスを宣言してそのようなコンポーネントを提供できます。

@Configurationアノテーションクラス  を作成するだけで、タイプはWebMvcConfigurerである必要があり、 @EnableWebMvcアノテーションをマークすることはできません。自分で作成します。configという新しいパッケージを作成し、クラスMyMvcConfigを作成します。 ;

//应为类型要求为WebMvcConfigurer,所以我们实现其接口
//可以使用自定义类扩展MVC的功能
@Configuration
public class MyMvcConfig implements WebMvcConfigurer {
    
    
    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
    
    
        // 浏览器发送/test , 就会跳转到test页面;
        registry.addViewController("/test").setViewName("test");
    }
}

ブラウザにアクセスして、次のサイトにアクセスしてみましょう。

img

  本当に飛び越えました!したがって、SpringMVCを拡張したいと考えており、SpringBootがすべての自動構成を保持するだけでなく、拡張構成を使用するためにも、この方法で使用することをお勧めします。

原理を分析することができます:

1. WebMvcAutoConfigurationは、SpringMVCの自動構成クラスであり、WebMvcAutoConfigurationAdapterクラスがあります。

2.このクラスにはアノテーションがあり、他の自動構成を行うときにインポートされます: @Import( EnableWebMvcConfiguration.class

3.親クラスを継承するEnableWebMvcConfigurationクラスを見てみましょう:DelegatingWebMvcConfiguration

この親クラスには、次のようなコードがあります。

public class DelegatingWebMvcConfiguration extends WebMvcConfigurationSupport {
    
    
    private final WebMvcConfigurerComposite configurers = new WebMvcConfigurerComposite();
  // 从容器中获取所有的webmvcConfigurer
    @Autowired(required = false)
    public void setConfigurers(List<WebMvcConfigurer> configurers) {
    
    
        if (!CollectionUtils.isEmpty(configurers)) {
    
    
            this.configurers.addWebMvcConfigurers(configurers);
        }
    }
}

4.このクラスで参照として設定したviewControllerを探して、それが

protected void addViewControllers(ViewControllerRegistry registry) {
    
    
    this.configurers.addViewControllers(registry);
}

5.入って見てみましょう

public void addViewControllers(ViewControllerRegistry registry) {
    
    
    Iterator var2 = this.delegates.iterator();
    while(var2.hasNext()) {
    
    
        // 将所有的WebMvcConfigurer相关配置来一起调用!包括我们自己配置的和Spring给我们配置的
        WebMvcConfigurer delegate = (WebMvcConfigurer)var2.next();
        delegate.addViewControllers(registry);
    }
}

  したがって、Spring独自の構成クラスだけでなく、もちろん独自の構成クラスも呼び出されるため、すべてのWebMvcConfigurationsが使用されると結論付けられます。

5SpringMVCを完全に引き継ぐ

公式ドキュメント:

If you want to take complete control of Spring MVC
you can add your own @Configuration annotated with @EnableWebMvc.

  完全な乗っ取りとは、SpringBootによるSpringMVCの自動構成が不要になり、すべてが自分で構成されることを意味します。

@EnableWebMvcを構成クラスに追加するだけです。

  SpringMVCを引き継ぐと、SpringBootが以前に構成した静的リソースマッピングが無効になることを確認しましょう。テストできます。

コメントする前に、ホームページにアクセスしてください。

img

構成クラスにアノテーションを付けます:@EnableWebMvc

img

すべてのSpringMVC自動構成が壊れていることがわかりました!元の状態に戻りました。

もちろん、私たちの開発では、SpringMVCの完全な乗っ取りを使用することはお勧めしません

問題について考えていますか?なぜ注釈を追加するのですか、自動構成は無効です!ソースコードを見てみましょう:

1.ここで、クラスをインポートしたことがわかります。引き続き調査できます。

@Import({
    
    DelegatingWebMvcConfiguration.class})
public @interface EnableWebMvc {
    
    
}

2.親クラスWebMvcConfigurationSupportを継承します

public class DelegatingWebMvcConfiguration extends WebMvcConfigurationSupport {
    
    
  // ......
}

3.Webmvc自動構成クラスを確認しましょう

@Configuration(proxyBeanMethods = false)
@ConditionalOnWebApplication(type = Type.SERVLET)
@ConditionalOnClass({
    
     Servlet.class, DispatcherServlet.class, WebMvcConfigurer.class })
// 这个注解的意思就是:容器中没有这个组件的时候,这个自动配置类才生效
@ConditionalOnMissingBean(WebMvcConfigurationSupport.class)
@AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE + 10)
@AutoConfigureAfter({
    
     DispatcherServletAutoConfiguration.class, TaskExecutionAutoConfiguration.class,
    ValidationAutoConfiguration.class })
public class WebMvcAutoConfiguration {
    
    
}

文を要約すると、@EnableWebMvcはWebMvcConfigurationSupportコンポーネントをインポートしました。

インポートされたWebMvcConfigurationSupportは、SpringMVCの最も基本的な機能にすぎません。

  SpringBootには多くの拡張機能構成があります。これを見る限り、もっと注意を払う必要があります〜

おすすめ

転載: blog.csdn.net/qq_41355222/article/details/123965808