使用IDEA创建Spring mvc工程及简要分析

缺乏、安全感 2022-08-21 08:52 49阅读 0赞

需要使用IDEA ultimate版本，才会有Web支持。

## 0.创建工程 ##

File->New->Project…  
![这里写图片描述][20160425161546684]

一路向下，最后创建一个tomcat server，mac上下载解压即可，非常简单，不详细描述。

完成后，idea会自动下载Spring相关lib，同时创建一个示例工程，下面看看idea到底自动做了哪些配置。对了解整个工程结构，web服务和框架的启动流程非常有用。

## 1.maven ##

根据配置的lib版本，会配置一个maven配置文件pom.xml，工程使用maven来进行项目管理，我们用的主要是依赖包导入。  
       IDEA完美集成maven，maven导入的lib包是脱离工程存在的，放在系统统一的目录下，如我的Mac上就是在目录~/.m2中，而IDEA则是使用External Libraries的形式导入，这样不同的工程如果使用的是相同版本的lib，则下次无需下载，直接就可使用。

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.springapp</groupId>
        <artifactId>spring_mvc_test</artifactId>
        <packaging>war</packaging>
        <version>1.0-SNAPSHOT</version>
        <name>spring_mvc_test</name>
    
        <properties>
            <spring.version>4.1.1.RELEASE</spring.version>
        </properties>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-core</artifactId>
                <version>${spring.version}</version>
            </dependency>
    
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-web</artifactId>
                <version>${spring.version}</version>
            </dependency>
    
            <dependency>
                <groupId>javax.servlet</groupId>
                <artifactId>servlet-api</artifactId>
                <version>2.5</version>
            </dependency>
    
            <dependency>
                <groupId>javax.servlet.jsp</groupId>
                <artifactId>jsp-api</artifactId>
                <version>2.1</version>
                <scope>provided</scope>
            </dependency>
    
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-webmvc</artifactId>
                <version>${spring.version}</version>
            </dependency>
    
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-test</artifactId>
                <version>${spring.version}</version>
                <scope>test</scope>
            </dependency>
    
            <dependency>
                <groupId>junit</groupId>
                <artifactId>junit</artifactId>
                <version>4.11</version>
                <scope>test</scope>
            </dependency>
        </dependencies>
    
        <build>
            <finalName>spring_mvc_test</finalName>
            <plugins>
                <plugin>
                    <artifactId>maven-compiler-plugin</artifactId>
                    <configuration>
                        <source>1.6</source>
                        <target>1.6</target>
                    </configuration>
                </plugin>
                <plugin>
                    <artifactId>maven-surefire-plugin</artifactId>
                    <configuration>
                        <includes>
                            <include>**/*Tests.java</include>
                        </includes>
                    </configuration>
                </plugin>
            </plugins>
        </build>
    </project>

## 2.web.xml ##

<web-app version="2.4" xmlns="http://java.sun.com/xml/ns/j2ee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd">
    
        <display-name>Spring MVC Application</display-name>
    
        
        <servlet>
            <servlet-name>mvc-dispatcher</servlet-name>
            <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
            
            <load-on-startup>1</load-on-startup>
            
        </servlet>
    
        <servlet-mapping>
            <servlet-name>mvc-dispatcher</servlet-name>
            
            <url-pattern>/</url-pattern>
        </servlet-mapping>
    </web-app>

org.springframework.web.servlet.DispatcherServlet类关系图：  
![这里写图片描述][20160425161611910]

这里主要配置Spring MVC的入口，所有的请求都从这里进入。DispatcherServlet的具体作用后面再详细说明，这里只要知道是整个mvc的流程调度者。

配置文件位置稍微提一下，开始就是想知道是怎么找到配置文件：mvc-dispatcher-servlet.xml的，翻了下源码，可以看到web.xml中也可以自定义这个文件的位置和名字，具体流程：

1.  配置load-on-startup的servlet，容器如tomcat启动时，会加载这个类并调用其init方法；
2.  DispatcherServlet的init方法具体实现在其祖先类org.springframework.web.servlet.HttpServletBean中；
3.  调用方法initServletBean()，由类org.springframework.web.servlet.FrameworkServlet具体实现；
4.  FrameworkServlet方法去初始化上下文类，这个类可以自定义，不自定义的话用默认类：`public static final Class<?> DEFAULT_CONTEXT_CLASS = XmlWebApplicationContext.class;`
5.  在这个类org.springframework.web.context.support.XmlWebApplicationContext中，就可以看到相关配置，

/** Default config location for the root context */
        public static final String DEFAULT_CONFIG_LOCATION = "/WEB-INF/applicationContext.xml";
    
        /** Default prefix for building a config location for a namespace */
        public static final String DEFAULT_CONFIG_LOCATION_PREFIX = "/WEB-INF/";
    
        /** Default suffix for building a config location for a namespace */
        public static final String DEFAULT_CONFIG_LOCATION_SUFFIX = ".xml";
        protected String[] getDefaultConfigLocations() {
            if (getNamespace() != null) {
            //有命名空间时默认使用/WEB-INF/{命名空间}.xml配置文件，而这个命名空间是在FrameworkServlet中定义的，默认为{servlet-name}-servlet，所以，最后得到的配置文件就是/WEB-INF/{servlet-name}-servlet.xml，因此Idea自动帮我们创建了一个/WEB-INF/mvc-dispatcher-servlet.xml，这个就是spring-mvc的入口配置文件
                return new String[] {DEFAULT_CONFIG_LOCATION_PREFIX + getNamespace() + DEFAULT_CONFIG_LOCATION_SUFFIX};
            }
            else {
            //否则使用/WEB-INF/applicationContext.xml配置文件
                return new String[] {DEFAULT_CONFIG_LOCATION};
            }
        }

