技术文章

SpringBoot 统⼀功能处理

Coisíní3333

An editor at Blogzine

2023-08-14
52天前
3507
12 Views
100

1.用户登录权限效验

⽤户登录权限的发展从之前每个⽅法中⾃⼰验证⽤户登录权限，到现在统⼀的⽤户登录验证处理，它是⼀个逐渐完善和逐渐优化的过程。

1.1 最初用户登录验证

每个⽅法中都有相同的⽤户登录验证权限，它的缺点是：

1. 每个⽅法中都要单独写⽤户登录验证的⽅法，即使封装成公共⽅法，也⼀样要传参调⽤和在⽅法中进⾏判断。

2. 添加控制器越多，调⽤⽤户登录验证的⽅法也越多，这样就增加了后期的修改成本和维护成本。

3. 这些⽤户登录验证的⽅法和接下来要实现的业务⼏何没有任何关联，但每个⽅法中都要写⼀遍。所以提供⼀个公共的 AOP ⽅法来进⾏统⼀的⽤户登录权限验证迫在眉睫。

1.2 Spring AOP 用户统⼀登录验证的问题

说到统⼀的⽤户登录验证，我们想到的第⼀个实现⽅案是 Spring AOP 前置通知或环绕通知来实现。如果要在Spring AOP 的切⾯中实现⽤户登录权限效验的功能，有以下两个问题：

1. 没办法获取到 HttpSession 对象。

2. 我们要对⼀部分⽅法进⾏拦截，⽽另⼀部分⽅法不拦截，如注册⽅法和登录⽅法是不拦截的，这样的话排除⽅法的规则很难定义，甚⾄没办法定义。

1.3 Spring 拦截器

对于以上问题 Spring 中提供了具体的实现拦截器：HandlerInterceptor，拦截器的实现分为以下两个步骤：

1. 创建⾃定义拦截器，实现 HandlerInterceptor 接⼝的 preHandle（执⾏具体⽅法之前的预处理）⽅法。

2. 将⾃定义拦截器加⼊ WebMvcConfigurer 的 addInterceptors ⽅法中。具体实现如下。

1.3.1 自定义拦截器

接下来使⽤代码来实现⼀个⽤户登录的权限效验，⾃定义拦截器是⼀个普通类，具体实现代码如下：

package com.example.demo.interceptor;

import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;

@Component
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("username") != null ){
            //拦截通过
            return true;
        }
        response.setStatus(401);
        return false;
    }
}

1.3.2 将自定义拦截器加⼊到系统配置

将上⼀步中的⾃定义拦截器加⼊到系统配置信息中，具体实现代码如下：

package com.example.demo.config;

import com.example.demo.interceptor.LoginInterceptor;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class AppConfig implements WebMvcConfigurer {
    @Autowired
    private LoginInterceptor loginInterceptor;
    // 添加拦截器
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(loginInterceptor)
                .addPathPatterns("/**")// 拦截所有接⼝
                .excludePathPatterns("/user/login")// 排除接⼝
                .excludePathPatterns("/user/reg");
    }
}

其中：

addPathPatterns：表示需要拦截的 URL，“**”表示拦截任意⽅法（也就是所有⽅法）。
excludePathPatterns：表示需要排除的 URL。说明：以上拦截规则可以拦截此项⽬中的使⽤ URL，包括静态⽂件（图⽚⽂件、JS 和 CSS 等⽂件）。

排除所有的静态资源

// 拦截器
@Override
public void addInterceptors(InterceptorRegistry registry) {
 registry.addInterceptor(new LoginInterceptor())
 .addPathPatterns("/**") // 拦截所有接⼝
 .excludePathPatterns("/**/*.js")
 .excludePathPatterns("/**/*.css")
 .excludePathPatterns("/**/*.jpg")
 .excludePathPatterns("/login.html")
 .excludePathPatterns("/**/login"); // 排除接⼝
}

1.4 拦截器实现原理

正常情况下的调⽤顺序：

然⽽有了拦截器之后，会在调⽤ Controller 之前进⾏相应的业务处理，执⾏的流程如下图所示：

1.4.1 实现原理源码分析

所有的 Controller 执⾏都会通过⼀个调度器 DispatcherServlet 来实现，这⼀点可以从 Spring Boot 控制台的打印信息看出，如下图所示

⽽所有⽅法都会执⾏ DispatcherServlet 中的 doDispatch 调度⽅法，doDispatch 源码如下：

