SpringMVC知识点总结

作者: 艾剪疏 | 来源:发表于2018-08-11 13:48 被阅读634次

主要内容：
1 SpringMVC总体框架图
2 包装类型pojo参数绑定
3 Springmvc校验
4 数据回显
5 异常处理
6 上传图片
7 RESTful支持
8 拦截器

1 SpringMVC总体框架图

image.png

DispatcherServlet前端控制器：接收request，进行response
HandlerMapping处理器映射器：根据url查找Handler。（可以通过xml配置方式，注解方式）
HandlerAdapter处理器适配器：根据特定规则去执行Handler，编写Handler时需要按照HandlerAdapter的要求去编写。
Handler处理器（后端控制器）：需要程序员去编写，常用注解开发方式。
Handler处理器执行后结果是ModelAndView，具体开发时Handler返回方法值类型包括：ModelAndView、String（逻辑视图名）、void（通过在Handler形参中添加request和response，类似原始 servlet开发方式，注意：可以通过指定response响应的结果类型实现json数据输出）
View Resolver视图解析器：根据逻辑视图名生成真正的视图（在springmvc中使用View对象表示）
View视图：jsp页面，仅是数据展示，没有业务逻辑

2 包装类型pojo参数绑定

方法一：在形参中添加HttpServletRequest request参数，通过request接收查询条件参数。
方法二：在形参中让包装类型的pojo接收查询条件参数。

举例方法二

<script type="text/javascript">
        function deleteItems(){
            //提交form
            document.itemsForm.action="${pageContext.request.contextPath }/items/deleteItems.action";
            document.itemsForm.submit();
        }
        function queryItems(){
            //提交form
            document.itemsForm.action="${pageContext.request.contextPath }/items/queryItems.action";
            document.itemsForm.submit();
        }
</script>

<form name="itemsForm" action="${pageContext.request.contextPath }/items/queryItems.action" method="post">
查询条件：
    <table width="100%" border=1>
        <tr>
            <td>
                商品名称：<input name="itemsCustom.name" />
            </td>
            <td><input type="button" value="查询" onclick="queryItems()"/>
                <input type="button" value="批量删除" onclick="deleteItems()"/>
            </td>
        </tr>
    </table>
商品列表：
</form>

商品名称：<input name="itemsCustom.name" />
注意：itemsCustom和包装pojo中的属性一致即可。

Controller代码，这时itemsQueryVo中的itemsCustom中的name属性就有值了。

@Controller
@RequestMapping("/items")

public class ItemsController {
 @RequestMapping("/queryItems")
    public ModelAndView queryItems(HttpServletRequest request,
                                   ItemsQueryVo itemsQueryVo) throws Exception {
        // 测试forward后request是否可以共享

        System.out.println(request.getParameter("id"));

        // 调用service查找 数据库，查询商品列表
        List<ItemsCustom> itemsList = itemsService.findItemsList(itemsQueryVo);

        // 返回ModelAndView
        ModelAndView modelAndView = new ModelAndView();
        // 相当 于request的setAttribut，在jsp页面中通过itemsList取数据
        modelAndView.addObject("itemsList", itemsList);

        // 指定视图
        // 下边的路径，如果在视图解析器中配置jsp路径的前缀和jsp路径的后缀，修改为
        // modelAndView.setViewName("/WEB-INF/jsp/items/itemsList.jsp");
        // 上边的路径配置可以不在程序中指定jsp路径的前缀和jsp路径的后缀
        modelAndView.setViewName("items/itemsList");

        return modelAndView;
    }
}

此外，集合类型绑定也是相同的，name属性要与后台pojo中的属性对应，即可完成传值。

3 Springmvc校验

项目中，通常使用较多是前端的校验，比如页面中js校验。对于安全要求较高点建议在服务端进行校验。

控制层conroller：校验页面请求的参数的合法性。在服务端控制层conroller校验，不区分客户端类型（浏览器、手机客户端、远程调用）
业务层service（使用较多）：主要校验关键业务参数，仅限于service接口中使用的参数。
持久层dao：一般是不校验的。

springmvc使用hibernate的校验框架validation(和hibernate没有任何关系)。

