想要年薪百萬，阿里Sentinel支援RESTful介面都搞不定？

2020 年 5 月 14 日
筆記
技術

最近正準備用阿里Sentinel，發現RESTful介面支援的不是很好。有些童鞋可能對Sentinel不是很了解，我們先簡單介紹一下。

Sentinel簡介

Sentinel是一套阿里巴巴開源的流量防衛框架，Github地址是：//github.com/alibaba/Sentinel。隨著微服務的流行，服務與服務之間的穩定性越來越重要。Sentinel以流量為切入點，從流量控制、熔斷降級、系統負載保護等多個維度保護服務的穩定性。

更多介紹可以在Github文檔中了解。

歡迎關注微信公眾號：萬貓學社，每周一分享Java技術乾貨。

問題描述

在Spring MVC或者Spring Boot中的RESTful介面中，有大量的@PathVariable註解，也就是把參數放在URL里，比如：

@RestController
public class DemoController {
    @GetMapping(value = "/hello/{name}")
    public String helloWithName(@PathVariable String name) {
        return "Hello, " + name;
    }
}

但是在Sentinel中把每一次請求的URL作為唯一的資源名，進行匹配和流量控制的，這就造成了一個介面本應是一個資源卻被當作多個資源看待，無法達到流量控制的目的。

白嫖小貼士：什麼是資源？只要通過 Sentinel API 包圍起來的程式碼，就是資源，能夠被 Sentinel 保護起來。例如，由應用程式提供的服務，或由應用程式調用的其它應用提供的服務，甚至可以是一段程式碼。每一個資源都有自己唯一的資源名，用於標識這個資源。

歡迎關注微信公眾號：萬貓學社，每周一分享Java技術乾貨。

查找問題原因

問題的根本原因就在於：Sentinel是如何把每一次請求URL作為唯一的資源名的？閱讀和調試Sentinel的源碼後，我找到CommonFilter的doFilter方法，以下是主要程式碼：

//調用filterTarget方法獲取當前請求的URL
String target = FilterUtil.filterTarget(sRequest);
UrlCleaner urlCleaner = WebCallbackManager.getUrlCleaner();
if (urlCleaner != null) {
    target = urlCleaner.clean(target);
}
if (!StringUtil.isEmpty(target)) {
    String origin = parseOrigin(sRequest);
    String contextName = webContextUnify ? WebServletConfig.WEB_SERVLET_CONTEXT_NAME : target;
    ContextUtil.enter(contextName, origin);

    if (httpMethodSpecify) {
        //如果配置加HTTP方法名做前綴，URL前加HTTP方法名後作為資源名。
        String pathWithHttpMethod = sRequest.getMethod().toUpperCase() + COLON + target;
        urlEntry = SphU.entry(pathWithHttpMethod, ResourceTypeConstants.COMMON_WEB, EntryType.IN);
    } else {
        //如果不加HTTP方法名做前綴，就直接使用URL作為資源名。
        urlEntry = SphU.entry(target, ResourceTypeConstants.COMMON_WEB, EntryType.IN);
    }
}

在上面的程式碼中，我們看見了請求URL作為資源名的整個過程，同時也發現有一個UrlCleaner介面，請求URL會經過它的clean方法進行處理。我們就在這個UrlCleaner介面上做文章了。

歡迎關注微信公眾號：萬貓學社，每周一分享Java技術乾貨。

解決方案

RestfulPattern

首先我們先創建一個類，用來存放URL和對應的正則表達式：

package onemore.study.sentineldemo;

import java.util.regex.Pattern;

/**
 * @author 萬貓學社
 */
public class RestfulPattern implements Comparable<RestfulPattern> {
    private Pattern pattern;
    private String realResource;

    public RestfulPattern(Pattern pattern, String realResource) {
        this.pattern = pattern;
        this.realResource = realResource;
    }

    public Pattern getPattern() {
        return pattern;
    }

    public String getRealResource() {
        return realResource;
    }

    @Override
    public int compareTo(RestfulPattern o) {
        return o.getPattern().pattern().compareTo(this.getPattern().pattern());
    }
}

RestfulUrlCleaner

再寫一個實現UrlCleaner介面的類，在clean方法中寫自己的邏輯：

package onemore.study.sentineldemo;

import com.alibaba.csp.sentinel.adapter.servlet.callback.UrlCleaner;
import com.alibaba.csp.sentinel.slots.block.flow.FlowRule;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