protected void doDispatch(HttpServletRequest request, HttpServletResponse
response) throws Exception {
 HttpServletRequest processedRequest = request;
 HandlerExecutionChain mappedHandler = null;
 boolean multipartRequestParsed = false;
 WebAsyncManager asyncManager = WebAsyncUtils.getAsyncManager(request);
 try {
 try {
 ModelAndView mv = null;
 Object dispatchException = null;
 try {
 processedRequest = this.checkMultipart(request);
 multipartRequestParsed = processedRequest != request;
 mappedHandler = this.getHandler(processedRequest);
 if (mappedHandler == null) {
 this.noHandlerFound(processedRequest, response);
 return;
 }
 HandlerAdapter ha = this.getHandlerAdapter(mappedHandler.g
etHandler());
 String method = request.getMethod();
 boolean isGet = HttpMethod.GET.matches(method);
 if (isGet || HttpMethod.HEAD.matches(method)) {
 long lastModified = ha.getLastModified(request, mapped
Handler.getHandler());
 if ((new ServletWebRequest(request, response)).checkNo
tModified(lastModified) && isGet) {
 return;
 }
 }
 // 调⽤预处理【重点】
 if (!mappedHandler.applyPreHandle(processedRequest, respon
se)) {
 return;
 }
 // 执⾏ Controller 中的业务
 mv = ha.handle(processedRequest, response, mappedHandler.g
etHandler());
 if (asyncManager.isConcurrentHandlingStarted()) {
 return;
}
 this.applyDefaultViewName(processedRequest, mv);
 mappedHandler.applyPostHandle(processedRequest, response,
mv);
 } catch (Exception var20) {
 dispatchException = var20;
 } catch (Throwable var21) {
 dispatchException = new NestedServletException("Handler di
spatch failed", var21);
 }
 this.processDispatchResult(processedRequest, response, mappedH
andler, mv, (Exception)dispatchException);
 } catch (Exception var22) {
 this.triggerAfterCompletion(processedRequest, response, mapped
Handler, var22);
 } catch (Throwable var23) {
 this.triggerAfterCompletion(processedRequest, response, mapped
Handler, new NestedServletException("Handler processing failed", var23));
 }
 } finally {
 if (asyncManager.isConcurrentHandlingStarted()) {
 if (mappedHandler != null) {
 mappedHandler.applyAfterConcurrentHandlingStarted(processe
dRequest, response);
 }
 } else if (multipartRequestParsed) {
 this.cleanupMultipart(processedRequest);
 }
 }
}

从上述源码可以看出在开始执⾏ Controller 之前，会先调⽤预处理⽅法 applyPreHandle，⽽ applyPreHandle ⽅法的实现源码如下：

boolean applyPreHandle(HttpServletRequest request, HttpServletResponse res
ponse) throws Exception {
 for(int i = 0; i < this.interceptorList.size(); this.interceptorIndex
= i++) {
 // 获取项⽬中使⽤的拦截器 HandlerInterceptor
 HandlerInterceptor interceptor = (HandlerInterceptor)this.intercep
torList.get(i);
 if (!interceptor.preHandle(request, response, this.handler)) {
 this.triggerAfterCompletion(request, response, (Exception)null
);
 return false;
 }
 }
 return true;
}

从上述源码可以看出，在 applyPreHandle 中会获取所有的拦截器 HandlerInterceptor 并执⾏拦截器中的 preHandle ⽅法，这样就会与定义的拦截器对应上了

1.4.2 拦截器小结

通过上⾯的源码分析，我们可以看出，Spring 中的拦截器也是通过动态代理和环绕通知的思想实现的，⼤体的调⽤流程如下：

1.5 扩展：统⼀访问前缀添加

所有请求地址添加 api 前缀：

@Configuration
public class AppConfig implements WebMvcConfigurer {
 // 所有的接⼝添加 api 前缀
 @Override
 public void configurePathMatch(PathMatchConfigurer configurer) {
 configurer.addPathPrefix("api", c -> true);
 }
}

2. 统⼀数据格式返回

统⼀异常处理使⽤的是 @ControllerAdvice + @ExceptionHandler 来实现的，@ControllerAdvice 表示控制器通知类，@ExceptionHandler 是异常处理器，两个结合表示当出现异常的时候执⾏某个通知，也就是执⾏某个⽅法事件，具体实现代码如下：

package com.example.demo.config;

import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

import java.util.HashMap;

@ControllerAdvice
public class ErrorHandler {

    @ResponseBody
    @ExceptionHandler(Exception.class)
    public Object error(Exception e){
        HashMap<String,Object> result = new HashMap<>();
        result.put("success",0);
        result.put("code",-1);
        result.put("msg","内部异常");
        return result;
    }
}

PS：⽅法名和返回值可以⾃定义，其中最重要的是 @ExceptionHandler(Exception.class) 注解。

以上⽅法表示，如果出现了异常就返回给前端⼀个 HashMap 的对象，其中包含的字段如代码中定义的那样。

我们可以针对不同的异常，返回不同的结果，⽐以下代码所示：

import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import java.util.HashMap;
@ControllerAdvice
@ResponseBody
public class ExceptionAdvice {
 @ExceptionHandler(Exception.class)
 public Object exceptionAdvice(Exception e) {
 HashMap<String, Object> result = new HashMap<>();
 result.put("success", -1);
 result.put("message", "总的异常信息：" + e.getMessage());
 result.put("data", null);
 return result;
 }
 @ExceptionHandler(NullPointerException.class)
 public Object nullPointerexceptionAdvice(NullPointerException e) {
 HashMap<String, Object> result = new HashMap<>();
 result.put("success", -1);
 result.put("message", "空指针异常：" + e.getMessage());
 result.put("data", null);
 return result;
 }
}

当有多个异常通知时，匹配顺序为当前类及其⼦类向上依次匹配，案例演示。

在 UserController 中设置⼀个空指针异常，实现代码如下：

@RestController
@RequestMapping("/u")
public class UserController {
 @RequestMapping("/index")
 public String index() {
 Object obj = null;
 int i = obj.hashCode();
 return "Hello,User Index.";
 }
}

3. 统⼀异常处理

3.1 为什么需要统⼀数据返回格式？

统⼀数据返回格式的优点有很多，⽐如以下⼏个：

1. ⽅便前端程序员更好的接收和解析后端数据接⼝返回的数据。

2. 降低前端程序员和后端程序员的沟通成本，按照某个格式实现就⾏了，因为所有接⼝都是这样返回的。

3. 有利于项⽬统⼀数据的维护和修改。

4. 有利于后端技术部⻔的统⼀规范的标准制定，不会出现稀奇古怪的返回内容。

3.2 统⼀数据返回格式的实现

统⼀的数据返回格式可以使⽤ @ControllerAdvice + ResponseBodyAdvice 的⽅式实现，具体实现代码如下：

package com.example.demo.config;

import com.fasterxml.jackson.databind.ObjectMapper;
import lombok.SneakyThrows;
import org.springframework.core.MethodParameter;
import org.springframework.http.MediaType;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;

import java.util.HashMap;

@ControllerAdvice
public class ResponseHandler implements ResponseBodyAdvice {
    
    /**
     * 内容是否需要重写（通过此⽅法可以选择性部分控制器和⽅法进⾏重写）
     * 返回 true 表示重写
     */
    @Override
    public boolean supports(MethodParameter returnType, Class converterType) {
        return true;
    }

    /**
     * ⽅法返回之前调⽤此⽅法
     */
    @SneakyThrows
    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
        HashMap<String,Object> result = new HashMap<>();
        result.put("success",1);
        result.put("data",body);
        result.put("errMsg","");
        // 对字符串进行特殊处理
        if (body instanceof String){
            ObjectMapper mapper = new ObjectMapper();
            return mapper.writeValueAsString(result);
        }
        return request;
    }
}