校验思路：
页面提交请求的参数，请求到controller方法中，使用validation进行校验。如果校验出错，将错误信息展示到页面。

3.1 在Spring配置文件中配置校验器

 <!-- 校验器 -->
    <bean id="validator"
          class="org.springframework.validation.beanvalidation.LocalValidatorFactoryBean">
        <!-- hibernate校验器-->
        <property name="providerClass" value="org.hibernate.validator.HibernateValidator" />
        <!-- 指定校验使用的资源文件，在文件中配置校验错误信息，如果不指定则默认使用classpath下的ValidationMessages.properties -->
        <property name="validationMessageSource" ref="messageSource" />
    </bean>
    <!-- 校验错误信息配置文件 -->
    <bean id="messageSource"
          class="org.springframework.context.support.ReloadableResourceBundleMessageSource">
        <!-- 资源文件名-->
        <property name="basenames">
            <list>
                <value>classpath:CustomValidationMessages</value>
            </list>
        </property>
        <!-- 资源文件编码格式 -->
        <property name="defaultEncoding" value="UTF-8"/>
    <!--    <property name="fileEncodings" value="utf-8" />-->
        <!-- 对资源文件内容缓存时间，单位秒 -->
        <property name="cacheSeconds" value="120" />
    </bean>

3.2 校验器注入到处理器适配器中

    <mvc:annotation-driven  validator="validator">
    </mvc:annotation-driven>

3.3 pojo中添加校验规则

在pojo中定义校验规则，而pojo是被多个 controller所共用，当不同的controller方法对同一个pojo进行校验，但是每个controller方法需要不同的校验。

解决方法：
定义多个校验分组（其实是一个java接口），分组中定义有哪些规则
每个controller方法使用不同的校验分组

下方groups={ValidGroup1.class}，即为分组。

public class Items {
    private Integer id;

    //校验名称在1到30字符中间
    //message是提示校验出错显示的信息
    //groups：此校验属于哪个分组，groups可以定义多个分组
    @Size(min=1,max=30,message="{items.name.length.error}",groups={ValidGroup1.class})
    private String name;
}

CustomValidationMessages.properties文件内容

items.name.length.error="名称不能过长"
items.createtime.isNUll="时间不能为空"

3.4 捕获校验错误信息指定分组的校验

指定分组的校验，并捕获校验错误信息
参数：@Validated(value = { ValidGroup1.class }) ItemsCustom itemsCustom,

 @RequestMapping("/editItemsSubmit")
    public String editItemsSubmit(Model model,
                                  HttpServletRequest request,
                                  Integer id,
                                  @Validated(value = { ValidGroup1.class }) ItemsCustom itemsCustom,
                                  MultipartFile items_pic,//接收商品图片
                                  BindingResult bindingResult) throws Exception{

        // 获取校验错误信息
        if (bindingResult.hasErrors()) {
            // 输出错误信息
            List<ObjectError> allErrors = bindingResult.getAllErrors();

            for (ObjectError objectError : allErrors) {
                // 输出错误信息
                System.out.println(objectError.getDefaultMessage());

            }
            // 将错误信息传到页面
            model.addAttribute("allErrors", allErrors);


            //可以直接使用model将提交pojo回显到页面
            model.addAttribute("items", itemsCustom);

            // 出错重新到商品修改页面
            return "items/editItems";
        }
}

3.5 页面显示错误信息

<!-- 显示错误信息 -->
<c:if test="${allErrors!=null }">
    <c:forEach items="${allErrors }" var="error">
    ${ error.defaultMessage}<br/>
</c:forEach>
</c:if>

4 数据回显

提交后，如果出现错误，将刚才提交的数据回显到刚才的提交页面。

4.1 springmvc默认对pojo数据进行回显

pojo数据传入controller方法后，springmvc自动将pojo数据放到request域，key等于pojo类型（首字母小写）
使用@ModelAttribute指定pojo回显到页面在request中的key。

4.2 @ModelAttribute还可以将方法的返回值传到页面

