資訊專欄INFORMATION COLUMN
摘要：前言上一篇文章自定義注解統一記錄用戶行為日志記錄了層中通過自定義注解配合自動記錄用戶行為日志的過程。那么按照分布式架構中服務層的調用過程是否也可以實現統一記錄日志自定義日志攔截器可以實現這個需求。
前言
上一篇文章 Spring aop+自定義注解統一記錄用戶行為日志 記錄了 web層中通過自定義注解配合Spring aop自動記錄用戶行為日志的過程。那么按照分布式架構中Dubbo服務層的調用過程是否也可以實現統一記錄日志？自定義日志攔截器可以實現這個需求。
需求場景在使用Dubbo搭建的分布式項目中，服務層代碼調用是這樣的:
@GetMapping(value = "/info")
2 public BaseResult userInfo() {
3 //rpc遠程調用用戶服務
4 BaseResult result = mUserService.userInfo();
6 return result;
7 }
這里的用戶服務位于另外一個服務進程，由服務提供者暴露出來，讓web層遠程調用，需要記錄服務結果的調用過程，便于跟蹤定位bug.
自定義日志攔截器翻看下Dubbo官方文檔，可以看到如下內容：
簡要說明：
Dubbo 中所有的攔截器全部繼承自org.apache.dubbo.rpc.Filter接口，我們自己也可以自行擴展，只要繼承該接口即可.
用戶自定義 filter 默認在內置 filter 之后執行
新增 DubboServiceFilter 攔截器如下：
public class DubboServiceFilter implements Filter {
private static final Logger LOGGER = LoggerFactory.getLogger(DubboServiceFilter.class);
@Override
public Result invoke(Invoker invoker, Invocation invocation) throws RpcException {
//外部日志開關默認關閉
String logSwitch = StringUtils.equals(RedisUtil.get(BaseConstants.CACHE_SERVICE_LOG_SWITCH), BaseConstants.YES) ? BaseConstants.YES : BaseConstants.NO;
if (StringUtils.equals(BaseConstants.YES, logSwitch)) {
//打印入參日志
DubboServiceRequest serviceRequest = new DubboServiceRequest();
serviceRequest.setInterfaceName(invocation.getInvoker().getInterface().getName());
serviceRequest.setMethodName(invocation.getMethodName());
serviceRequest.setArgs(invocation.getArguments());
LOGGER.info("dubbo服務接口入參: " + JSON.toJSONString(serviceRequest));
}
//開始時間
long startTime = System.currentTimeMillis();
//執行接口調用邏輯
Result result = invoker.invoke(invocation);
//調用耗時
long elapsed = System.currentTimeMillis() - startTime;
//如果發生異常 則打印異常日志
if (result.hasException() && invoker.getInterface() != GenericService.class) {
LOGGER.error("dubbo執行異常: ", result.getException());
} else {
if (StringUtils.equals(BaseConstants.YES, logSwitch)) {
//打印響應日志
DubboServiceResponse serviceResponse = new DubboServiceResponse();
serviceResponse.setMethodName(invocation.getMethodName());
serviceResponse.setInterfaceName(invocation.getInvoker().getInterface().getName());
serviceResponse.setArgs(invocation.getArguments());
serviceResponse.setResult(new Object[]{result.getValue()});
serviceResponse.setSpendTime(elapsed);
LOGGER.info("dubbo服務響應成功,返回數據: " + JSON.toJSONString(serviceResponse));
}
}
//返回結果響應結果
return result;
}
}
代碼中對應的實體bean如下：
入參實體：
/**
* @program: easywits
* @description:Dubbo服務請求入參實體
* @author: zhangshaolin
* @create: 2019-01-08 20:35
**/
@Data
public class DubboServiceRequest implements Serializable{
private static final long serialVersionUID = 7127824956842786618L;
/**
* 接口名
*/
private String interfaceName;
/**
* 方法名
*/
private String methodName;
/**
* 參數
*/
private Object[] args;
}
響應實體：
/**
* @program: easywits
* @description: Dubbo服務響應結果實體
* @author: zhangshaolin
* @create: 2019-01-08 20:36
**/
@Data
public class DubboServiceResponse implements Serializable{
private static final long serialVersionUID = -2531169660859647737L;
/**
* 接口名
*/
private String interfaceName;
/**
* 方法名
*/
private String methodName;
/**
* 參數
*/
private Object[] args;
/**
* 返回結果
*/
private Object result;
/**
* 調用耗時(毫秒)
*/
private long spendTime;
}
在/src/main/resources/META-INF/dubbo目錄下新增純文本文件org.apache.dubbo.rpc.Filter 內容為：
dubboServiceFilter=com.easywits.common.filter.DubboServiceFilter
鍵值對形式,鍵隨便起個名字
值為DubboServiceFilter攔截器的完整包名.
最后在服務提供者配置文件中添加配置使攔截器生效：
