详解OpenAPI开发如何动态的添加接口实现

更新时间：2023年04月13日 11:06:06 作者：烂笔头

这篇文章主要为大家介绍了OpenAPI开发如何动态的添加接口实现详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪

0 | 需求说明

在如何动态的处理接口的返回数据里提到了我们的业务场景：服务A对接了服务B，服务C等服务的一些接口，然后由服务A统一暴露接口给到外部用户使用。

其中有个需求是：服务A可以动态的接入服务B/C的接口，对外暴露，并无需重启服务Ａ，即支持API接口的动态添加。

1 | 思路方案

传统的API接口暴露方法

传统的业务开发，使用 springboot 的话，会把服务需要暴露的 API 接口写在 controller 层里，然后调用 service 层的接口方法，在实现层 implement 该 service 接口方法的具体实现函数。

controller层

@RestController
@RequestMapping({"/v1"})
@Slf4j
public class HelloController {
    @Autowired
    private HelloService helloService;
    @PostMapping(path = {"/hello"})
    public String hello() {
        return Optional.ofNullable(helloService.hello())
                .map(ret -> new ResponseEntity<>(ret, HttpStatus.OK))
                .orElseThrow(() -> new MMException("something wrong"));
    }
}

service层

public interface HelloService {
    String hello();
}

实现层

@Service
public class HelloServiceImpl implements HelloService {
    @Override
    public String hello(){
        return "hello world";
    }
}

我们可以看到，在 controller 层 API 接口的 subpath 是写好的，构建部署之后，服务具有的 API 接口列表就固定了。如果需要新增 API 接口，就需要重新在 controller 里写代码，编译构建，再部署上线。这样效率很低，而且每次部署，都会影响到线上服务，也不安全。

泛化的方法

对于 OpenAPI 的业务场景来说，其实是不关心接入的 API subpath 具体是什么，只关心能不能通过 subpath 找到对应的需要转发的服务。

那么，在 controller 层，就可以不根据具体的 subpath 来匹配对应的服务，而是通过请求的方法get、post、put　+　通配符的方式来分类接收外部请求，然后利用 AOP切面和 Threadlocal 来处理和传递 subpath 携带的信息，给到实现层，最终在实现层分发请求到各个业务服务的 API 接口。

2 | 具体实施

OpenAPI 的 URL 规范

分为几个组成部分：

http method：请求方法，get、post、put、delete等
http scheme： http or https
OpenAPI统一域名：外部访问 OpenAPI 的统一域名
资源访问类型：访问的资源，api、web等
OpenAPI版本号： OpenAPI 服务自身的版本号
内部服务的名称： OpenAPI 对接的内部服务名称（标识）
内部服务的path：对接内部服务API的 subpath

代码实现

泛化的 controller 层实现以Get、Post请求为例：

@RestController
@RequestMapping({"/v1"})
@Slf4j
@ServicePath
public class OpenApiController {
    @Autowired
    private OpenApiService openApiService;
    @ApiOperation("OpenAPI POST接收")
    @PostMapping(path = {"/**"})
    public ResponseEntity<ReturnBase> filterPost(@Validated @RequestBody(required = false) Map<String, Object> reqMap) {
        return Optional.ofNullable(openApiService.filter(reqMap, null))
                .map(ret -> new ResponseEntity<>(ret, HttpStatus.OK))
                .orElseThrow(() -> new MMException("error.openapi.filter", ReturnEnum.C_GENERAL_BUSINESS_ERROR.getMsgCode()));
    }
    @ApiOperation("OpenAPI GET接收")
    @GetMapping(path = {"/**"})
    public ResponseEntity<ReturnBase> filterGet(@RequestParam(required = false) MultiValueMap<String, String> params) {
        return Optional.ofNullable(openApiService.filter(null, params))
                .map(ret -> new ResponseEntity<>(ret, HttpStatus.OK))
                .orElseThrow(() -> new MMException("error.openapi.filter", ReturnEnum.C_GENERAL_BUSINESS_ERROR.getMsgCode()));
    }
}

service层和service实现层

public interface OpenApiService {
    ReturnBase filter(Map<String, Object> reqBodyMap, MultiValueMap<String, String> reqGetParamsMap);
}
@Service
@Slf4j
public class OpenApiServiceImpl implements OpenApiService {
    @Override
    public ReturnBase filter(Map<String, Object> reqBodyMap, MultiValueMap<String, String> reqGetParamsMap) {
        String svcName = (String) OpenapiThreadlocal.getServiceParams().get(BizConstant.SVC_NAME);
        String svcPathPublic = (String) OpenapiThreadlocal.getServiceParams().get(BizConstant.SVC_PATH_PUBLIC);
        return doBizHandler(svcName, svcPathPublic);
    }
}

AOP切面和注解