在商品查询列表页面，通过商品类型查询商品信息。
在controller中定义商品类型查询方法，最终将商品类型传到页面。

 @RequestMapping("/editItemsSubmit")
    public String editItemsSubmit(Model model,
                                  HttpServletRequest request,
                                  Integer id,
                                  @Validated(value = { ValidGroup1.class }) ItemsCustom itemsCustom,
                                  MultipartFile items_pic,//接收商品图片
                                  BindingResult bindingResult) throws Exception{

        // 获取校验错误信息
        if (bindingResult.hasErrors()) {
            // 输出错误信息
            List<ObjectError> allErrors = bindingResult.getAllErrors();

            for (ObjectError objectError : allErrors) {
                // 输出错误信息
                System.out.println(objectError.getDefaultMessage());

            }
            // 将错误信息传到页面
            model.addAttribute("allErrors", allErrors);


            //可以直接使用model将提交pojo回显到页面
            model.addAttribute("items", itemsCustom);

            // 出错重新到商品修改页面
            return "items/editItems";
        }
}

回显页面

<form id="itemForm" action="${pageContext.request.contextPath }/items/editItemsSubmit.action" method="post" enctype="multipart/form-data">
<input type="hidden" name="id" value="${items.id }"/>
修改商品信息：
<table width="100%" border=1>
<tr>
    <td>商品名称</td>
    <td><input type="text" name="name" value="${items.name}"/></td>
</tr>
<tr>
    <td>商品价格</td>
    <td><input type="text" name="price" value="${items.price}"/></td>
</tr>
<tr>
    <td>商品生产日期</td>
    <td><input type="text" name="createtime" value="<fmt:formatDate value="${items.createtime}" pattern="yyyy-MM-dd HH:mm:ss"/>"/></td>
</tr>
</table>
</form>

5 异常处理

5.1 异常处理思路

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

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

image.png

springmvc提供全局异常处理器（一个系统只有一个异常处理器）进行统一异常处理。

第一步：自定义异常类

public class CustomException extends Exception {
    
    //异常信息
    public String message;
    
    public CustomException(String message){
        super(message);
        this.message = message;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }
}

第二步：实现全局异常处理器，HandlerExceptionResolver接口

处理思路：
1 解析出异常类型
2 如果该异常类型是系统自定义的异常，直接取出异常信息，在错误页面展示
3 如果该异常类型不是系统自定义的异常，构造一个自定义的异常类型（信息为“未知错误”）
handler就是处理器适配器要执行Handler对象（只有method）

@Override
    public ModelAndView resolveException(HttpServletRequest request,
            HttpServletResponse response, Object handler, Exception ex) {
        CustomException customException = null;
        if(ex instanceof CustomException){
            customException = (CustomException)ex;
        }else{
            customException = new CustomException("未知错误");
        }
    //错误信息
        String message = customException.getMessage();
        
        
        ModelAndView modelAndView = new ModelAndView();
        
        //将错误信息传到页面
        modelAndView.addObject("message", message);
        
        //指向错误页面
        modelAndView.setViewName("error");

        
        return modelAndView;
}

第三步：定义JSP的error页面，展示错误

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>错误提示</title>
</head>
<body>
${message }
</body>
</html>

第四步：在springmvc.xml配置全局异常处理器

<!-- 全局异常处理器 只要实现HandlerExceptionResolver接口就是全局异常处理器 -->
<bean class="cn.itcast.ssm.exception.CustomExceptionResolver"></bean>

第五步：异常测试

在controller、service、dao中任意一处需要手动抛出异常。
如果是程序中手动抛出的异常，在错误页面中显示自定义的异常信息，如果不是手动抛出异常说明是一个运行时异常，在错误页面只显示“未知错误”。

  @RequestMapping("/editItems")
    public String editItems(Model model,
                            @RequestParam(value = "id", required = true) Integer items_id)
            throws Exception {
        // 调用service根据商品id查询商品信息
        ItemsCustom itemsCustom = itemsService.findItemsById(items_id);
        //判断商品是否为空，根据id没有查询到商品，抛出异常，提示用户商品信息不存 在
        if(itemsCustom == null){
            throw new CustomException("修改的商品信息不存在!");
        }

        // 通过形参中的model将model数据传到页面
        // 相当于modelAndView.addObject方法
        model.addAttribute("items", itemsCustom);

        return "items/editItems";
    }

