SpringBoot统一功能处理网站首页 技术杂谈

SpringBoot统一功能处理

YoLo♪ 2024-07-02 12:01:02

简介SpringBoot统一功能处理

1.统一用户登陆权限验证

1.创建自定义拦截器

2.统一异常处理

3.统一数据格式返回

实现三个SpringBoot统一功能处理

1.统一用户登陆权限验证

2.统一异常处理

3.统一数据格式返回

1.统一用户登陆权限验证

之前的博客系统中,我们在每个页面都要检查用户是否登录,之后才有权限去做其他操作,之前的判断方式就是,需要验权的每一处都写了相同的验证方法.业务代码中夹杂了这些非业务的代码

现在我们提供一个公共的AOP方法来进行统一的用户登陆权限验证

在AOP的切面中实现用户登陆权限的校验功能非常麻烦

Spring中提供了具体的实现拦截器:HandlerInterceptor

拦截器的实现:

WebMvcConfigurer+HandlerInterceptor

1.创建自定义拦截器

创建一个 Java 类，并实现 HandlerInterceptor 接口，该接口有三个方法：preHandle、postHandle 和 afterCompletion。在 preHandle 方法中编写前置处理逻辑，在 postHandle 方法中编写后置处理逻辑，在 afterCompletion 方法中编写完成后的处理逻辑

此方法返回的是布尔类型的值,返回true表示拦截器验证成功,继续执行目标方法

返回false,则表示拦截器执行失败,验证不通过,后续目标方法不会执行

public class LoginInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        //用户登录判断的业务
        HttpSession session = request.getSession(false);
        if(session!=null && session.getAttribute("session_userinfo")!=null){
            //用户登陆成功
            return true;
        }
        //response.sendRedirect("http://www.baidu.com");跳转页面
        //response.setStatus(401);没有权限
        return false;
    }
}

2.将自定义拦截器配置到系统配置项,并设置拦截规则

代码

@Configuration
public class MyConfig implements WebMvcConfigurer {

    @Autowired
    private LoginInterceptor loginInterceptor;
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(loginInterceptor)
                .addPathPatterns("/**")//拦截所有的url
                .excludePathPatterns("/user/login")//排除登陆功能
                .excludePathPatterns("/user/reg")//排除注册功能
                .excludePathPatterns("/image/**")//排除image下所有的文件
                ;
    }
}

对如下代码测试

这里登陆失败后由于将状态设置为了401,所以网页无法正常运作了

正常的应该是,返回检验登陆失败的信息,让用户从前端了解情况

有了拦截器之后,会在调用Controller之前进行拦截器的预处理操作

执行流程:用户->拦截器->controller->service->mapper->database

下来我们分析源码

所有的Controller执行都会通过一个DispatcherServlet来实现,可以从打印台看出

DispatcherServlet是SpringMVC框架的核心，主要负责管理请求和处理器之间的映射关系，并结合所配置的拦截器和视图解析器来实现请求的分发和结果的呈现

例如:拦截器：DispatcherServlet支持对请求进行拦截，并允许用户定义自己的拦截器来进行请求处理前和处理后的操作

大致流程如下

2.统一异常处理

如果不进行统一异常处理,出现异常,会直接将异常抛到前端

统一的异常处理使用的是@ControllerAdvice和@ExceptionHandler来实现的

@ControllerAdvice表示控制器通知类,@ExceptionHandler是异常处理器,两者结合表示出现异常时执行某个通知

1.建立异常处理类

添加该注解可以集中处理所有 Controller 中抛出的异常，从而避免开发人员在每个 Controller 中都编写异常处理代码的重复劳动

2.创建异常检测的类和业务处理方法

@ControllerAdvice 可以定义一些方法，在方法内部使用 @ExceptionHandler 注解来处理指定类型的异常。当 Controller 中抛出该类型的异常时，就会自动调用相应的方法来处理异常，而不是直接将异常抛到前端

此时就会返回一个json格式的异常信息到前端

上述只是处理了空指针异常,其它异常是拦截不到的.所以将监视异常的范围扩大,出现各种异常,就会找到它们的父类--Exception

添加一个异常代码

如果实现了具体的异常类,也实现了Exception.那么默认是匹配具体的异常处理,匹配不到就会寻找父类的处理

3.统一数据格式返回

统一数据格式返回是指在 Spring MVC 中，定义一个通用的数据结构，来封装所有接口的返回值，这样可以更好地对所有返回结果进行统一处理和管理，从而提高代码的可维护性、可重用性和可扩展性

使用注解@ControllerAdvice+ResponseBodyAdvice接口

步骤:

1.创建一个类，并添加 @ControllerAdvice 注解，该注解作用于类上，表示这是一个全局控制器增强器

2.实现 ResponseBodyAdvice 接口，并指定泛型 T 为 Object 类型。该接口中定义了两个方法 beforeBodyWrite() 和 supports()，分别用于处理响应前的操作和判断是否支持当前返回值类型

3.在 beforeBodyWrite() 方法中，判断响应的对象是否为自定义的统一数据格式返回类型，如果不是，则将它转换成统一的格式，例如封装成一个 Result 对象

4.在 supports() 方法中，判断当前返回值类型是否需要进行统一数据格式返回的处理

使用该方法后，所有返回类型为非基本数据类型的请求，都会经过 ResponseBodyAdvice 的处理，从而统一返回给前端一个自定义的结构体数据

@ControllerAdvice
public class ResponseBody implements ResponseBodyAdvice {

    //是否执行beforeBodyWrite,true为执行
    @Override
    public boolean supports(MethodParameter returnType, Class converterType) {
        return true;
    }
    //返回数据之前进行数据重写
    //body:原始返回值
    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
        //标准返回格式定义为:HashMap<String,Object>->code,msg,data
        if(body instanceof HashMap){
            return body;
        }
        //重写返回结果,返回统一格式
        HashMap<String,Object> res = new HashMap<>();
        res.put("code",200);
        res.put("msg","");
        res.put("data",body);
        return res;
    }
}

reg:

按照保底的数据返回格式应该返回data为sayhello

Resolved [java.lang.ClassCastException: java.util.HashMap cannot be cast to java.lang.String]

将String格式化数据执行流程分为三部

1.方法返回String

2.统一数据格式返回之前处理:String转换为Hash Map

3.将Hash Map转换为application/json 字符串返回给前端(接口)

不进行异常拦截时:

通过报错信息,可以看出是第三步出了问题,无法将HashMap 转换为json字符串

原因:在第三步会对原body类型进行判断

1.String类型:使用StringHttpMessageConverter转换器进行转换

2.非string类型:HttpMessageConverter转换器进行转换

使用的却是StringHttpMessageConverter转换器对HashMap转换成json字符串.就会抛出异常

应当适用HttpMessageConverter

判断时使用原body进行判断,转换时使用的是Hash Map进行转换的..StringHttpMessageConverter转换不了Hash Map

解决方案:

1. 移除StringHttpMessageConverter

通过config配置文件移除

@Configuration
public class MyConfig implements WebMvcConfigurer {
    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        converters.removeIf(converter -> converter instanceof StringHttpMessageConverter);
    }
}