com.biz.trace.store.TraceStoreService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of biz-all Show documentation

BizX 是一个灵活而高效的业务开发框架, 其中也有很多为业务开发所需要的工具类的提供。

The newest version!

package com.biz.trace.store;

/**
 * 日志追踪存储接口。
 *
 * 该接口定义了用于管理日志追踪Id的方法。实现类应提供获取和移除当前线程的追踪Id的具体逻辑。
 *
 * 此接口通常用于在分布式系统中，通过跟踪请求链路来实现日志的统一管理和追踪。每个线程可以拥有独立的追踪Id，便于在复杂的系统中定位和分析请求路径。
 *
 *  * 示例使用：
 * {@code
 * TraceStoreService traceStoreService = ...;
 * String traceId = traceStoreService.get();
 * traceStoreService.remove();
 * }
 * 
 *
 * @see com.biz.trace.interceptor.TraceInterceptor
 * @see DefaultTraceStoreServiceImpl
 *
 * @author francis
 * @since 1.0.1
 **/
public interface TraceStoreService {


    /**
     * 设置当前线程的追踪Id。
     *
     * 实现类应确保每个线程都有独立的追踪Id，以便在多线程环境中能够正确地追踪和关联日志。
     *
     * @param traceId 追踪Id
     */
    void put(String traceId);

    /**
     * 获取当前线程的追踪Id。
     *
     * 实现类应确保每个线程都有独立的追踪Id，以便在多线程环境中能够正确地追踪和关联日志。
     *
     * @return 当前线程的追踪Id
     */
    String get();

    /**
     * 移除当前线程的追踪Id。
     *
     * 该方法通常在请求处理完成后调用，以确保追踪Id不会在线程间泄露，并且能够正确清理资源。
     */
    void remove();

}