Spring Boot微服务：如何批量为Java类方法添加Zipkin自定义Span

这情况我太懂了，重复写20遍一模一样的Span创建/关闭代码简直是噩梦！给你几个更优雅的方案，能彻底摆脱这种冗余代码：

Spring Cloud Sleuth本身就提供了@NewSpan和@SpanTag注解，完全不用手动操作Tracer，自动帮你创建、管理Span的生命周期。

直接给你的Repository方法加注解就行：

@Repository
public class MyClass {

    @NewSpan(name = "dbcall-myMethod1") // 指定Span名称，也可以不写，默认用方法名
    public int myMethod1(@SpanTag("param") String param) { // 标记参数作为Span的tag
        // 原来的方法内容，不用加任何Span相关代码！
        return 1;
    }

    @NewSpan(name = "dbcall-myMethod2")
    public int myMethod2() {
        // 业务逻辑
        return 2;
    }

    // ...剩下的18个方法同理，只需要加@NewSpan就行
}

如果想给所有Repository方法统一设置Span前缀，还可以配合AOP或者属性配置，不过单个方法加注解已经足够简洁了。

如果不想给每个方法加注解，或者需要对所有Repository的数据库调用做统一的Span处理，写一个AOP切面是最优解，一次性搞定所有方法：

首先创建切面类：

@Aspect
@Component
public class RepositorySpanAspect {

    private final Tracer tracer;

    public RepositorySpanAspect(Tracer tracer) {
        this.tracer = tracer;
    }

    // 拦截所有@Repository类下的公共方法
    @Around("within(@org.springframework.stereotype.Repository *) && execution(public * *(..))")
    public Object addDbSpan(ProceedingJoinPoint joinPoint) throws Throwable {
        // 获取方法名作为Span名称，也可以自定义命名规则
        String methodName = joinPoint.getSignature().getName();
        Span span = tracer.createSpan("dbcall-" + methodName);
        try {
            // 可以添加额外Tag，比如类名、参数信息等
            span.tag("class", joinPoint.getTarget().getClass().getSimpleName());
            return joinPoint.proceed(); // 执行原方法
        } finally {
            tracer.close(span);
        }
    }
}

这样你的Repository类完全不用改，所有方法都会自动被加上Span，彻底消除重复代码！而且后续新增方法也不用额外处理，切面会自动拦截。

如果不想用AOP，也可以把Span的逻辑封装成一个模板方法，业务方法只需要关注核心逻辑：

先写一个模板工具类：

@Component
public class SpanTemplate {

    private final Tracer tracer;

    public SpanTemplate(Tracer tracer) {
        this.tracer = tracer;
    }

    // 带返回值的模板方法
    public <T> T executeWithSpan(String spanName, Supplier<T> businessLogic) {
        Span span = tracer.createSpan(spanName);
        try {
            return businessLogic.get();
        } finally {
            tracer.close(span);
        }
    }

    // 无返回值的重载方法
    public void executeWithSpan(String spanName, Runnable businessLogic) {
        Span span = tracer.createSpan(spanName);
        try {
            businessLogic.run();
        } finally {
            tracer.close(span);
        }
    }
}

然后在Repository里注入模板类，调用方法：

@Repository
public class MyClass {

    @Autowired
    private SpanTemplate spanTemplate;

    public int myMethod1() {
        return spanTemplate.executeWithSpan("dbcall-myMethod1", () -> {
            // 原来的方法内容
            return 1;
        });
    }

    public void myMethod2() {
        spanTemplate.executeWithSpan("dbcall-myMethod2", () -> {
            // 原来的方法内容
        });
    }

    // ...其他方法同理，把业务逻辑放到Lambda中即可
}

这种方式比手动写try/finally简洁很多，而且Span逻辑集中在模板类里，后续修改只要调整模板类就行。

个人优先推荐方案1或方案2，尤其是方案2，完全不侵入业务代码，维护成本最低。

内容的提问来源于stack exchange，提问作者Vitalii