springMVC学习1------新建工程

2023-12-18 09:49:46

1、新建一个Spring项目

2、新建一个maven 模块

新建module，选择maven，然后什么都不选，田springMVC-demo1，maven默认打包方式为jar包，因为我们是一个web项目，所以在pom文件中添加打包方式为war包，然后添加所需的依赖。

------------------插入知识点--------------

（tomcat自带servletAPI和jspAPI）

<scope>provided</scope>是定义jar包的依赖范围，什么时候能用到这个jar包，provided的代表这个jar包已经被提供，所以这个项目被打包为war包的时候，不会把这个jar打包到war包里的webapp下面的WEB-INF里的lib目录下，这个时候的jar包由服务器提供。

------------------插入结束--------------

所添加的依赖如下：

    <dependencies>
        <!-- https://mvnrepository.com/artifact/org.springframework/spring-webmvc -->
        <!---springmvc  -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>5.3.1</version>
        </dependency>

        <!-- https://mvnrepository.com/artifact/ch.qos.logback/logback-classic -->
        <!--  日志 -->
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-classic</artifactId>
            <version>1.2.3</version>
            <scope>test</scope>
        </dependency>

        <!-- https://mvnrepository.com/artifact/javax.servlet/javax.servlet-api -->
        <!-- servletAPI -->
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>javax.servlet-api</artifactId>
            <version>3.1.0</version>
            <scope>provided</scope>
        </dependency>

        <!-- https://mvnrepository.com/artifact/org.thymeleaf/thymeleaf -->
        <!-- spring5和thymeleaf整合包 -->
        <dependency>
            <groupId>org.thymeleaf</groupId>
            <artifactId>thymeleaf-spring5</artifactId>
            <version>3.0.12.RELEASE</version>
        </dependency>
        
    </dependencies>

注意：下面开始错了，把webapp建到springMVC下了，其实我自己的目录springMVC-demo1里已经有webapp文件夹了（不知道为啥了）

3、在maven模块下添加webapp文件夹，增加WEB-INF，和web.xml配置文件（这一步操作是因为在创建maven模块的时候什么都没选才需要进行，如果创建maven模块的时候选了webapp，那就需要这一步）

查看项目结构project structure，

点击上面的加号，选择了web.xml后，下面这个界面是创建的web.xml文件的地址，可以看到地址是不对的，需要我们手动改一下，web.xml文件是在WEB-INF下，WEB-INF是在webapp下，webapp是在main下，main是在src下，src是在springMVC-demo1下。所以地址应该为springMVC-demo1/src/main/webapp/WEB-INF/web.xml。

这里点击apply的时候报错了，找了下问题发现第3步开始弄错了，我的项目目录是这样的现在，本来应该是在1的地方新建webapp目录，然后再按上面的操作建web-inf和web.xml文件，但是我建到了2的位置，然后报错发现了错误，我已经把2的位置的webapp文件删掉了，然后1的这个位置的webapp和web-inf我已经不知道是我新建maven自动创建的还是因为3的操作建的，后面有机会再验证吧。

按照3的步骤创建web.xml文件（除去创建webapp文件夹的过程），点击ok，

点击apply，提示错误，和刚刚的错误是一样的，然后我看了下项目目录，我觉得应该是说一个项目里不能有两个src/main/java文件吧，然后打算把下面的src删了试试，也就是父模块的src删了试试，这次点击apply，没报错，然后点击ok之后，创建web.xml文件成功。

4、配置web.xml文件

web.xml的配置方式有两种：一种是默认配置方式，另一种是扩展的默认方式。

默认配置方式：