总结

本⽂介绍了统⼀⽤户登录权限的效验使⽤ WebMvcConfigurer + HandlerInterceptor来实现，统⼀异常处理使⽤ @ControllerAdvice + @ExceptionHandler 来实现，统⼀返回值处理使用@ControllerAdvice + ResponseBodyAdvice 来处理。

本文为[Coisíní3333]所创，转载请带上原文链接，感谢

https://blog.csdn.net/qq_59561046/article/details/132086828

选择最适合自己的笔记本

新闻聚合

评论数 0

留下回复

如果您是个网络喷子或者键盘侠，那么建议您多看少说。

SpringBoot 统⼀功能处理

1.用户登录权限效验

1.1 最初用户登录验证

1.2 Spring AOP 用户统⼀登录验证的问题

1.3 Spring 拦截器

1.3.1 自定义拦截器

1.3.2 将自定义拦截器加⼊到系统配置

排除所有的静态资源

1.4 拦截器实现原理

1.4.1 实现原理源码分析

1.4.2 拦截器小结

1.5 扩展：统⼀访问前缀添加

2. 统⼀数据格式返回

3. 统⼀异常处理

3.1 为什么需要统⼀数据返回格式？

3.2 统⼀数据返回格式的实现

总结

选择最适合自己的笔记本

SQL 语句解析过程详解

新闻聚合

评论数 0

留下回复

分享此文章

SQL 语句解析过程详解

SpringBoot—统一功能处理

【服务器】Python一行命令搭建HTTP服务器并外网访问 ...

MyBatis查询数据库（1）

高级会员资格

SpringBoot 统⼀功能处理

1.用户登录权限效验

1.1 最初用户登录验证

1.2 Spring AOP 用户统⼀登录验证的问题

1.3 Spring 拦截器

1.3.1 自定义拦截器

1.3.2 将自定义拦截器加⼊到系统配置

排除所有的静态资源

1.4 拦截器实现原理

1.4.1 实现原理源码分析

1.4.2 拦截器小结

1.5 扩展：统⼀访问前缀添加

2. 统⼀数据格式返回

3. 统⼀异常处理

3.1 为什么需要统⼀数据返回格式？

3.2 统⼀数据返回格式的实现

总结

选择最适合自己的笔记本

SQL 语句解析过程详解

新闻聚合

评论数 0

留下回复

分享此文章

SQL 语句解析过程详解