Spring Boot中如何仅允许调用application.yml内定义的外部API?
完全可行,落地逻辑非常直接,不需要引入额外的复杂组件
第一步:先把yml里的配置绑定成统一可读取的白名单集合
不要散在各个类里读yml配置,写个专门的配置绑定类,把所有声明过的第三方API地址统一存成集合,再加好匹配判断方法,示例代码:
@Component @ConfigurationProperties(prefix = "custom.external-api") @Data public class ExternalApiWhitelistProperties { // 自动把yml下该节点的所有键值对映射成Map,key是你定义的别名,value是对应的API完整地址 private Map<String, String> allowedApis = new HashMap<>(); /** * 判断待调用的目标URL是否在白名单范围内 */ public boolean isUrlAllowed(String targetUrl) { if (targetUrl == null || targetUrl.isBlank()) { return false; } return allowedApis.values().stream() .anyMatch(configUrl -> { try { // 用URI类做规范化解析,避免末尾斜杠、协议小写这类格式差异导致的误判 URI configUri = URI.create(configUrl.trim()); URI targetUri = URI.create(targetUrl.trim()); // 匹配规则可以根据需求调整:比如严格全URL完全相等,或者同域名下匹配路径前缀 return configUri.getHost().equalsIgnoreCase(targetUri.getHost()) && targetUri.getPath().startsWith(configUri.getPath()); } catch (Exception e) { return false; } }); } }
这里要注意匹配规则可以按需自定义,如果要求严格到路径完全一致,就把path判断改成完全相等就行,不需要硬编码固定逻辑。
第二步:在所有外部请求的统一出口加拦截校验
最靠谱的管控方式不是靠写代码的人自觉在每个调用方法前加if判断,而是给所有用来发外部请求的客户端组件(不管是RestTemplate还是WebClient)加全局拦截器,所有发出去的请求统一过校验:
比如用RestTemplate的场景,自定义拦截器逻辑:
public class ApiWhitelistInterceptor implements ClientHttpRequestInterceptor { @Autowired private ExternalApiWhitelistProperties whitelistProperties; @Override public ClientHttpResponse intercept(HttpRequest request, byte[] body, ClientHttpRequestExecution execution) throws IOException { String targetUrl = request.getURI().toString(); // 不在白名单的请求直接抛出异常中断,根本不会真实发出去 if (!whitelistProperties.isUrlAllowed(targetUrl)) { throw new AccessDeniedException("目标API未在配置白名单中,禁止调用: " + targetUrl); } // 白名单内的请求正常放行 return execution.execute(request, body); } }
把这个拦截器注册到你项目里所有使用的RestTemplate实例中即可。如果是用WebClient做请求,逻辑完全一致,加个对应的过滤器做同样的URL校验就行。
这种方式的好处是,哪怕后续写代码时手滑写了个没在配置里的第三方地址,请求根本发不出去,从根源上实现白名单管控。
补充场景处理
如果你的接口设计是直接接收客户端传入的目标第三方API地址、由你的服务代为调用,那光靠请求出口的拦截还不够:
- 要在Controller层接收参数的第一时间就调用白名单校验方法
- 对不合法的目标地址直接返回403错误,不走后续业务逻辑,减少不必要的资源消耗
几个落地的注意点:
- 一定要做URL规范化处理,不要靠简单的字符串比对判断,避免格式差异导致的误判
- 所有需要调用的第三方地址全部放在yml配置里维护,调整白名单只需要改配置重启即可,不需要改代码重新打包
- 匹配规则不要写太宽松,比如如果只是按域名匹配,可能会出现配置了一个域名下的某一个接口,结果把同域名下所有接口都放通的风险,根据实际业务收紧规则
内容的提问来源于stack exchange,提问作者VersuS
相关产品推荐
相关产品推荐

