• 1.数据校验-拦截器-全局异常-json数据处理


    目录

    1.数据校验-拦截器-全局异常-json数据处理

    1. JSR303

    2. JSR303中含有的注解

    3. spring中使用JSR303进行服务端校验

    3.1 导入依赖包

    3.2 添加验证规则

    3.3执行校验

    3.4 错误信息的展示

    4. SpringMVC定义Restfull接口

    5.1 增加spring配置

    5.2 Controller

    5.3 格式化返回数据

    2. 拦截器介绍

    1.1 什么是拦截器

    1.2 与web过滤器的区别

    1.3 执行时机

    1.3 应用场景

    2. 入门案例

    1. 拦截器介绍

    1.1 什么是拦截器

    1.2 与web过滤器的区别

    1.3 执行时机

    1.3 应用场景

    2.入门案例

    2.1 创建自定义拦截器

    2.2 配置文件

    4. 开发示例

    1.全局异常

    1. 为什么使用全局一场处理

    2. 异常处理流程

    3. SpringMVC异常分类

    4. 使用示例

    4.1 SpringMVC自带的简单异常处理器

    4.2 通过接口实现全局异常

    4.3 使用注解方式定义全局异常

    4.4 RestController异常处理


    1.数据校验-拦截器-全局异常-json数据处理

    1. JSR303

    JSR303是Java为Bean数据合法性校验提供给的标准框架,已经包含在 JavaEE6.0中,JSR303通过在Bean 属性中标注类似 @NotNull @Max 等标准的注解指定校验规则,并通过标准的验证接口对 Bean进行验证。

    2. JSR303中含有的注解

    @Null 被注释的元素必须为 null @NotNull 被注释的元素必须不为 null @AssertTrue 被注释的元素必须为 true @AssertFalse 被注释的元素必须为 false @Min(value) 被注释的元素必须是一个数字,其值必须大于等于指定的最小值 @Max(value) 被注释的元素必须是一个数字,其值必须小于等于指定的最大值 @DecimalMin(value) 被注释的元素必须是一个数字,其值必须大于等于指定的最小值 @DecimalMax(value) 被注释的元素必须是一个数字,其值必须小于等于指定的最大值 @Size(max=, min=) 被注释的元素的大小必须在指定的范围内 @Digits (integer, fraction) 被注释的元素必须是一个数字,其值必须在可接受的范围内 @Past 被注释的元素必须是一个过去的日期 @Future 被注释的元素必须是一个将来的日期 @Pattern(regex=,flag=) 被注释的元素必须符合指定的正则表达式


    Hibernate Validator 附加的注解 @NotBlank(message =) 验证字符串非null,且长度必须大于0 @Email 被注释的元素必须是电子邮箱地址 @Length(min=,max=) 被注释的字符串的大小必须在指定的范围内 @NotEmpty 被注释的字符串的必须非空 @Range(min=,max=,message=) 被注释的元素必须在合适的范围内

    注:HIbernate Validator是JSR303的一个参考实现,除了支持所有标准的校验注解外,另外HIbernate Validator还有JSR-380的实现

    3. spring中使用JSR303进行服务端校验

    3.1 导入依赖包

    1. <dependency>
    2.   <groupId>org.hibernate</groupId>
    3.   <artifactId>hibernate-validator</artifactId>
    4.   <version>6.0.7.Final</version>
    5. </dependency>

    3.2 添加验证规则

    1. package com.zking.mybatis01.model;
    2. import lombok.Data;
    3. import javax.validation.constraints.NotBlank;
    4. import javax.validation.constraints.NotNull;
    5. @Data
    6. public class Book {
    7.    //定义分组 验证
    8.    public static interface Add{}
    9.    public  static  interface  Edit{}
    10.    @NotNull(message = "bid 不可为空" ,groups = Edit.class)
    11.    private Integer bid;
    12.    //只有我在调用莫个接口才会生效
    13.    @NotBlank(message = "bname 书本名称不可为空" ,groups = { Add.class,Edit.class })
    14.    private String bname;
    15.    @NotNull(message = "price 书本价格不可为空" ,groups = { Add.class,Edit.class })
    16.    private Double price;
    17.    private String fileid;
    18. }

    3.3执行校验

    在请求处理方法中,使用@Validated或@Valid注解要验证的对象,并根据BindingResult判断校验是否通过, 另外,验证参数后必须紧跟BindingResult参数,否则spring会在校验不通过时直接抛出异常。

    注:@Valid和@Validated的区别 两者的作用是一样的,但@Validated功能更丰富,有分组功能。

    1. //@ModelAttribute("books") 必须保存 参数 | @Validated(Book.Add.class) 调用定义好的接口 只有被标记成添加的才会生效
    2. @RequestMapping("endtBook")            
    3.    public String endtBook(@Validated(Book.Add.class) @ModelAttribute("books") Book bo, BindingResult bindingResult) {
    4.        //如果出现 参数异常 返回为true 直接返回添加界面
    5.        if(bindingResult.hasErrors()){
    6.            return "book/endtbook";
    7.       }
    8.        if (bo.getBid() != null) {
    9.            book.updBooks(bo);
    10.       } else {
    11.            book.addBooks(bo);
    12.       }
    13.        return "redirect:/bookList";
    14.   }

    3.4 错误信息的展示

    1. <%@ page contentType="text/html;charset=UTF-8" language="java" %>
    2. //spring web提供的form 标签
    3. <%@ taglib prefix="f" uri="http://www.springframework.org/tags/form" %>
    4. <%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>
    5. <html>
    6. <head>
    7.    <title>Title</title>
    8. </head>
    9. <body>
    10. <f:form action="endtBook" modelAttribute="books" method
    11.       ="post">
    12.    <f:hidden path="bid"/>
    13.    <br>
    14.    <!-- <f:errors path="bname" /> 异常信息 -->
    15. 书名:  <f:input path="bname" /><f:errors path="bname" />  
    16.    <br>
    17.   价格: <f:input path="price"/><f:errors path="price" />
    18.    <br>
    19.    <input type="submit" value="提交">
    20. </f:form>
    21. </body>
    22. </html>

    实现效果

     

    4. SpringMVC定义Restfull接口

    json 数据处理 理解

    在前后端分离开发中,服务端通过Json对象返回数据给前端使用。

    导入架包

    1.   <!-- 导入解析 Json的包 -->
    2.        <dependency>
    3.            <groupId>com.fasterxml.jackson.core</groupId>
    4.            <artifactId>jackson-databind</artifactId>
    5.            <version>2.13.3</version>
    6.        </dependency>

    5.1 增加spring配置

    1. <!-- 转换器,将返回消息转换为json -->
    2. <bean class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter">
    3. <property name="messageConverters">
    4.    <list>
    5.        <ref bean="mappingJackson2HttpMessageConverter"/>
    6.    </list>
    7. </property>
    8. </bean>
    9. <!-- 处理中文编码,(spring通过该配置自动设置响应头)-->
    10. <bean id="mappingJackson2HttpMessageConverter"
    11.  class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
    12. <!--处理中文乱码以及避免IE执行AJAX时,返回JSON出现下载文件-->
    13. <property name="supportedMediaTypes">
    14.    <list>
    15.        <value>text/html;charset=UTF-8</value>
    16.        <value>text/json;charset=UTF-8</value>
    17.        <value>application/json;charset=UTF-8</value>
    18.    </list>
    19. </property>
    20. </bean>

    注:spring为简化开发提供了丰富的组件,在使用时需要将组件配置到spring中,并为这些组件提供合适的参数。

    5.2 Controller

     

    5.3 格式化返回数据

    在前后端分离模式的开发中,提供给前端使用的数据(或提供给第三方系统)通常需要按双方协商定义的格式返回,以方便解析。一般有两种处理方式:1)将用户Map组织格式化返回的数据,2)定义一个放回数据的实体来格式化返回的数据。

    定义数据返回格式:

    1. package com.zking.mybatis01.utils;
    2. import org.springframework.validation.Errors;
    3. import java.util.HashMap;
    4. public class RetrunData extends HashMap<String, Object> {
    5.    public RetrunData(int code, String msg, Object data) {
    6.        this.put("code", code);
    7.        this.put("msg", msg);
    8.        this.put("data", data);
    9.   }
    10.    public void setCode(int code) {
    11.        this.put("code", code);
    12.   }
    13.    public void setMsg(String msg) {
    14.        this.put("msg", msg);
    15.   }
    16.    public void setData(Object data) {
    17.        this.put("data", data);
    18.   }
    19.    public void setErrors(Object errors) {
    20.        this.put("errors", errors);
    21.   }
    22. }

    测试

    1. package com.zking.mybatis01.controller;
    2. import com.zking.mybatis01.utils.RetrunData;
    3. import org.springframework.stereotype.Controller;
    4. import org.springframework.web.bind.annotation.RequestMapping;
    5. import org.springframework.web.bind.annotation.ResponseBody;
    6. import java.util.ArrayList;
    7. import java.util.List;
    8. @Controller
    9. public class TestController {
    10.    //发送异步请求 如果时普通的 controller 发送异步请求 需要添加注解
    11.    @ResponseBody
    12.    
    13.    @RequestMapping("test")
    14.    public RetrunData Mytest(){
    15.        List c= new ArrayList<>();
    16.        c.add("e0");
    17.     return new RetrunData(1,"buhao",c);
    18.   }
    19. }

    2. 拦截器介绍

    1.1 什么是拦截器

    SpringMVC的处理器拦截器,类似于Servlet开发中的过滤器Filter,用于对处理器进行预处理和后处理。 依赖于web框架,在实现上基于Java的反射机制,属于面向切面编程(AOP)的一种运用。由于拦截器是基于web框架的调用,因此可以使用Spring的依赖注入(DI)进行一些业务操作,同时一个拦截器实例在一个 controller生命周期之内可以多次调用。

    1.2 与web过滤器的区别

    依赖于servlet容器。在实现上基于函数回调,可以对几乎所有请求进行过滤,但是缺点是一个过滤器实例只能在容器初始化时调用一次。使用过滤器的目的是用来做一些过滤操作,比如:在过滤器中修改字符编码;在过滤器中修改HttpServletRequest的一些参数,包括:过滤低俗文字、危险字符等。

    过滤器:

    • 依赖与servlet容器,基于在实现上基于函数回调,可以对几乎所有请求进行过滤

    • 基于servlet标准,只要是web工程即可使用,通用性强

    • 过滤器的出现早已拦截器

    拦截器:

    • 属于springmvc技术,必须依赖于springmvc环境采用使用

    • springmvc拦截器通常对处理器(controller)进行拦截

    • 拦截器只能拦截dispatcherServlet处理的请求

    • 可以使用spring提供的容器,及强大的依赖注入

    1.3 执行时机

    来自官方文档): 执行处理程序之前的拦截点。在HandlerMapping确定适当的处理程序对象之后,但在HandlerAdapter调用处理程序之前调用。DispatcherServlet处理执行链中的处理程序,该执行链由任意数量的拦截器组成,处理程序本身位于末尾。使用此方法,每个拦截器可以决定中止执行链,通常发送HTTP错误或写入自定义响应。

    1.3 应用场景

    1)日志记录:记录请求信息的日志,以便进行信息监控、信息统计、计算PV(Page View)等。 2)权限检查:如登录检测,进入处理器检测是否登录,如果没有直接返回到登录页面; 3)性能监控:有时候系统在某段时间莫名其妙的慢,可以通过拦截器在进入处理器之前记录开始时间,在处理完后记录结束时间,从而得到该请求的处理时间(如果有反向代理,如apache可以自动记录); 4)通用行为:读取cookie得到用户信息并将用户对象放入请求,从而方便后续流程使用,还有如提取Locale、Theme信息等,只要是多个Controller中的处理方法都需要的,我们就可以使用拦截器实现。

    2.入门案例

    2.1 创建自定义拦截器

    1. public class CustomInterceptor implements HandlerInterceptor {
    2.    @Override
    3.    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
    4.        System.out.println("CustomInterceptor preHandle");
    5.        return true;
    6.   }
    7.    @Override
    8.    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
    9.        System.out.println("CustomInterceptor postHandle");
    10.   }
    11.    @Override
    12.    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
    13.        System.out.println("CustomInterceptor afterCompletion");
    14.   }
    15. }

    关于拦截器接口中定义的方法的说明:

    • preHandle方法 作用:用于对拦截到的请求进行预处理,方法接收布尔(true,false)类型的返回值,返回true:放行,false:不放行。 执行时机:在处理器方法执行前执行 方法参数: 1)request请求对象 2)response响应对象 3)handler拦截到的方法处理

    • postHandle方法 作用:用于对拦截到的请求进行后处理,可以在方法中对模型数据和视图进行修改 执行时机:在处理器的方法执行后,视图渲染之前 方法参数: 1)request请求对象 2)response响应对象 3)handler拦截到的处理器方法 4)ModelAndView处理器方法返回的模型和视图对象,可以在方法中修改模型和视图

    • afterCompletion方法 作用:用于在整个流程完成之后进行最后的处理,如果请求流程中有异常,可以在方法中获取对象 执行时机:视图渲染完成后(整个流程结束之后) 方法参数: 1)request请求参数 2)response响应对象 3)handler拦截到的处理器方法 4)ex异常对象

    拦截器的处理流程

     

    为更好的理解拦截器接口中定义的方法的参数,可以使用如下代码:

    1.   @Override
    2.   public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
    3.       if(handler instanceof HandlerMethod){
    4.           HandlerMethod handlerMethod = (HandlerMethod) handler;
    5.           log.info("当前拦截的方法为:{}",handlerMethod.getMethod().getName());
    6.           log.info("当前拦截的方法参数长度为:{}",handlerMethod.getMethod().getParameters().length);
    7.           log.info("当前拦截的Bean为:{}",handlerMethod.getBean().getClass().getName());
    8.           System.out.println("开始拦截---------");
    9.           String uri = request.getRequestURI();
    10.           System.out.println("拦截的uri:"+uri);
    11.       }
    12.       log.info("视图名称:"+modelAndView.getViewName());
    13.       log.info("传给视图的模式:"+modelAndView.getModel().toString());
    14.       System.out.println("CustomInterceptor02 postHandle");
    15.   }

    2.2 配置文件

    在spring-mvc.xml文件中配置拦截器
    ​
      
    1.  <mvc:interceptors>
    2.        <mvc:interceptor>
    3.            <!-- 该拦截器会拦截所有的请求 -->
    4.            <mvc:mapping path="/**"/>
    5.            <bean class="com.zking.mybatisdemo.interceptor.CustomInterceptor"/>
    6.        </mvc:interceptor>
    7.        <!-- 可在此 添加多个拦截器
    8.        <mvc:interceptor>
    9.            <mvc:mapping path="/**"/>
    10.            <bean class="com.zking.mybatisdemo.interceptor.CustomInterceptor"/>
    11.        </mvc:interceptor>
    12.        -->
    13.    </mvc:interceptors>

    4. 开发示例

    登录验证, 开发步骤:

    • 开发登录功能,当用户登录成功,将用户记入session

    • 开发拦截器,如果用户访问除登录功能之外的其他资源,则验证是否登录,否则不允许访问

    1) 登录页面

    1. <%@ page contentType="text/html;charset=UTF-8" language="java" %>
    2. <%@taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>
    3. <html>
    4. <head>
    5.    <title>Title</title>
    6. </head>
    7. <body>
    8.    <c:if test="${not empty error}">
    9.        <div>
    10.           ${error}
    11.        </div>
    12.    </c:if>
    13.    <form action="<%=request.getContextPath()%>/user/login" method="post">
    14.       用户名: <input type="text" name="name"> <br data-tomark-pass>       密码: <input type="password" name="password"><br data-tomark-pass>        <input type="submit" value="提交">
    15.    </form>
    16. </body>
    17. </html>

    2)登录Controller

    1. @Controller
    2. public class LoginController {
    3.    @RequestMapping("/")
    4.    public String loginPage() {
    5.        return "login";
    6.   }
    7.    @PostMapping("/user/login")
    8.    public String login(String name, String password, HttpSession session, Model model) {
    9.        if("admin".equals(name) && "123".equals(password)) {
    10.            session.setAttribute("user", name);
    11.            return "index";
    12.       }
    13.        model.addAttribute("error", "用户名或密码错误");
    14.        return "login";
    15.   }
    16.    @GetMapping("/user/logout")
    17.    public String logout(HttpSession session) {
    18.        session.removeAttribute("user");
    19.        return "redirect:/";
    20.   }
    21. }

    3)编写index.jsp页面,可以是任何内容,可用于演示即可。 在index中加入退出系统的代码(也是为方便演示)

    <a href="<%=request.getContextPath()%>/user/logout">退出</a>

    测试可以登录后,可以进行拦截器的编写了

    4)拦截器的编写,参考代码

    1. public class LoginInterceptor implements HandlerInterceptor {
    2.    @Override
    3.    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
    4.        String uri = request.getRequestURI();
    5.        String contextPath = request.getContextPath();
    6.        //登录页面,放行
    7.        if (uri.endsWith(contextPath+"/") || uri.indexOf("/user/login") >= 0) {
    8.            return true;
    9.       }
    10.        //其他情况需要验证登录
    11.        HttpSession session = request.getSession();
    12.        Object user = session.getAttribute("user");
    13.        //已登录,放行
    14.        if (Objects.nonNull(user)) {
    15.            return true;
    16.       }
    17.        session.setAttribute("error", "请先登录");
    18.        //request.getRequestDispatcher("/WEB-INF/jsp/login.jsp").forward(request,response);
    19.        response.sendRedirect(contextPath+"/");
    20.        //不再处理其他拦截器,直接返回
    21.        return false;
    22.   }
    23. }

    5) 将拦截器配置到spring-mvc.xml

        
            
                
                
            
        

    1.全局异常

    1. 为什么使用全局一场处理

    我们知道,系统中异常包括:编译时异常和运行时异常RuntimeException,前者通过捕获异常从而获取异常信息,后者主要通过规范代码开发、测试通过手段减少运行时异常的发生。在开发中,不管是dao层、service层还是controller层,都有可能抛出异常,在springmvc中,能将所有类型的异常处理从各处理过程解耦出来,既保证了相关处理过程的功能较单一,也实现了异常信息的统一处理和维护。

    2. 异常处理流程

     

    系统的dao、service、controller出现异常都通过throws Exception向上抛出,最后由springmvc前端控制器交由异常处理器进行异常处理。springmvc提供全局异常处理器(一个系统只有一个异常处理器)进行统一异常处理。

    3. SpringMVC异常分类

    1)使用Spring MVC提供的简单异常处理器SimpleMappingExceptionResolver; 2)实现Spring的异常处理接口HandlerExceptionResolver自定义自己的异常处理器; 3)使用@ControllerAdvice + @ExceptionHandler

    4. 使用示例

    4.1 SpringMVC自带的简单异常处理器

    SpringMVC中自带了一个异常处理器叫SimpleMappingExceptionResolver,该处理器实现了HandlerExceptionResolver 接口,全局异常处理器都需要实现该接口

    1)在spring-mvc.xml 中加入如下配置

      
    1.   <bean class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">
    2.      
    3.       <property name="defaultErrorView" value="error"/>
    4.      
    5.       <property name="exceptionAttribute" value="ex"/>
    6.      
    7.       <property name="exceptionMappings">
    8.           <props>
    9.          
    10.               <prop key="java.lang.RuntimeException">errorprop>
    11.           props>
    12.          
    13.       property>
    14.   bean>

    2)配置错误页面 在WEB-INF/jsp 目录下,创建error.jsp, 与上面的spring-mvc.xml中的配置相对应

    1. <%@ page contentType="text/html;charset=UTF-8" language="java" %>
    2. <html>
    3. <head>
    4.    <title>Title</title>
    5. </head>
    6. <body>
    7.    <h1>系统异常,请与管理员联系</h1>
    8. </body>
    9. </html>

    3)可以在Controller中直接抛出一个异常进行测试。

    4.2 通过接口实现全局异常

    通过实现异常处理处理接口HandlerExceptionResovler处理全局异常。

    1) 实现接口

    1. @Component
    2. public class GlobalException implements HandlerExceptionResolver {
    3.    @Override
    4.    public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
    5.        ModelAndView mv = new ModelAndView();
    6.        mv.setViewName("error");
    7.        if(ex instanceof RuntimeException) {
    8.            mv.addObject("msg", ex.getMessage());
    9.       }
    10.        return mv;
    11.   }
    12. }

    注意: 使用这种方式,请将spring-mvc.xml中配置的全局异常删除。

    4.3 使用注解方式定义全局异常

    定义全局异常处理器:

    1. @ControllerAdvice
    2. public class HandlerGlobalException {
    3.    @ExceptionHandler
    4.    public ModelAndView handler(Exception ex) {
    5.        ModelAndView mv = new ModelAndView();
    6.        if(ex instanceof RuntimeException) {
    7.            mv.addObject("msg", ex.getMessage());
    8.       }
    9.        mv.setViewName("error");
    10.        //如果系统直接返回JSON格式的错误数据,可以如下操作
    11.        //mv.setView(new MappingJackson2JsonView());
    12.        
    13.        return mv;
    14.   }
    15. }

    4.4 RestController异常处理

    处理上面的mv.setView(new MappingJackson2JsonView());这种方式,来将错误信息使用JSON方式返回外,还可以使用如下方式:

    @RestControllerAdvice = @ControllerAdvice + @ResponseBody

    1. @RestControllerAdvice
    2. public class HandlerRestGlobalException {
    3.    @ExceptionHandler
    4.    public Map<String,Object> handler(Exception e) {
    5.        Map<String,Object> map = new HashMap<>();
    6.        if(e instanceof RuntimeException) {
    7.            map.put("cod", -1);
    8.            map.put("msg", e.getMessage());
    9.       }
    10.        return map;
    11.   }
    12. }

    注意:返回JSON格式的数据,需要Jackson的支持,在pom.xml中加入jackson的依赖 还需要在 spring配置文件中配置好 jackson

           
    1.  <dependency>
    2.            <groupId>com.fasterxml.jackson.core</groupId>
    3.            <artifactId>jackson-databind</artifactId>
    4.            <version>2.13.3</version>
    5.        </dependency>

  • 相关阅读:
    【科学计算与可视化】1. Numpy 基础
    网络安全等级保护基本要求解读- 安全计算环境-应用系统和数据安全
    C++ 组合模式
    golang实现一个优先队列
    【已解决】CentOS7 启动tomcat服务器,提示Tomcat started,但实际服务未启动成功(失败原因与图片服务器配置和用户权限有关)
    DNG格式详解,DNG是什么?为何DNG可以取代RAW统一单反相机、苹果安卓移动端相机拍摄输出原始图像数据标准
    【EI会议征稿】第五届人工智能、网络与信息技术国际学术会议(AINIT 2024)
    Java多线程
    【linux】倒计时小程序
    在openSUSE-Leap-15.4-DVD-x86_64下安装网易云音乐linux客户端
  • 原文地址:https://blog.csdn.net/qq_62898618/article/details/126817219