给dubbo接口添加白名单——dubbo Filter的使用

在开发中，有时候需要限制访问的权限，白名单就是一种方法。对于Java Web应用，Spring的拦截器可以拦截Web接口的调用；而对于dubbo接口，Spring的拦截器就不管用了。
dubbo提供了Filter扩展，可以通过自定义Filter来实现这个功能。本文通过一个事例来演示如何实现dubbo接口的IP白名单。
扩展Filter
实现com.alibaba.dubbo.rpc.Filter接口：

public class AuthorityFilter implements Filter {
    private static final Logger LOGGER = LoggerFactory.getLogger(AuthorityFilter.class);

    private IpWhiteList ipWhiteList;

    //dubbo通过setter方式自动注入
    public void setIpWhiteList(IpWhiteList ipWhiteList) {
        this.ipWhiteList = ipWhiteList;
    }

    @Override
    public Result invoke(Invoker<?> invoker, Invocation invocation) throws RpcException {
        if (!ipWhiteList.isEnabled()) {
            LOGGER.debug("白名单禁用");
            return invoker.invoke(invocation);
        }

        String clientIp = RpcContext.getContext().getRemoteHost();
        LOGGER.debug("访问ip为{}", clientIp);
        List<String> allowedIps = ipWhiteList.getAllowedIps();
        if (allowedIps.contains(clientIp)) {
            return invoker.invoke(invocation);
        } else {
            return new RpcResult();
        }
    }
}

注意：只能通过setter方式来注入其他的bean，且不要标注注解！
dubbo自己会对这些bean进行注入，不需要再标注@Resource让Spring注入，参见扩展点加载
配置文件
参考：调用拦截扩展
在resources目录下添加纯文本文件META-INF/dubbo/com.alibaba.dubbo.rpc.Filter，内容如下：

xxxFilter=com.xxx.AuthorityFilter  

修改dubbo的provider配置文件，在dubbo:provider中添加配置的filter，如下：

<dubbo:provider filter="xxxFilter" />  

这样就可以实现dubbo接口的IP白名单功能了。



filter例子:

/**
 *
 */
public class BizExctionFilter implements Filter {
	private static Logger logger = LoggerFactory.getLogger(BizExctionFilter.class);

	@Override
	public Result invoke(Invoker<?> arg0, Invocation arg1) throws RpcException {
		Result result = arg0.invoke(arg1);
		if (result.hasException()) {
			Throwable exception = result.getException();
			if (exception instanceof BaseDubboException) {
				StringBuilder error = new StringBuilder(arg0.getInterface().getName()).append(" ********* 业务异常(").append(arg1.getMethodName()).append(") ********* ");
				error.append(" REQ_ID:").append(ReqIdUtil.getReqId());
				error.append(",error_code=").append(((BaseDubboException) exception).getCode());
				error.append(",error_msg=").append(exception.getMessage());
				logger.error(error.toString());
			}
		}

		return result;
	}

}