springMVC: RestFul案例1

1. 创建maven项目

新建一个java项目，工程名字springMVC：在项目中，右键new - module - maven - next - 取名RestFul；

Groupld可以写自己的，这里用的是com.atguigu.mvc，下面的配置文件中有对应的部分；

Artifactld和上面新取的工程名一样。

2. 打开pom.xml配置文件

①添加打包方式：<packaging>war</packaging>

②添加依赖：复制到下面

 代码如下：

<dependencies>
        <!-- SpringMVC -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>5.3.1</version>
        </dependency>

        <!-- 日志 -->
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-classic</artifactId>
            <version>1.2.3</version>
        </dependency>

        <!-- ServletAPI -->
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>javax.servlet-api</artifactId>
            <version>3.1.0</version>
            <scope>provided</scope>
        </dependency>

        <!-- Spring5和Thymeleaf整合包 -->
        <dependency>
            <groupId>org.thymeleaf</groupId>
            <artifactId>thymeleaf-spring5</artifactId>
            <version>3.0.12.RELEASE</version>
        </dependency>
</dependencies>

注：

 - 如果报红的话，可以等下载、重启；

 - <scope>provided</scope>表示该jar包由服务器提供。

3. 创建web

 - 在maven工程 - src - main - 右键新建Directory - 输入webapp，至此新建了一个名叫webapp的文件夹；

 - File - Project Structure - Modules - 在中间的竖框选择对应的maven工程右键 - Add - Web；

 - 点击新建的这个Web，然后点击右边的Deployment Descriptors下面的铅笔符号，将地址改到webapp目录下：springMVC_demo1\src\main\webapp\WEB-INF\web.xml；

 - Apply - ok（再把系统自己创建的web删除）

 4. 配置web.xml

① 默认配置方式

此配置作用下，SpringMVC的配置文件默认位于WEB-INF下，默认名称为<servlet-name>-

servlet.xml（位置、名称默认）。例如，以下配置所对应SpringMVC的配置文件位于WEB-INF下，文件名为springMVCservlet.xml。

代码：web.xml的<web-app>...</web-app>中

<!--配置springMVC的编码过滤器-->
    <filter>
        <filter-name>CharacterEncodingFilter</filter-name>
        <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
        <init-param>
            <param-name>encoding</param-name>
            <param-value>UTF-8</param-value>
        </init-param>
        <init-param>
            <param-name>forceResponseEncoding</param-name>
            <param-value>true</param-value>
        </init-param>
    </filter>
    <filter-mapping>
        <filter-name>CharacterEncodingFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

<!-- 配置SpringMVC的前端控制器，对浏览器发送的请求统一进行处理 -->
<servlet>
    <servlet-name>springMVC</servlet-name>
