SpringMVC框架

一、概述 1. 基本介绍

MVC：M业务模型-Service层和Dao层、V用户界面-前端、C控制器-Web层Controller

SpringMVC ：基于 Java 的实现 MVC 设计模型的请求驱动类型的轻量级 Web 框架，通过一套注解，让一个简单的 Java 类成为处理请求的控制器，而无须实现任何接口。

作用

将Web中多个Servlet的共有行为封装到SpringMVC前端控制器中，使Web层无需再编写Servlet，只需通过创建pojo类的Controller来实现Web层的各个servlet不共有的逻辑。

由于Spring的存在，编写的Controller也可以直接使用Spring来维护。

2. 入门案例

SpringMVC步骤

导入SpringMVC相关坐标

pom.xml


    org.springframework
    spring-webmvc
    5.0.5.RELEASE

配置SpringMVC核心控制器DispathcerServlet

web.xml


    DispatcherServlet
    org.springframework.web.servlet.DispatcherServlet
    	
        contextConfigLocation
        classpath:spring_mvc.xml
    
    1



	
    DispatcherServlet
    /

创建Controller类和视图页、注解配置Controller类中业务方法的映射地址

@Controller	//配置到Spring
public class UserController {
    @RequestMapping("/quick")	//映射地址
    public String save() {
        System.out.println("Controller save...");
        return "success.jsp";	//跳转到视图页
    }
}

配置SpringMVC核心文件 spring-mvc.xml：
```
	
    
    
```

二、SpringMVC组件 1. 组件解析 1.1 执行流程

用户发送请求至前端控制器DispatcherServlet。
DispatcherServlet收到请求调用HandlerMapping处理器映射器。
处理器映射器找到具体的处理器(可以根据xml配置、注解进行查找，如自定义的Controller)，生成处理器对象及处理器拦截器(如果有则生成)一并返回给DispatcherServlet。
DispatcherServlet调用HandlerAdapter处理器适配器。
HandlerAdapter经过适配调用具体的处理器(Controller，也叫后端控制器)。
Controller执行完成返回ModelAndView。
HandlerAdapter将controller执行结果ModelAndView返回给DispatcherServlet。
DispatcherServlet将ModelAndView传给ViewReslover视图解析器。
ViewReslover解析后返回具体View。
DispatcherServlet根据View进行渲染视图（即将模型数据填充至视图中）。DispatcherServlet响应用户。

1.2 组件

前端控制器：DispatcherServlet，用户请求到达前端控制器，它就相当于 MVC 模式中的 C，DispatcherServlet 是整个流程控制的中心，由它调用其它组件处理用户的请求，DispatcherServlet 的存在降低了组件之间的耦合性。

处理器映射器：HandlerMapping 负责根据用户请求找到 Handler 即处理器（如自定义的Controller），SpringMVC 提供了不同的映射器实现不同的
映射方式，例如：配置文件方式，实现接口方式，注解方式等。

处理器适配器：通过 HandlerAdapter 对处理器进行执行，这是适配器模式的应用，通过扩展适配器可以对更多类型的处理器进行执行。

处理器：它就是我们开发中要编写的具体业务控制器。由 DispatcherServlet 把用户请求转发到 Handler。由Handler 对具体的用户请求进行处理。

视图解析器：View Resolver 负责将处理结果生成 View 视图，View Resolver 首先根据逻辑视图名解析成物理视图名，即
具体的页面地址，再生成 View 视图对象，最后对 View 进行渲染将处理结果通过页面展示给用户。

视图：SpringMVC 框架提供了很多的 View 视图类型的支持，包括：jstlView、freemarkerView、pdfView等。最常用的视图就是 jsp。一般情况下需要通过页面标签或页面模版技术将模型数据通过页面展示给用户，需要由程序员根据业务需求开发具体的页面

2. 配置解析 2.1 @RequestMapping注解

作用：用于建立请求 URL 和处理请求方法之间的对应关系，即进行地址映射

位置

类上：请求URL 的第一级访问目录。此处不写的话，就相当于应用的根目录
方法上：请求 URL 的第二级访问目录，与类上的使用@ReqquestMapping标注的一级目录一起组成访问虚拟路径

属性

Value：映射的地址
method：request请求的方式，post或get
params：指定请求必须要加入的参数条件。

@Controller
@RequestMapping(value = "/user", method = RequestMethod.GET, params = {"username!=100"})
public class UserController {
    @RequestMapping("/quick")
    public String userControl() {
        System.out.println("userControl...");
        return "redirect:/jsp/success.jsp";
    }
}

