【dubbo】自定义filter打印接口请求日志

目标

在应用调用dubbo接口或提供的dubbo接口被调用时，通过自定义的filter打印接口请求时的入参信息、服务名、方法名及返回值

实现filter

1. 自定义filter实现类

@Slf4j
@Activate(group = {
    
    "provider", "consumer"})
public class DubboProviderLogFilter implements Filter {
    
    

    @Override
    public Result invoke(Invoker<?> invoker, Invocation invocation) throws RpcException {
    
    
        Map<String, Object> map = new LinkedHashMap<>();
        map.put("service", invocation.getTargetServiceUniqueName());
        map.put("method", invocation.getMethodName());
        map.put("params", getParams(invocation.getArguments(), invocation.getParameterTypes()));

        Result result = null;
        try {
    
    
            result = invoker.invoke(invocation);
            map.put("result", result.getValue());
            log.info("dubbo_request_log={}", JSONObject.toJSONString(map));
            return result;
        } catch (Exception e) {
    
    
            log.error("dubbo_request_catch_exception={}, e", JSONObject.toJSONString(map));
            throw new RuntimeException(e);
        }
    }

    private Map<String, Argument> getParams(Object[] argvs, Class<?>[] argts) {
    
    
        Map<String, Argument> map = new LinkedHashMap<>();
        int size = argvs.length;
        try {
    
    
            for (int i = 0; i < size; i++) {
    
    
                map.put("param" + i, new Argument(JSONObject.toJSONString(argts[i]).replaceAll("\"", ""), argvs[i]));
            }
        } catch (Exception e) {
    
    
            log.error("getParams_catch_exception=", e);
        }
        return map;
    }

    @Data
    @AllArgsConstructor
    private static class Argument {
    
    
        private String type;
        private Object value;
    }
}

注解@Activate中的group参数用以指定filter生效范围，此处同时添加了provider和consumer，那么应用调用dubbo接口和自身对外提供的dubbo接口被调用时会打印日志

2. 配置filter

在资源目录下创建文件META-INF/dubbo/internal/org.apache.dubbo.rpc.Filter
写入以下内容：
dubboRequestLog=com.yourapp.path.DubboProviderLogFilter

3. 使filter生效

有三种方式

1. 在自定义filter实现类中，通过注解@Activate的group参数指定服务提供者还是消费者生效，也可以选择同时生效
2. 在服务提供者的filter属性中指定
3. 在xml配置文件中，统一设置filter
   <dubbo:provider filter="dubboRequestLog"/>或<dubbo:consumer filter="dubboRequestLog"/> 通过filter来配置要使用的filter，这种是针对所有的服务提供者或者服务消费者