SpringBoot的统一功能处理

news2024/10/5 18:30:20

1.统一用户的的登录权限校验

最开始的用户登录

Spring拦截器

2.统一数据返回格式

统一数据的返回格式意义

统一数据返回格式的实现

3.统一异常处理

在上篇博客中我介绍了Spring AOP的基础知识,这篇博客则是AOP的实践练习,通过借助AOP实现三个目标

1.统一用户登录权限的校验

2.统一数据的返回格式

3.统一异常处理

接下来我们一个一个来实现

1.统一用户的的登录权限校验

最开始的用户登录

在实现统一用户登录之前先回顾一下之前如何判断用户登录的

@RestController
@RequestMapping("/user")
public class UserController {
    /**
     * 某⽅法 1
     */
    @RequestMapping("/m1")
    public Object method(HttpServletRequest request) {
        // 有 session 就获取，没有不会创建
        HttpSession session = request.getSession(false);
        if (session != null && session.getAttribute("userinfo") != null) {
            // 说明已经登录，业务处理
            return true;
        } else {
            // 未登录
            return false;
        }
    }
}

可以看到为完成登录校验判断就需要在方法中单独写判断方法,封装成公共方法也需要进行调用,如果校验方法修改那么所有调用都需要修改,这将大大增加代码的维护成本,并且这些登录校验代码与所要写的业务代码并无关系但还是需要写出来,所以就需要提供AOP来解决这个问题

当想使用Spring AOP的环绕方法解决问题时我们发现无法获取到HttpSession对象并且有一些方法是不需要拦截的,此时无法准确使用切点定义拦截规则,如何接解决问题呢?可以使用Spring拦截器

Spring拦截器

Spring提供了拦截器:HandlerInterceptor,拦截器实现分为两个步骤

1.创建自定义拦截器,实现HandlerInterceptor接口重写preHandle方法(返回boolean)

**
 * 登录拦截器
 */
@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("userinfo'")!=null) {
            return true;
        }
        response.setStatus(401);
        return false;
    }
}

2.配置拦截规则 实现WebMvcConfigurer接口重写addInterceptors方法将自定义拦截器添加到addInterceptors中

@Configuration
public class MyConfig implements WebMvcConfigurer {
    @Autowired
    private LoginInterceptor loginInterceptor;
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(loginInterceptor)
                .addPathPatterns("/**")//拦截所有请求
                .excludePathPatterns("/user/login")
                .excludePathPatterns("/user/reg");//排除不拦截的url
    }
}

addPathPatterns()表示拦截的URL

excludePathPatterns()表示排除的URL

以上拦截规则可以拦截项目中的URL,包括静态文件(图片/JS/CSS)

2.统一数据返回格式

统一数据的返回格式意义

1.方便前端程序员更好获取和解析后端数据接口返回的数据

2.减低前后端程序员因为数据形式的沟通成本,按照相同格式所有的接口返回数据格式相同

3.有利于代码的维护和修改

统一数据返回格式的实现

统一数据返回格式是通过@ControllerAdvice+ResponseBodyAdvice的方式实现

/**
 * 统一功能的处理
 */
@ControllerAdvice
public class ResponseAdvice implements ResponseBodyAdvice {

    @Override
    public boolean supports(MethodParameter returnType, Class converterType) {
        return true;
    }

    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
        HashMap<String,Object> result=new HashMap<>();
        result.put("code","200");
        result.put("msg","");
        result.put("data",body);
        return result;
    }
}

注意:实现ResponseBodyAdvice接口重写两个方法

1.supports()方法返回值需要改为true,表示内容是否需要重写

2.beforeBodyWrite()方法中就可以通过返回对象统一数据的返回格式了

可以看到我们数据的返回值不再是方法定义的String 或Boolean类型而是统一封装的返回格式

3.统一异常处理

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

/**
 * 统一处理异常
 */
@ControllerAdvice
@ResponseBody
public class ErrorAdvice {
    @ExceptionHandler(Exception.class)
    public HashMap<String,Object> exAdvice(Exception e) {
        HashMap<String,Object>result=new HashMap<>();
        result.put("code","-1");
        result.put("msg",e.getMessage());
        return result;
    }
}