欢送拜访我的GitHub
https://github.com/zq2599/blog_demos
内容：所有原创文章分类汇总及配套源码，波及Java、Docker、Kubernetes、DevOPS等；
本篇概览
- 在《Jaeger开发入门(java版)》一文中，咱们编码实现了span的创立和上报，如下图红框，尽管代码量不大，然而把这些代码写在业务代码中，侵入性太强，很多程序员都不喜爱：
- 明天咱们试试AOP+自定义注解来解决上述问题，如下图，<font color="blue">mock</font>是个一般办法，增加了红框中的注解<font color="red">@MySpan</font>，就会创立span而后上报到Jaeger，mock办法的代码没有任何改变：
- 通过下面两图的比照，可见注解十分简洁，接下来就实战上述伎俩，具体的步骤如下：
- 新建web工程，外面有controller层，调用service层的服务Biz，服务Biz再调用另一个服务ChildBiz
- 创立两个注解<font color="blue">MySpan</font>和<font color="blue">MyChildSpan</font>
- 创立AOP类SpanAspect，负责解决所有被注解<font color="blue">MySpan</font>和<font color="blue">MyChildSpan</font>润饰的办法；
- 把注解<font color="blue">MySpan</font>和<font color="blue">MyChildSpan</font>用在一般的服务Biz和ChildBiz上
- 启动服务，验证性能；
源码下载
- 本篇实战中的残缺源码可在GitHub下载到，地址和链接信息如下表所示(https://github.com/zq2599/blo...)：
| 名称 | 链接 | 备注 |
|---|---|---|
| 我的项目主页 | https://github.com/zq2599/blo... | 该我的项目在GitHub上的主页 |
| git仓库地址(https) | https://github.com/zq2599/blo... | 该我的项目源码的仓库地址，https协定 |
| git仓库地址(ssh) | git@github.com:zq2599/blog_demos.git | 该我的项目源码的仓库地址，ssh协定 |
- 这个git我的项目中有多个文件夹，本篇的源码在<font color="blue">spring-cloud-tutorials</font>文件夹下，如下图红框所示：
- <font color="blue">spring-cloud-tutorials</font>文件夹下有多个子工程，本篇的代码是<font color="red">jaeger-annonation-demo</font>，如下图红框所示：
编码
- 创立spring-cloud-tutorials的子工程<font color="blue">jaeger-annonation-demo</font>，其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-demoopentracing: jaeger: enabled: true udp-sender: host: 127.0.0.1 port: 6831server: port: 18080- 启动类：
package com.bolingcavalry.annonation;import org.springframework.boot.SpringApplication;import org.springframework.boot.autoconfigure.SpringBootApplication;@SpringBootApplicationpublic 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@Slf4jpublic 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@Slf4jpublic 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：
- 注解<font color="blue">MySpan</font>用于心愿全新创立一个span的场景：
package com.bolingcavalry.annonation.aop;import java.lang.annotation.*;@Retention(RetentionPolicy.RUNTIME)@Target(ElementType.METHOD)@Documentedpublic @interface MySpan { String spanName() default "";}- 第二个是MyChildSpan，用于心愿在以后span下创立一个子span的场景：
package com.bolingcavalry.annonation.aop;import java.lang.annotation.*;@Retention(RetentionPolicy.RUNTIME)@Target(ElementType.METHOD)@Documentedpublic @interface MyChildSpan { String spanName() default "";}- 定义好了注解，能够开发AOP来解决注解的逻辑了
AOP和注解开发
- 接下来是明天的外围：解决注解的AOP类，中文正文曾经写得很具体，就不再赘述太多了，惟一要留神的是注解<font color="red">@Around("@annotation(mySpan)")</font>，它指定了该办法会解决所有被<font color="blue">mySpan</font>润饰的办法：
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@Slf4jpublic 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办法，留神设置其<font color="blue">spanName</font>属性，作为span的name：
- 把MyChildSpan用来润饰办法ChildBizImpl.mockChild办法，用于创立一个子span，留神注解不设置任何属性，AOP类中会给这个span设置默认的名称：
- 以上就是全副代码了，咱们运行起来试试吧；
验证
- 用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- 启动利用jaeger-annonation-demo
- 浏览器拜访<font color="blue">http://localhost:18080/hello</font>，触发web接口类和service类的执行
- 关上jaeger的web页面，地址是<font color="blue">http://localhost:16686/search</font>，如下图，可见trace曾经上报了：
- 点开上图红框中的记录，能够看到这个trace的详情，如下图可见，数据都合乎预期：
- 至此，基于注解的Jaeger上报就实现了，本篇只是提供一个思路和参考代码，在理论利用中，聪慧的您齐全能够制作出更加弱小的注解式上报，例如减少更丰盛的注解属性、基于类的注解、基于参数的注解等，甚至弃用注解，间接用纯正的AOP针对特定package、办法等进行Jaeger上报；
你不孤独，欣宸原创一路相伴
- Java系列
- Spring系列
- Docker系列
- kubernetes系列
- 数据库+中间件系列
- DevOps系列
欢送关注公众号：程序员欣宸
微信搜寻「程序员欣宸」，我是欣宸，期待与您一起畅游Java世界...
https://github.com/zq2599/blog_demos