業務開發時,接口不能對外暴露怎麼辦?
大家好, 我是 風哥
來源:https://juejin.cn/post/7055862842540425223
在業務開發的時候,經常會遇到某一個接口不能對外暴露,只能內網服務間調用的實際需求。面對這樣的情況,我們該如何實現呢?今天,我們就來理一理這個問題,從幾個可行的方案中,挑選一個來實現。
1. 內外網接口微服務隔離
將對外暴露的接口和對內暴露的接口分別放到兩個微服務上,一個服務裏所有的接口均對外暴露,另一個服務的接口只能內網服務間調用。
該方案需要額外編寫一個只對內部暴露接口的微服務,將所有隻能對內暴露的業務接口聚合到這個微服務裏,通過這個聚合的微服務,分別去各個業務側獲取資源。該方案,新增一個微服務做請求轉發,增加了系統的複雜性,增大了調用耗時以及後期的維護成本。
2. 網關 + redis 實現白名單機制
在 redis 裏維護一套接口白名單列表,外部請求到達網關時,從 redis 獲取接口白名單,在白名單內的接口放行,反之拒絕掉。
該方案的好處是,對業務代碼零侵入,只需要維護好白名單列表即可;
不足之處在於,白名單的維護是一個持續性投入的工作,在很多公司,業務開發無法直接觸及到 redis,只能提工單申請,增加了開發成本;另外,每次請求進來,都需要判斷白名單,增加了系統響應耗時,考慮到正常情況下外部進來的請求大部分都是在白名單內的,只有極少數惡意請求才會被白名單機制所攔截,所以該方案的性價比很低。
3. 方案三 網關 + AOP
相比於方案二對接口進行白名單判斷而言,方案三是對請求來源進行判斷,並將該判斷下沉到業務側。避免了網關側的邏輯判斷,從而提升系統響應速度。
我們知道,外部進來的請求一定會經過網關再被分發到具體的業務側,內部服務間的調用是不用走外部網關的(走 k8s 的 service)。
根據這個特點,我們可以對所有經過網關的請求的 header 裏添加一個字段,業務側接口收到請求後,判斷 header 裏是否有該字段,如果有,則說明該請求來自外部,沒有,則屬於內部服務的調用,再根據該接口是否屬於內部接口來決定是否放行該請求。
該方案將內外網訪問權限的處理分佈到各個業務側進行,消除了由網關來處理的系統性瓶頸;同時,開發者可以在業務側直接確定接口的內外網訪問權限,提升開發效率的同時,增加了代碼的可讀性。另外,搜索公衆號互聯網架構師後臺回覆 “9”,獲取一份驚喜禮包。
當然該方案會對業務代碼有一定的侵入性,不過可以通過註解的形式,最大限度的降低這種侵入性。
具體實操
下面就方案三,進行具體的代碼演示。
首先在網關側,需要對進來的請求 header 添加外網標識符: from=public
@Component
public class AuthFilter implements GlobalFilter, Ordered {
@Override
public Mono < Void > filter ( ServerWebExchange exchange, GatewayFilterChain chain ) {
return chain.filter(
exchange.mutate().request(
exchange.getRequest().mutate().header("id", "").header("from", "public").build())
.build()
);
}
@Override
public int getOrder () {
return 0;
}
}
接着,編寫內外網訪問權限判斷的 AOP 和註解
@Aspect
@Component
@Slf4j
public class OnlyIntranetAccessAspect {
@Pointcut ( "@within(org.openmmlab.platform.common.annotation.OnlyIntranetAccess)" )
public void onlyIntranetAccessOnClass () {}
@Pointcut ( "@annotation(org.openmmlab.platform.common.annotation.OnlyIntranetAccess)" )
public void onlyIntranetAccessOnMethed () {
}
@Before ( value = "onlyIntranetAccessOnMethed() || onlyIntranetAccessOnClass()" )
public void before () {
HttpServletRequest hsr = (( ServletRequestAttributes ) RequestContextHolder.getRequestAttributes()) .getRequest ();
String from = hsr.getHeader ( "from" );
if ( !StringUtils.isEmpty( from ) && "public".equals ( from )) {
log.error ( "This api is only allowed invoked by intranet source" );
throw new MMException ( ReturnEnum.C_NETWORK_INTERNET_ACCESS_NOT_ALLOWED_ERROR);
}
}
}
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface OnlyIntranetAccess {
}
最後,在只能內網訪問的接口上加上@OnlyIntranetAccess
註解即可
@GetMapping ( "/role/add" )
@OnlyIntranetAccess
public String onlyIntranetAccess() {
return "該接口只允許內部服務調用";
}
本文由 Readfog 進行 AMP 轉碼,版權歸原作者所有。
來源:https://mp.weixin.qq.com/s/9pXQ48arggTFTbX_Ebz_uQ