2.2 View Resolver配置

SpringMVC有默认组件配置，默认组件都是DispatcherServlet.properties配置文件中配置的，该配置文件地址
org/springframework/web/servlet/DispatcherServlet.properties

REDIRECT_URL_PREFIX = "redirect:" 	-- 重定向前缀
FORWARD_URL_PREFIX = "forward:" 	-- 转发前缀（默认值）
prefix = ""; 					-- 视图名称前缀
suffix = ""; 					-- 视图名称 后缀

源码部分

配置视图解析器

加上前缀和后缀

三、获取请求 1. 获取请求参数

基本类型：Controller中的业务方法的参数名称要与请求参数的name一致，参数值会自动映射匹配。

http://localhost:8080/user/quick9?username=zhangsan&age=12

@RequestMapping("/quick8")
public void userControl8(String username, int age) {
    System.out.println(username);
    System.out.println(age);
}

pojo类型：Controller中的业务方法的POJO参数的属性set方法与请求参数的name一致，参数值会自动映射匹配。

public class User {
    private String name;
    private int age;

    public void setName(String name) {
        this.name = name;
    }
    public void setAge(int age) {
        this.age = age;
    }
}

http://localhost:8080/user/quick9?name=jeff&age=12

@RequestMapping("/quick9")
public void userControl9(User user) {
    System.out.println(user);
}

数组类型：Controller中的业务方法数组名称与请求参数的name一致，参数值会自动映射匹配。

http://localhost:8080/user/quick10?strs=a&strs=b&strs=c

@RequestMapping("/quick10")
public void userControl10(String[] strs) {
    for (String str : strs) {
        System.out.println(str);
    }
}

集合类型：

获得普通集合类型集合参数时，要将集合参数包装到一个POJO中才可以。

public class User {
    private String userName;
    private int age;
    public void setUserName(String userName) {
        this.userName = userName;
    }
    public void setAge(int age) {
        this.age = age;
    }
}

public class VO {
    private List userList;
    public List getUserList() {
        return userList;
    }
    public void setUserList(List userList) {
        this.userList = userList;
    }
}

@RequestMapping("/quick11")
public void userControl11(VO vo) {
    System.out.println(vo);
}

当使用ajax提交时，可以指定contentType为json形式，那么在方法参数位置使用@RequestBody可以直接接收集合数据而无需使用POJO进行包装。

注意：访问静态资源时需要开放访问的资源

spring-mvc.xml


    Title

@RequestMapping(value="/quick15")
public void save15(@RequestBody List userList) throws IOException {
    System.out.println(userList);
}

2. 相关注解/配置

开放静态资源配置

spring-mvc.xml

全局乱码过滤器配置