@Aspect
@Component
@Slf4j
@Order(1)
public class ServicePathAspect {
    static final Pattern PATTERN = Pattern.compile("/v\\d+(/.+)");
    @Resource
    private CustomProperty customProperty;
    @Pointcut("@within(org.xxx.annotation.ServicePath)")
    public void servicePathOnClass() {}
    @Pointcut("@annotation(org.xxx.annotation.ServicePath)")
    public void servicePathOnMethod() {
    }
    @Before(value = "servicePathOnClass() || servicePathOnMethod()")
    public void before() {
        HttpServletRequest hsr = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
        String reqUri = hsr.getRequestURI();
        String httpMethod = hsr.getMethod();
        if (StrUtil.isEmpty(reqUri)) {
            log.error("request uri is empty");
            throw new MMException(ReturnEnum.A_PARAM_VALIDATION_ERROR);
        }
        Matcher matcher = PATTERN.matcher(reqUri);
        String servicePath = "";
        while (matcher.find()) {
            servicePath = matcher.group(1);
        }
        if (StrUtil.isEmpty(servicePath)) {
            log.error("can't parse service path from {}", reqUri);
            throw new MMException(ReturnEnum.A_PARAM_VALIDATION_ERROR);
        }
        String[] split = servicePath.split("\\/");
        if (split.length < 3) {
            log.error("api format error: {}", servicePath);
            throw new MMException(ReturnEnum.A_PARAM_VALIDATION_ERROR);
        }
        String serviceName = split[1];
        servicePath = servicePath.substring(serviceName.length() + 1);
        Map<String, Object> map = Maps.newHashMap();
        map.put(BizConstant.SVC_NAME, serviceName);
        map.put(BizConstant.SVC_PATH_PUBLIC, servicePath);
        map.put(BizConstant.START_TIMESTAMP, start);
        OpenapiThreadlocal.addServiceParams(map);
    }
}
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ServicePath {
}

Threadlocal工具

public class OpenapiThreadlocal {
    private final static ThreadLocal<Map<String,Object>> SERVICE_PARAMS_HOLDER = new ThreadLocal<>();
    public static void addServiceParams(Map<String, Object> svcParamsMap) {
        SERVICE_PARAMS_HOLDER.set(svcParamsMap);
    }
    public static Map<String, Object> getServiceParams() {
        return SERVICE_PARAMS_HOLDER.get();
    }
    public static void removeServiceParams() {
        SERVICE_PARAMS_HOLDER.remove();
    }
}

至此，服务A可以动态的接入服务B/C的接口，对外暴露，并无需重启服务Ａ，即支持API接口的动态添加的业务需求实现完毕。

以上就是详解OpenAPI开发如何动态的添加接口实现的详细内容，更多关于OpenAPI动态添加接口的资料请关注脚本之家其它相关文章！

您可能感兴趣的文章:

tk.mybatis扩展通用接口使用详解
这篇文章主要介绍了tk.mybatis扩展通用接口使用详解,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2019-08-08
IDEA启动Springboot报错：无效的目标发行版：17 的解决办法
这篇文章主要给大家介绍了IDEA启动Springboot报错：无效的目标发行版：17 的解决办法,文中通过代码示例和图文讲解的非常详细,对大家的学习或工作有一定的帮助,需要的朋友可以参考下
2024-02-02
java实现遍历树形菜单两种实现代码分享
这篇文章主要介绍了java实现遍历树形菜单两种实现代码分享，两种实现：OpenSessionView实现、TreeAction实现。具有一定参考价值，需要的朋友可以了解下。
2017-11-11
如何实现自己的spring boot starter
这篇文章主要介绍了如何实现自己的spring boot starter,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2019-08-08
使用Maven打包、发布、配置版本号命令
在软件开发过程中,打包和发布是关键步骤,本文介绍了如何在打包和发布时跳过测试,如何指定项目版本号,以及如何指定配置文件,提供了实用的技巧和方法,希望对开发者有所帮助
2024-09-09
Spring实战之使用Resource作为属性操作示例
这篇文章主要介绍了Spring实战之使用Resource作为属性,结合实例形式分析了spring载人Resource作为属性相关配置与使用技巧,需要的朋友可以参考下
2020-01-01
Java 轻松入门使用Fiddler抓包工具教程
超文本传输协议（HTTP）是一个简单的请求-响应协议,其主要是基于TCP来实现的，可以通过Chrome开发者工具或者Wireshark或者Fiddler抓包，以便分析 HTTP 请求/响应的细节，本篇博客主要谈论如何使用Fiddler抓取HTTP，当然也可以抓取HTTPS
2022-02-02
JavaEE中struts2实现文件上传下载功能实例解析
这篇文章主要为大家详细介绍了JavaEE中struts2实现文件上传下载功能实例，感兴趣的小伙伴们可以参考一下
2016-05-05
spring整合redis消息监听通知使用的实现示例
在电商系统中，秒杀，抢购，红包优惠卷等操作，一般都会设置时间限制，本文主要介绍了spring整合redis消息监听通知使用，具有一定的参考价值，感兴趣的可以了解一下
2021-12-12
Java @Value("${xxx}")取properties时中文乱码的解决
这篇文章主要介绍了Java @Value("${xxx}")取properties时中文乱码的解决方案，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-07-07