SpringMVC使用（一）

1. SpringMVC简介

SpringMVC 是隶属于 Spring 框架的一部分，主要是用来进行 Web 开发，是对 Servlet 进行了封装。

2. MVC和三层架构

2.1 MVC

MVC是GoF设计模式的其中一种，属于应用模式，其中：

M：Model，业务模型，处理业务，将数据返回给控制器。

V：View，视图，界面展示，为用户提供使用界面，与用户直接进行交互。

C：Controller，控制器，处理请求，将用户请求转发给相应的 Model 进行处理。

2.2 三层架构

三层架构是软件设计架构，将项目分成了表现层、业务逻辑层、数据访问层。

表现层：接收请求，封装数据，调用业务逻辑层，响应数据。

业务逻辑层：对业务逻辑进行封装，组合数据访问层层中基本功能，形成复杂的业务逻辑功能。

数据访问层：对数据库的CRUD基本操作。

2.3 MVC与三层架构的区别和联系

如上图所示，MVC 中的 C（控制器）和 V（视图）就是 三层架构 中的表现层，而 MVC 模式 中的 M（模型）就是 三层架构 中的 业务逻辑层 和 数据访问层。

3. SpringMVC入门案例

3.1 maven依赖

引入maven依赖，包括servlet、springmvc、tomcat插件等等

<dependencies>
  <dependency>
    <groupId>javax.servlet</groupId>
    <artifactId>javax.servlet-api</artifactId>
    <version>3.1.0</version>
    <scope>provided</scope>
  </dependency>
  <dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-webmvc</artifactId>
    <version>5.2.10.RELEASE</version>
  </dependency>
</dependencies>

<build>
  <plugins>
    <plugin>
      <groupId>org.apache.tomcat.maven</groupId>
      <artifactId>tomcat7-maven-plugin</artifactId>
      <version>2.1</version>
      <configuration>
        <!-- 指定启动端口 -->
        <port>80</port>
        <!-- 指定路径 -->
        <path>/</path>
      </configuration>
    </plugin>
  </plugins>
</build>

3.2 定义SpringMVC配置类

定义SpringMVC配置类，配置需要扫描的Controller

package com.lan.config;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;

@Configuration
@ComponentScan("com.lan.controller")
public class SpringMvcConfig {
}

3.3 定义Spring配置类

定义Spring配置类，扫描Controller以外的其它bean

package com.lan.config;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.FilterType;
import org.springframework.stereotype.Controller;

@Configuration
//@ComponentScan({"com.lan.service","com.lan.dao"})
//设置spring配置类加载bean时的过滤规则，当前要求排除掉表现层对应的bean
//excludeFilters属性：设置扫描加载bean时，排除的过滤规则
//type属性：设置排除规则，当前使用按照bean定义时的注解类型进行排除
//classes属性：设置排除的具体注解类，当前设置排除@Controller定义的bean
@ComponentScan(value="com.lan",
    excludeFilters = @ComponentScan.Filter(
        type = FilterType.ANNOTATION,
        classes = Controller.class
    )
)
public class SpringConfig {
}

3.3 定义容器配置类

初始化servlet容器，加载springmvc环境，并设置springmvc处理的请求路径。

注意，Controller需要加载到SpringMVC容器中，其它的bean加载到Spring容器中。

package com.lan.config;

import org.springframework.web.context.WebApplicationContext;
import org.springframework.web.context.support.AnnotationConfigWebApplicationContext;
import org.springframework.web.servlet.support.AbstractDispatcherServletInitializer;

//web容器配置类
public class ServletContainersInitConfig extends AbstractDispatcherServletInitializer {
    //加载springmvc配置类，产生springmvc容器（本质还是spring容器）
    protected WebApplicationContext createServletApplicationContext() {
        //初始化WebApplicationContext对象
        AnnotationConfigWebApplicationContext ctx = new AnnotationConfigWebApplicationContext();
        //加载指定配置类
        ctx.register(SpringMvcConfig.class);
        return ctx;
    }

    //设置由springmvc控制器处理的请求映射路径
    protected String[] getServletMappings() {
        return new String[]{"/"};
    }

    //加载spring配置类
    protected WebApplicationContext createRootApplicationContext() {
        AnnotationConfigWebApplicationContext ctx = new AnnotationConfigWebApplicationContext();
        ctx.register(SpringConfig.class);
        return ctx;
    }
}

或者使用以下这个

package com.lan.config;

import org.springframework.web.context.WebApplicationContext;
import org.springframework.web.context.support.AnnotationConfigWebApplicationContext;
import org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer;
import org.springframework.web.servlet.support.AbstractDispatcherServletInitializer;
//web配置类简化开发，仅设置配置类类名即可
public class ServletContainersInitConfig extends AbstractAnnotationConfigDispatcherServletInitializer {

    protected Class<?>[] getRootConfigClasses() {
        return new Class[]{SpringConfig.class};
    }

    protected Class<?>[] getServletConfigClasses() {
        return new Class[]{SpringMvcConfig.class};
    }