#这个名字可以随便写，一般和servlet的名字保持一致，例如：起名为DispatcherServlet，这里起为springMVC也没问题
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
</servlet>
<servlet-mapping>
    <servlet-name>springMVC</servlet-name>
    <!--设置springMVC的核心控制器所能处理的请求的请求路径
        /所匹配的请求可以是/login或.html或.js或.css方式的请求路径
        但是/不能匹配.jsp请求路径的请求
        /* 代表所有请求-->
    <url-pattern>/</url-pattern>
</servlet-mapping>

② 扩展配置方式

在上面默认配置方式的基础上，增加了参数。直接在上面代码的基础上加即可。

这里配置了编码过滤器、请求处理方式的HiddenHttpMethodFilter过滤器、前端控制器。

注：

 - 由于在web.xml中写入了classpath:springMVC.xml，因此需要创建springMVC.xml文件，使新添进去的代码能够找到这个地址。这个将在下一步操作，这里就先让他报错。

 - 可通过init-param标签设置SpringMVC配置文件的位置和名称，通过load-on-startup标签设置SpringMVC前端控制器DispatcherServlet的初始化时间。

代码：web.xml的<web-app>...</web-app>中

    <!--配置springMVC的编码过滤器-->
    <filter>
        <filter-name>CharacterEncodingFilter</filter-name>
        <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
        <init-param>
            <param-name>encoding</param-name>
            <param-value>UTF-8</param-value>
        </init-param>
        <init-param>
            <param-name>forceResponseEncoding</param-name>
            <param-value>true</param-value>
        </init-param>
    </filter>
    <filter-mapping>
        <filter-name>CharacterEncodingFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>


    <!--配置请求处理方式put和delete的HiddenHttpMethodFilter-->
    <filter>
        <filter-name>HiddenHttpMethodFilter</filter-name>
        <filter-class>org.springframework.web.filter.HiddenHttpMethodFilter</filter-class>
    </filter>
    <filter-mapping>
        <filter-name>HiddenHttpMethodFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>


<!-- 配置SpringMVC的前端控制器，对浏览器发送的请求统一进行处理 -->
    <servlet>
        <servlet-name>DispatcherServlet</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <!-- 如果不设置springMVC，那么它的配置文件的默认位置为WEB-INF，默认名称为<servlet-name>的值/Servlet.xml
          解释一下：一般Servlet的配置文件在web.xml里，现在引入了springMVC框架，那么配置文件需要在spring的配置文件中。 -->
        <!-- 通过初始化参数指定SpringMVC配置文件的位置和名称 -->
        <init-param>
            <!-- contextConfigLocation为固定值 -->
            <param-name>contextConfigLocation</param-name>
            <!-- 使用classpath确定springMVC的配置文件，这里起名为springMVC.xml。和(5)②建立的spring的xml的配置文件名称保持一致 -->
            <param-value>classpath:springMVC.xml</param-value>
        </init-param>
        <!--
            作为框架的核心组件，在启动过程中有大量的初始化操作要做
            而这些操作放在第一次请求时才执行会严重影响访问速度
            因此需要通过此标签将启动控制DispatcherServlet的初始化时间提前到服务器启动时
        -->
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>DispatcherServlet</servlet-name>
        <!--这name和上面那个servlet-name保持一致 -->
        <!--设置springMVC的核心控制器所能处理的请求的请求路径
            /所匹配的请求可以是/login或.html或.js或.css方式的请求路径
            但是/不能匹配.jsp请求路径的请求
            /* 代表所有请求-->
        <url-pattern>/</url-pattern>
    </servlet-mapping>

5. 配置springMVC.xml文件

(1) 创建springMVC.xml

路径：

src - main - resources右键 - new - XML Configuration File - Spring Config - 起名springMVC

注：如果没有Spring Config，可以重启一下，这个时候会发现webapp文件夹上出现了蓝色圆球。

(2) 配置springMVC.xml文件（resources目录下）

web-inf下的内容无法通过浏览器直接访问，重定向也不行，只能用请求转发。

①首先在xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"下面补上：

xmlns:context="http://www.springframework.org/schema/context"

②在xsi:schemaLocation="后面的地址补上：

http://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd"

（这两个地址其实是下面的context爆红，我用快捷键处理后自动加上的）

③ 以下代码放进springMVC.xml的<beans>...</beans>中

<!-- 自动扫描包 -->
    <context:component-scan base-package="com.atguigu.rest"/>

    <!-- 配置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>

<!--
    <mvc:view-controller path="/" view-name="index"></mvc:view-controller>
    <!-- 开启mvc注解驱动-->
    <mvc:annotation-driven/>
-->

6. 创建实体类

① 右键java - new - package - 起名com.atguigu.rest.bean；

在该包下创建一个实体类：Employee

public class Employee {
    private Integer id;
    private String lastName;
    private String email;
    //1 male, 0 female
    private Integer gender;

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getLastName() {
        return lastName;
    }

    public void setLastName(String lastName) {
        this.lastName = lastName;
    }

    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }

    public Integer getGender() {
        return gender;
    }

    public void setGender(Integer gender) {
        this.gender = gender;
    }

    public Employee(Integer id, String lastName, String email, Integer gender) {
        super();
        this.id = id;
        this.lastName = lastName;
        this.email = email;
        this.gender = gender;
    }

    public Employee() {
    }
}

② 右键com.atguigu.rest - new - java class - 起名：dao.EmployeeDao

// Dao: 数据访问接口
// @Repository持久层注解
@Repository
public class EmployeeDao {
    private static Map<Integer, Employee> employees = null;

    static {
        employees = new HashMap<Integer, Employee>();
        employees.put(1001, new Employee(1001, "E-AA", "aa@163.com", 1));
        employees.put(1002, new Employee(1002, "E-BB", "bb@163.com", 1));
        employees.put(1003, new Employee(1003, "E-CC", "cc@163.com", 0));
        employees.put(1004, new Employee(1004, "E-DD", "dd@163.com", 0));
        employees.put(1005, new Employee(1005, "E-EE", "ee@163.com", 1));
    }

    private static Integer initId = 1006;

    public void save(Employee employee) {
        if (employee.getId() == null) {
            employee.setId(initId++);
        }
        employees.put(employee.getId(), employee);
    }

    public Collection<Employee> getAll() {
        return employees.values();
    }

    public Employee get(Integer id) {
        return employees.get(id);
    }

    public void delete(Integer id) {
        employees.remove(id);
    }
}

这里由于添加了Repository注解，因此需要在前面springMVC.xml的扫描组件部分不仅要扫描控制器，对于该持久性注解也需要进行扫描。写为：

<context:component-scan base-package="com.atguigu.rest.controller, com.atguigu.rest.dao"/>

或者

<context:component-scan base-package="com.atguigu.rest"/>

这样就可以找到控制层组件、DAO组件。

PS: 原本为：<context:component-scan base-package="com.atguigu.rest.controller"/>

只扫描控制器

③创建控制器：

说明：

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

请求控制器中每一个处理请求的方法成为控制器方法；

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

创建：

src - main - java右键 - Java Class - 起名：com.atguigu.rest.controller.EmployeeController

并添加：@Controller 注解

注：用注解进行标识，通过扫描让其作为bean进行管理。让springMVC知道这个类是一个控制器，从而将这个类中的方法作为控制器方法。

@Controller
public class EmployeeController {
    @Autowired
    //自动装配：默认根据ByType，其次ByName。在IOC容器的范围内找到一个Bean来赋值
    //通过注解 + 扫描，IOC容器中就包含了EmployeeDao这个Bean，从而进行自动装配
    private EmployeeDao employeeDao;

}

结构如下：

7. 首页

① 创建首页的html

在WEB-INF右键创建目录Directory，起名为：templates；

右键templates创建一个html，起名为：index.html

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>首页</title>
</head>
<body>
<!--首页：在templates目录下，由视图前缀决定-->
<h1>首页</h1>
<!--超链接发送的请求类型为get请求-->
<a th:href="@{/employee}">查看员工信息</a>

</body>
</html>

注：这里别忘了加上：xmlns:th="http://www.thymeleaf.org"

② 添加view-controller视图控制器

在springMVC.xml添加访问首页的view-controller（视图控制器）：使得显示出首页

需要添加：

xmlns:mvc="http://www.springframework.org/schema/mvc"

以及：

http://www.springframework.org/schema/mvc
http://www.springframework.org/schema/mvc/spring-mvc.xsd

<mvc:view-controller path="/" view-name="index"></mvc:view-controller>
<!-- 开启mvc注解驱动-->
<mvc:annotation-driven/>

8. 配一个Tomcat访问实例

步骤：

①锤子右边的Add Configuration - +号 - Tomcat Server - local - 起个名springMVC；

②Development - +号 - Artifact - war exploded；

③Application context（上下文路径）改为：/springMVC；

④Server - On ‘update’ action: Redeploy

⑤On frame deactivation: Update classes and resources;

⑥Application server - Configure - 选择自己安装的Tomcat解压的文件夹 - Apply - ok

到这里，就可以采用debug方式测试一下，能否到达首页。

最后附下完整的配置文件程序：

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">

    <!--配置springMVC的编码过滤器-->
    <filter>
        <filter-name>CharacterEncodingFilter</filter-name>
        <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
        <init-param>
            <param-name>encoding</param-name>
            <param-value>UTF-8</param-value>
        </init-param>
        <init-param>
            <param-name>forceResponseEncoding</param-name>
            <param-value>true</param-value>
        </init-param>
    </filter>
    <filter-mapping>
        <filter-name>CharacterEncodingFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>


    <!--配置请求处理方式put和delete的HiddenHttpMethodFilter-->
    <filter>
        <filter-name>HiddenHttpMethodFilter</filter-name>
        <filter-class>org.springframework.web.filter.HiddenHttpMethodFilter</filter-class>
    </filter>
    <filter-mapping>
        <filter-name>HiddenHttpMethodFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>


    <!-- 配置SpringMVC的前端控制器，对浏览器发送的请求统一进行处理 -->
    <servlet>
        <servlet-name>DispatcherServlet</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <!-- 如果不设置springMVC，那么它的配置文件的默认位置为WEB-INF，默认名称为<servlet-name>的值/Servlet.xml
          解释一下：一般Servlet的配置文件在web.xml里，现在引入了springMVC框架，那么配置文件需要在spring的配置文件中。 -->
        <!-- 通过初始化参数指定SpringMVC配置文件的位置和名称 -->
        <init-param>
            <!-- contextConfigLocation为固定值 -->
            <param-name>contextConfigLocation</param-name>
            <!-- 使用classpath确定springMVC的配置文件，这里起名为springMVC.xml。和(5)②建立的spring的xml的配置文件名称保持一致 -->
            <param-value>classpath:springMVC.xml</param-value>
        </init-param>
        <!--
            作为框架的核心组件，在启动过程中有大量的初始化操作要做
            而这些操作放在第一次请求时才执行会严重影响访问速度
            因此需要通过此标签将启动控制DispatcherServlet的初始化时间提前到服务器启动时
        -->
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>DispatcherServlet</servlet-name>
        <!--这name和上面那个servlet-name保持一致 -->
        <!--设置springMVC的核心控制器所能处理的请求的请求路径
            /所匹配的请求可以是/login或.html或.js或.css方式的请求路径
            但是/不能匹配.jsp请求路径的请求
            /* 代表所有请求-->
        <url-pattern>/</url-pattern>
    </servlet-mapping>

</web-app>

springMVC.xml:

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xmlns:context="http://www.springframework.org/schema/context"
       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
       http://www.springframework.org/schema/context
       https://www.springframework.org/schema/context/spring-context.xsd
       http://www.springframework.org/schema/mvc
       http://www.springframework.org/schema/mvc/spring-mvc.xsd">

    <!-- 自动扫描包 -->
    <context:component-scan base-package="com.atguigu.rest"/>

    <!-- 配置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>

    <mvc:view-controller path="/" view-name="index"></mvc:view-controller>
    <!-- 开启mvc注解驱动-->
    <mvc:annotation-driven/>
</beans>