默认的配置，SpringMVC的配置文件默认位于WEB-INF下，默认名称为<servlet-name>-servlet.xml，例如，以下配置中servlet-name为springMVC，那么它的SpringMVC的配置文件就是在WEB-INF下，文件名为springMVC-servlet.xml

    <!--配置springmvc的前端控制器，对浏览器发送的请求进行统一的处理-->
    <servlet>
        <servlet-name>springMVC</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    </servlet>
    <servlet-mapping>
        <servlet-name>springMVC</servlet-name>
        <!--两个标签servlet和servlet-mapping里的servlet-name必须是同一个，比如这个都叫springMVC-->
        <url-pattern>/</url-pattern>
        <!--设置springMVC的核心控制器所能处理的请求的请求路径
            /所匹配的请求可以是/login或.html或.css或.js方式的请求路径
            但是/不能匹配.jsp请求的路径的请求
            因为jsp本质是一个servlet，需要经过服务器特殊的servlet指定的servlet进行处理
            如果springMVC可以匹配jsp请求的话，前端控制器就会把jsp请求当作一个普通的请求，就不会找到它对应的jsp页面
            /*代表的是所有请求，包括.jsp的请求-->
    </servlet-mapping>

但这样做好吗，不好，因为学了maven工程后，配置文件是统一放在resource文件下(这里发现自己main文件下没有java文件夹和resources文件夹，以及src下没有test文件夹，所以自己创建了一下，选中src-右键-new directory)，所以我们选用第二种配置方式-扩展配置方式。

扩展配置方式（用的最多）：

配置文件不放在WEB-INF下，WEB-INF下只放html页面和web.xml。

使用init-param标签（初始化参数），参数名为contextConfigLocation(这个参数已经在前端控制器中定义好了，所以在这里直接赋值就会具有相对应的功能)，来配置SpringMVC配置文件的位置和名称。

我们把配置文件的名称叫为springMVC.xml，然后发现报错，是因为这个时候我们在resources下没有springMVC.xml文件。

按照下面的操作，在resources下建立一个xml的配置文件springMVC.xml，然后这个时候就不报错了。

除了配置文件名和位置外，我们还可以使用标签<load-on-startup>来配置前端控制器的初始化时间（servlet的初始化时间默认是第一次访问的时候，但是因为前端控制器封装了所有的请求处理，如果把众多的初始化的内容都放到第一次访问的时候才初始化的话，那第一次访问的时间就会很长），将初始化时间提前到服务器启动时，这样就不会影响第一次访问的速度。

下面是扩展配置方式的配置文件：

 <!--配置springmvc的前端控制器，对浏览器发送的请求进行统一的处理-->
    <servlet>
        <servlet-name>springMVC</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <!--contextConfigLocation是在前端控制器中已经定义好的，这里直接用来赋值-->
            <param-value>classpath:springMVC.xml</param-value>
            <!--classpath对应的就是类路径，也就是java和resources-->
            <!--param-value中有两个值，一个是位置一个是名称-->
        </init-param>
        <!--将前端控制器DispatcherServlet的初始化时间提前都服务器启动时-->
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>springMVC</servlet-name>
        <!--两个标签servlet和servlet-mapping里的servlet-name必须是同一个，比如这个都叫springMVC-->
        <url-pattern>/</url-pattern>
        <!--设置springMVC的核心控制器所能处理的请求的请求路径
            /所匹配的请求可以是/login或.html或.css或.js方式的请求路径
            但是/不能匹配.jsp请求的路径的请求
            因为jsp本质是一个servlet，需要经过服务器特殊的servlet指定的servlet进行处理
            如果springMVC可以匹配jsp请求的话，前端控制器就会把jsp请求当作一个普通的请求，就不会找到它对应的jsp页面
            /*代表的是所有请求，包括.jsp的请求-->
    </servlet-mapping>

以上就是web.xml文件的配置。

5、创建请求控制器

由于前端控制器对浏览器发送的请求进行了统一的处理，但是不同的请求有不同的处理过程，因此需要创建处理具体请求的类，即请求控制器。请求控制器中每一个处理请求的方法称为控制器方法。

SpringMVC的控制器由一个POJO（Plain Ordinary Java Object）(普通的java类)担任，因此需要通过@Controller注解将其标识为一个控制层组件，交给Spring的IOC容器管理，此时SpringMVC才能够识别控制器的存在。

创建请求控制器，即类

现在呢，这就是一个普通的类，我们怎么让这个普通的类被SpringMVC识别为控制器呢？

把这个普通的类变为Spring IOC容器中一个组件的时候，它才是一个控制器。

要把这个普通的类作为Spring IOC中的一个组件来管理有两种方法，第一种是通过Bean标签来进行配置；第二种是通过注解加扫描的方式。

这里用注解+扫描的方式来配置当前的控制器。

把一个类标识为一个IOC容器组件的注解一共有4种，第一个是@Component，把当前的类标识为一个普通组件；第二个是@Controller，把它标识为控制层组件；第三个是@Service，把它标识为业务层组件；第四个是@Repository，把它标识为持久层组件。

我们这里使用@Controller注解。

但是仅仅使用@Controller来注解还不够，我们还需要把这个类经过扫描才可以作为bean来管理。

然后这个扫描的话需要在springMVC.xml文件中进行配置。

 <!--扫描组件-->
    <context:component-scan base-package="com.xxxx.mvc.controller"></context:component-scan>

配置完之后，就可以看到这个类这里出现了一个图标，有这个图标就代表这个类的对象已经交给了IOC容器来管理了。

6、配置springMVC.xml文件（配置视图解析器）

视图解析器负责页面的跳转。

<!--配置thymeleaf视图解析器-->
    <bean id="viewResolver" class="org.thymeleaf.spring5.view.ThymeleafViewResolver">
        <property name="order" value="1"/>
        <property name="characterEncoding" value="UTF-8"/>
        <property name="templateEngine">
            <bean class = "org.thymeleaf.spring5.SpringTemplateEngine">
                <property name ="templateResolver">
                    <bean class="org.thymeleaf.spring5.templateresolver.SpringResourceTemplateResolver">
                        <!--视图前缀-->
                        <property name="prefix" value="/WEB-INF/templates/"/>
                        <!--视图后缀-->
                        <property name="suffix" value=".html"/>
                        <property name="templateMode" value="HTML5"/>
                        <property name="characterEncoding" value="UTF-8"/>
                    </bean>
                </property>

            </bean>
        </property>
    </bean>

7、在/WEB-INF下新建一个文件夹templates，然后在templates下面新建一个html，叫index.html

现在我们想跳转到这个页面可以吗？不可以，因为WEB-INF下的内容通过浏览器是不可以直接访问的，通过重定向也不可以访问。我们只能通过转发才可以进行访问。

8、在控制器下写控制器方法--实现对首页的访问

    //当前的请求路径是"/"，要访问的页面是"/WEB-INF/templates/index.html"
    @RequestMapping(value = "/")
    //请求映射注解，把当前和请求和控制器方法建立映射关系，value可以省略（"/"）
    //当浏览器发送的请求是/时候，就会执行注解所标识的方法，其实就相当于设置的默认页面
    public String index(){
        //返回视图的名称
        //返回的视图名称会被视图解析器进行解析，视图前缀+视图名称+视图后缀，就是最终要访问的页面
        return "index";
    }

9、配置tomcat，通过tomcat来访问当前的工程

点加号如果没有Artifact这个选项的话，就是因为在pom文件里没有设置打包方式为war包，选artifact。

然后选exploded这个。

点击apply，ok，配置完成之后，建议用debug启动方式启动，因为后面断点调试都用debug。

（如果你这里启动了tomcat服务，但是页面是404，很可能是tomcat的版本太高了，我用的tomcat10，404，查了很多都不是，最后tomcat选9，就ok了）

10、在index页面添加跳转的页面

在index.html里增加一个超链接

<!--这个路径写得不对
    <a href="/target">访问目标页面target.html</a>
    /代表的是绝对路径，绝对路径又分为浏览器解析的和服务器解析的
    超链接里的路径是浏览器解析的，这里的绝对路径指得localhost:8080下的绝对路径
    所以这里少一个上下文路径，tomcat里配置的就是上下文路径/springMVC
    所以可以写成这样<a href="/springMVC/target">访问目标页面target.html</a>
    但是有可能我们的上下文路径会改，所以这里不能写死
    所以就需要用到thymeleaf
    <a th:href="@{/target}">访问目标页面target.html</a>
    加一个th：，这个属性就会被thymeleaf解析，然后@{}里面如果放的绝对路径，thymeleaf解析的时候就会自动加上上下文路径
-->
<a th:href="@{/target}">访问目标页面target.html</a>

新建一个target.html

在HelloController里添加控制器方法

    @RequestMapping(value = "/target")
    public String toTarget(){
        return "target";
    }

然后重新启动tomcat，点击超链接，跳转到target页面。

11、总结

浏览器发送请求，如果请求地址符合前端控制器的url-pattern，该请求就会被前端控制器DispatcherServlet处理，前端控制器会读取SpringMVC的核心配置文件，通过扫描组件找到控制器，将请求地址和控制器中@RequestMapping注解的value属性值进行匹配，若匹配成功，该注解所标识的控制器方法就是处理请求的方法。处理请求的方法需要返回一个字符串类型的视图名称，该视图名称会被视图解析器解析，加上前缀和后缀组成视图的路径，通过thymeleaf对视图进行渲染，最终转发到视图所对应的页面。

码农公寓