    protected String[] getServletMappings() {
        return new String[]{"/"};
    }
}

3.4 创建表现层的控制器

package com.lan.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

//定义表现层控制器bean
@Controller
public class UserController {

    //设置映射路径为/save，即外部访问路径
    @RequestMapping("/save")
    //设置当前操作返回结果为指定json数据（本质上是一个字符串信息）
    @ResponseBody
    public String save(){
        System.out.println("user save ...");
        return "{'info':'springmvc'}";
    }

    //设置映射路径为/delete，即外部访问路径
    @RequestMapping("/delete")
    @ResponseBody
    public String delete(){
        System.out.println("user save ...");
        return "{'info':'springmvc'}";
    }
}

3.5 启动应用

因为集成tomcat的maven插件，所以执行插件命令，即可启动web应用。

执行tomcat7:run命令启动web应用。

3.6 访问应用

浏览器或者postman访问http://localhost/save和http://localhost/delete

3.7 常用注解

注解	作用	作用目标
@Controller	定义控制器	类
@RequestMapping	设置控制器的访问路径的前缀，或设置控制器方法的请求路径	类、方法
@ResponseBody	设置控制器方法响应内容以json格式返回	类、方法

4. 请求参数

4.1 参数传递

tomcat版本不通，servlet支持获取到的参数途径也会有区别。

通常情况下，GET请求参数是通过Query String传递的，如下图所示

POST请求参数可以Query String传递，也可以通过x-www-form-urlencoded传递，tomcat8版本的servlet实现，POST请求参数也可以通过form-data传递。

 4.2 常用的参数传递方式

4.2.1 普通参数

@RequestMapping("/commonParam")
@ResponseBody
public String commonParam(@RequestParam("name") String username ,int age){
    System.out.println("普通参数传递 name ==> "+username);
    System.out.println("普通参数传递 age ==> "+age);
    return "{'module':'common param'}";
}

4.2.2 数组与集合

//数组参数：同名请求参数可以直接映射到对应名称的形参数组对象中
@RequestMapping("/arrayParam")
@ResponseBody
public String arrayParam(String[] likes){
    System.out.println("数组参数传递 likes ==> "+ Arrays.toString(likes));
    return "{'module':'array param'}";
}

//集合参数：同名请求参数可以使用@RequestParam注解映射到对应名称的集合对象中作为数据
@RequestMapping("/listParam")
@ResponseBody
public String listParam(@RequestParam List<String> likes){
    System.out.println("集合参数传递 likes ==> "+ likes);
    return "{'module':'list param'}";
}

4.2.3 POJO与嵌套POJO

//POJO参数：请求参数与形参对象中的属性对应即可完成参数传递
@RequestMapping("/pojoParam")
@ResponseBody
public String pojoParam(User user){
    System.out.println("pojo参数传递 user ==> "+user);
    return "{'module':'pojo param'}";
}

@Data
public class User {
    private String name;
    private int age;
    private Address address;
}

@Data
public class Address {
    private String province;
    private String city;
}

4.3 JSON数据参数传输

4.3.1 引入jackson依赖

SpringMVC默认使用Jackson处理json报文的转换，所以需要引入jackson的依赖。

<dependency>
  <groupId>com.fasterxml.jackson.core</groupId>
  <artifactId>jackson-databind</artifactId>
  <version>2.9.0</version>
</dependency>

不引入jackson依赖时，不支持Content-Type是application/json的参数自动转换，报错信息如下：

[WARNING] Resolved [org.springframework.web.HttpMediaTypeNotSupportedException: Content type 'application/json;charset=UTF-8' not supported]

4.3.2 开启SpringMVC注解支持

在SpringMVC的配置类中开启SpringMVC的注解支持，这里面就包含了将JSON转换成对象的功能。

@Configuration
@ComponentScan("com.lan.controller")
//开启json数据类型自动转换
@EnableWebMvc
public class SpringMvcConfig {
}

4.3.3 使用@RequestBody标明接收参数

@RequestMapping("/listPojoParamForJson")
@ResponseBody
public String pojoParamForJson(@RequestBody List<User> list){
    System.out.println("pojo(json)参数传递 user ==> "+user);
    return "{'module':'pojo for json param'}";
}

4.3.4 请求数据

 4.4 日期类型参数传参

//日期参数
//使用@DateTimeFormat注解设置日期类型数据格式，默认格式yyyy/MM/dd
@RequestMapping("/dataParam")
@ResponseBody
public String dataParam(Date date,
                        @DateTimeFormat(pattern="yyyy-MM-dd") Date date1,
                        @DateTimeFormat(pattern="yyyy/MM/dd HH:mm:ss") Date date2){
    System.out.println("参数传递 date ==> "+date);
    System.out.println("参数传递 date1(yyyy-MM-dd) ==> "+date1);
    System.out.println("参数传递 date2(yyyy/MM/dd HH:mm:ss) ==> "+date2);
    return "{'module':'data param'}";
}

