SpringBoot——统一功能处理
处理登陆拦截
上一片博客中讲到SpringAOP可以对页面进行拦截,我们可以用SpringAOP实现对登陆的拦截
但是由于拦截需要HttpSession对象,并且之后还需要页面重定向,因此在实际应用中,并不用SpringAOP进行登陆拦截,而是采用下面这种方法
- 定义一个拦截器,实现HandlerInterceptor接口
- 重写preHandler方法
- 配置文件中添加拦截器,定义拦截规则
其中的preHandler方法中有request对象,我们可以利用它获得session对象,就可以实现判断用户是否登陆,页面重定向等功能了
public class 自定义拦截器名称 implements HandlerInterceptor {@Overridepublic boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {if(判断符合规则){return true;} return false;}
}
例如定义登陆拦截器:
public class LoginInterceptor implements HandlerInterceptor {/*** @param request* @param response* @param handler* @return 返回true说明登陆成功,否则登陆失败* @throws Exception*/@Overridepublic 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;}
}
自定义一个配置文件,继承WebMvcConfigurer接口,重写addInterceptor方法
@Configuration
public class 配置文件名 implements WebMvcConfigurer {@Overridepublic void addInterceptors(InterceptorRegistry registry) {registry.addInterceptor(new 自定义拦截器).addPathPatterns("添加拦截的请求").excludePathPatterns("添加不拦截的请求")}
}
例如:添加刚才的登陆拦截器
@Configuration
public class Appconfig implements WebMvcConfigurer {@Overridepublic void addInterceptors(InterceptorRegistry registry) {registry.addInterceptor(new LoginInterceptor()).addPathPatterns("/**")//拦截所有请求.excludePathPatterns("/user/login")//不拦截的url地址.excludePathPatterns("/user/reg").excludePathPatterns("/**/*.html")//不拦截的静态资源.excludePathPatterns("/**/*.js").excludePathPatterns("/**/*.css");}
}
代码中把登陆请求,注册请求和登陆html文件请求排除出去,其他的请求都进行拦截,想要对其进行验证,先实现对应代码
@RestController
@RequestMapping("/user")
public class UserController {@RequestMapping("/getuser")public String getUser(){System.out.println("执行getuser");return "执行getuser";}@RequestMapping("/login")public String login(){System.out.println("执行login");return "执行login";}@RequestMapping("/reg")public String reg(){System.out.println("执行reg");return "执行reg";}
}
当我们访问/getuser方法时
页面会自动跳转到login.html
而访问login方法时不会跳转
统一添加前缀
不仅可以在配置文件中添加拦截器,还可以对所有请求的url中都添加前缀
重写configurePathMatch方法:
@Override
public void configurePathMatch(PathMatchConfigurer configurer) {configurer.addPathPrefix("前缀", c -> true);
}
例如我们将所有url都加上/prefix前缀
@Override
public void configurePathMatch(PathMatchConfigurer configurer) {configurer.addPathPrefix("/prefix", c -> true);
}
再次访问login界面,就不会找到该界面了
需要添加/prefix前缀才能访问
除了这种添加统一前缀的方法,还可以在properies中配置
server.servlet.context-path=/prefix
统一异常封装
如果项目中有异常,页面就会出现5XX页面,这时用户会非常懵逼
因此,如果项目中有异常,也需要统一封装成固定格式,返回给前端,让前端编写好看的页面,让用户知道问题所在
对于异常封装有下面的步骤:
- 创建一个类
- 类上添加@ControllerAdvice注解
- 添加异常处理方法
- 方法上用@ExceptionHandler注解,订阅异常
@ControllerAdvice
public class 异常处理类名称 {@ExceptionHandler(异常.class)@ResponseBodypublic 返回格式 自定义名称(异常对应类 e){return 返回信息}
}
例如:
import java.util.HashMap;@ControllerAdvice
public class MyExceptionHandler {/*** 拦截所有空指针异常* @param e* @return 返回code,message,data*/@ExceptionHandler(NullPointerException.class)@ResponseBodypublic HashMap<String, Object> nullException(NullPointerException e){HashMap<String, Object> result = new HashMap<>();result.put("code", "-1");result.put("message", "空指针异常" + e.getMessage());//错误描述信息result.put("data", null);return result;}@ExceptionHandler(Exception.class)@ResponseBodypublic HashMap<String, Object> Exception(Exception e){HashMap<String, Object> result = new HashMap<>();result.put("code", "-1");result.put("message", "异常" + e.getMessage());//错误描述信息result.put("data", null);return result;}
}
这时如果login请求中有空指针异常,页面就会返回下面的结果
统一数据格式返回
步骤:
- 创建类
- 添加@ControllerAdvice方法
- 实现ResponseBodyAdvice接口
- 重写support方法
- 重写beforeBodyWrite方法
其中support方法是beforeBodyWrite方法的开关,只有supproy方法返回true,beforeBodyWrite方法才会生效
@ControllerAdvice
public class 类名称 implements ResponseBodyAdvice {public boolean supports(MethodParameter returnType, Class converterType) {return true;}@Overridepublic Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {return 返回格式;}
}
例如:
@ControllerAdvice
public class ResponseAdvice implements ResponseBodyAdvice {/*** @param returnType* @param converterType* @return 返回true则执行beforeBodyWrite*/@Overridepublic boolean supports(MethodParameter returnType, Class converterType) {return true;}@Overridepublic 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;}
}
返回的结果如下: