Spring Cloud —— 網關

使用Zuul搭建網關

• 可參考：spring cloud-構建微服務架構的網關(API GateWay)

zuul的Filter配置

• 繼承ZuulFilter類，重寫方法

import javax.servlet.http.HttpServletRequest;  
  
import com.netflix.zuul.ZuulFilter;  
import com.netflix.zuul.context.RequestContext;  
  
public class AccessUserNameFilter extends ZuulFilter {  
    @Override  
    public Object run() {  
        RequestContext ctx = RequestContext.getCurrentContext();  
        HttpServletRequest request = ctx.getRequest();  
  
        System.out.println(String.format("%s AccessUserNameFilter request to %s", request.getMethod(), request.getRequestURL().toString()));  
  
        String username = request.getParameter("username");// 獲取請求的參數  
        if(null != username && username.equals("chhliu")) {// 如果請求的參數不爲空，且值爲chhliu時，則通過  
            ctx.setSendZuulResponse(true);// 對該請求進行路由  
            ctx.setResponseStatusCode(200);  
            ctx.set("isSuccess", true);// 設值，讓下一個Filter看到上一個Filter的狀態  
            return null;  
        }else{  
            ctx.setSendZuulResponse(false);// 過濾該請求，不對其進行路由  
            ctx.setResponseStatusCode(401);// 返回錯誤碼  
            ctx.setResponseBody("{\"result\":\"username is not correct!\"}");// 返回錯誤內容  
            ctx.set("isSuccess", false);  
            return null;  
        }  
    }  
  
    @Override  
    public boolean shouldFilter() {  
        return true;// 是否執行該過濾器，此處爲true，說明需要過濾  
    }  
  
    @Override  
    public int filterOrder() {  
        return 0;// 優先級爲0，數字越大，優先級越低  
    }  
  
    @Override  
    public String filterType() {  
        return "pre";// 前置過濾器  
    }  
}

通過繼承ZuulFilter然後覆寫上面的4個方法，就可以實現一個簡單的過濾器，下面就相關注意點進行說明：

• filterType：返回一個字符串代表過濾器的類型，在zuul中定義了四種不同生命週期的過濾器類型，具體如下：

1. pre：可以在請求被路由之前調用
2. route：在路由請求時候被調用
3. post：在route和error過濾器之後被調用
4. error：處理請求時發生錯誤時被調用

• Zuul的主要請求生命週期包括“pre”，“route”和“post”等階段。對於每個請求，都會運行具有這些類型的所有過濾器。
• filterOrder：通過int值來定義過濾器的執行順序
• shouldFilter：返回一個boolean類型來判斷該過濾器是否要執行，所以通過此函數可實現過濾器的開關。在上例中，我們直接返回true，所以該過濾器總是生效
• run：過濾器的具體邏輯。需要注意，這裏我們通過ctx.setSendZuulResponse(false)令zuul過濾該請求，不對其進行路由，然後通過ctx.setResponseStatusCode(401)設置了其返回的錯誤碼    

仿照如上例子可建立多個過濾器，根據filterType的不同在不同的生命週期被調用，具體可參考：spring cloud-zuul的Filter詳解

token續租處理

處理方式與上方自定義過濾器類一致，filterType設置爲“post”，原理是post在route和error過濾器之後被調用，說明已經合法通。此時再根據判斷Token是否即將過期來決定是否進行Token續租。下方判斷規則爲小於 60*20=1200時進行續租

import com.netflix.zuul.ZuulFilter;
import com.netflix.zuul.context.RequestContext;
import com.finshell.hyacinthcloud.base.enums.ErrorCodeEnum;
import com.finshell.hyacinthcloud.base.exception.BusinessException;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang.StringUtils;
import org.springframework.http.HttpHeaders;
import org.springframework.security.oauth2.common.OAuth2AccessToken;
import org.springframework.security.oauth2.provider.token.store.JwtTokenStore;
import org.springframework.stereotype.Component;

import javax.annotation.Resource;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * The class Renew filter.
 *
 * @author [email protected]
 */
@Component
@Slf4j
public class RenewFilter extends ZuulFilter {

	@Resource
	private JwtTokenStore jwtTokenStore;
	private static final int EXPIRES_IN = 60 * 20;

	/**
	 * Filter type string.
	 *
	 * @return the string
	 */
	@Override
	public String filterType() {
		return "post";
	}

	/**
	 * Filter order int.
	 *
	 * @return the int
	 */
	@Override
	public int filterOrder() {
		return 10;
	}

	/**
	 * Should filter boolean.
	 *
	 * @return the boolean
	 */
	@Override
	public boolean shouldFilter() {
		return true;
	}

	/**
	 * Run object.
	 *
	 * @return the object
	 */
	@Override
	public Object run() {
		log.info("RenewFilter - token續租...");
		RequestContext requestContext = RequestContext.getCurrentContext();
		try {
			doSomething(requestContext);
		} catch (Exception e) {
			log.error("RenewFilter - token續租. [FAIL] EXCEPTION={}", e.getMessage(), e);
			throw new BusinessException(ErrorCodeEnum.UAC10011041);
		}
		return null;
	}

	private void doSomething(RequestContext requestContext) {
		HttpServletRequest request = requestContext.getRequest();
		String token = StringUtils.substringAfter(request.getHeader(HttpHeaders.AUTHORIZATION), "bearer ");
		if (StringUtils.isEmpty(token)) {
			return;
		}
		OAuth2AccessToken oAuth2AccessToken = jwtTokenStore.readAccessToken(token);
		int expiresIn = oAuth2AccessToken.getExpiresIn();

		if (expiresIn < EXPIRES_IN) {
			HttpServletResponse servletResponse = requestContext.getResponse();
			servletResponse.addHeader("Renew-Header", "true");
		}
	}

}

可供參考資料：

• Spring OAuth2 token自動續簽方案（與上述並非同一個處理方案請注意）