JAVA开发中SpringMVC框架的使用及常见的404问题原因以及SpringMVC框架基于注解的开发实例

一、JAVA开发中SpringMVC框架的使用及常见的404问题原因

使用SpringMVC建立一个web项目，在IDEA中file->new->project建立一个空项目project。不用选择create from archetype从模板创建。然后在项目的pom.xml中添加公共的依赖包括org.springframework，junit，然后在此目录下建立new module，依然不要选择create from archetype。每个module可以是一个独立的子项目，创建好之后在模块上右键添加add framework support ,钩选WEB支持即可。然后在此module中添加其所需要的依赖到其pom.xml中。

<!--上述公共依赖包如下-->
<!--导入公共依赖-->
    <dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.13</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>5.3.0</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.2</version>
        </dependency>
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>jstl</artifactId>
            <version>1.2</version>
        </dependency>
    </dependencies>

此处需要注意，别忘了添加上静态资源过滤：

    <build>
        <resources>
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                </includes>
                <filtering>false</filtering>
            </resource>
            <resource>
                <directory>src/main/resources</directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                </includes>
                <filtering>false</filtering>
            </resource>
        </resources>
    </build>

完成项目建立并添加要的依赖之后，开始配置web.xml。包括把spring mvc的dispatcherServlet注册到servlet中，并设置所有由根地址请求的URL匹配到springMVC的servlet来处理。如下：

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
         version="4.0">
    
    <!--注册dispatcherServlet-->
    <servlet>
        <servlet-name>springmvc</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:springmvc-servlet.xml</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>
    
    <servlet-mapping>
        <servlet-name>springmvc</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>
</web-app>

另外上面在配置springMVC框架的时候需要指定contextConfigLocation上下文的配置文件地址，即SpringMVC集合spring时，spring需要用的配置文件，如上我们使用的springmvc-servlet.xml文件，此文件放在java源代码下的src/main/resources目录中。内容如下：

<?xml version="1.0" encoding="utf-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans.xsd">

    <bean class="org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping" />
    <bean class="org.springframework.web.servlet.mvc.SimpleControllerHandlerAdapter" />

    <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver" id="InternalResourceViewResolver">
        <property name="prefix" value="/WEB-INF/jsp/" />
        <property name="suffix" value=".jsp" />
    </bean>

    <bean id="/index" class="com.kermit.controller.IndexController" />
</beans>

上述InternalResourceViewResolver中的property指定了视图的加载路径及后缀，并配置了当请求为/index时，交由class类：IndexController 来处理。IndexController 是spring的import org.springframework.web.servlet.mvc.Controller;的实现，其实例化一个MV并操作数据将数据绑定给mv后返回给视图展示，代码如下：

package com.kermit.controller;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.mvc.Controller;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class IndexController implements Controller {

    public ModelAndView handleRequest(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse) throws Exception {
        ModelAndView mv = new ModelAndView();
        mv.addObject("msg", "springMVC Project");
        mv.setViewName("home");
        return mv;
    }
}

视图内容不用过多编辑，只需要添加对应目录文件：/WEB-INF/jsp/home.jsp，里面使用${msg} 取得msg的内容展示即可。如下示例：

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
${msg}
</body>
</html>

然后启动tomcat服务器即可成功运行springMVC框架。

在项目执行的时候可能容易遇到404错误，如果代码上没有什么问题，错误可能出在使用tomcat运行的时候未把lib包放到tomcat下，导致tomcat运行时找不到jar包从而运行出错。进入project structure选项，找到Artifacts选项卡，看要运行的module下打的包文件下是不是缺少classes/lib目录及文件，添加上对应文件即可。如下图：

二、SpringMVC框架基于注解的开发实例

JAVA中SpringMVC框架将以前很多需要人工手动重复做的通用东西打包封装好，让开发者上手就只要关注业务开发，确实方便不少。包括使用注解，直接在当前控制器、方法上方便地与url进行绑定，而不用跑到一个什么route里面去进行各项配置等。使用SpringMVC框架注解开发小实例如下：

首先我们还是要导入springmvc依赖等，这个可以复制上一篇文章中的依赖内容。然后我们创建一个module，添加web framework support。接下来是我们的web.xml配置文件内容以及由这个配置文件中指定的spring配置文件位置contextConfigLocation：比如下面的springmvc.xml(路径为src/main/resources/springmvc.xml)。如下：

<!--web.xml配置文件-->
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
         version="4.0">
    <servlet>
        <servlet-name>springmvc</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:springmvc.xml</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>springmvc</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>
</web-app>

<!--src/main/resources/springmvc.xml配置文件-->
<?xml version="1.0" encoding="utf-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/mvc https://www.springframework.org/schema/mvc/spring-mvc.xsd">
    <!--自动扫包设置-->
    <context:component-scan base-package="cn.kermitest.controllers" />
    <!--处理器映射器，适配器-->
    <mvc:default-servlet-handler/>
    <!--注解开发驱动支持-->
    <mvc:annotation-driven/>

    <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"
          id="InternalResourceViewResolver">
        <property name="prefix" value="/WEB-INF/jsp/" />
        <property name="suffix" value=".jsp" />
    </bean>

</beans>

在上方的springmvc.xml配置文件中，我们不再使用bean导入handlemapping和adapter之类的类，而是使用<mvc:default-servlet-handler/>让springMVC直接自己调用默认类，使用<mvc:annotation-driven/>添加注解开发驱动支持。另外使用context:component-scan自动扫包，而不用我们将每一个class类在这里与url绑定。其它视图控制基础配置如下。接下来我们依然添加一个只有${msg}的jsp文件放在视图目录下，然后就只需要对控制器进行开发， TestController代码如下：

package cn.kermitest.controllers;

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;

@Controller
public class TestController {

    @RequestMapping(value = "/index")
    public String index(Model model){

        model.addAttribute("msg", "hello, everyone.");
        return "index";
    }
}

如上，我们在控制器的上方只需要通过@Controller 注解让此方法由springmvc接管，在方法上方使用 @RequestMapping注解并通过value指定浏览器中哪个uri请求转发到当前的方法即可完成前端请求和后端的处理class类相绑定，最后由model类取得数据，在return中只需要返回视图的名字，springMVC会自动找到视图文件并将model中的数据取到视图中进行呈现处理。而在使用java做服务端的api开发的时候只需要将上面的 @Controller注解改成 @RestController 则页面就会直接呈现return 返回的字符串，而不会去加载视图文件。非常适合api开发。