web.xml


    CharacterEncodingFilter
    org.springframework.web.filter.CharacterEncodingFilter


    CharacterEncodingFilter
    /*

参数绑定注解@RequestParam

当请求的参数名称与Controller的业务方法参数名称不一致时，就需要通过@RequestParam注解显示的绑定。

value：代表要客户端传入的参数名，并将该参数的值传给形参
required：true-若参数名不对会报错，false-若参数名不对得到的是null
defaultValue：若为传入参数值时，使用该默认参数的值

http://localhost:8080/user/quick14?name=jeff

//参数绑定注解
@RequestMapping("/quick12")
public void userControl12(@RequestParam(value = "name", required = true，defaultValue = "jeff") String userName) {
    System.out.println(userName);
}

Restful风格参数获取注解@PathVariable

Restful是一种软件架构风格、而不是标准，只是提供了一组设计原则和约束条件。主要用于客户端和服务
器交互类的软件，基于这个风格设计的软件可以更简洁，更有层次，更易于实现缓存机制等。

Restful风格的请求是使用“url+请求方式”表示一次请求目的的，HTTP 协议里面四个表示操作方式的动词如下：

GET：用于获取资源
POST：用于新建资源
PUT：用于更新资源
DELETE：用于删除资源

@PathVariable注解会将传入value传给形参

http://localhost:8080/user/quick13/jeff

@RequestMapping("/quick13/{name}")
public void userControl13(@PathVariable(value = "name", required = true) String userName) {
    System.out.println(userName);	//输出jeff
}

自定义类型转换器

SpringMVC 默认已经提供了一些常用的类型转换器，例如客户端提交的字符串转换成int型进行参数设置。

自定义类型转换器的开发步骤：

定义转换器类实现Converter接口

public class DateConverter implements Converter {	//传入String类型，传出Date类型
    @Override
    public Date convert(String s) {
        try {
            SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd");
            Date date = null;
            date = simpleDateFormat.parse(s);
        } catch (ParseException e) {
            e.printStackTrace();
        }
        return date;
    }
}

在spring-mvc.xml配置文件中声明转换器

在mvc注解驱动中引用转换器

获取Servlet相关API

通过形参的方式，SpringMVC会自动注入

@RequestMapping("/quick5")
public String userControl5(ServletRequest request, ServletRespinse response, Session session) {
	sout(request);
    sout(response);
    sout(session);
}

获取请求头

获取普通请求头注解@RequestHeader

value：请求头的名称
required：是否必须携带此请求头

@RequestMapping("/quick15")
public void userControl15(@RequestHeader("User-Agent") String header) {
    System.out.println(header);
}

获取cookie的值@cookievalue

value：指定cookie的名称
required：是否必须携带此cookie

@RequestMapping("/quick16")
public void userControl16(@cookievalue("Idea-c843aaf6") String header) {
    System.out.println(header);
}

3. 文件上传

文件上传步骤

导入fileupload和io坐标


    commons-fileupload
    commons-fileupload
    1.3.1


    commons-io
    commons-io
    2.3

配置spring-mvc.xml文件上传解析器
```
    
    
```

编写文件上传代码

@RequestMapping(value="/quick23")ssss
public void save23(String username, MultipartFile[] uploadFile) throws IOException {
    System.out.println(username);
    for (MultipartFile multipartFile : uploadFile) {
        String originalFilename = multipartFile.getOriginalFilename();
        multipartFile.transferTo(new File("C:\upload\"+originalFilename));
    }
}

@RequestMapping(value="/quick22")
public void save22(String username, MultipartFile uploadFile,MultipartFile uploadFile2) throws IOException {
    System.out.println(username);
    //获得上传文件的名称
    String originalFilename = uploadFile.getOriginalFilename();
    uploadFile.transferTo(new File("C:\upload\"+originalFilename));
    String originalFilename2 = uploadFile2.getOriginalFilename();
    uploadFile2.transferTo(new File("C:\upload\"+originalFilename2));
}

四、处理响应

SpringMVC数据响应的方式

页面跳转：

直接返回字符串
通过ModelAndView对象返回

回写数据

直接返回字符串
返回对象或集合

1. 页面跳转

根据返回的ModelAndView对象或字符串指定的页面进行页面跳转

返回ModelAndView对象

@Controller
@RequestMapping(value = "/user")
public class UserController {
    
    //自定义ModelAndView
    @RequestMapping("/quick2")	
    public ModelAndView userControl2() {
        System.out.println("userControl...");
        ModelAndView modelAndView = new ModelAndView();
        modelAndView.addObject("userName", "张三");
        modelAndView.setViewName("success");
        return modelAndView;
    }

    //ModelAndView形参，SpringMVC自动注入
    @RequestMapping("/quick3")
    public ModelAndView userControl3(ModelAndView modelAndView) {
        modelAndView.addObject("userName", "张三");
        modelAndView.setViewName("success");
        return modelAndView;
    }
}

直接返回字符串

@Controller
@RequestMapping(value = "/user")
public class UserController {
    @RequestMapping("/quick")
    public String userControl() {
        System.out.println("userControl...");
        return "redirect:/jsp/success.jsp";
    }
}

返回字符串，model单独封装

@Controller
@RequestMapping(value = "/user")
public class UserController {
    //Model形参，SpringMVC自动注入，返回View
    @RequestMapping("/quick4")
    public String userControl4(Model model) {
        model.addAttribute("userName", "张三");
        return "success";
    }

    //SpringMVC自动注入ServletContext形参
    @RequestMapping("/quick5")
    public String userControl5(ServletRequest request) {
        request.setAttribute("userName", "张三");
        return "success";
    }   
}

2. 回写数据

直接回写字符串

通过SpingMVC框架注入response对象

@RequestMapping("/quick1")
public void quickMethod4(HttpServletResponse response) throws IOException {
	response.getWriter().print("hello world");
}

通过@ResponseBody注解告知SpringMVC数据回写而非跳转

@RequestMapping("/quick5")
@ResponseBody
public String quickMethod5() throws IOException {
	return "hello springMVC!!!";
}

回写Json或集合

导入Json转换相关的Maven依赖


    com.fasterxml.jackson.core
    jackson-core
    2.9.0


    com.fasterxml.jackson.core
    jackson-annotations
    2.9.0


    com.fasterxml.jackson.core
    jackson-databind
    2.9.0

直接返回字符串

@RequestMapping("/quick2")
@ResponseBody
public String quickMethod7() throws IOException {
    User user = new User();
    user.setUsername("zhangsan");
    user.setAge(18);
    ObjectMapper objectMapper = new ObjectMapper();
    String s = objectMapper.writevalueAsString(user);
    return s;
}

修改处理器适配器的转换参数，通过SpringMVC转换，直接返回Json对象

@RequestMapping("/quick8")
@ResponseBody
public User quickMethod8() throws IOException {
    User user = new User();
    user.setUsername("zhangsan");
    user.setAge(18);
    return user;
}

使用mvc的注解驱动代替修改处理器适配器转换参数的配置，默认底层就会集成jackson进行对象或集合的json格式字符串的转换。注意：需要mvc命名空间
```
    
```

五、其它功能 1. 拦截器

**Spring MVC 的拦截器类似于Servlet开发中的过滤器Filter，用于对处理器进行预处理和后处理。**拦截器也是AOP思想的具体实现。

拦截器链（Interceptor Chain）将拦截器按一定的顺序联结成一条链。在访问被拦截的方法或字段时，拦截器链中的拦截器就会按其之前定义的顺序被调用。

拦截器与过滤器的区别

使用方式

创建拦截器类实现HandlerInterceptor接口

public class MyInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Object handler) {
        sout("请求处理之前的相关逻辑...");
       String username = request.getParameter("username");
        try {
            if (null == username) {
                request.getRequestDispatcher("/error.jsp").forward(request, response);
                return false;
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
        return true;
    }
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) {
        sout("请求处理之后,进行渲染之前的相关逻辑...");
        modelAndView.addObject("username", "张三");
        System.out.println("postHandle...");
    }
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
        sout("整个请求完成之后的相关逻辑...");
        System.out.println("afterCompletion");
    }
}

配置拦截器

测试


    Hello ${username}

http://localhost:8080/target?username=jeff

@Controller
public class TargetController {
    @RequestMapping("/target")
    public ModelAndView show(String username) {
        ModelAndView modelAndView = new ModelAndView();
        modelAndView.addObject("username", username);
        modelAndView.setViewName("success");
        return modelAndView;
    }
}

2. 异常处理机制

系统中异常包括两类：预期异常和运行时异常RuntimeException，前者通过捕获异常从而获取异常信息，后
者主要通过规范代码开发、测试等手段减少运行时异常的发生。

SpringMVC异常的处理思路

系统的Dao、Service、Controller出现都通过throws Exception向上抛出，最后由SpringMVC前端控制器交
由异常处理器进行异常处理，如下图：

SpringMVC异常处理方式

使用Spring MVC提供的简单异常处理器SimpleMappingExceptionResolver
实现Spring的异常处理接口HandlerExceptionResolver 自定义自己的异常处理器

2.1 简单异常处理器

配置

测试

http://localhost:8080/show

@Override
public void show1() {
    System.out.println("抛出类型转换异常....");
    Object str = "zhangsan";
    Integer num = (Integer)str;
}


    CastError ${error}

2.2 自定义异常处理器

创建异常处理器类实现HandlerExceptionResolver

public class MyException extends Exception {
}

public class MyExceptionHandler implements HandlerExceptionResolver {
    @Override
    public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
        ModelAndView modelAndView = new ModelAndView();
        if (ex instanceof MyException) {
            modelAndView.addObject("error", "自定义异常");
            modelAndView.setViewName("artifcial_exception");
        } else {
            modelAndView.addObject("error", "类型转换异常");
            modelAndView.setViewName("class_cast_exception.jsp");
        }
        return modelAndView;
    }
}

配置异常处理器

编写异常页面


    Self Exception${error}


    CastError ${error}

测试异常跳转

@Controller
public class ExceptionController {
    @Autowired
    private ExceptionService service;
    @RequestMapping("/show")
    public void show() throws MyException {
        service.show5();
    }
}

SpringMVC框架

Hello ${username}

CastError ${error}

Self Exception${error}

CastError ${error}

Java相关栏目本月热门文章