SpringBoot 统⼀功能处理

柔情只为你懂 2023-10-12 19:47 7阅读 0赞

**目录**

SpringBoot 统一功能处理概念

统一用户登录权限验证

登录功能代码

Spring拦截器实现步骤：

统一项目访问前缀

第一种方法：重写configurePathMatch方法进行配置

第二种方法：在系统的配置文件.properties中进行配置

统一异常处理返回

统一数据格式返回

--------------------

## SpringBoot 统一功能处理概念 ##

SpringBoot 统一功能处理就是AOP思想的实战环节，接下来就开始讲解SpringBoot 统一功能实战处理了。

SpringBoot 统一功能实现主要是实现以下功能：

1、统一用户登录权限验证（使用拦截器实现）

2、统一数据格式返回

3、统一异常处理返回

## 统一用户登录权限验证 ##

在原来进行用户登录权限验证时 ，需要在每一个方法体中进行登录方法的验证，代码十分的麻烦。于是就出现了Spring AOP思想，可以进行统一登录权限验证，但是原生Spring AOP实现统一拦截的难点就在于：

1、定义拦截的规则（表达式）非常难；

2、在切面类中拿到HttpSession比较难。

因此在该背景下于是就出现了Spring拦截器。

### 登录功能代码 ###

@RequestMapping("/hi")
    @RestController
    public class controller {
    
        @RequestMapping("/getLogin")
        public String Login(){
            System.out.println("执行了login~~");
            return "login~~";
        }
    
        @RequestMapping("/getUser")
        public String User(){
            System.out.println("执行了user~~");
            return "user~~";
        }
    
        @RequestMapping("/getReg")
        public String reg(){
            System.out.println("执行了reg~~");
            return "reg~~";
        }
    
    }

### **Spring拦截器实现步骤：** ###

**1、实现HandlerInterceptor接口并且重写preHeadler方法，在方法中编写自己的业务代码**

public class LoginInter implements HandlerInterceptor {
        @Override
        public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
            // 用户登录效验
            HttpSession session = request .getSession(false);
            if(session != null && session.getAttribute("userInfo") != null){
                // 说明用户已经登录
                return true;
            }
            // 执行到这里说明用户未登录，既可以设置跳转到登录界面进行重新登录
            response.sendRedirect("/login.html");
            return false;
        }
    }

**2、将拦截器添加到配置文件中，并且设置拦截规则**

1.添加注解：@Configuration

2.实现WebMvcConfigurer接口并重写addInterceptors方法

3.使用 addPathPatterns确定哪些需要拦截的方法，excludePathPatterns为不拦截哪些URL（\*\*表示拦截所有的方法）

**代码如下**

@Configuration
    public class config implements WebMvcConfigurer {
    
        @Override
        public void addInterceptors(InterceptorRegistry registry) {
            registry.addInterceptor(new LoginInter())
                    .addPathPatterns("/**") // 拦截所有请求
                    .excludePathPatterns("/hi/getLogin") // 不拦截该请求URL
                   .excludePathPatterns("/hi/getReg") // 不拦截该请求URL
                    .excludePathPatterns("/**/*.html"); // 不拦截所有的html页面
        }
    }

![6bb125a10ceb48e1a5a5ffc6ca3c5cd4.png][]![5e19552094d74da484913a58b659109a.png][]

![c7cb69406c7e4a0ca16f380aeca6f15c.png][]

> 以上代码未拦截URL为 **"/hi/getLogin"** 、**"/hi/getReg"**、**"/\*\*/\*.html"**, 而是拦截了URL为**"/hi/getUser",**并且自动跳转到了登录界面login.html

不加拦截器效果

![b568366be4b0481ba5cd32aa16223d97.png][]

加了拦截器，会在调⽤ Controller 之前进⾏相应的业务处理，执⾏的流程如下图

![6cecc4d9c7f14daf9be1ca8cc96b5c9b.png][]

## 统一项目访问前缀 ##

#### 第一种方法：重写configurePathMatch方法进行配置 ####

@Override
        public void configurePathMatch(PathMatchConfigurer configurer) {
            configurer.addPathPrefix("hello",c->true);
        }

![d9e78730c6c9480984e99374c36d4d10.png][]

#### 第二种方法：在系统的配置文件.properties中进行配置 ####

# 配置统一访问前缀
    server.servlet.context-path=/hello

![b0ce05f929504383bd31079d0eed51a3.png][]

配置后如果使用原来的URL就会报404错误，此时需要添加**前缀/hello**进行访问

![fa4c0a771532421ab6ac8922abb44361.png][]

![738f34292dbe4536b7a49c6a6231e6e8.png][]

## 统一异常处理返回 ##

当后端发生异常时，需要返回异常通知到前端，方便前端接收识别到异常并进行处理。因此就需要后端返回**统一的异常**提交给前端，否则前端会无法识别到后端返回的异常错误

示例：当后端发生空指针异常时

@RequestMapping("/login")
        public String Login(){
            int a = 100/0;
            System.out.println("执行了login~~");
            return "login~~";
        }

![32dfaaf93a30459886af32c36d1332df.png][]

此时我们需要返回一个统一的异常格式json给前端

**步骤：**

**1.创建一个类，并在类上标明@ControllerAdvice**

**2.添加方法@ExceptionHandler来订阅异常**