如果与业务功能相关的异常，建议在service中抛出异常。
与业务功能没有关系的异常，建议在controller中抛出。

上边的功能，建议在service中抛出异常。

6 上传图片

6.1 在springmvc.xml中配置multipart类型解析器

   <!-- 文件上传 -->
    <bean id="multipartResolver"
          class="org.springframework.web.multipart.commons.CommonsMultipartResolver">
        <!-- 设置上传文件的最大尺寸为5MB -->
        <property name="maxUploadSize">
            <value>5242880</value>
        </property>
    </bean>

6.2 创建图片虚拟目录存储图片

https://blog.csdn.net/cheney550995353/article/details/70185282

6.3 代码上传图片

<tr>
    <td>商品图片</td>
    <td>
        <c:if test="${items.pic !=null}">
            <img src="/pic/${items.pic}" width=100 height=100/>
            <br/>
        </c:if>
        <input type="file"  name="items_pic"/> 
    </td>
</tr>

 @RequestMapping("/editItemsSubmit")
    public String editItemsSubmit(Model model,
                                  HttpServletRequest request,
                                  Integer id,
                                  @Validated(value = { ValidGroup1.class }) ItemsCustom itemsCustom,
                                  MultipartFile items_pic,//接收商品图片
                                  BindingResult bindingResult) throws Exception{

        //原始名称
        String originalFilename = items_pic.getOriginalFilename();

        //上传图片
        if(items_pic!=null && originalFilename!=null && originalFilename.length()>0){

            //存储图片的物理路径
            String pic_path = "G:\\mine\\pic\\";

            //新的图片名称
            String newFileName = UUID.randomUUID() + originalFilename.substring(originalFilename.lastIndexOf("."));
            //新图片
            File newFile = new File(pic_path+newFileName);
            //将内存中的数据写入磁盘
            items_pic.transferTo(newFile);
            //将新图片名称写到itemsCustom中
            itemsCustom.setPic(newFileName);
        }
        itemsService.updateItems(id,itemsCustom);

        return "forward:queryItems.action";
}

7 RESTful支持

6.1 controller书写方式

@RequestMapping(value="/ itemsView/{id}")：{×××}占位符，请求的URL可以是“/viewItems/1”或“/viewItems/2”，通过在方法中使用@PathVariable获取{×××}中的×××变量。
@PathVariable用于将请求URL中的模板变量映射到功能处理方法的参数上。
如果RequestMapping中表示为"/ itemsView /{id}"，id和形参名称一致，@PathVariable不用指定名称。

 //查询商品信息，输出json
    ///itemsView/{id}里边的{id}表示占位符，通过@PathVariable获取占位符中的参数，
    //如果占位符中的名称和形参名一致，在@PathVariable可以不指定名称
    @RequestMapping("/itemsView/{id}")
    public @ResponseBody
    ItemsCustom itemsView(@PathVariable("id") Integer id)throws Exception{

        //调用service查询商品信息
        ItemsCustom itemsCustom = itemsService.findItemsById(id);
        return itemsCustom;
    }

6.2 REST方法的前端控制器配置

<!-- springmvc前端控制器，rest配置 -->
    <servlet>
        <servlet-name>springmvc_rest</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <!-- contextConfigLocation配置springmvc加载的配置文件（配置处理器映射器、适配器等等） 如果不配置contextConfigLocation，默认加载的是/WEB-INF/servlet名称-serlvet.xml（springmvc-servlet.xml） -->
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:spring/springmvc.xml</param-value>
        </init-param>
    </servlet>

    <servlet-mapping>
        <servlet-name>springmvc_rest</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>

配置前端控制器的url-parttern中指定/，对静态资源的解析出现问题：
在springmvc.xml中添加静态资源解析方法。

    <!-- 静态资源解析 包括 ：js、css、img、..-->
    <mvc:resources location="/js/" mapping="/js/**"/>

8 拦截器

http://jinnianshilongnian.iteye.com/blog/1670856/