零配置简单搭建SpringMVC 项目

时间：2023-03-08 16:21:42

SpringMVC是比较常用的JavaWeb框架，非常轻便强悍，能简化Web开发，大大提高开发效率，在各种Web程序中广泛应用。本文采用Java Config的方式搭建SpringMVC项目，并对SpringMVC启动时加载顺序做简单的说明。

　1、SpringMVC启动流程图

零配置简单搭建SpringMVC 项目

2、SpringMVC项目启动流程介绍

SpringMVC 是Spring 框架的重要模块，借助于Spring 的容器技术，可以非常方面的搭建Web项目。

SpringMVC项目启动时要完成Spring 容器的初始化和SpringMVC配置的初始化。

2.1 Spring容器的初始化：

1、项目中需要配置ContextLoadListener监听器，它会监听项目的启动，在项目启动时调用容器初始化方法完成Spring容器的初始化

如果采用XML配置，通常需要在web.xml文件里面添加如下配置：

零配置简单搭建SpringMVC 项目

本文采用Java Config 实现，所以在配置中继承了AbstractAnnotationConfigDispatcherServletInitializer 这个抽象类，这个类的继承关系如下：

零配置简单搭建SpringMVC 项目

在父类AbstractContextLoaderInitializer中注册了ContextLoadListener监听器:

具体如下：

零配置简单搭建SpringMVC 项目

2、在需要在容器初始化时创建的类上面加上注解，就可以实现Bean的自动装配了。

@Controller @Service @Bean  @Conponent等注解都可以显示表明Bean需要自动装配

3、配置Bean初始化的范围

零配置简单搭建SpringMVC 项目

2.2 SpringMVC 的配置

1、配置SpringMVC需要添加DispatchServlet ，DispatcherServlet主要负责前端调用URL的分发，他在Web容器初始化的时候被注册。在2.1中，我们已经知道，本文配置中继承了DispatchServlet 的一个抽象类AbstractAnnotationConfigDispatcherServletInitializer ，此抽象类的父类在实例化的时候会注册一个DispatchServlet到容器中，方法名如下。

零配置简单搭建SpringMVC 项目

2、定义视图解析器

前端访问URL，DispatchServlet 会把URL 匹配到Controller中相应的@RequstMapper的方法上去，该方法处理完请求后返回需要的业务数据模型，然后会调用自己的视图解析器把数据渲染到前端页面中，渲染之后返回给浏览器。

视图解析器定义如下：

零配置简单搭建SpringMVC 项目

3、其实SpringMVC 项目启动时配置的东西还有很多，HandlerException 异常处理，数据校验等，这些Spring提供的抽象类WebMvcConfigurerAdapter中已经实现好了，我们在项目中直接继承就行了。

3、代码实现：

项目采用Maven管理：pom.xml如下：

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">

    <modelVersion>4.0.0</modelVersion>

    <groupId>com.beiyan</groupId>

    <artifactId>demo</artifactId>

    <packaging>war</packaging>

    <version>0.0.1-SNAPSHOT</version>

    <name>demo Maven Webapp</name>

    <url>http://maven.apache.org</url>

    <properties>

        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>

        <java.version>1.8</java.version>

    </properties>

    <dependencies>

        <dependency>

            <!-- Test -->

            <groupId>junit</groupId>

            <artifactId>junit</artifactId>

            <version>4.10</version>

            <scope>test</scope>

        </dependency>

        <!-- Servlet -->

        <dependency>

            <groupId>javax.servlet</groupId>

            <artifactId>javax.servlet-api</artifactId>

            <version>3.1.0</version>

        </dependency>

        <!-- SpringMVC -->

        <dependency>

            <groupId>org.springframework</groupId>

            <artifactId>spring-webmvc</artifactId>

            <version>4.3.3.RELEASE</version>

        </dependency>

    </dependencies>

    <build>

        <plugins>

            <plugin>

                <groupId>org.springframework.boot</groupId>

                <artifactId>spring-boot-maven-plugin</artifactId>

            </plugin>

        </plugins>

    </build>

</project>

项目结构如下：

零配置简单搭建SpringMVC 项目

RootConfig类中配置了包扫描的范围：

package com.beiyan.demo.config;

import org.springframework.context.annotation.ComponentScan;

import org.springframework.context.annotation.Configuration;

@Configuration

@ComponentScan(basePackages = { "com.beiyan.demo" })

public class RootConfig {

}

WebConfig 中配置了视图解析器以及RequestMapper的扫描范围

package com.beiyan.demo.config;

import org.springframework.context.annotation.Bean;

import org.springframework.context.annotation.ComponentScan;

import org.springframework.context.annotation.Configuration;

import org.springframework.web.servlet.ViewResolver;

import org.springframework.web.servlet.config.annotation.DefaultServletHandlerConfigurer;

import org.springframework.web.servlet.config.annotation.EnableWebMvc;

import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;

import org.springframework.web.servlet.view.InternalResourceViewResolver;

@Configuration

@EnableWebMvc

@ComponentScan("com.beiyan.demo.controller")

public class WebConfig extends WebMvcConfigurerAdapter {

    @Bean

    public ViewResolver viewResolver() {

        InternalResourceViewResolver resolver = new InternalResourceViewResolver();

        resolver.setPrefix("/WEB-INF/views/");

        resolver.setSuffix(".jsp");

        resolver.setExposeContextBeansAsAttributes(true);

        return resolver;

    }

    /**

     * 启用spring mvc 的注解

     */

    public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {

        configurer.enable();

    }

}

WebAppInitializer类配置了容器初始化时需要加载的配置类

package com.beiyan.demo.config;

import org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer;

public class WebAppInitializer extends AbstractAnnotationConfigDispatcherServletInitializer {

    @Override

    protected Class<?>[] getRootConfigClasses() {

        return new Class<?>[] { RootConfig.class };

    }

    @Override

    protected Class<?>[] getServletConfigClasses() {

        return new Class<?>[] { WebConfig.class };

    }

    @Override

    protected String[] getServletMappings() {

        return new String[] { "/" };

    }

}

TestController中定义了测试用的URL：

package com.beiyan.demo.controller;

import org.springframework.stereotype.Controller;

import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RequestMethod;

import org.springframework.web.bind.annotation.ResponseBody;

@Controller

public class TestController {

    @RequestMapping(value = "/test", method = RequestMethod.GET)

    public String test() {

        return "test";

    }

}

项目的Web 文件如下：

零配置简单搭建SpringMVC 项目

启动项目后，浏览器访问http://localhost:8080/SpringServlet/test 可以成功访问如下：

零配置简单搭建SpringMVC 项目

至此，SpringMVC项目配置成功了。

写在后面的话：

本项目只是简单搭建了SpringMVC项目，采用了最简配置，实际项目中可能会对Servlet，Filter进行自定义，还会添加Mybatis /hibernate, SpringSecurity等功能。关于JPA，SpringSecurity，Themeleaf 的集成将会在下一篇关于SpringBoot 的项目搭建中集成。

本项目完整代码已上传开源中国Git仓库：https://git.oschina.net/beiyan/mvc-config

相关文章