4.5 实现原理

从servlet的HttpServletRequest对象中获取参数，然后经过Spring的org.springframework.core.convert.converter.Converter接口进行请求参数的转换，经过org.springframework.http.converter.HttpMessageConverter接口进行报文体中的json转对象

4.6 中文乱码问题

tomcat8.5以上的版本，默认已经解决了中文乱码问题。

Query String（uri）方式传参时出现中文乱码时，可以配置tomcat的uriEncoding属性为UTF-8。

表单方式传参出现中文乱码时，可以添加javax.servlet.Filter对表单数据设置UTF-8编码。

public class ServletContainersInitConfig extends AbstractAnnotationConfigDispatcherServletInitializer {
    protected Class<?>[] getRootConfigClasses() {
        return new Class[0];
    }

    protected Class<?>[] getServletConfigClasses() {
        return new Class[]{SpringMvcConfig.class};
    }

    protected String[] getServletMappings() {
        return new String[]{"/"};
    }

    //乱码处理
    @Override
    protected Filter[] getServletFilters() {
        CharacterEncodingFilter filter = new CharacterEncodingFilter();
        filter.setEncoding("UTF-8");
        return new Filter[]{filter};
    }
}

4.7 常用注解

注解	作用	作用目标
@Controller	定义控制器	类
@RequestMapping	设置控制器的访问路径的前缀，或设置控制器方法的请求路径	类、方法
@GetMapping	相当于@RequestMapping(method=RequestMethod.GET)	方法
@PostMapping	相当于@RequestMapping(method=RequestMethod.POST)	方法
@PutMapping	相当于@RequestMapping(method=RequestMethod.PUT)	方法
@DeleteMapping	相当于@RequestMapping(method=RequestMethod.DELETE)	方法
@ResponseBody	设置控制器方法响应内容以json格式返回	类、方法
@RequestParam	设置映射的参数，不加该注解时，也会默认是RequestParam	参数
@RequestBody	标识映射http json报文体的方法参数，一个方法只能标识一个参数	参数
@RestController	相当于@Controller + @ResponseBody	类
@DateTimeFormat	设置接收的日期格式	参数
@EnableWebMvc	开启SpringMVC多项辅助功能	配置类

4.8 restful风格传参

@GetMapping("/{id}")    //使用@GetMapping简化GET请求方法对应的映射配置
@ResponseBody
public String getById(@PathVariable Integer id){
    System.out.println("book getById..."+id);
    return "{'module':'book getById'}";
}

5. 响应

5.1 @ResponseBody修饰

Controller的方法或类加了@ResponseBody时，响应类型是text/plain、application/json等非html类型。

//响应文本数据
//返回值为String类型，设置返回值为任意字符串信息，即可实现返回指定字符串信息，需要依赖@ResponseBody注解
@RequestMapping("/toText")
@ResponseBody
public String toText(){
    System.out.println("返回纯文本数据");
    return "response text";
}

//响应POJO对象
//返回值为实体类对象，设置返回值为实体类类型，即可实现返回对应对象的json数据，需要依赖@ResponseBody注解和@EnableWebMvc注解
@RequestMapping("/toJsonPOJO")
@ResponseBody
public User toJsonPOJO(){
    System.out.println("返回json对象数据");
    User user = new User();
    user.setName("itcast");
    user.setAge(15);
    return user;
}

5.2 非@ResponseBody修饰

非@ResponseBody修饰的控制器方法，相应类型是text/html，返回类型只可以是void、String、ModelAndView。

返回值是void时，必须通过HttpServletResponse对象设置返回的内容，或者通过HttpServletRequest设置要重定向或转发的页面。

@RequestMapping("/testVoid")
public void testVoid(HttpServletRequest request, HttpServletResponse response) throws Exception {
    //转发
    //request.getRequestDispatcher("/WEB-INF/pages/success.jsp").forward(request,response);
    //重定向  ---不可访问WEB-INF目录
    // response.sendRedirect(request.getContextPath()+"/success.jsp");
    response.getWriter().write("helloWorld!!!");
}

返回值是String类型时，值的内容表示要返回的jsp。

//响应页面/跳转页面
//返回值为String类型，设置返回值为页面名称，即可实现页面跳转
@RequestMapping(value = "/toJumpPage")
public String toJumpPage(){
    System.out.println("跳转页面");
    // return "success.jsp";
    return "success"; // 可不带jsp后缀
}

返回值是ModelAndView时，通过ModelAndView对象设置返回的jps页面和数据对象

// 返回ModelAndView
@RequestMapping("/testModelAndView")
public ModelAndView testModelAndView(){

    //创建ModelAndView对象
    ModelAndView mv = new ModelAndView();

    User user = new User();
    //存到request域中，使用ModelAndView的方法
    mv.addObject("user",user);
    //设置跳转页面success.jsp
    mv.setViewName("success");

    //注：手动返回"success"，底层也是使用ModelAndView对象 ，也是使用视图解析器
    return mv;
}