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