/**
 * @author 萬貓學社
 */
public class RestfulUrlCleaner implements UrlCleaner {

    private List<RestfulPattern> patterns = new ArrayList<>();

    private RestfulUrlCleaner() {
    }

    /**
     * 根據流量控制規則創建與之匹配的RestfulUrlCleaner
     * @param rules 流量控制規則
     * @return RestfulUrlCleaner
     */
    public static RestfulUrlCleaner create(List<FlowRule> rules) {
        RestfulUrlCleaner cleaner = new RestfulUrlCleaner();
        if (rules == null || rules.size() == 0) {
            return cleaner;
        }
        Pattern p = Pattern.compile("\\{[^\\}]+\\}");
        for (FlowRule rule : rules) {
            Matcher m = p.matcher(rule.getResource());
            //如果發現類似{xxx}的結構，斷定其為RESTful介面
            if (m.find()) {
                cleaner.patterns.add(
                        new RestfulPattern(Pattern.compile(m.replaceAll("\\\\S+?")), rule.getResource()));
            }
        }
        //根據正則表達式重新排序
        Collections.sort(cleaner.patterns);
        return cleaner;
    }

    @Override
    public String clean(String originUrl) {
        for (RestfulPattern pattern : patterns) {
            if (pattern.getPattern().matcher(originUrl).matches()) {
                return pattern.getRealResource();
            }
        }
        return originUrl;
    }
}

單元測試

為了驗證程式碼的正確性，我們再寫一下單元測試：

package onemore.study.sentineldemo;

import com.alibaba.csp.sentinel.slots.block.flow.FlowRule;
import org.junit.Assert;
import org.junit.Test;

import java.util.ArrayList;
import java.util.List;

/**
 * @author 萬貓學社
 */
public class RestfulUrlCleanerTest {

    @Test
    public void test(){
        List<FlowRule> rules = new ArrayList<>();
        rules.add(new FlowRule("/hello"));
        rules.add(new FlowRule("/hello/{name}"));
        rules.add(new FlowRule("/hello/{firstName}/{lastName}"));
        rules.add(new FlowRule("/hello/{firstName}/and/{lastName}"));
        RestfulUrlCleaner cleaner = RestfulUrlCleaner.create(rules);

        Assert.assertEquals("/hello", cleaner.clean("/hello"));
        Assert.assertEquals("/hello/{name}", cleaner.clean("/hello/onemore"));
        Assert.assertEquals("/hello/{firstName}/{lastName}", cleaner.clean("/hello/onemore/study"));
        Assert.assertEquals("/hello/{firstName}/and/{lastName}", cleaner.clean("/hello/onemore/and/study"));
    }
}

運行一下單元測試，發現沒有錯誤。

歡迎關注微信公眾號：萬貓學社，每周一分享Java技術乾貨。

設置UrlCleaner

在實際開發中，流量控制規則可能配置在Redis、ZooKeeper或者 Apollo中。無論在哪裡，流量控制規則每次發生變更時都要重新設置UrlCleaner。我們就以硬編碼流量控制規則為例：

package onemore.study.sentineldemo;

import com.alibaba.csp.sentinel.adapter.servlet.callback.WebCallbackManager;
import com.alibaba.csp.sentinel.slots.block.RuleConstant;
import com.alibaba.csp.sentinel.slots.block.flow.FlowRule;
import com.alibaba.csp.sentinel.slots.block.flow.FlowRuleManager;
import org.springframework.context.annotation.Configuration;

import javax.annotation.PostConstruct;
import java.util.ArrayList;
import java.util.List;

@Configuration
public class DemoConfiguration {
    @PostConstruct
    public void initRules() {
        List<FlowRule> rules = new ArrayList<>();
        FlowRule rule = new FlowRule();
        rule.setResource("/hello/{name}");
        rule.setGrade(RuleConstant.FLOW_GRADE_QPS);
        //設置QPS限流閾值為1
        rule.setCount(1);
        rules.add(rule);

        WebCallbackManager.setUrlCleaner(RestfulUrlCleaner.create(rules));
        FlowRuleManager.loadRules(rules);
    }
}

至此，RESTful介面多資源的問題被完美解決。

微信公眾號：萬貓學社

微信掃描二維碼

獲得更多Java技術乾貨

Tags: 技術