springboot整合dubbo設置全局唯一ID進行日志追蹤的示例代碼

更新時間：2020年10月26日 17:21:22 作者：松下聽泉

這篇文章主要介紹了springboot整合dubbo設置全局唯一ID進行日志追蹤,本文通過圖文示例相結合給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下

1.新建項目

在這里插入圖片描述

利用idea創(chuàng)建一個父項目，三個子項目，其中一個項目為生產(chǎn)者，一個項目為消費者，一個為接口等公共服務項目，生產(chǎn)者和消費者需要有web依賴，可以作為tomcat容器啟動。

2.項目依賴

<dependencies>
    <dependency>
      <groupId>org.apache.dubbo</groupId>
      <artifactId>dubbo-spring-boot-starter</artifactId>
      <version>2.7.6</version>
    </dependency>

    <!-- zk的依賴 -->
    <dependency>
      <groupId>org.apache.dubbo</groupId>
      <artifactId>dubbo-dependencies-zookeeper</artifactId>
      <version>2.7.6</version>
      <type>pom</type>
      <exclusions>
        <exclusion>
          <groupId>org.slf4j</groupId>
          <artifactId>slf4j-log4j12</artifactId>
        </exclusion>
      </exclusions>
    </dependency>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-aop</artifactId>
      <scope>test</scope>
    </dependency>
    <dependency>
      <groupId>org.aspectj</groupId>
      <artifactId>aspectjweaver</artifactId>
    </dependency>

3.在facade項目中新建接口

在這里插入圖片描述

4.編寫生產(chǎn)者

4.1 增加dubbo配置

server.port=8081
dubbo.registry.address=zookeeper://localhost:2181
dubbo.protocol.name=dubbo
dubbo.protocol.port=20880
dubbo.registry.timeout=30000
dubbo.application.name=dubbo-provider-ll

4.2 編寫生產(chǎn)者dubbo filter

public class ProviderFilter implements Filter {
  @Override
  public Result invoke(Invoker<?> invoker, Invocation invocation) throws RpcException {
    Object threadName= invocation.getAttachment("ThreadName");
    if(null!=threadName){
      Thread thread = Thread.currentThread();
      thread.setName(threadName.toString());
    }
    return invoker.invoke(invocation);
  }
}

注意：此處Filter 是dubbo的filter，不是servlet的filter

這里代碼的目的是將從消費端傳來的線程名稱設置為線程名稱

在resources目錄下新建META-INF/dubbo/com.alibaba.dubbo.rpc.Filter 文件
即新增目錄META-INF/dubbo和文件 com.alibaba.dubbo.rpc.Filter

在文件中增加，等號后面為實現(xiàn)dubbo filter的實現(xiàn)類路徑
providerFilter=com.dubbo.spring.provider.filter.ProviderFilter

4.3編寫dubbo生產(chǎn)者實現(xiàn)類

@Service(filter = {"providerFilter"})
public class DemoServiceImpl implements IDemoService {
  public Logger LOGGER= LoggerFactory.getLogger(DemoServiceImpl.class);
  @Override
  public String getName() {
    LOGGER.info("provider ThreadName : "+Thread.currentThread().getName());
    return "dubbo-test";
  }
}

5.編寫消費者

5.1編寫消費者filter

public class DubboFilter implements Filter {
  @Override
  public Result invoke(Invoker<?> invoker, Invocation invocation) throws RpcException {
    String name = Thread.currentThread().getName();
    invocation.setAttachment("ThreadName",name);
    return invoker.invoke(invocation);
  }
}

此處是將線程名稱放入到attachment中，attachment底層是hashmap，后續(xù)使用dubbo請求生產(chǎn)者時，會把attachment給到生產(chǎn)者，故在生產(chǎn)中中可以通過key ThreadName來獲取消費者端的線程名稱
在resources目錄下新建META-INF/dubbo/com.alibaba.dubbo.rpc.Filter 文件
即新增目錄META-INF/dubbo和文件 com.alibaba.dubbo.rpc.Filter

在文件中增加，等號后面為實現(xiàn)dubbo filter的實現(xiàn)類路徑
consumerFilter=com.dubbo.spring.consumer.filter.DubboFilter

5.2 編寫response對象

public class Response implements Serializable {

  private static final long serialVersionUID = -3186818832535757509L;
  private String code;

  private String message;

  private Object result;

  private String index;

  public String getCode() {
    return code;
  }

  public void setCode(String code) {
    this.code = code;
  }

  public String getMessage() {
    return message;
  }

  public void setMessage(String message) {
    this.message = message;
  }

  public Object getResult() {
    return result;
  }

  public void setResult(Object result) {
    this.result = result;
  }

  public String getIndex() {
    return index;
  }

  public void setIndex(String index) {
    this.index = index;
  }
}

此response為web端返回到頁面統(tǒng)一對象

5.3 編寫aop切面

@Aspect
@Component
public class AopContext {

  @Before("execution(* com.dubbo.spring..*.*(..))")
  public void before(){
    Thread thread = Thread.currentThread();
    thread.setName(UUIDUtil.getUUID());
  }
  @Around("execution(* com.dubbo.spring..*.*(..))")
  public Object around(ProceedingJoinPoint pjp){
    Response response=new Response();
    try {
      Object proceed = pjp.proceed();
      if(proceed instanceof Response){
         response=(Response) proceed;
        response.setIndex(Thread.currentThread().getName());
      }
    } catch (Throwable throwable) {
      throwable.printStackTrace();
    }
    return response;
  }
}

1.before是在請求進入時給線程設置名稱，為隨機生成的uuid
2.around是環(huán)繞通知，在執(zhí)行完之后，在返回的結果中將線程名稱設置進去，便于以后異常追蹤

5.4 編寫web

@RestController
public class WebController {

  private Logger LOGGER= LoggerFactory.getLogger(WebController.class);

  @Reference(filter = {"consumerFilter"})
  private IDemoService iDemoService;

  @GetMapping("/getName")
  public Response getName(){
    LOGGER.info("consumer ThreadName : "+Thread.currentThread().getName());
    String name = iDemoService.getName();
    Response response=new Response();
    response.setResult(name);
    response.setCode("1001");
    response.setMessage("success");
    return response;
  }
}

請求結果

在這里插入圖片描述