最近公司给我提了一个需求:实现接口的版本校验
文章目录
前言
公司项目有小程序和app两个端的版本,由于开发app的同事只有一位,小程序团队迭代比较快 ,但是我们后端代码用的是同一套后端代码,因此后端接口需要加版本号,app请求时携带版本号,拦截校验对比版本号大小。
思路
1、创建一个注解
2、需要版本检验的接口加上注解
3、创建一个拦截器,在请求进入方法前对版本校验
一、创建注解
提示:注解的创建我是参考了这位博主的:https://www.cnblogs.com/rixiang/p/5709110.html,如果有不明白的小伙伴可以先看看了解一下
代码如下(示例):
package com.yourProject.utils;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
// 声明注解作用于方法
@Target(ElementType.METHOD)
// 声明注解运行时有效
@Retention(RetentionPolicy.RUNTIME)
public @interface CheckVer {
String versions();
}
二、拦截器中的拦截逻辑
代码如下(示例):
package com.yourProject.utils;
import com.github.pagehelper.util.StringUtil;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.HandlerInterceptor;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.lang.reflect.Method;
import java.util.prefs.BackingStoreException;
/**
* AKai
*/
@Slf4j
public class ParamCheck implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
if (handler instanceof HandlerMethod) {
HandlerMethod handlerMethod = (HandlerMethod) handler;
Method method = handlerMethod.getMethod();
CheckVer checkVer = method.getAnnotation(CheckVer.class);
// 没有加注解的接口直接放行
if( checkVer == null ){
return true;
}
// 项目当前版本
String projectVersion = checkVer.versions();
// 请求头的版本
String requestVersion = request.getHeader("versions");
// 必须同时取到两个版本号才进行比较
if ( StringUtil.isEmpty(projectVersion) || StringUtil.isEmpty(requestVersion)) {
return true;
}
int pojVersionInt = 0;
int reqVersion = 0;
// 将版本号字符去除再比较大小
try {
// 删除版本号的字符 '.' => 在转成int 去比较大小
pojVersionInt = Integer.parseInt(projectVersion.replace(".", ""));
reqVersion = Integer.parseInt(requestVersion.replace(".", ""));
} catch (Exception e) {
log.info("版本号转换数字异常!");
// 公司自定义的一个抛异常类,这里写自己的异常处理!
//throw new BackingStoreException("版本号转换数字异常");
}
// 比较版本号大小
if ( reqVersion < pojVersionInt ) {
// 公司自定义的一个抛异常类,这里写自己的异常处理!
throw new BackingStoreException("版本号过低");
}
}
return true;
}
}
三、创建config类让自定义的拦截器生效
代码如下(示例):
package com.yourProject.utils;
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 KaiConfig implements WebMvcConfigurer {
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new ParamCheck());
}
}
拦截器参考资料: https://blog.csdn.net/nnmxyz/article/details/103561911
四、开始测试
1、控制层测试接口
代码如下(示例):
@ApiOperation("测试注解")
@GetMapping("/text")
@CheckVer(versions = "2.2.1")
public Response<TopicInfoRes> getTopicText() {
return Response.success();
}
2、postman 设置
这里的参数昵称 要和拦截器的获取参数的保持一致中 String requestVersion = request.getHeader(“versions”);
3、 测试模拟app携带版本号请求
3.1、传入版本号(2.2.1) 等于 注解版本号(2.2.1) 请求成功
3.2 传入版本号(2.1.1) 等于 注解版本号(2.2.1) 抛异常
版本号低了,成功抛异常
3.3 其他未加注解的接口也要校验一下
返回成功不影响业务功能
总结
感谢阅读,以上就是今天花费两个小时百度自学的一个版本号控制的一个历程,记载一下帮助自己记忆,也希望能帮到大家,如果有错误和遗漏的地方还请大家指点指点O(∩_∩)O。