> @ControllerAdvice 表示控制器通知类，@ExceptionHandler 是异常处理器，两个结合表示当出现异常的时候执行某个通知，执行某个方法事件

@ControllerAdvice
    @ResponseBody
    public class ErrorException {
        @ExceptionHandler(Exception.class)
        public HashMap<String,Object> exception(Exception e){
            HashMap<String,Object> result = new HashMap<>();
            result.put("code","-1"); // 状态码
            result.put("emg",e.getMessage());  // 错误码描述信息
            result.put("data",null);
            return result;
        }
    
    }

![f0a51bf3399545bfbe38ef0699b9cc6a.png][]

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

##  ##

## 统一数据格式返回 ##

统一数据格式返回可以更好的方便前端接收和解析后端返回的数据，可以大大加快工作效率

步骤：

1.在类上添加注解：@ControllerAdvice

2.实现接口ResponseBodyAdvice并且**必须重写****supports**和**beforeBodyWrite**这两个方法

@ControllerAdvice
    public class Advice implements ResponseBodyAdvice {
        /*
         *重写support和beforeBodyRead两个方法
         * */
        @Override
        public boolean supports(MethodParameter returnType, Class converterType) {
            return true;  // 返回true 则执行下面的beforeBodyWrite，否则不执行
        }
    
        @Override
        public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
            HashMap<String,Object> map = new HashMap<>(); // 返回数据格式为哈希map格式
            map.put("code",200); // 状态码
            map.put("message","");
            map.put("data",body);
            return map;
        }
    }

后端返回给前端数据为数字和字符串形式

**controller代码如下：**

@RequestMapping("/num")
        public Integer getNum(){
            return new Random().nextInt(100); // 后端传递100以内的随机数字给前端
        }
        @RequestMapping("/char")
        public String getString(){
            return "hello,world"; //后端传递字符串"hello,world"给前端
        }

**后端传递数字给前端，结果正常显示**

![d963da06443f4518974a7a9bb366769a.png][]

**后端传递"hello,world"字符串给前端，结果错误显示**

**原因：HashMap 转换成字符串出现异常，因为字符串是一个特殊的类型，需要借助jakson****的转换工具来进行HashMap 转换成字符串**

![91a72cdea8c343bf9021f2ae8ad73e97.png][]

添加jaskon代码如下：

if(body instanceof String){ // instanceof 为判断数据类型
                try {
                    return objectMapper.writeValueAsString(map); // 将HashMap 转换成字符串类型
                } catch (JsonProcessingException e) {
                    e.printStackTrace();
                }
            }

![5b3946601f8b4d1abdff63b93bd36400.png][]

再次运行项目，此时后端将hello,world字符串就成功传递给前端了

![48a8c8744f024e4e8fc765a32ab8f1e9.png][]

[6bb125a10ceb48e1a5a5ffc6ca3c5cd4.png]: https://img-blog.csdnimg.cn/6bb125a10ceb48e1a5a5ffc6ca3c5cd4.png
[5e19552094d74da484913a58b659109a.png]: https://img-blog.csdnimg.cn/5e19552094d74da484913a58b659109a.png
[c7cb69406c7e4a0ca16f380aeca6f15c.png]: https://img-blog.csdnimg.cn/c7cb69406c7e4a0ca16f380aeca6f15c.png
[b568366be4b0481ba5cd32aa16223d97.png]: https://img-blog.csdnimg.cn/b568366be4b0481ba5cd32aa16223d97.png
[6cecc4d9c7f14daf9be1ca8cc96b5c9b.png]: https://img-blog.csdnimg.cn/6cecc4d9c7f14daf9be1ca8cc96b5c9b.png
[d9e78730c6c9480984e99374c36d4d10.png]: https://img-blog.csdnimg.cn/d9e78730c6c9480984e99374c36d4d10.png
[b0ce05f929504383bd31079d0eed51a3.png]: https://img-blog.csdnimg.cn/b0ce05f929504383bd31079d0eed51a3.png
[fa4c0a771532421ab6ac8922abb44361.png]: https://img-blog.csdnimg.cn/fa4c0a771532421ab6ac8922abb44361.png
[738f34292dbe4536b7a49c6a6231e6e8.png]: https://img-blog.csdnimg.cn/738f34292dbe4536b7a49c6a6231e6e8.png
[32dfaaf93a30459886af32c36d1332df.png]: https://img-blog.csdnimg.cn/32dfaaf93a30459886af32c36d1332df.png
[f0a51bf3399545bfbe38ef0699b9cc6a.png]: https://img-blog.csdnimg.cn/f0a51bf3399545bfbe38ef0699b9cc6a.png
[d963da06443f4518974a7a9bb366769a.png]: https://img-blog.csdnimg.cn/d963da06443f4518974a7a9bb366769a.png
[91a72cdea8c343bf9021f2ae8ad73e97.png]: https://img-blog.csdnimg.cn/91a72cdea8c343bf9021f2ae8ad73e97.png
[5b3946601f8b4d1abdff63b93bd36400.png]: https://img-blog.csdnimg.cn/5b3946601f8b4d1abdff63b93bd36400.png
[48a8c8744f024e4e8fc765a32ab8f1e9.png]: https://img-blog.csdnimg.cn/48a8c8744f024e4e8fc765a32ab8f1e9.png