span设置教程（如何用span设置版权） - 原点资讯

编码

创建spring-cloud-tutorials的子工程jaeger-annonation-demo，其pom.xml如下：

<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <parent> <artifactId>Spring-cloud-tutorials</artifactId> <groupId>com.bolingcavalry</groupId> <version>1.0-SNAPSHOT</version> </parent> <modelVersion>4.0.0</modelVersion> <artifactId>jaeger-annonation-demo</artifactId> <dependencies> <dependency> <groupId>com.bolingcavalry</groupId> <artifactId>common</artifactId> <version>${project.version}</version> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>io.opentracing.contrib</groupId> <artifactId>opentracing-spring-jaeger-cloud-starter</artifactId> </dependency> <dependency> <groupId>org.apache.commons</groupId> <artifactId>commons-lang3</artifactId> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> <configuration> <layers> <enabled>true</enabled> </layers> </configuration> </plugin> </plugins> </build> </project>

配置文件application.yml：

spring: application: name: jaeger-annonation-demo opentracing: jaeger: enabled: true udp-sender: host: 127.0.0.1 port: 6831 server: port: 18080

启动类：

package com.bolingcavalry.annonation; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; @SpringBootApplication public class AnnonationDemoApplication { public static void main(String[] args) { SpringApplication.run(AnnonationDemoApplication.class, args); } }

第一个接口Biz：

package com.bolingcavalry.annonation.service; public interface ChildBiz { void mockChild(); }

它的实现：

package com.bolingcavalry.annonation.service.impl; import lombok.extern.slf4j.Slf4j; import org.springframework.stereotype.Component; @Component @Slf4j public class ChildBizImpl implements ChildBiz { @Override public void mockChild() { log.info("mockChild"); } }

第二个接口：

package com.bolingcavalry.annonation.service; public interface Biz { void mock(); }

它的实现，可见其mock方法中会调用childBiz的mockChild方法：

package com.bolingcavalry.annonation.service.impl; import com.bolingcavalry.annonation.service.Biz; import lombok.extern.slf4j.Slf4j; import org.springframework.stereotype.Component; @Component @Slf4j public class BizImpl implements Biz { final ChildBiz childBiz; public BizImpl(ChildBiz childBiz) { this.childBiz = childBiz; } @Override public void mock() { log.info("mock"); childBiz.mockChild(); } }

现在一个简单的web服务开发完成，有web层也有service层，够咱们来实验了

定义注解

定义两个注解，一个用于创建span，另一个用于创建子span：
注解MySpan用于希望全新创建一个span的场景：

package com.bolingcavalry.annonation.aop; import java.lang.annotation.*; @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD) @Documented public @interface MySpan { String spanName() default ""; }

第二个是MyChildSpan，用于希望在当前span下创建一个子span的场景：

定义好了注解，可以开发AOP来处理注解的逻辑了

AOP和注解开发

接下来是今天的核心：处理注解的AOP类，中文注释已经写得很详细，就不再赘述太多了，唯一要注意的是注解@Around("@annotation(mySpan)")，它指定了该方法会处理所有被mySpan修饰的方法：

package com.bolingcavalry.annonation.aop; import io.opentracing.Span; import io.opentracing.Tracer; import lombok.extern.slf4j.Slf4j; import org.apache.commons.lang3.StringUtils; import org.aspectj.lang.ProceedingJoinPoint; import org.aspectj.lang.Signature; import org.aspectj.lang.annotation.Around; import org.aspectj.lang.annotation.Aspect; import org.springframework.stereotype.Component; @Aspect @Component @Slf4j public class SpanAspect { private Tracer tracer; public SpanAspect(Tracer tracer) { this.tracer = tracer; } /** * 取得真实方法的相关信息 * @param proceedingJoinPoint * @return */ private static String getOperationDesc(ProceedingJoinPoint proceedingJoinPoint) { Signature signature = proceedingJoinPoint.getSignature(); // 提取类名 return StringUtils.substringAfterLast(signature.getDeclaringTypeName(), ".") ":" signature.getName(); } @Around("@annotation(mySpan)") public Object traceSpan(ProceedingJoinPoint proceedingJoinPoint, MySpan mySpan) throws Throwable { // 类名:方法名 String operationDesc = getOperationDesc(proceedingJoinPoint); // 看方法的注解中有没有设置name String name = mySpan.spanName(); // 如果没有设置name，就给span一个默认name if (StringUtils.isEmpty(name)) { name = "span-aspect-" operationDesc; } // 创建一个span，在创建的时候就添加一个tag Span span = tracer.buildSpan(name).start(); // span日志 span.log("span log of " operationDesc); // 增加一个tag span.setTag("operation-desc", operationDesc); // span结束 span.finish(); return proceedingJoinPoint.proceed(); } @Around("@annotation(myChildSpan)") public Object traceChildSpan(ProceedingJoinPoint proceedingJoinPoint, MyChildSpan myChildSpan) throws Throwable { // 类名:方法名 String operationDesc = getOperationDesc(proceedingJoinPoint); // 看方法的注解中有没有设置name String name = myChildSpan.spanName(); // 如果没有设置name，就给span一个默认name if (StringUtils.isEmpty(name)) { name = "child-span-aspect-" operationDesc; } // 从上下文中取得已存在的span Span parentSpan = tracer.activeSpan(); if (null==parentSpan) { log.error("can not get span from context"); } else { Span span = tracer.buildSpan(name).asChildOf(parentSpan).start(); // span日志 span.log("child span log of " operationDesc); // 增加一个tag span.setTag("child-operation-desc", operationDesc); // span结束 span.finish(); } return proceedingJoinPoint.proceed(); } }

注解和AOP都写好了，咱们把注解用上，看看效果如何

使用注解

把MySpan用来修饰BizImpl.mock方法，注意设置其spanName属性，作为span的name：

span设置教程,如何用span设置版权(5)

把MyChildSpan用来修饰方法ChildBizImpl.mockChild方法，用于创建一个子span，注意注解不设置任何属性，AOP类中会给这个span设置默认的名称：

span设置教程,如何用span设置版权(6)

以上就是全部代码了，咱们运行起来试试吧；

验证

用docker启动Jaeger后台服务：

docker run -d \ --name jaeger \ -e COLLECTOR_ZIPKIN_HTTP_PORT=9411 \ -p 5775:5775/udp \ -p 6831:6831/udp \ -p 6832:6832/udp \ -p 5778:5778 \ -p 16686:16686 \ -p 14268:14268 \ -p 14269:14269 \ -p 9411:9411 jaegertracing/all-in-one:1.26