## 3.mvc-dispatcher-servlet.xml ##

如上面所说，这个配置文件是spring mvc框架的入口配置文件。

### 3.1 context:component-scan ###

在xml配置了这个标签后，spring可以自动去扫描base-pack下面或者子包下面的java文件，如果扫描到有@Component @Controller@Service等这些注解的类，则把这些类注册为bean。这样就不需要在xml文件中详细配置每一个bean了。

### 3.2 DispatcherServlet中的特殊Bean ###

可以看到，IDEA还配置了一个Bean，这是DispacherServlet中几个特殊Bean的一种：ViewResolver——视图解析器，InternalResourceViewResolver是视图解析器的一种，会将返回的ModelAndView转换为相应jsp文件进行渲染，这里有两个配置选项，分别是jsp文件的前缀和后缀。

## 4.Controller ##

IDEA生成了一个最简单的Controller，也就是最常用来测试的Hello World!

1.  在上面说context:component-scan时提到过，我们在com.springapp.mvc下创建的Controller会自动注册为bean，IDEA就在这个包下创建了一个Controller:HelloController.java。并添加注解

//Controller注解，通过配置自动注册
    @Controller
    //注册地址映射，这里是映射网站根目录
    @RequestMapping("/")
    public class HelloController { 
        @RequestMapping(method = RequestMethod.GET)
        public String printWelcome(ModelMap model) {
            //绑定变量
            model.addAttribute("message", "Hello world!");
            //返回hello，则视图解析器会自动加前后缀，最后解析到/WEB-INF/pages/hello.jsp
            return "hello";
        }
    }

1.  hello.jsp，这个文件进行视图渲染，直接使用绑定变量

<html>
    <body>
        <h1>${message}</h1>
    </body>
    </html>

## 5.IDEA配置 ##

除了上面自动创建的几个文件，IDEA还做了一些通用配置，了解一下有助于以后手动配置。

### 5.1 IDEA的UI ###

先提一下IDEA的UI，有许多帮助开发的小工具。

1.  Spring->Bean模块，专门为Spring相关功能做得一个信息收集模块，可以看到相关的配置文件、配置文件注册的Bean、对应的JAVA类等，如下图：  
    ![图片名称][20160425161702302]
2.  Spring->MVC模块，主要是展示MVC的Controller地址映射，不同的URL下，对应的Controller类、方法，可以快速定位代码，非常方便，如下图：  
    ![图片名称][20160425161717044]
3.  代码编辑框中，Spring注解相应操作标识，根据不同Spring注解，点击会有不同操作，如下图：  
    ![图片名称][20160425161735240]

### 5.2 IDEA配置 ###

File->Project Structure中可以看到相关配置：

1.  Modules配置，添加Spring相关配置，如下图：  
    ![图片名称][20160425161752584]
2.  Artifacts配置，添加服务器部署配置，如下图：  
    ![图片名称][20160425161807209]

## 6.小结 ##

通过了解IDEA创建Spring mvc工程自动添加的文件与配置，初步了解框架的结构，当然，最好还是找本好书系统学习一下^\_^

[20160425161546684]: /images/20220724/79215cfc6b524071918ca0354c0ea1a6.png
[20160425161611910]: /images/20220724/4cf3a515216545f785d705e42545b4ec.png
[20160425161702302]: /images/20220724/9dca329e6d564ade81461f37ff0b9444.png
[20160425161717044]: /images/20220724/ad355d9532bc4069a55b331e7b522ebb.png
[20160425161735240]: /images/20220724/b82d808bc17b468288e715d7acc47e81.png
[20160425161752584]: /images/20220724/b6205e4ed7d246c1858ebe64cd481e47.png
[20160425161807209]: /images/20220724/182545f84ce54014a75aa11b7ff323c1.png